Introduce --skip-user-config flag, allowing e2e tests to ignore the current user's config

Author: Moritz Clasmeier

cmd/deploy.go

@@ -267,8 +267,10 @@ func runDeploy(cmd *cobra.Command, args []string) error {
 	deploySettings := deployer.DefaultConfig()
 
 	// Apply user config on top (overriding defaults).
-	if err := tryApplyUserDefaults(globalLogger, &deploySettings); err != nil {
-		return fmt.Errorf("applying user config: %w", err)
+	if !skipUserConfig {
+		if err := tryApplyUserDefaults(globalLogger, &deploySettings); err != nil {
+			return fmt.Errorf("applying user config: %w", err)
+		}
 	}
 
 	// Apply changes from arg parsing.

cmd/main.go

@@ -20,6 +20,8 @@ var (
 	envrc   string
 	dryRun  bool
 
+	skipUserConfig bool
+
 	globalLogger = logger.New()
 
 	// We need this set up before command line flags are parsed.
@@ -75,6 +77,8 @@ Red Hat Advanced Cluster Security (ACS) on any Kubernetes/OpenShift cluster.`,
 func init() {
 	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Enable verbose output (show CRs)")
 	rootCmd.PersistentFlags().BoolVar(&dryRun, "dry-run", false, "Do not actually modify cluster")
+	rootCmd.PersistentFlags().BoolVar(&skipUserConfig, "skip-user-config", false,
+		fmt.Sprintf("Skips reading of user's configuration (%s)", paths.UserConfigPathString()))
 	rootCmd.AddCommand(newDeployCmd(&deploySettingsFromArgs))
 	rootCmd.AddCommand(newTeardownCmd(&deploySettingsFromArgs))
 	rootCmd.AddCommand(newShellCmd())

cmd/teardown.go

@@ -60,8 +60,10 @@ func runTeardown(cmd *cobra.Command, args []string) error {
 	deploySettings := deployer.DefaultConfig()
 
 	// Apply user config on top (overriding defaults).
-	if err := tryApplyUserDefaults(globalLogger, &deploySettings); err != nil {
-		return fmt.Errorf("applying user config: %w", err)
+	if !skipUserConfig {
+		if err := tryApplyUserDefaults(globalLogger, &deploySettings); err != nil {
+			return fmt.Errorf("applying user config: %w", err)
+		}
 	}
 
 	// Apply changes from arg parsing.

internal/paths/paths.go

@@ -16,6 +16,14 @@ func UserConfigPath() (string, error) {
 	return filepath.Join(dir, "config.yaml"), nil
 }
 
+func UserConfigPathString() string {
+	path, err := UserConfigPath()
+	if err != nil {
+		return "(UNAVAILABLE)"
+	}
+	return path
+}
+
 func configDir() (string, error) {
 	dir, err := os.UserConfigDir()
 	if err != nil {

tests/e2e/basic_test.go

@@ -46,7 +46,7 @@ func TestDeployBothSimple(t *testing.T) {
 
 	// Cleanup
 	t.Log("=== Cleaning up ===")
-	teardownArgs := []string{roxieBinary, "teardown", "both"}
+	teardownArgs := []string{roxieBinary, "teardown", "--skip-user-config", "both"}
 	runCommand(t, teardownTimeout, nil, teardownArgs...)
 
 	t.Log("Verifying components are removed")
@@ -90,7 +90,7 @@ func TestDetachedPortForwarding(t *testing.T) {
 	testCentralAPI(t, endpoint, caCertFile)
 
 	t.Log("=== Cleaning up ===")
-	teardownArgs := []string{roxieBinary, "teardown", "central"}
+	teardownArgs := []string{roxieBinary, "teardown", "--skip-user-config", "central"}
 	runCommand(t, teardownTimeout, env, teardownArgs...)
 
 	// Verify port-forward cleanup by checking the port is free. We can't use

tests/e2e/e2e_test.go

@@ -57,7 +57,7 @@ func TestDeployBothComponentsTogetherInSingleNamespace(t *testing.T) {
 	verifySecuredClusterInstalled(t, "stackrox")
 
 	t.Log("=== Tearing down both components in single namespace ===")
-	args = []string{roxieBinary, "teardown", "--single-namespace"}
+	args = []string{roxieBinary, "teardown", "--skip-user-config", "--single-namespace"}
 	runCommand(t, teardownTimeout, nil, args...)
 
 	verifyCentralNotInstalled(t, "stackrox")

tests/e2e/helpers.go

@@ -29,7 +29,7 @@ const (
 )
 
 var (
-	commonDeployArgs = []string{"--resources=small"}
+	commonDeployArgs = []string{"--resources=small", "--skip-user-config"}
 
 	roxieBinary = "roxie"
 )
@@ -41,7 +41,7 @@ func teardownAllDeployments() error {
 	defer cancel()
 
 	// Teardown standard deployments
-	cmd := exec.CommandContext(ctx, roxieBinary, "teardown")
+	cmd := exec.CommandContext(ctx, roxieBinary, "teardown", "--skip-user-config")
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
 	if err := cmd.Run(); err != nil {
@@ -51,7 +51,7 @@ func teardownAllDeployments() error {
 	// Teardown single-namespace deployments
 	ctx, cancel = context.WithTimeout(context.Background(), teardownTimeout)
 	defer cancel()
-	cmd = exec.CommandContext(ctx, roxieBinary, "teardown", "--single-namespace")
+	cmd = exec.CommandContext(ctx, roxieBinary, "teardown", "--skip-user-config", "--single-namespace")
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
 	if err := cmd.Run(); err != nil {

tests/e2e/olm_switch_test.go

@@ -107,7 +107,7 @@ func TestOLMToNonOLMSwitch(t *testing.T) {
 
 	// Cleanup
 	t.Log("=== Cleaning up ===")
-	teardownArgs := []string{roxieBinary, "teardown", "central"}
+	teardownArgs := []string{roxieBinary, "teardown", "--skip-user-config", "central"}
 	runCommand(t, teardownTimeout, nil, teardownArgs...)
 
 	verifyCentralNotInstalled(t, "acs-central")
@@ -157,7 +157,7 @@ func TestNonOLMToOLMSwitch(t *testing.T) {
 
 	// Cleanup
 	t.Log("=== Cleaning up ===")
-	teardownArgs := []string{roxieBinary, "teardown", "central"}
+	teardownArgs := []string{roxieBinary, "teardown", "--skip-user-config", "central"}
 	runCommand(t, teardownTimeout, nil, teardownArgs...)
 
 	verifyCentralNotInstalled(t, "acs-central")
@@ -221,7 +221,7 @@ func TestOLMOperatorVersionUpgrade(t *testing.T) {
 
 	// Cleanup
 	t.Log("=== Cleaning up ===")
-	teardownArgs := []string{roxieBinary, "teardown", "central"}
+	teardownArgs := []string{roxieBinary, "teardown", "--skip-user-config", "central"}
 	runCommand(t, teardownTimeout, nil, teardownArgs...)
 
 	verifyCentralNotInstalled(t, "acs-central")
@@ -277,7 +277,7 @@ func TestSecuredClusterWithOLMSwitch(t *testing.T) {
 
 	// Cleanup
 	t.Log("=== Cleaning up ===")
-	teardownArgs := []string{roxieBinary, "teardown", "both"}
+	teardownArgs := []string{roxieBinary, "teardown", "--skip-user-config", "both"}
 	runCommand(t, teardownTimeout, nil, teardownArgs...)
 
 	verifyCentralNotInstalled(t, "acs-central")