Update makefile to generate kuttl tests

All tests in the `testing/kuttl/e2e` directory will be templates and the target `make generate-kuttl` will envsubst variables and output to a gitignored `testing/kuttl/e2e-generated` directory Tests from the sources directory have been synced with the e2e directory. There were minor differences in the duplicated tests. Tests in the e2e directory now have environment variables for the postgres version and the psql connect image.
CrunchyData · Mar 11, 2022 · b5a9cc5 · b5a9cc5
1 parent dc9d6a0
commit b5a9cc5
Show file tree

Hide file tree

Showing 61 changed files with 58 additions and 396 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
 .DS_Store
 /vendor/
 tools
-/testing/kuttl/generated/
+/testing/kuttl/e2e-generated/
diff --git a/Makefile b/Makefile
@@ -217,34 +217,18 @@ check-kuttl:
 	${PGO_KUBE_CLIENT} ${KUTTL_TEST} \
 		--config testing/kuttl/kuttl-test.yaml
 
-# Set reasonable default for KUTTL_ env vars for templating
-KUTTL_PG_VERSION ?= 14
-KUTTL_PG_UPGRADE_FROM_VERSION ?= 13
-KUTTL_PSQL_IMAGE ?= registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
-
-# TODO: When I attempted to loop through the directories and find the yaml files,
-# due to how makefile expands variables, each file would end up in each directory.
-# So this implementation loops through to create the folders under generated
-# and then loops through all the yaml files, using a `sed` substition to place them
-# For safety, this removes the `testing/kuttl/generated` folder if it exists
 .PHONY: generate-kuttl
+generate-kuttl: export KUTTL_PG_VERSION ?= 14
+generate-kuttl: export KUTTL_PSQL_IMAGE ?= registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
 generate-kuttl:
-	[ ! -d testing/kuttl/generated ] || rm -r testing/kuttl/generated
-	for SRCDIR in $(shell ls testing/kuttl/source); do \
-		mkdir -p testing/kuttl/generated/$${SRCDIR}; \
-	done;
-	for FILEPATH in $(wildcard testing/kuttl/source/*/*.yaml); do \
-		NEW_FILEPATH=`echo $${FILEPATH} | sed 's/source/generated/'`; \
-		KUTTL_PG_VERSION=$(KUTTL_PG_VERSION) \
-			KUTTL_PG_UPGRADE_FROM_VERSION=$(KUTTL_PG_UPGRADE_FROM_VERSION) \
-			KUTTL_PSQL_IMAGE=$(KUTTL_PSQL_IMAGE) \
-			envsubst < $${FILEPATH} > $${NEW_FILEPATH}; \
-	done
-
-.PHONY: check-generated-kuttl
-check-generated-kuttl: generate-kuttl
-	${PGO_KUBE_CLIENT} ${KUTTL_TEST} \
-		--config testing/kuttl/kuttl-test-generated.yaml
+	[ ! -d testing/kuttl/e2e-generated ] || rm -r testing/kuttl/e2e-generated
+	bash -ceu ' \
+	render() { envsubst '"'"'$$KUTTL_PG_VERSION $$KUTTL_PSQL_IMAGE'"'"'; }; \
+	while [ $$# -gt 0 ]; do \
+		source="$${1}" target="$${1/e2e/e2e-generated}"; \
+		mkdir -p "$${target%/*}"; render < "$${source}" > "$${target}"; \
+		shift; \
+	done' - $(wildcard testing/kuttl/e2e/*/*.yaml)
 
 .PHONY: check-generate
 check-generate: generate-crd generate-deepcopy generate-rbac

diff --git a/testing/kuttl/e2e/cluster-start/00--cluster.yaml b/testing/kuttl/e2e/cluster-start/00--cluster.yaml
@@ -3,7 +3,7 @@ kind: PostgresCluster
 metadata:
   name: cluster-start
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - name: instance1
       dataVolumeClaimSpec:

diff --git a/testing/kuttl/e2e/cluster-start/01--psql-connect.yaml b/testing/kuttl/e2e/cluster-start/01--psql-connect.yaml
@@ -8,7 +8,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - -c
@@ -24,3 +24,5 @@ spec:
             valueFrom: { secretKeyRef: { name: cluster-start-pguser-cluster-start, key: user } }
           - name: PGPASSWORD
             valueFrom: { secretKeyRef: { name: cluster-start-pguser-cluster-start, key: password } }
+          # Do not wait indefinitely.
+          - { name: PGCONNECT_TIMEOUT, value: '5' }
diff --git a/testing/kuttl/e2e/password-change/00--cluster.yaml b/testing/kuttl/e2e/password-change/00--cluster.yaml
@@ -3,7 +3,7 @@ kind: PostgresCluster
 metadata:
   name: password-change
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - name: instance1
       dataVolumeClaimSpec:

diff --git a/testing/kuttl/e2e/password-change/01--psql-connect-uri.yaml b/testing/kuttl/e2e/password-change/01--psql-connect-uri.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - "$(PGURI)"

diff --git a/testing/kuttl/e2e/password-change/01--psql-connect.yaml b/testing/kuttl/e2e/password-change/01--psql-connect.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - -c

