Add integration test workflow (#71)

Author: astaticvoid

.github/workflows/integration-test.yaml

@@ -0,0 +1,35 @@
+name: integration
+on:
+  push:
+    branches:
+      - main
+jobs:
+  integration-test:
+    name: Run Integration Test
+    runs-on: ubuntu-latest
+    environment: Integration Test
+    permissions:
+      id-token: write
+    steps:
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@master
+        with:
+          aws-region: us-west-2
+          role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
+          role-session-name: IntegrationTestSession
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.17
+      - name: Set up env
+        run: source ~/.bashrc
+      - name: Start clean
+        run: make integration-cleanup
+      - name: Set up cluster
+        run: make integration-setup
+      - name: Run tests
+        run: make integration-run
+      - name: Clean up clusters
+        run: make integration-cleanup

Makefile

@@ -55,18 +55,26 @@ vet: ## Run go vet against code.
 	go vet ./...
 
 ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
-test: manifests generate generate-mocks fmt vet ## Run tests.
+test: manifests generate generate-mocks fmt vet test-setup ## Run tests.
+	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./... -coverprofile cover.out -covermode=atomic
+
+test-setup: # setup test environment
 	mkdir -p ${ENVTEST_ASSETS_DIR}
 	test -f ${ENVTEST_ASSETS_DIR}/setup-envtest.sh || curl -sSLo ${ENVTEST_ASSETS_DIR}/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/v0.7.2/hack/setup-envtest.sh
-	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./... -coverprofile cover.out -covermode=atomic
+	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR)
+
+integration-suite: ## Provision and run integration tests with cleanup
+	make integration-setup && \
+	make integration-run && \
+	make integration-cleanup
 
-integration-setup:  ## Setup the integration test using kind clusters
+integration-setup: build kind test-setup ## Setup the integration test using kind clusters
 	@./integration/scripts/setup-kind.sh
 
 integration-run: ## Run the integration test controller
 	@./integration/scripts/run-tests.sh
 
-integration-cleanup:  ## Cleanup integration test resources in Cloud Map and local kind cluster
+integration-cleanup: kind  ## Cleanup integration test resources in Cloud Map and local kind cluster
 	@./integration/scripts/cleanup-cloudmap.sh
 	@./integration/scripts/cleanup-kind.sh
 
@@ -126,6 +134,9 @@ MOCKGEN = $(shell pwd)/bin/mockgen
 mockgen: ## Download mockgen
 	$(call go-get-tool,$(MOCKGEN),github.com/golang/mock/[email protected])
 
+KIND = $(shell pwd)/bin/kind
+kind: ## Download kind
+	$(call go-get-tool,$(KIND),sigs.k8s.io/[email protected])
 
 # go-get-tool will 'go get' any package $2 and install it to $1.
 PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))

README.md

@@ -4,6 +4,7 @@
 [![CodeQL](https://github.com/aws/aws-cloud-map-mcs-controller-for-k8s/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/aws/aws-cloud-map-mcs-controller-for-k8s/actions/workflows/codeql-analysis.yml)
 [![Build status](https://github.com/aws/aws-cloud-map-mcs-controller-for-k8s/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/aws/aws-cloud-map-mcs-controller-for-k8s/actions/workflows/build.yml)
 [![Deploy status](https://github.com/aws/aws-cloud-map-mcs-controller-for-k8s/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/aws/aws-cloud-map-mcs-controller-for-k8s/actions/workflows/deploy.yml)
+[![Integration status](https://github.com/aws/aws-cloud-map-mcs-controller-for-k8s/actions/workflows/integration-test.yml/badge.svg?branch=main)](https://github.com/aws/aws-cloud-map-mcs-controller-for-k8s/actions/workflows/integration-test.yml)
 [![codecov](https://codecov.io/gh/aws/aws-cloud-map-mcs-controller-for-k8s/branch/main/graph/badge.svg)](https://codecov.io/gh/aws/aws-cloud-map-mcs-controller-for-k8s)
 
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg?color=success)](http://www.apache.org/licenses/LICENSE-2.0)
@@ -60,7 +61,7 @@ kubectl apply -f https://raw.githubusercontent.com/aws/aws-cloud-map-mcs-control
 
 ### Import services
 
-In your other cluster, the controller will automatically sync services registered in AWS CloudMap by applying the appropriate `ServiceImport`. To list them all, run
+In your other cluster, the controller will automatically sync services registered in AWS Cloud Map by applying the appropriate `ServiceImport`. To list them all, run
 ```sh
 kubectl get ServiceImport -A
 ```
@@ -93,6 +94,12 @@ To install from `latest` tag run
 kubectl apply -k "github.com/aws/aws-cloud-map-mcs-controller-for-k8s/config/controller_install_latest"
 ```
 
+## Integration testing
+The end-to-end integration test suite can be run locally to validate controller core functionality. This will provision a local Kind cluster and build and run the AWS Cloud Map MCS Controller for K8s. The test will verify service endpoints sync with AWS Cloud Map. If successful, the suite will then de-provision the local test cluster and delete AWS Cloud Map namespace `aws-cloud-map-mcs-e2e` along with test service and service instance resources.
+```sh
+make integration-suite
+```
+
 ## Contributing
 `aws-cloud-map-mcs-controller-for-k8s` is an open source project. See [CONTRIBUTING](https://github.com/aws/aws-cloud-map-mcs-controller-for-k8s/blob/main/CONTRIBUTING.md) for details.
 

integration/scripts/cleanup-cloudmap.sh

@@ -5,4 +5,4 @@
 set -eo pipefail
 source ./integration/scripts/common.sh
 
-go run ./integration/janitor/runner/main.go "$NAMESPACE"
+go run ./integration/janitor/runner/main.go "$NAMESPACE"

integration/scripts/cleanup-kind.sh

@@ -5,4 +5,4 @@
 set -eo pipefail
 source ./integration/scripts/common.sh
 
-$KIND_BIN delete cluster --name "$KIND_SHORT"
+$KIND_BIN delete cluster --name "$KIND_SHORT"

integration/scripts/common.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-KIND_BIN='kind'
+KIND_BIN='./bin/kind'
 KUBECTL_BIN='./testbin/bin/kubectl'
 LOGS='./integration/testlog'
 CONFIGS='./integration/configs'
@@ -11,4 +11,4 @@ ENDPT_PORT=80
 KIND_SHORT='cloud-map-e2e'
 CLUSTER='kind-cloud-map-e2e'
 IMAGE='kindest/node:v1.19.11@sha256:07db187ae84b4b7de440a73886f008cf903fcf5764ba8106a9fd5243d6f32729'
-EXPECTED_ENDPOINT_COUNT=5
+EXPECTED_ENDPOINT_COUNT=5

integration/scripts/poll-endpoints.sh

@@ -21,10 +21,10 @@ do
     continue
   fi
 
-  endpts=$(echo "$addresses" | tr -s " " "$addresses" | cut -f 3 -d " ")
+  endpts=$(echo "$addresses" | tr -s " " | cut -f 3 -d " ")
 
   endpt_count=$(echo "$endpts" | tr ',' '\n' | wc -l | xargs)
 done
 
 echo "$endpts"
-exit 0
+exit 0

integration/scripts/run-tests.sh

@@ -13,10 +13,9 @@ $KUBECTL_BIN apply -f "$CONFIGS/e2e-export.yaml"
 endpts=$(./integration/scripts/poll-endpoints.sh "$EXPECTED_ENDPOINT_COUNT")
 
 mkdir -p "$LOGS"
-make
 ./bin/manager &> "$LOGS/ctl.log" &
 CTL_PID=$!
 
 go run $SCENARIOS/runner/main.go $NAMESPACE $SERVICE $ENDPT_PORT "$endpts"
 
-kill $CTL_PID
+kill $CTL_PID