Ensure the $ARTIFACT_DIR variable is respected (#2721)

* .gitignore: Filter out the nested .kube cache

This directory is populating when the e2e suite is supplied with an output $ARTIFACT_DIR, and the script that's responsible for gathering CI testing artifacts when a test case fails.

Signed-off-by: timflannagan <[email protected]>

* Makefile,test: Ensure that the $ARTIFACT_DIR is respected

Signed-off-by: timflannagan <[email protected]>
Upstream-repository: operator-lifecycle-manager
Upstream-commit: 3f07f21154867a72009051ec3f4a831c4725050a

Author: timflannagan

staging/operator-lifecycle-manager/.gitignore

@@ -455,5 +455,5 @@ apiserver.key
 
 !vendor/**
 test/e2e-local.image.tar
-
+test/e2e/.kube
 dist/

staging/operator-lifecycle-manager/Makefile

@@ -139,11 +139,10 @@ E2E_TEST_NS ?= operators
 e2e:
 	$(GINKGO) $(E2E_OPTS) $(or $(run), ./test/e2e) $< -- -namespace=$(E2E_TEST_NS) -olmNamespace=$(E2E_INSTALL_NS) -dummyImage=bitnami/nginx:latest $(or $(extra_args), -kubeconfig=${KUBECONFIG})
 
-
 # See workflows/e2e-tests.yml See test/e2e/README.md for details.
 .PHONY: e2e-local
 e2e-local: BUILD_TAGS="json1 experimental_metrics"
-e2e-local: extra_args=-kind.images=../test/e2e-local.image.tar -test-data-dir=../test/e2e/testdata
+e2e-local: extra_args=-kind.images=../test/e2e-local.image.tar -test-data-dir=../test/e2e/testdata -gather-artifacts-script-path=../test/e2e/collect-ci-artifacts.sh
 e2e-local: run=bin/e2e-local.test
 e2e-local: bin/e2e-local.test test/e2e-local.image.tar
 e2e-local: e2e

staging/operator-lifecycle-manager/test/e2e/ctx/ctx.go

@@ -42,8 +42,9 @@ type TestContext struct {
 	e2eClient      *util.E2EKubeClient
 	ssaClient      *controllerclient.ServerSideApplier
 
-	kubeconfigPath string
-	artifactsDir   string
+	kubeconfigPath      string
+	artifactsDir        string
+	artifactsScriptPath string
 
 	scheme *runtime.Scheme
 
@@ -132,8 +133,7 @@ func (ctx TestContext) DumpNamespaceArtifacts(namespace string) error {
 		"KUBECONFIG=" + kubeconfigPath,
 	}
 
-	// compiled test binary running e2e tests is run from the root ./bin directory
-	cmd := exec.Command("../test/e2e/collect-ci-artifacts.sh")
+	cmd := exec.Command(ctx.artifactsScriptPath)
 	cmd.Env = append(cmd.Env, envvars...)
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
@@ -153,6 +153,17 @@ func setDerivedFields(ctx *TestContext) error {
 		return fmt.Errorf("nil RESTClient")
 	}
 
+	if ctx.artifactsDir == "" {
+		if artifactsDir := os.Getenv("ARTIFACT_DIR"); artifactsDir != "" {
+			ctx.artifactsDir = artifactsDir
+		}
+	}
+	if ctx.artifactsScriptPath == "" {
+		if scriptPath := os.Getenv("E2E_ARTIFACT_SCRIPT"); scriptPath != "" {
+			ctx.artifactsScriptPath = scriptPath
+		}
+	}
+
 	kubeClient, err := operatorclient.NewClientFromRestConfig(ctx.restConfig)
 	if err != nil {
 		return err

staging/operator-lifecycle-manager/test/e2e/ctx/provisioner_kind.go

@@ -1,3 +1,4 @@
+//go:build kind
 // +build kind
 
 package ctx
@@ -135,10 +136,6 @@ func Provision(ctx *TestContext) (func(), error) {
 		return nil, fmt.Errorf("error loading kubeconfig: %s", err.Error())
 	}
 	ctx.restConfig = restConfig
-
-	if artifactsDir := os.Getenv("ARTIFACTS_DIR"); artifactsDir != "" {
-		ctx.artifactsDir = artifactsDir
-	}
 	ctx.kubeconfigPath = kubeconfigPath
 
 	var once sync.Once

staging/operator-lifecycle-manager/test/e2e/e2e_test.go

@@ -42,6 +42,12 @@ var (
 		"dummy image to treat as an operator in tests",
 	)
 
+	collectArtifactsScriptPath = flag.String(
+		"gather-artifacts-script-path",
+		"./collect-ci-artifacts.sh",
+		"configures the relative/absolute path to the script resposible for collecting CI artifacts",
+	)
+
 	testdataPath = flag.String(
 		"test-data-dir",
 		"./testdata",
@@ -82,6 +88,9 @@ var _ = BeforeSuite(func() {
 		// This flag can be deprecated in favor of the kubeconfig provisioner:
 		os.Setenv("KUBECONFIG", *kubeConfigPath)
 	}
+	if collectArtifactsScriptPath != nil && *collectArtifactsScriptPath != "" {
+		os.Setenv("E2E_ARTIFACT_SCRIPT", *collectArtifactsScriptPath)
+	}
 
 	testNamespace = *namespace
 	operatorNamespace = *olmNamespace