diff --git a/testing/kuttl/e2e/password-change/03--psql-connect-uri.yaml b/testing/kuttl/e2e/password-change/03--psql-connect-uri.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - "$(PGURI)"

diff --git a/testing/kuttl/e2e/password-change/03--psql-connect.yaml b/testing/kuttl/e2e/password-change/03--psql-connect.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - -c

diff --git a/testing/kuttl/e2e/password-change/05--psql-connect-uri.yaml b/testing/kuttl/e2e/password-change/05--psql-connect-uri.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - "$(PGURI)"

diff --git a/testing/kuttl/e2e/password-change/05--psql-connect.yaml b/testing/kuttl/e2e/password-change/05--psql-connect.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - -c

diff --git a/testing/kuttl/e2e/password-change/07--psql-connect-uri.yaml b/testing/kuttl/e2e/password-change/07--psql-connect-uri.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - "$(PGURI)"

diff --git a/testing/kuttl/e2e/password-change/07--psql-connect.yaml b/testing/kuttl/e2e/password-change/07--psql-connect.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - -c

diff --git a/testing/kuttl/e2e/password-change/09--psql-connect-uri.yaml b/testing/kuttl/e2e/password-change/09--psql-connect-uri.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - "$(PGURI)"

diff --git a/testing/kuttl/e2e/password-change/09--psql-connect.yaml b/testing/kuttl/e2e/password-change/09--psql-connect.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - -c

diff --git a/testing/kuttl/e2e/password-change/11--psql-connect-uri.yaml b/testing/kuttl/e2e/password-change/11--psql-connect-uri.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - "$(PGURI)"

diff --git a/testing/kuttl/e2e/password-change/11--psql-connect.yaml b/testing/kuttl/e2e/password-change/11--psql-connect.yaml
@@ -9,7 +9,7 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - -c

diff --git a/testing/kuttl/e2e/pgadmin/01--cluster.yaml b/testing/kuttl/e2e/pgadmin/01--cluster.yaml
@@ -20,7 +20,7 @@ metadata:
   name: interfaced
   labels: { postgres-operator-test: kuttl }
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - name: instance1
       replicas: 1

diff --git a/testing/kuttl/e2e/pgbackrest-init/00--cluster.yaml b/testing/kuttl/e2e/pgbackrest-init/00--cluster.yaml
@@ -3,7 +3,7 @@ kind: PostgresCluster
 metadata:
   name: init-pgbackrest
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - name: instance1
       dataVolumeClaimSpec:

diff --git a/testing/kuttl/e2e/pgbackrest-restore/01--create-cluster.yaml b/testing/kuttl/e2e/pgbackrest-restore/01--create-cluster.yaml
@@ -7,7 +7,7 @@ metadata:
   name: original
   labels: { postgres-operator-test: kuttl }
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   patroni:
     dynamicConfiguration:
       postgresql:

diff --git a/testing/kuttl/e2e/pgbackrest-restore/02--create-data.yaml b/testing/kuttl/e2e/pgbackrest-restore/02--create-data.yaml
@@ -14,7 +14,7 @@ spec:
       restartPolicy: Never
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             - name: PGURI
               valueFrom: { secretKeyRef: { name: original-pguser-original, key: uri } }

diff --git a/testing/kuttl/e2e/pgbackrest-restore/04--clone-cluster.yaml b/testing/kuttl/e2e/pgbackrest-restore/04--clone-cluster.yaml
@@ -11,7 +11,7 @@ spec:
       clusterName: original
       repoName: repo1
 
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - dataVolumeClaimSpec: { accessModes: [ReadWriteOnce], resources: { requests: { storage: 1Gi } } }
   backups:

diff --git a/testing/kuttl/e2e/pgbackrest-restore/05--check-data.yaml b/testing/kuttl/e2e/pgbackrest-restore/05--check-data.yaml
@@ -14,7 +14,7 @@ spec:
       restartPolicy: Never
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             # Connect to the cluster using the restored database and original credentials.
             - name: PGHOST

diff --git a/testing/kuttl/e2e/pgbackrest-restore/07--update-cluster.yaml b/testing/kuttl/e2e/pgbackrest-restore/07--update-cluster.yaml
@@ -6,7 +6,7 @@ metadata:
   name: original
   labels: { postgres-operator-test: kuttl }
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   patroni:
     dynamicConfiguration:
       postgresql:

diff --git a/testing/kuttl/e2e/pgbackrest-restore/09--add-data.yaml b/testing/kuttl/e2e/pgbackrest-restore/09--add-data.yaml
@@ -14,7 +14,7 @@ spec:
       restartPolicy: Never
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             - name: PGURI
               valueFrom: { secretKeyRef: { name: original-pguser-original, key: uri } }

diff --git a/testing/kuttl/e2e/pgbackrest-restore/11--clone-cluster.yaml b/testing/kuttl/e2e/pgbackrest-restore/11--clone-cluster.yaml
@@ -11,7 +11,7 @@ spec:
       clusterName: original
       repoName: repo1
 
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - dataVolumeClaimSpec: { accessModes: [ReadWriteOnce], resources: { requests: { storage: 1Gi } } }
   backups:

