allow user to skip must-gather (#1769)

* allow user to skip must-gather

If using amd64 via laptop, and arm64 cluster
the must-gather will panic and fail.

* add doc

Author: weshayutin

Makefile

@@ -568,13 +568,15 @@ test-e2e-setup: login-required build-must-gather
 	VSL_REGION="$(VSL_REGION)" \
 	BSL_REGION="$(BSL_REGION)" \
 	BSL_AWS_PROFILE="$(BSL_AWS_PROFILE)" \
+        SKIP_MUST_GATHER="$(SKIP_MUST_GATHER)" \
 	/bin/bash "tests/e2e/scripts/$(CLUSTER_TYPE)_settings.sh"
 
 VELERO_INSTANCE_NAME ?= velero-test
 ARTIFACT_DIR ?= /tmp
 HCO_UPSTREAM ?= false
 TEST_VIRT ?= false
 TEST_HCP ?= false
+SKIP_MUST_GATHER  ?= false
 TEST_UPGRADE ?= false
 TEST_FILTER = (($(shell echo '! aws && ! gcp && ! azure && ! ibmcloud' | \
 $(SED) -r "s/[&]* [!] $(CLUSTER_TYPE)|[!] $(CLUSTER_TYPE) [&]*//")) || $(CLUSTER_TYPE))
@@ -607,6 +609,7 @@ test-e2e: test-e2e-setup install-ginkgo ## Run E2E tests against OADP operator i
 	-artifact_dir=$(ARTIFACT_DIR) \
 	-kvm_emulation=$(KVM_EMULATION) \
 	-hco_upstream=$(HCO_UPSTREAM) \
+        -skipMustGather=$(SKIP_MUST_GATHER) \
 	--ginkgo.vv \
 	--ginkgo.no-color=$(OPENSHIFT_CI) \
 	--ginkgo.label-filter="$(TEST_FILTER)" \

docs/developer/testing/TESTING.md

@@ -23,6 +23,9 @@ To get started, you need to provide the following **required** environment varia
 | `OPENSHIFT_CI` | Disable colored output from tests suite run | `true` | false |
 | `TEST_VIRT` | Exclusively run Virtual Machine backup/restore testing | `false` | false |
 | `TEST_UPGRADE` | Exclusively run upgrade tests. Need to first run `make catalog-test-upgrade`, if testing non production operator | `false` | false |
+| `SKIP_MUST_GATHER` | must-gather is compiled locally in the Makefile, may cause issue if local and cluster arch do not match| `false` | false |
+
+> **Note:**
 
 The expected format for `OADP_CRED_FILE` and `CI_CRED_FILE` files is:
 ```
@@ -42,6 +45,7 @@ export VSL_REGION=<snapshotLocations_region>
 export BSL_REGION=<backupLocations_region>
 export OADP_TEST_NAMESPACE=<test_namespace>
 export OPENSHIFT_CI=false
+export SKIP_MUST_GATHER=true
 ```
 
 It is also possible to set the environment variables during make command call. Example

tests/e2e/backup_restore_suite_test.go

@@ -303,9 +303,12 @@ var _ = ginkgo.Describe("Backup and restore tests", ginkgo.Ordered, func() {
 		err = lib.CreateUploadTestOnlyDPT(dpaCR.Client, dpaCR.Namespace, bslName)
 		gomega.Expect(err).ToNot(gomega.HaveOccurred())
 
-		log.Printf("Running OADP must-gather")
-		err = lib.RunMustGather(artifact_dir, dpaCR.Client)
-		gomega.Expect(err).ToNot(gomega.HaveOccurred())
+		log.Printf("skipMustGather: %v", skipMustGather)
+		if !skipMustGather {
+			log.Printf("Running OADP must-gather")
+			err = lib.RunMustGather(artifact_dir, dpaCR.Client)
+			gomega.Expect(err).ToNot(gomega.HaveOccurred())
+		}
 
 		err = dpaCR.Delete()
 		gomega.Expect(err).ToNot(gomega.HaveOccurred())

tests/e2e/e2e_suite_test.go

@@ -42,6 +42,7 @@ var (
 
 	kvmEmulation   bool
 	useUpstreamHco bool
+	skipMustGather bool
 )
 
 func init() {
@@ -57,6 +58,7 @@ func init() {
 	flag.Int64Var(&flakeAttempts, "flakeAttempts", 3, "Customize the number of flake retries (3)")
 	flag.BoolVar(&kvmEmulation, "kvm_emulation", true, "Enable or disable KVM emulation for virtualization testing")
 	flag.BoolVar(&useUpstreamHco, "hco_upstream", false, "Force use of upstream virtualization operator")
+	flag.BoolVar(&skipMustGather, "skipMustGather", false, "avoid errors with local execution and cluster architecture")
 
 	// helps with launching debug sessions from IDE
 	if os.Getenv("E2E_USE_ENV_FLAGS") == "true" {
@@ -106,6 +108,13 @@ func init() {
 				log.Println("Error parsing HCO_UPSTREAM, it will be disabled by default: ", err)
 			}
 		}
+		if envValue := os.Getenv("SKIP_MUST_GATHER"); envValue != "" {
+			if parsedValue, err := strconv.ParseBool(envValue); err == nil {
+				skipMustGather = parsedValue
+			} else {
+				log.Println("Error parsing SKIP_MUST_GATHER, must-gather will be enabled by default: ", err)
+			}
+		}
 	}
 
 }