test(e2e): environment setup (#43)

Create the CI and testing infrastructure for e2e testing. Running the ci
task now will push the plugin and sidecar images to a local registry,
start kind, install the CloudNativePG and cert-manager operators, and
then install the plugin-barman-cloud one.

No actual test is implemented.

Signed-off-by: Francesco Canovai <[email protected]>

Author: fcanovai

.github/workflows/ci.yml

@@ -8,12 +8,35 @@ jobs:
   ci:
     runs-on: ubuntu-latest
     steps:
+      - name: Cleanup Disk
+        uses: jlumbroso/[email protected]
+        with:
+          android: true
+          dotnet: true
+          haskell: true
+          tool-cache: true
+          large-packages: false
+          swap-storage: false
+      - name: Cleanup docker cache
+        run: |
+          echo "-------------Disk info before cleanup----------------"
+          df -h
+          echo "-----------------------------------------------------"
+          docker system prune -a -f
+          echo "-------------Disk info after cleanup----------------"
+          df -h
+          echo "-----------------------------------------------------"
       - name: Checkout
         uses: actions/checkout@v4
         # We need the full history for the commitlint task
         with:
           fetch-depth: 0
           ref: ${{ github.event.pull_request.head.sha }}
+      # TODO: remove this when we daggerize the e2e
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.23.x'
       - name: Install Task
         uses: arduino/setup-task@v2
       - name: Install Dagger

.gitignore

@@ -34,3 +34,8 @@ go.work
 
 # Taskfile cache
 .task
+
+# E2e test artifacts
+test/e2e/bin
+# Test registry certificates
+certs/

Taskfile.yml

@@ -1,5 +1,12 @@
 version: 3
 
+# Environment variables that are shared across tasks.
+env:
+  REGISTRY_NETWORK: barman-cloud-plugin
+  REGISTRY_NAME: registry.barman-cloud-plugin
+  REGISTRY_PORT: 5000
+  DAGGER_ENGINE_CONTAINER_NAME: e2e-dagger-engine
+
 tasks:
   lint:
     desc: Run golangci-lint
@@ -66,32 +73,133 @@ tasks:
     sources:
       - ./**/*.go
 
+  generate-certs:
+    desc: Generate certificates for the local registry
+    run: once
+    cmds:
+      - > 
+          mkdir -p certs &&
+          pushd certs &&
+          openssl genrsa -out ca-key.pem 4096 &&
+          openssl req -new -x509 -days 365 -key ca-key.pem -sha256 -out ca.pem \
+              -subj "/O=CloudNativePG/OU=Barman Cloud Plugin Testing" &&
+          openssl genrsa -out server-key.pem 4096 &&
+          openssl req -subj "/CN=${REGISTRY_NAME}" -sha256 -new -key server-key.pem -out server.csr &&
+          echo subjectAltName = DNS:${REGISTRY_NAME},IP:127.0.0.1 >> extfile.cnf &&
+          echo extendedKeyUsage = serverAuth >> extfile.cnf &&
+          openssl x509 -req -days 365 -sha256 -in server.csr -CA ca.pem -CAkey ca-key.pem \
+              -CAcreateserial -out server-cert.pem -extfile extfile.cnf &&
+          popd
+    status:
+        - test -f certs/ca-key.pem
+        - test -f certs/ca.pem
+        - test -f certs/server-key.pem
+        - test -f certs/server.csr
+        - test -f certs/server-cert.pem
+
+  start-build-network:
+    desc: Create a docker network for image building used by the dagger engine and the registry
+    run: once
+    cmds:
+      - docker network create ${REGISTRY_NETWORK}
+    status:
+      - docker network inspect ${REGISTRY_NETWORK}
+
+  start-registry:
+    desc: Start a container registry
+    run: once
+    deps:
+      - generate-certs
+      - start-build-network
+    env:
+      # TODO: renovate
+      REGISTRY_VERSION: 2
+    cmds:
+      - >
+        docker run -d --name ${REGISTRY_NAME}
+        -p ${REGISTRY_PORT}:5000
+        --network ${REGISTRY_NETWORK}
+        -v $(pwd)/certs:/certs
+        -e REGISTRY_HTTP_TLS_CERTIFICATE=/certs/server-cert.pem -e REGISTRY_HTTP_TLS_KEY=/certs/server-key.pem
+        registry:${REGISTRY_VERSION}
+    status:
+      - \[ "$(docker inspect -f {{`'{{.State.Running}}'`}} "${REGISTRY_NAME}" 2> /dev/null )" == 'true' \]
+
+
+  # Start a dagger engine that mounts the CA certificate for the local registry.
+  start-dagger-engine-for-local-builds:
+    desc: Start a dagger engine mounting the CA
+    run: once
+    deps:
+      - generate-certs
+      - start-build-network
+    env:
+      # TODO: renovate
+      DAGGER_ENGINE_IMAGE: registry.dagger.io/engine:v0.13.6
+    cmds:
+      - >
+        docker run -d -v /var/lib/dagger --name "${DAGGER_ENGINE_CONTAINER_NAME}"
+        --network=${REGISTRY_NETWORK}
+        -v $(pwd)/certs/ca.pem:/usr/local/share/ca-certificates/ca.crt
+        --privileged ${DAGGER_ENGINE_IMAGE}
+    status:
+      - \[ "$(docker inspect -f {{`'{{.State.Running}}'`}} "${DAGGER_ENGINE_CONTAINER_NAME}" 2> /dev/null )" == 'true' \]
+
+  # We build an image and push it to a local registry.
+  # The name is always `plugin-barman-cloud:testing`.
   build-plugin-image:
     desc: Build the operator container image for the plugin
+    deps:
+      - start-registry
+      - start-dagger-engine-for-local-builds
     env:
       # renovate: datasource=git-refs depName=docker lookupName=https://github.com/purpleclay/daggerverse currentValue=main
       DAGGER_DOCKER_SHA: 4778f39b9cf56e0242c124000a563f9486dafa4b
+      _EXPERIMENTAL_DAGGER_RUNNER_HOST: docker-container://{{.DAGGER_ENGINE_CONTAINER_NAME}}
     cmds:
       - >
-        GITHUB_REF= dagger -s call -m github.com/purpleclay/daggerverse/docker@${DAGGER_DOCKER_SHA}
-        build --dir . --file containers/Dockerfile.plugin --platform linux/amd64 image > /dev/null
+        GITHUB_REF= dagger call -m github.com/purpleclay/daggerverse/docker@${DAGGER_DOCKER_SHA}
+        build --dir . --file containers/Dockerfile.plugin --platform linux/amd64
+        publish --ref ${REGISTRY_NAME}:${REGISTRY_PORT}/plugin-barman-cloud --tags testing
 
+  # We build an image and push it to a local registry.
+  # The name is always `sidecar-barman-cloud:testing`.
   build-sidecar-image:
     desc: Build the sidecar container image for the plugin
+    deps:
+      - start-registry
+      - start-dagger-engine-for-local-builds
     env:
       # renovate: datasource=git-refs depName=docker lookupName=https://github.com/purpleclay/daggerverse currentValue=main
       DAGGER_DOCKER_SHA: 4778f39b9cf56e0242c124000a563f9486dafa4b
+      _EXPERIMENTAL_DAGGER_RUNNER_HOST: docker-container://{{.DAGGER_ENGINE_CONTAINER_NAME}}
     cmds:
       - >
-        GITHUB_REF= dagger -s call -m github.com/purpleclay/daggerverse/docker@${DAGGER_DOCKER_SHA}
-        build --dir . --file containers/Dockerfile.sidecar --platform linux/amd64 image > /dev/null
+        GITHUB_REF= dagger call -m github.com/purpleclay/daggerverse/docker@${DAGGER_DOCKER_SHA}
+        build --dir . --file containers/Dockerfile.sidecar --platform linux/amd64
+        publish --ref ${REGISTRY_NAME}:${REGISTRY_PORT}/sidecar-barman-cloud --tags testing
 
   build-images:
     desc: Build the container images for the plugin
     deps:
       - build-plugin-image
       - build-sidecar-image
 
+  # TODO: see if it is possible to daggerize this. It will have to manage docker to make kind work.
+  # TODO: add a task to clean up the kind cluster for new test runs.
+  # Run the e2e tests. This task will start a kind cluster, deploy the plugin, and run the tests.
+  # Running the e2e tests requires:
+  # * The registry to have a valid TLS certificate.
+  # * The registry to be in the same network of the dagger-engine.
+  # * The dagger-engine to mount the CA.
+  # * The kind cluster to mount the CA.
+  e2e:
+    desc: Run e2e tests
+    deps:
+      - build-images
+    cmds:
+      - go test -v ./test/e2e
+
   ci:
     desc: Run the CI pipeline
     deps:
@@ -100,7 +208,7 @@ tasks:
       - uncommitted
       - lint
       - go-test
-      - build-images
+      - e2e
 
   publish:
     desc: Build and publish a container image for the plugin
@@ -125,12 +233,12 @@ tasks:
       DAGGER_DOCKER_SHA: 4778f39b9cf56e0242c124000a563f9486dafa4b
     cmds:
       - >
-        dagger -s call -m github.com/purpleclay/daggerverse/docker@${DAGGER_DOCKER_SHA}
+        dagger call -m github.com/purpleclay/daggerverse/docker@${DAGGER_DOCKER_SHA}
         --registry ghcr.io --username $REGISTRY_USER --password env:REGISTRY_PASSWORD
         build --dir . --file containers/Dockerfile.plugin --platform linux/amd64 --platform linux/arm64
         publish --ref {{.PLUGIN_IMAGE_NAME}} --tags {{.IMAGE_VERSION}}
       - >
-        dagger -s call -m github.com/purpleclay/daggerverse/docker@${DAGGER_DOCKER_SHA}
+        dagger call -m github.com/purpleclay/daggerverse/docker@${DAGGER_DOCKER_SHA}
         --registry ghcr.io --username $REGISTRY_USER --password env:REGISTRY_PASSWORD
         build --dir . --file containers/Dockerfile.sidecar --platform linux/amd64 --platform linux/arm64
         publish --ref {{.SIDECAR_IMAGE_NAME}} --tags {{.IMAGE_VERSION}}

go.mod

@@ -5,26 +5,31 @@ go 1.23
 toolchain go1.23.1
 
 require (
-	github.com/cloudnative-pg/barman-cloud v0.0.0-20240924124724-92831d48562a
-	github.com/cloudnative-pg/cloudnative-pg v1.24.1-0.20241031170209-ad2b0d78a230
-	github.com/cloudnative-pg/cnpg-i v0.0.0-20241030162745-80b6d07403c1
+	github.com/cert-manager/cert-manager v1.16.1
+	github.com/cloudnative-pg/barman-cloud v0.0.0-20241105055149-ae6c2408bd14
+	github.com/cloudnative-pg/cloudnative-pg v1.24.1-0.20241113134512-8608232c2813
+	github.com/cloudnative-pg/cnpg-i v0.0.0-20241109002750-8abd359df734
 	github.com/cloudnative-pg/cnpg-i-machinery v0.0.0-20241014090747-e9c2b3738d19
-	github.com/cloudnative-pg/machinery v0.0.0-20241014090714-c27747f9974b
-	github.com/onsi/ginkgo/v2 v2.20.2
-	github.com/onsi/gomega v1.34.2
+	github.com/cloudnative-pg/machinery v0.0.0-20241030141148-670a0f16f836
+	github.com/onsi/ginkgo/v2 v2.21.0
+	github.com/onsi/gomega v1.35.1
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/viper v1.19.0
-	google.golang.org/grpc v1.67.1
+	google.golang.org/grpc v1.68.0
+	gopkg.in/yaml.v3 v3.0.1
 	k8s.io/api v0.31.2
+	k8s.io/apiextensions-apiserver v0.31.2
 	k8s.io/apimachinery v0.31.2
 	k8s.io/client-go v0.31.2
-	k8s.io/utils v0.0.0-20240921022957-49e7df575cb6
+	k8s.io/utils v0.0.0-20241104163129-6fe5fd82f078
 	sigs.k8s.io/controller-runtime v0.19.1
+	sigs.k8s.io/kustomize/api v0.17.3
+	sigs.k8s.io/kustomize/kyaml v0.17.2
 )
 
 require (
 	github.com/antlr4-go/antlr/v4 v4.13.0 // indirect
-	github.com/asaskevich/govalidator v0.0.0-20190424111038-f61b66f89f4a // indirect
+	github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/blang/semver v3.5.1+incompatible // indirect
 	github.com/blang/semver/v4 v4.0.0 // indirect
@@ -37,6 +42,7 @@ require (
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/fxamacker/cbor/v2 v2.7.0 // indirect
+	github.com/go-errors/errors v1.5.1 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-logr/zapr v1.3.0 // indirect
@@ -51,12 +57,13 @@ require (
 	github.com/google/gnostic-models v0.6.8 // indirect
 	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
-	github.com/google/pprof v0.0.0-20240910150728-a0b0bb1d4134 // indirect
+	github.com/google/pprof v0.0.0-20241029153458-d1b30febd7db // indirect
+	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
 	github.com/google/uuid v1.6.0 // indirect
-	github.com/gorilla/websocket v1.5.0 // indirect
+	github.com/gorilla/websocket v1.5.1 // indirect
 	github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.1.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0 // indirect
-	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/hashicorp/hcl v1.0.1-vault-5 // indirect
 	github.com/imdario/mergo v0.3.16 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
@@ -70,11 +77,12 @@ require (
 	github.com/moby/spdystream v0.4.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/monochromegane/go-gitignore v0.0.0-20200626010858-205db1a8cc00 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f // indirect
 	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
-	github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring v0.77.2 // indirect
+	github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring v0.78.1 // indirect
 	github.com/prometheus/client_golang v1.20.5 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/common v0.59.1 // indirect
@@ -91,14 +99,16 @@ require (
 	github.com/subosito/gotenv v1.6.0 // indirect
 	github.com/thoas/go-funk v0.9.3 // indirect
 	github.com/x448/float16 v0.8.4 // indirect
-	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.53.0 // indirect
-	go.opentelemetry.io/otel v1.28.0 // indirect
+	github.com/xlab/treeprint v1.2.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.54.0 // indirect
+	go.opentelemetry.io/otel v1.29.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.28.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.27.0 // indirect
-	go.opentelemetry.io/otel/metric v1.28.0 // indirect
+	go.opentelemetry.io/otel/metric v1.29.0 // indirect
 	go.opentelemetry.io/otel/sdk v1.28.0 // indirect
-	go.opentelemetry.io/otel/trace v1.28.0 // indirect
+	go.opentelemetry.io/otel/trace v1.29.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.3.1 // indirect
+	go.starlark.net v0.0.0-20240925182052-1207426daebd // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	go.uber.org/zap v1.27.0 // indirect
 	golang.org/x/exp v0.0.0-20240909161429-701f63a606c0 // indirect
@@ -109,21 +119,21 @@ require (
 	golang.org/x/term v0.25.0 // indirect
 	golang.org/x/text v0.19.0 // indirect
 	golang.org/x/time v0.7.0 // indirect
-	golang.org/x/tools v0.25.0 // indirect
+	golang.org/x/tools v0.26.0 // indirect
 	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
-	google.golang.org/genproto/googleapis/api v0.0.0-20240814211410-ddb44dafa142 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20240814211410-ddb44dafa142 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20240903143218-8af14fe29dc1 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240903143218-8af14fe29dc1 // indirect
 	google.golang.org/protobuf v1.35.1 // indirect
+	gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
-	k8s.io/apiextensions-apiserver v0.31.2 // indirect
 	k8s.io/apiserver v0.31.2 // indirect
 	k8s.io/component-base v0.31.2 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20240903163716-9e1beecbcb38 // indirect
 	sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.30.3 // indirect
+	sigs.k8s.io/gateway-api v1.1.0 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
 	sigs.k8s.io/yaml v1.4.0 // indirect