diff --git a/testing/kuttl/e2e/pgbackrest-restore/12--check-data.yaml b/testing/kuttl/e2e/pgbackrest-restore/12--check-data.yaml
@@ -14,7 +14,7 @@ spec:
       restartPolicy: Never
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             # Connect to the cluster using the restored database and original credentials.
             - name: PGHOST

diff --git a/testing/kuttl/e2e/pgbackrest-restore/16--check-data.yaml b/testing/kuttl/e2e/pgbackrest-restore/16--check-data.yaml
@@ -14,7 +14,7 @@ spec:
       restartPolicy: Never
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             - name: PGURI
               valueFrom: { secretKeyRef: { name: original-pguser-original, key: uri } }
@@ -57,7 +57,7 @@ spec:
       restartPolicy: Never
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             - name: PGPORT
               valueFrom: { secretKeyRef: { name: original-pguser-original, key: port } }

diff --git a/testing/kuttl/e2e/pgbouncer/00--cluster.yaml b/testing/kuttl/e2e/pgbouncer/00--cluster.yaml
@@ -4,7 +4,7 @@ metadata:
   name: proxied
   labels: { postgres-operator-test: kuttl }
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - name: instance1
       replicas: 2

diff --git a/testing/kuttl/e2e/pgbouncer/01--psql-connect.yaml b/testing/kuttl/e2e/pgbouncer/01--psql-connect.yaml
@@ -12,7 +12,7 @@ spec:
       restartPolicy: Never
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             - psql
             - -c

diff --git a/testing/kuttl/e2e/pgbouncer/10--read-certificate.yaml b/testing/kuttl/e2e/pgbouncer/10--read-certificate.yaml
@@ -14,7 +14,7 @@ spec:
       restartPolicy: Never
       containers:
         - name: openssl
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             - name: PGHOST
               valueFrom: { secretKeyRef: { name: proxied-pguser-proxied, key: pgbouncer-host } }

diff --git a/testing/kuttl/e2e/pgbouncer/11--open-connection.yaml b/testing/kuttl/e2e/pgbouncer/11--open-connection.yaml
@@ -17,7 +17,7 @@ spec:
         - { name: tls, secret: { secretName: proxied-cluster-cert } }
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             # Connect through PgBouncer.
             - name: PGURI

diff --git a/testing/kuttl/e2e/pgbouncer/13--read-certificate.yaml b/testing/kuttl/e2e/pgbouncer/13--read-certificate.yaml
@@ -14,7 +14,7 @@ spec:
       restartPolicy: Never
       containers:
         - name: openssl
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             - name: PGHOST
               valueFrom: { secretKeyRef: { name: proxied-pguser-proxied, key: pgbouncer-host } }

diff --git a/testing/kuttl/e2e/pgbouncer/16--reconnect.yaml b/testing/kuttl/e2e/pgbouncer/16--reconnect.yaml
@@ -17,7 +17,7 @@ spec:
         - { name: tls, secret: { secretName: proxied-cluster-cert } }
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           env:
             # Connect through PgBouncer.
             - name: PGURI

diff --git a/testing/kuttl/e2e/replica-read/00--cluster.yaml b/testing/kuttl/e2e/replica-read/00--cluster.yaml
@@ -3,7 +3,7 @@ kind: PostgresCluster
 metadata:
   name: replica-read
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - name: instance1
       dataVolumeClaimSpec:

diff --git a/testing/kuttl/e2e/replica-read/01--psql-replica-read.yaml b/testing/kuttl/e2e/replica-read/01--psql-replica-read.yaml
@@ -9,12 +9,12 @@ spec:
       restartPolicy: "OnFailure"
       containers:
         - name: psql
-          image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:centos8-14.1-0
+          image: ${KUTTL_PSQL_IMAGE}
           command:
             # https://www.postgresql.org/docs/current/plpgsql-errors-and-messages.html#PLPGSQL-STATEMENTS-ASSERT
             # If run on a non-replica, this assertion fails, resulting in the pod erroring
-            # Note: the `$$$$` is reduced to `$$` by kuttl
-            # - https://kuttl.dev/docs/testing/steps.html#running-commands
+            # Note: the `$$$$` is reduced to `$$` by Kubernetes.
+            # - https://kubernetes.io/docs/tasks/inject-data-application/
             - psql
             - -qc
             - |

diff --git a/testing/kuttl/e2e/scaledown/00--create-cluster.yaml b/testing/kuttl/e2e/scaledown/00--create-cluster.yaml
@@ -3,7 +3,7 @@ kind: PostgresCluster
 metadata:
   name: scaledown
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - name: instance1
       dataVolumeClaimSpec:

diff --git a/testing/kuttl/e2e/scaledown/01--update-cluster.yaml b/testing/kuttl/e2e/scaledown/01--update-cluster.yaml
@@ -3,7 +3,7 @@ kind: PostgresCluster
 metadata:
   name: scaledown
 spec:
-  postgresVersion: 14
+  postgresVersion: ${KUTTL_PG_VERSION}
   instances:
     - name: instance1
       dataVolumeClaimSpec: