IDE launch template. e2e flags from environment.

Author: kaovilai

docs/developer/testing/AttatchingIDEDebuggers.md

@@ -0,0 +1,63 @@
+
+# Attatching IDE Debuggers to project.
+
+## VSCode
+Create `.vscode/launch.json` file with following content
+
+```json
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug E2E Test",
+            "type": "go",
+            "request": "launch",
+            "mode": "test",
+            "program": "${workspaceRoot}/tests/e2e/e2e_suite_test.go",
+            "env": {
+                // "KUBECONFIG": "/path/to/.kube/config",
+                "KUBERNETES_MASTER": "http://localhost:8080",
+                // modifying values from test-e2e flags
+                "E2E_USE_ENV_FLAGS": "true",
+                "VELERO_NAMESPACE": "openshift-adp",
+                "SETTINGS": "${workspaceRoot}/.vscode/default_settings.json",
+                "CLOUD_CREDENTIALS": "",
+                "VELERO_INSTANCE_NAME": "",
+                "CLUSTER_PROFILE": "",
+                "CREDS_SECRET_REF": "",
+                "PROVIDER": "",
+                "AZURE_RESOURCE_FILE": "",
+                "CI_CRED_FILE": "",
+                "ARTIFACT_DIR": "",
+                "OC_CLI": "",
+            }
+        },
+        {
+            "name": "Launch main.go",
+            "type": "go",
+            "request": "launch",
+            "mode": "debug",
+            "program": "${workspaceRoot}/main.go",
+            "env": {
+                "WATCH_NAMESPACE": "openshift-adp",
+                // "KUBECONFIG": "",
+                "KUBERNETES_MASTER": "http://localhost:8080"
+            }
+        },
+    ]
+}
+
+```
+
+copy `default_settings.json` file from `test/e2e/templates/` directory to `.vscode/` directory and modify it as per your needs.
+
+You can now use Run and Debug menu to launch
+- Debug E2E Test
+  - This runs the test suite in debug mode. You can add breakpoints to step through the end to end test.
+  - Prerequisites:
+    - You have installed OADP Operator. To install current commit run `make deploy-olm`
+- Launch main.go
+  - This runs the operator on your machine in debug mode. You can add breakpoints and step through the code.

tests/e2e/e2e_suite_test.go

@@ -5,6 +5,7 @@ import (
 	"flag"
 	"fmt"
 	"log"
+	"os"
 	"strconv"
 	"testing"
 	"time"
@@ -33,6 +34,45 @@ func init() {
 	flag.StringVar(&artifact_dir, "artifact_dir", "/tmp", "Directory for storing must gather")
 	flag.StringVar(&oc_cli, "oc_cli", "oc", "OC CLI Client")
 
+	// helps with launching debug sessions from IDE
+	if os.Getenv("E2E_USE_ENV_FLAGS") == "true" {
+		if os.Getenv("CLOUD_CREDENTIALS") != "" {
+			credFile = os.Getenv("CLOUD_CREDENTIALS")
+		}
+		if os.Getenv("VELERO_NAMESPACE") != "" {
+			namespace = os.Getenv("VELERO_NAMESPACE")
+		}
+		if os.Getenv("VELERO_INSTANCE_NAME") != "" {
+			instanceName = os.Getenv("VELERO_INSTANCE_NAME")
+		}
+		if os.Getenv("CLUSTER_PROFILE") != "" {
+			bsl_profile = os.Getenv("CLUSTER_PROFILE")
+		}
+		if os.Getenv("CREDS_SECRET_REF") != "" {
+			credSecretRef = os.Getenv("CREDS_SECRET_REF")
+		}
+		if os.Getenv("PROVIDER") != "" {
+			provider = os.Getenv("PROVIDER")
+		}
+		if os.Getenv("AZURE_RESOURCE_FILE") != "" {
+			azure_resource_file = os.Getenv("AZURE_RESOURCE_FILE")
+		}
+		if os.Getenv("CI_CRED_FILE") != "" {
+			ci_cred_file = os.Getenv("CI_CRED_FILE")
+		} else {
+			ci_cred_file = credFile
+		}
+		if os.Getenv("SETTINGS") != "" {
+			settings = os.Getenv("SETTINGS")
+		}
+		if os.Getenv("ARTIFACT_DIR") != "" {
+			artifact_dir = os.Getenv("ARTIFACT_DIR")
+		}
+		if os.Getenv("OC_CLI") != "" {
+			oc_cli = os.Getenv("OC_CLI")
+		}
+	}
+
 	timeoutMultiplierInput := flag.Int64("timeout_multiplier", 1, "Customize timeout multiplier from default (1)")
 	timeoutMultiplier = 1
 	if timeoutMultiplierInput != nil && *timeoutMultiplierInput >= 1 {