Run Riff in e2e CI tests (#311)

Author: kars7e

Makefile

@@ -26,13 +26,9 @@ GO_LDFLAGS += -X $(VERSION_PACKAGE).commit=$(shell git rev-parse HEAD)
 GO_LDFLAGS +="
 
 PKGS := pkg
-
 GIT_VERSION = $(shell git describe --tags)
+PREFIX ?= $(shell pwd)
 
-# Output prefix, defaults to local directory if not specified
-ifeq ($(PREFIX),)
-	PREFIX := $(shell pwd)
-endif
 
 .PHONY: all
 all: generate linux darwin

ci/Makefile

@@ -0,0 +1,126 @@
+# Allows running CI jobs manually, each step at a time. It serves following purposes:
+# * validation of tasks - if task succeeded invoked using this file, it's more likely it will succeed in pipeline.
+#   Executing entire pipeline costs time, so validating individual tasks brings value.
+# * debugging issues with PRs - when pipeline fails, it might be easier to debug by reducing the debugging iteration time.
+#
+#
+# ## Details: ##
+# "make images" will build images. This step and the "build-cli" step are the only steps that are executed locally.
+# Other steps are executed in concourse worker.
+#
+#
+# ## Example workflow: ##
+#
+# 1. Build images (set DOCKER_REGISTRY if you want to use other registry than vmware):
+#    DOCKER_REGISTRY=gcr.io/project-id make -f ci/Makefile images
+# At this point, images are pushed to the repo.
+#
+# 2. Create a GKE cluster:
+#    make create-cluster
+# This will create a GKE cluster and print its name. You can retrieve kubelet credentials using following command:
+#    gcloud container clusters get-credentials CLUSTER_NAME
+# You don't need to do it, as deploy dispatch command will deploy dispatch for you.
+# NOTE: Once you created a cluster, you can skip this step in next debugging iteration.
+#
+# 4. Prepare Dispatch CLI:
+#    make build-cli
+# if you changed something in CLI code, run this step again before running tests or deploying dispatch
+#
+# 3. Deploy dispatch:
+#    DOCKER_REGISTRY=gcr.io/project-id make deploy-dispatch-openfaas
+# or
+#    DOCKER_REGISTRY=gcr.io/project-id make deploy-dispatch-riff
+# depending on which faas backend you would like to use. Once you deploy dispatch, you can update it manually using kubectl,
+# or rerun this step (if you, for example, updated image tag).
+#
+# 4. Run e2e tests:
+#    make e2e-tests-riff
+# or
+#    make e2e-tests-openfaas
+# this step will execute e2e-tests.
+#
+# 5. Uninstall dispatch:
+#    make uninstall-dispatch
+# Run this when you're done with testing. Note: make sure you run this step so there are no leftovers after cluster is deleted.
+#
+# 6. Delete the cluster:
+#    make cleanup
+# Run this to delete the k8s cluster on GKE. MAKE SURE YOU RUN THIS STEP!
+#
+
+MAKE_PATH := $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
+DISPATCH_PATH := $(MAKE_PATH)/..
+
+GKE_KEY ?= ((gke-key))
+GKE_PROJECT_ID ?= ((gke-project-id))
+DOCKER_REGISTRY ?= vmware
+PUSH_IMAGES ?= 1
+BUILD ?= $(shell date +%s)
+CLUSTER_NAME_SUFFIX ?= $(shell whoami)
+
+DOCKER_REGISTRY_HOST = $(DOCKER_REGISTRY)
+export GKE_KEY
+export GKE_PROJECT_ID
+export DOCKER_REGISTRY
+export DOCKER_REGISTRY_HOST
+export PUSH_IMAGES
+export BUILD
+export CLUSTER_NAME_SUFFIX
+
+.PHONY: all
+all: images create-cluster build-cli deploy-dispatch e2e-tests cleanup
+
+.PHONY: login
+login:
+	fly -t dispatch login
+
+.PHONY: images
+images:
+	if [[ "$(DOCKER_REGISTRY)" =~ ^gcr\.io.* ]]; then gcloud docker --authorize-only; fi
+	$(MAKE) -f $(DISPATCH_PATH)/Makefile images
+	mkdir -p ciinputs/properties
+	echo "tag=dev-$(BUILD)" > ciinputs/properties/keyval.properties
+
+
+.PHONY: create-cluster
+create-cluster: ## Create a Kubernetes cluster on GKE
+	rm -rf ciinputs/cluster
+	mkdir -p ciinputs/cluster
+	fly -t dispatch e -c $(MAKE_PATH)/e2e/gke-cluster-create.yml -i dispatch=$(DISPATCH_PATH) -o k8s-cluster=ciinputs/cluster
+	@echo "Cluster $(shell cat ciinputs/cluster/name) created"
+
+.PHONY: build-cli
+build-cli: ## Build CLI to be used in CI
+	mkdir -p ciinputs/dispatch-cli
+	GOOS=linux go build -o ciinputs/dispatch-cli/dispatch github.com/vmware/dispatch/cmd/dispatch
+
+.PHONY: deploy-dispatch-openfaas
+deploy-dispatch-openfaas: ## Deploy dispatch with OpenFaaS on Kubernetes cluster
+	FAAS=openfaas fly -t dispatch e -c $(MAKE_PATH)/e2e/deploy-dispatch.yml -i dispatch=$(DISPATCH_PATH) -i cluster=ciinputs/cluster -i dispatch-cli=ciinputs/dispatch-cli -i properties=ciinputs/properties
+
+.PHONY: deploy-dispatch-riff
+deploy-dispatch-riff: ## Deploy dispatch with Riff on Kubernetes cluster
+	FAAS=riff fly -t dispatch e -c $(MAKE_PATH)/e2e/deploy-dispatch.yml -i dispatch=$(DISPATCH_PATH) -i cluster=ciinputs/cluster -i dispatch-cli=ciinputs/dispatch-cli -i properties=ciinputs/properties
+
+.PHONY: e2e-tests-openfaas
+e2e-tests-openfaas: ## Run e2e tests with OpenFaaS
+	FAAS=riff fly -t dispatch e -c $(MAKE_PATH)/e2e/run-tests.yml -i dispatch=$(DISPATCH_PATH) -i cluster=ciinputs/cluster -i dispatch-cli=ciinputs/dispatch-cli -o tests-logs=ciinputs/tests-logs
+
+.PHONY: e2e-tests-riff
+e2e-tests-riff: ## Run e2e tests with Riff
+	FAAS=riff fly -t dispatch e -c $(MAKE_PATH)/e2e/run-tests.yml -i dispatch=$(DISPATCH_PATH) -i cluster=ciinputs/cluster -i dispatch-cli=ciinputs/dispatch-cli -o tests-logs=ciinputs/tests-logs
+
+.PHONY: collect-logs
+collect-logs: ## Collect logs && uninstall
+	fly -t dispatch e -c $(MAKE_PATH)/e2e/collect-logs.yml -i dispatch=$(DISPATCH_PATH) -i cluster=ciinputs/cluster -i tests-logs=ciinputs/tests-logs -o dispatch-logs=ciinputs/dispatch-logs
+
+.PHONY: uninstall-dispatch
+uninstall-dispatch: ## Uninstall Dispatch from the cluster.
+	fly -t dispatch e -c $(MAKE_PATH)/e2e/uninstall-dispatch.yml -i dispatch=$(DISPATCH_PATH) -i cluster=ciinputs/cluster -i dispatch-cli=ciinputs/dispatch-cli
+
+.PHONY: cleanup
+cleanup: ## Cleanup the cluster
+	fly -t dispatch e -c $(MAKE_PATH)/e2e/cleanup.yml -i dispatch=$(DISPATCH_PATH) -i cluster=ciinputs/cluster
+
+help: ## Display make help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(firstword $(MAKEFILE_LIST)) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

ci/e2e/cleanup.yml

@@ -8,11 +8,9 @@ image_resource:
     tag: v0.0.10
 
 # dispatch must be dispatch git repo.
-# dispatch-cli must contain "dispatch" binary
 inputs:
 - name: dispatch
 - name: cluster
-- name: dispatch-cli
 
 params:
   GKE_KEY:

ci/e2e/collect-logs.yml

@@ -8,11 +8,9 @@ image_resource:
     tag: v0.0.10
 
 # dispatch must be dispatch git repo.
-# dispatch-cli must contain "dispatch" binary
 inputs:
 - name: dispatch
 - name: cluster
-- name: dispatch-cli
 - name: tests-logs
 
 params:
@@ -23,6 +21,7 @@ params:
   APIGATEWAY_NAMESPACE: kong
   APIGATEWAY_NAME: api-gateway
   POSTGRES_NAME: postgres
+  RIFF_NAMESPACE: riff
 
 outputs:
 - name: dispatch-logs
@@ -44,8 +43,10 @@ run:
     kubectl logs --tail 100 -n kube-system $(kubectl get deployments -n kube-system -o=name | grep ingress-controller) > ingress_controller.log 2>&1
 
     # OpenFaaS logs
-    kubectl logs deploy/gateway -n ${FAAS_NAMESPACE} > openfaas_gateway.log 2>&1
-    kubectl logs deploy/faas-netesd -n ${FAAS_NAMESPACE} > openfaas_faas-netesd.log 2>&1
+    if kubectl get namespace ${FAAS_NAMESPACE}; then
+      kubectl logs deploy/gateway -n ${FAAS_NAMESPACE} > openfaas_gateway.log 2>&1
+      kubectl logs deploy/faas-netesd -n ${FAAS_NAMESPACE} > openfaas_faas-netesd.log 2>&1
+    fi
 
     # Dispatch logs
     kubectl logs deploy/dispatch-function-manager -n ${DISPATCH_NAMESPACE} -c function-manager | sed 's/\\n/\n/g' > dispatch-function-manager.log 2>&1
@@ -67,27 +68,23 @@ run:
     kubectl exec ${KONG_PODNAME} -n=${APIGATEWAY_NAMESPACE} cat /usr/local/kong/logs/admin_access.log > kong-admin-access.log 2>&1
     kubectl exec ${KONG_PODNAME} -n=${APIGATEWAY_NAMESPACE} cat /usr/local/kong/logs/error.log > kong-error.log 2>&1
 
+    # Riff logs
+    if kubectl get namespace ${RIFF_NAMESPACE}; then
+      kubectl logs deploy/riff-riff-function-controller -n ${RIFF_NAMESPACE} | sed 's/\\n/\n/g' > riff-function-controller.log 2>&1
+      kubectl logs deploy/riff-riff-topic-controller -n ${RIFF_NAMESPACE} | sed 's/\\n/\n/g' > riff-topic-controller.log 2>&1
+      kubectl logs deploy/riff-riff-http-gateway -n ${RIFF_NAMESPACE} | sed 's/\\n/\n/g' > riff-http-gateway.log 2>&1
+    fi
+
     # Bats log
     cp tests-logs/bats.log .
 
 
+
+
     tar -czf dispatch-logs/${BUNDLE_ID}.tar.gz *.log
 
     echo
     echo
     echo "Job failed. Download logs from dispatch-logs/${BUNDLE_ID}.tar.gz on S3"
     echo
     echo
-
-    cp dispatch-cli/dispatch /usr/local/bin/dispatch
-    mkdir -p ~/.dispatch
-
-    set +x
-    if [[ -n ${GKE_PROJECT_ID} ]]; then
-        cp dispatch/ci/e2e/configs/dispatch-install-gke.yml install.yaml
-    else
-        cp dispatch/ci/e2e/configs/dispatch-install-local.yml install.yaml
-    fi
-    set -x
-    dispatch uninstall --file install.yaml
-    exit $?

ci/e2e/config-gke-env.sh

@@ -4,9 +4,13 @@ set -e +x -u
 
 : ${GKE_ZONE:="us-west1-c"}
 
+echo "Setting up GKE key"
 echo ${GKE_KEY} | base64 --decode --ignore-garbage > ${HOME}/gcloud-service-key.json
+echo "Activating GKE account"
 gcloud auth activate-service-account --key-file ${HOME}/gcloud-service-key.json >/dev/null 2>&1
-gcloud config set project $GKE_PROJECT_ID >/dev/null 2>&1
+echo "Setting GKE project"
+gcloud config set project ${GKE_PROJECT_ID} >/dev/null 2>&1
+echo "Setting default GKE compute zone"
 gcloud config set compute/zone ${GKE_ZONE} >/dev/null 2>&1
 
 set -x

ci/e2e/configs/dispatch-install-gke.yml

@@ -7,6 +7,7 @@ dispatch:
   host: 10.0.0.1
   port: 443
   skipAuth: true
+  faas: FAAS
   image:
     host: DOCKER_REGISTRY_HOST
     tag: IMAGE_TAG

ci/e2e/configs/dispatch-install-local.yml

@@ -4,6 +4,7 @@ dispatch:
   host: dispatch.local
   port: 443
   skipAuth: true
+  faas: FAAS
   image:
     host: DOCKER_REGISTRY_HOST
     tag: IMAGE_TAG

ci/e2e/deploy-dispatch.yml

@@ -11,6 +11,7 @@ params:
   GKE_KEY:
   GKE_PROJECT_ID:
   DOCKER_REGISTRY_HOST:
+  FAAS: openfaas
 
 # dispatch must be dispatch git repo.
 # dispatch-cli must contain "dispatch" binary
@@ -43,6 +44,7 @@ run:
 
     sed -i "s/IMAGE_TAG/${IMAGE_TAG}/g" install.yaml
     sed -i "s#DOCKER_REGISTRY_HOST#${DOCKER_REGISTRY_HOST}#g" install.yaml
+    sed -i "s/FAAS/${FAAS}/g" install.yaml
 
     cp dispatch-cli/dispatch /usr/local/bin/dispatch
 

ci/e2e/gke-cluster-create.yml

@@ -12,6 +12,7 @@ params:
   GKE_PROJECT_ID:
   K8S_VERSION: 1.8.7-gke.1
   GKE_ZONE: us-west1-c
+  CLUSTER_NAME_SUFFIX: job
 
 inputs:
 - name: dispatch
@@ -28,7 +29,7 @@ run:
 
     source dispatch/ci/e2e/config-gke-env.sh
 
-    export cluster_name=dispatch-ci-$(date +%s)
+    export cluster_name=dispatch-ci-${CLUSTER_NAME_SUFFIX}-$(date +%s)
     echo ${cluster_name} > k8s-cluster/name
 
     gcloud container clusters create -m n1-standard-2 --cluster-version ${K8S_VERSION} ${cluster_name}

ci/e2e/run-tests.yml

@@ -10,6 +10,7 @@ image_resource:
 params:
   GKE_KEY:
   GKE_PROJECT_ID:
+  FAAS: openfaas
 
 # dispatch must be dispatch git repo.
 # dispatch-cli must contain "dispatch" binary
@@ -58,24 +59,5 @@ run:
     fi
     export BATS_LOG="$(pwd)/tests-logs/bats.log"
     pushd dispatch
-    set +e
     ./e2e/scripts/run-e2e.sh e2e/tests
-    test_result=$?
-    popd
-    set -e
-    if [ "$test_result" -eq 0 ]
-    then
-        set +x
-        if [[ -n ${GKE_PROJECT_ID} ]]; then
-            cp dispatch/ci/e2e/configs/dispatch-install-gke.yml install.yaml
-        else
-            cp dispatch/ci/e2e/configs/dispatch-install-local.yml install.yaml
-        fi
-        set -x
-        dispatch uninstall --file install.yaml
-        exit $?
-    else
-        # collect logs must uninstall
-        exit 1
-    fi