chore(e2e) use shared envvar definitions (#4727)

* chore(e2e) use testenv.ClusterVersion()

* chore(e2e) use testenv image/tag overrides

* chore(e2e) use testenv pull credentials

* chore(e2e) use testenv cluster info

* chore(e2e) use testenv image load flag

* chore(e2e) move Github env into testenv

* chore(e2e) remove e2e-specific envvars

* chore(e2e) update workflow envvars

.github/workflows/_e2e_tests.yaml

@@ -134,6 +134,25 @@ jobs:
         with:
           password: ${{ secrets.PULP_PASSWORD }}
 
+      - name: split image and tag
+        id: split
+        env:
+          KONG: ${{ inputs.kong-image }}
+          CONTROLLER: ${{ inputs.controller-image }}
+        run: |
+          if [ "${{ inputs.kong-image }}" != "" ]; then
+            export kong_image=$(echo ${{ inputs.kong-image }} | awk '{split($0,a,":"); print a[1]}')
+            export kong_tag=$(echo ${{ inputs.kong-image }} | awk '{split($0,a,":"); print a[2]}')
+            echo "kong-image=$kong_image" >> $GITHUB_OUTPUT
+            echo "kong-tag=$kong_tag" >> $GITHUB_OUTPUT
+          fi
+          if [ "${{ inputs.kic-image }}" != "" ]; then
+            export kic_image=$(echo ${{ inputs.kic-image }} | awk '{split($0,a,":"); print a[1]}')
+            export kic_tag=$(echo ${{ inputs.kic-image }} | awk '{split($0,a,":"); print a[2]}')
+            echo "kic-image=$kic_image" >> $GITHUB_OUTPUT
+            echo "kic-tag=$kic_tag" >> $GITHUB_OUTPUT
+          fi
+
       # We need to pull the Gateway image locally if loading local image was specified.
       # This is a "workaround" of the fact that we bind the env variable - responsible for
       # indicating whether we'd like to load the images - for both controller
@@ -149,9 +168,11 @@ jobs:
         env:
           E2E_TEST_RUN: ${{ matrix.test }}
           KONG_CLUSTER_VERSION: ${{ matrix.kubernetes-version }}
-          TEST_KONG_CONTROLLER_IMAGE_OVERRIDE: ${{ inputs.kic-image }}
+          TEST_CONTROLLER_IMAGE: ${{ steps.split.outputs.kic-image }}
+          TEST_CONTROLLER_TAG: ${{ steps.split.outputs.kic-tag }}
           TEST_KONG_LOAD_IMAGES: ${{ inputs.load-local-image }}
-          TEST_KONG_IMAGE_OVERRIDE: ${{ inputs.kong-image }}
+          TEST_KONG_IMAGE: ${{ steps.split.outputs.kong-image }}
+          TEST_KONG_TAG: ${{ steps.split.outputs.kong-tag }}
           TEST_KONG_KONNECT_ACCESS_TOKEN: ${{ secrets.K8S_TEAM_KONNECT_ACCESS_TOKEN }}
           KONG_LICENSE_DATA: ${{ steps.license.outputs.license }}
           GOTESTSUM_JUNITFILE: "e2e-${{ matrix.test }}${{ matrix.kubernetes-version }}-tests.xml"
@@ -199,20 +220,37 @@ jobs:
         with:
           password: ${{ secrets.PULP_PASSWORD }}
 
+      - name: split image and tag
+        id: split
+        env:
+          KONG: ${{ inputs.kong-image }}
+          CONTROLLER: ${{ inputs.controller-image }}
+        run: |
+          if [ "${{ inputs.kong-image }}" != "" ]; then
+            export kong_image=$(echo ${{ inputs.kong-image }} | awk '{split($0,a,":"); print a[1]}')
+            export kong_tag=$(echo ${{ inputs.kong-image }} | awk '{split($0,a,":"); print a[2]}')
+            echo "kong-image=$kong_image" >> $GITHUB_OUTPUT
+            echo "kong-tag=$kong_tag" >> $GITHUB_OUTPUT
+          fi
+          # see the https://github.com/Kong/kubernetes-testing-framework/issues/587 TODO below
+          # if we add local image GKE support, we probably need to split it into components here
+
       - name: run ${{ matrix.test }}
         run: make test.e2e
         env:
           # NOTE: The limitation of the GKE setup is that we cannot run tests against a local image,
           # therefore we need to use the nightly one.
           # TODO: Once we have a way to load images into GKE, we can use the local image.
           # KTF issue that should enable it: https://github.com/Kong/kubernetes-testing-framework/issues/587
-          TEST_KONG_CONTROLLER_IMAGE_OVERRIDE: "kong/nightly-ingress-controller:nightly"
-          TEST_KONG_IMAGE_OVERRIDE: ${{ inputs.kong-image }}
+          TEST_CONTROLLER_IMAGE: "kong/nightly-ingress-controller"
+          TEST_CONTROLLER_TAG: "nightly"
+          TEST_KONG_IMAGE: ${{ steps.split.outputs.kong-image }}
+          TEST_KONG_TAG: ${{ steps.split.outputs.kong-tag }}
           TEST_KONG_EFFECTIVE_VERSION: ${{ inputs.kong-effective-version }}
           KONG_LICENSE_DATA: ${{ steps.license.outputs.license }}
           TEST_KONG_KONNECT_ACCESS_TOKEN: ${{ secrets.K8S_TEAM_KONNECT_ACCESS_TOKEN }}
           KONG_CLUSTER_VERSION: ${{ matrix.kubernetes-version }}
-          KONG_TEST_CLUSTER_PROVIDER: gke
+          KONG_CLUSTER_PROVIDER: gke
           E2E_TEST_RUN: ${{ matrix.test }}
           GOTESTSUM_JUNITFILE: "e2e-gke-${{ matrix.test }}-${{ matrix.kubernetes-version }}-tests.xml"
           GOOGLE_APPLICATION_CREDENTIALS: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
@@ -270,12 +308,34 @@ jobs:
         with:
           password: ${{ secrets.PULP_PASSWORD }}
 
+      - name: split image and tag
+        id: split
+        env:
+          KONG: ${{ inputs.kong-image }}
+          CONTROLLER: ${{ inputs.controller-image }}
+        run: |
+          if [ "${{ inputs.kong-image }}" != "" ]; then
+            export kong_image=$(echo ${{ inputs.kong-image }} | awk '{split($0,a,":"); print a[1]}')
+            export kong_tag=$(echo ${{ inputs.kong-image }} | awk '{split($0,a,":"); print a[2]}')
+            echo "kong-image=$kong_image" >> $GITHUB_OUTPUT
+            echo "kong-tag=$kong_tag" >> $GITHUB_OUTPUT
+          fi
+          if [ "${{ inputs.kic-image }}" != "" ]; then
+            export kic_image=$(echo ${{ inputs.kic-image }} | awk '{split($0,a,":"); print a[1]}')
+            export kic_tag=$(echo ${{ inputs.kic-image }} | awk '{split($0,a,":"); print a[2]}')
+            echo "kic-image=$kic_image" >> $GITHUB_OUTPUT
+            echo "kic-tag=$kic_tag" >> $GITHUB_OUTPUT
+          fi
+
+
       - name: run Istio tests
         run: make test.istio
         env:
-          TEST_KONG_CONTROLLER_IMAGE_OVERRIDE: ${{ inputs.kic-image }}
+          TEST_CONTROLLER_IMAGE: ${{ steps.split.outputs.kic-image }}
+          TEST_CONTROLLER_TAG: ${{ steps.split.outputs.kic-tag }}
           TEST_KONG_LOAD_IMAGES: ${{ inputs.load-local-image }}
-          TEST_KONG_IMAGE_OVERRIDE: ${{ inputs.kong-image }}
+          TEST_KONG_IMAGE: ${{ steps.split.outputs.kong-image }}
+          TEST_KONG_TAG: ${{ steps.split.outputs.kong-tag }}
           KONG_LICENSE_DATA: ${{ steps.license.outputs.license }}
           KONG_CLUSTER_VERSION: ${{ matrix.kind }}
           ISTIO_VERSION: ${{ matrix.istio }}

test/e2e/features_test.go

@@ -96,9 +96,11 @@ func TestWebhookUpdate(t *testing.T) {
 	require.NoError(t, err)
 	addons := []clusters.Addon{}
 	addons = append(addons, metallb.New())
-	if shouldLoadImages() {
-		if b, err := loadimage.NewBuilder().WithImage(controllerImageOverride); err == nil {
+	if testenv.ClusterLoadImages() == "true" {
+		if b, err := loadimage.NewBuilder().WithImage(testenv.ControllerImageTag()); err == nil {
 			addons = append(addons, b.Build())
+		} else {
+			require.NoError(t, err)
 		}
 	}
 	builder := environments.NewBuilder().WithExistingCluster(cluster).WithAddons(addons...)

test/e2e/helpers_test.go

@@ -115,9 +115,9 @@ func setupE2ETest(t *testing.T, addons ...clusters.Addon) (context.Context, envi
 func getEnvironmentBuilder(ctx context.Context, t *testing.T) (*environments.Builder, error) {
 	t.Helper()
 
-	if existingCluster == "" {
-		t.Logf("no existing cluster provided, creating a new one for %q type", clusterProvider)
-		switch clusterProvider {
+	if testenv.ExistingClusterName() == "" {
+		t.Logf("no existing cluster provided, creating a new one for %q type", testenv.ClusterProvider())
+		switch testenv.ClusterProvider() {
 		case string(gke.GKEClusterType):
 			t.Log("creating a GKE cluster builder")
 			return createGKEBuilder(t)
@@ -127,9 +127,9 @@ func getEnvironmentBuilder(ctx context.Context, t *testing.T) (*environments.Bui
 		}
 	}
 
-	clusterParts := strings.Split(existingCluster, ":")
+	clusterParts := strings.Split(testenv.ExistingClusterName(), ":")
 	if len(clusterParts) < 2 {
-		return nil, fmt.Errorf("expected existing cluster in format <type>:<name>, got %s", existingCluster)
+		return nil, fmt.Errorf("expected existing cluster in format <type>:<name>, got %s", testenv.ExistingClusterName())
 	}
 
 	clusterType, clusterName := clusterParts[0], clusterParts[1]
@@ -171,8 +171,8 @@ func createKINDBuilder(t *testing.T) *environments.Builder {
 		clusterBuilder = clusterBuilder.WithClusterVersion(clusterVersion)
 	}
 	builder := environments.NewBuilder().WithClusterBuilder(clusterBuilder).WithAddons(metallb.New())
-	if shouldLoadImages() {
-		builder = builder.WithAddons(buildImageLoadAddon(t, controllerImageOverride, kongImageOverride))
+	if testenv.ClusterLoadImages() == "true" {
+		builder = builder.WithAddons(buildImageLoadAddon(t, testenv.ControllerImageTag(), testenv.KongImageTag()))
 	}
 	return builder
 }
@@ -184,8 +184,8 @@ func createExistingKINDBuilder(t *testing.T, name string) (*environments.Builder
 
 	builder = builder.WithExistingCluster(cluster)
 	builder = builder.WithAddons(metallb.New())
-	if shouldLoadImages() {
-		builder = builder.WithAddons(buildImageLoadAddon(t, controllerImageOverride, kongImageOverride))
+	if testenv.ClusterLoadImages() == "true" {
+		builder = builder.WithAddons(buildImageLoadAddon(t, testenv.ControllerImageTag(), testenv.KongImageTag()))
 	}
 	return builder, nil
 }
@@ -237,7 +237,7 @@ type ManifestDeploy struct {
 	Path string
 
 	// SkipTestPatches is a flag that controls whether to apply standard test patches (e.g. replace controller
-	// image when TEST_KONG_CONTROLLER_IMAGE_OVERRIDE set, etc.) to the manifests before deploying them.
+	// image when TEST_CONTROLLER_IMAGE set, etc.) to the manifests before deploying them.
 	SkipTestPatches bool
 
 	// AdditionalSecrets is a list of additional secrets to create before deploying the manifest.
@@ -723,7 +723,7 @@ func buildImageLoadAddon(t *testing.T, images ...string) clusters.Addon {
 func createKongImagePullSecret(ctx context.Context, t *testing.T, env environments.Environment) {
 	t.Helper()
 
-	if kongImagePullUsername == "" || kongImagePullPassword == "" {
+	if testenv.KongPullUsername() == "" || testenv.KongPullPassword() == "" {
 		return
 	}
 	kubeconfigFilename := getTemporaryKubeconfig(t, env)
@@ -733,8 +733,8 @@ func createKongImagePullSecret(ctx context.Context, t *testing.T, env environmen
 		ctx,
 		"kubectl", "--kubeconfig", kubeconfigFilename,
 		"create", "secret", "docker-registry", secretName,
-		"--docker-username="+kongImagePullUsername,
-		"--docker-password="+kongImagePullPassword,
+		"--docker-username="+testenv.KongPullUsername(),
+		"--docker-password="+testenv.KongPullPassword(),
 	)
 	out, err := cmd.CombinedOutput()
 	require.NoError(t, err, "command output: "+string(out))
@@ -792,18 +792,18 @@ func getTemporaryKubeconfig(t *testing.T, env environments.Environment) string {
 func runOnlyOnKindClusters(t *testing.T) {
 	t.Helper()
 
-	existingClusterIsKind := strings.Split(existingCluster, ":")[0] == string(kind.KindClusterType)
+	existingClusterIsKind := strings.Split(testenv.ExistingClusterName(), ":")[0] == string(kind.KindClusterType)
 	if existingClusterIsKind {
 		return
 	}
 
-	clusterProviderIsKind := clusterProvider == string(kind.KindClusterType)
+	clusterProviderIsKind := testenv.ClusterProvider() == string(kind.KindClusterType)
 	if clusterProviderIsKind {
 		return
 	}
 
-	clusterProviderUnspecified := clusterProvider == ""
-	existingClusterUnspecified := existingCluster == ""
+	clusterProviderUnspecified := testenv.ClusterProvider() == ""
+	existingClusterUnspecified := testenv.ExistingClusterName() == ""
 	if clusterProviderUnspecified && existingClusterUnspecified {
 		return
 	}

test/e2e/konnect_test.go

@@ -35,6 +35,7 @@ import (
 	"github.com/kong/kubernetes-ingress-controller/v2/internal/konnect/roles"
 	"github.com/kong/kubernetes-ingress-controller/v2/test/helpers/certificate"
 	"github.com/kong/kubernetes-ingress-controller/v2/test/internal/helpers"
+	"github.com/kong/kubernetes-ingress-controller/v2/test/internal/testenv"
 )
 
 const (
@@ -176,9 +177,9 @@ func generateTestKonnectControlPlaneDescription(t *testing.T) string {
 	t.Helper()
 
 	desc := fmt.Sprintf("control plane for test %s", t.Name())
-	if githubServerURL != "" && githubRepo != "" && githubRunID != "" {
+	if testenv.GithubServerURL() != "" && testenv.GithubRepo() != "" && testenv.GithubRunID() != "" {
 		githubRunURL := fmt.Sprintf("%s/%s/actions/runs/%s",
-			githubServerURL, githubRepo, githubRunID)
+			testenv.GithubServerURL(), testenv.GithubRepo(), testenv.GithubRunID())
 		desc += ", github workflow run " + githubRunURL
 	}