E2E framework (linode#77)

* Introduce E2E framework

* Use Tilt for provisioning on CI

* Allow oud.tilt.dev for e2e test GA

* Allow storage.googleapis.com  for build-test GA

---------

Co-authored-by: Richard Kovacs <[email protected]>

.github/workflows/build_test_ci.yml

@@ -30,6 +30,7 @@ jobs:
           proxy.golang.org:443
           sum.golang.org:443
           objects.githubusercontent.com:443
+          storage.googleapis.com:443
 
     - uses: actions/checkout@v4
 
@@ -89,6 +90,64 @@ jobs:
     - name: Nilcheck
       run: make nilcheck
 
+  e2e-test:
+    needs:  [go-build-test, docker-build]
+    runs-on: ubuntu-latest
+    steps:
+    - name: Harden Runner
+      uses: step-security/harden-runner@v2
+      with:
+        disable-sudo: true
+        egress-policy: block
+        allowed-endpoints: >
+          api.github.com:443
+          github.com:443
+          gcr.io:443
+          proxy.golang.org:443
+          sum.golang.org:443
+          *.githubusercontent.com:443
+          docker.io:443
+          registry-1.docker.io:443
+          auth.docker.io:443
+          production.cloudflare.docker.com:443
+          storage.googleapis.com:443
+          registry.k8s.io:443
+          *.pkg.dev:443
+          *.amazonaws.com:443
+          *.blob.core.windows.net:443
+          quay.io:443
+          *.quay.io:443
+          api.snapcraft.io:443
+          cloud.tilt.dev:443
+
+    - uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: 'stable'
+
+    - name: Docker cache
+      uses: ScribeMD/[email protected]
+      with:
+        key: docker-${{ runner.os }}-${{ hashFiles('Makefile') }}}
+
+    - name: E2E test
+      run: make e2etest
+      env:
+        GITHUB_TOKEN: ${{ secrets.github_token }}
+        LINODE_TOKEN: ${{ secrets.LINODE_TOKEN }}
+
+    - name: Copy logs
+      if: ${{ always() }}
+      run: docker cp tilt-control-plane:/var/log .logs
+
+    - uses: actions/upload-artifact@v4
+      if: ${{ always() }}
+      with:
+        name: logs
+        path: .logs/*
+
   docker-build:
     runs-on: ubuntu-latest
     steps:
@@ -114,7 +173,7 @@ jobs:
     - name: Docker cache
       uses: ScribeMD/[email protected]
       with:
-        key: docker-${{ runner.os }}-${{ hashFiles('Dockerfile') }}
+        key: docker-${{ runner.os }}-${{ hashFiles('Makefile') }}
 
     - name: Build the Docker image
       run: make docker-build

.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 .idea
 bin/*
+kind-logs-*
 cover.out
 kubeconfig

ctlptl-config.yaml → .tilt/ctlptl-config.yaml

@@ -2,6 +2,7 @@
 apiVersion: ctlptl.dev/v1alpha1
 kind: Cluster
 product: kind
+registry: ctlptl-registry
 kindV1Alpha4Cluster:
   name: tilt
   nodes:

Makefile

@@ -88,6 +88,13 @@ vulncheck: govulncheck ## Run vulnerability check against code.
 test: manifests generate fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test -race -timeout 60s ./... -coverprofile cover.out
 
+.PHONY: e2etest
+e2etest: kind ctlptl tilt kuttl kustomize clusterctl manifests generate
+	@echo -n "LINODE_TOKEN=$(LINODE_TOKEN)" > config/default/.env.linode
+	$(CTLPTL) apply -f .tilt/ctlptl-config.yaml
+	$(TILT) ci --timeout 180s -f Tiltfile
+	$(KUTTL) test --config e2e/kuttl-config.yaml
+
 ##@ Build
 
 .PHONY: build
@@ -152,8 +159,8 @@ undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/confi
 .PHONY: tilt-cluster
 tilt-cluster: ctlptl tilt kind clusterctl
 	@echo -n "LINODE_TOKEN=$(LINODE_TOKEN)" > config/default/.env.linode
-	$(CTLPTL) apply -f ctlptl-config.yaml
-	$(TILT) up
+	$(CTLPTL) apply -f .tilt/ctlptl-config.yaml
+	$(TILT) up --stream
 
 ##@ Build Dependencies
 
@@ -171,6 +178,7 @@ CLUSTERCTL ?= $(LOCALBIN)/clusterctl
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 TILT ?= $(LOCALBIN)/tilt
 KIND ?= $(LOCALBIN)/kind
+KUTTL ?= $(LOCALBIN)/kuttl
 ENVTEST ?= $(LOCALBIN)/setup-envtest
 HUSKY ?= $(LOCALBIN)/husky
 NILAWAY ?= $(LOCALBIN)/nilaway
@@ -183,6 +191,7 @@ CLUSTERCTL_VERSION ?= v1.5.3
 CONTROLLER_TOOLS_VERSION ?= v0.13.0
 TILT_VERSION ?= 0.33.6
 KIND_VERSION ?= 0.20.0
+KUTTL_VERSION ?= 0.15.0
 HUSKY_VERSION ?= v0.2.16
 NILAWAY_VERSION ?= latest
 GOVULNC_VERSION ?= v1.0.1
@@ -231,6 +240,12 @@ $(KIND): $(LOCALBIN)
 	test -s $(KIND) && $(KIND) version | grep -q $(KIND_VERSION) || \
 	(cd $(LOCALBIN); curl -Lso ./kind https://github.com/kubernetes-sigs/kind/releases/download/v$(KIND_VERSION)/kind-$(OS)-$(ARCH_SHORT) && chmod +x kind)
 
+.PHONY: kuttl
+kuttl: $(KUTTL) ## Download kuttl locally if necessary. If wrong version is installed, it will be overwritten.
+$(KUTTL): $(LOCALBIN)
+	test -s $(KUTTL) && $(KUTTL) version | grep -q $(KUTTL_VERSION) || \
+	(cd $(LOCALBIN); curl -Lso ./kuttl https://github.com/kudobuilder/kuttl/releases/download/v$(KUTTL_VERSION)/kubectl-kuttl_$(KUTTL_VERSION)_$(OS)_$(ARCH) && chmod +x kuttl)
+
 .PHONY: envtest
 envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
 $(ENVTEST): $(LOCALBIN)

README.md

@@ -10,6 +10,22 @@
 # Cluster API Provider Linode
 A [Cluster API](https://cluster-api.sigs.k8s.io/) implementation for the [Linode](https://www.linode.com/) to create kubernetes clusters.
 
+## Local development
+
+### Enable git hooks
+
+To enable automatic code validation on code push, execute the following commands:
+
+```bash
+PATH="$PWD/bin:$PATH" make husky && husky install
+```
+
+If you temporary would like to disable git hook, set `SKIP_GIT_PUSH_HOOK` value:
+
+```bash
+SKIP_GIT_PUSH_HOOK=1 git push
+```
+
 ### Local development with Tilt
 
 For local development execute the following `make` target:
@@ -19,3 +35,15 @@ LINODE_TOKEN=<YOUR LINODE TOKEN> make tilt-cluster
 ```
 
 This command creates a Kind cluster, and deploys resources via Tilt. You can freely change the code and wait for Tilt to update provider.
+
+### E2E testing
+
+For local development execute the following `make` target:
+
+```bash
+LINODE_TOKEN=<YOUR LINODE TOKEN> make e2etest
+```
+
+This command creates a Kind cluster, and executes all the defined tests.
+
+> Please ensure you have increased maximum open files on your host: https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files

Tiltfile

@@ -1,8 +1,8 @@
-docker_build("controller", ".", only=("vendor","go.mod", "go.sum", "./api", "./cloud","./cmd", "./controller", "./util"))
+docker_build("controller", ".", only=("Dockerfile", "Makefile", "vendor","go.mod", "go.sum", "./api", "./cloud","./cmd", "./controller", "./util"))
 
 local_resource(
-	'capi-controller-manager',
-	cmd='clusterctl init',
+    'capi-controller-manager',
+    cmd='clusterctl init',
 )
 
 k8s_yaml(kustomize('config/default'))

config/manager/kustomization.yaml

@@ -1,2 +1,8 @@
 resources:
 - manager.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+images:
+- name: controller
+  newName: controller
+  newTag: latest

config/samples/infrastructure_v1alpha1_linodevpc.yaml

@@ -0,0 +1,12 @@
+apiVersion: infrastructure.cluster.x-k8s.io/v1alpha1
+kind: LinodeVPC
+metadata:
+  labels:
+    app.kubernetes.io/name: linodevpc
+    app.kubernetes.io/instance: linodevpc-sample
+    app.kubernetes.io/part-of: cluster-api-provider-linode
+    app.kubernetes.io/managed-by: kustomize
+    app.kubernetes.io/created-by: cluster-api-provider-linode
+  name: linodevpc-sample
+spec:
+  region: us-east

config/samples/kustomization.yaml

@@ -4,4 +4,5 @@ resources:
 - infrastructure_v1alpha1_linodemachine.yaml
 - infrastructure_v1alpha1_linodemachinetemplate.yaml
 - infrastructure_v1alpha1_linodeclustertemplate.yaml
+- infrastructure_v1alpha1_linodevpc.yaml
 #+kubebuilder:scaffold:manifestskustomizesamples

e2e/kind-config.yaml

@@ -0,0 +1,11 @@
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+name: kuttl
+nodes:
+- role: control-plane
+  image: kindest/node:v1.28.0
+  extraPortMappings:
+  - containerPort: 8080
+    hostPort: 28080
+  - containerPort: 8081
+    hostPort: 28081

e2e/kuttl-config.yaml

@@ -0,0 +1,6 @@
+apiVersion: kuttl.dev/v1beta1
+kind: TestSuite
+testDirs:
+- e2e/basic
+kindConfig: e2e/kind-config.yaml
+timeout: 120