Enable debugging integration tests in VS Code

integration/assumptions/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/bundle/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/alerts/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/api/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/auth/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/clusters/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/fs/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/jobs/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/repos/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/secrets/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/storage_credentials/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/sync/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/version/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/cmd/workspace/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/internal/acc/workspace.go

@@ -21,30 +21,20 @@ type WorkspaceT struct {
 }
 
 func WorkspaceTest(t testutil.TestingT) (context.Context, *WorkspaceT) {
-	loadDebugEnvIfRunFromIDE(t, "workspace")
-
-	t.Log(testutil.GetEnvOrSkipTest(t, "CLOUD_ENV"))
-
 	w, err := databricks.NewWorkspaceClient()
 	require.NoError(t, err)
 
 	wt := &WorkspaceT{
 		TestingT: t,
-
-		W: w,
-
-		ctx: context.Background(),
+		W:        w,
+		ctx:      context.Background(),
 	}
 
 	return wt.ctx, wt
 }
 
 // Run the workspace test only on UC workspaces.
 func UcWorkspaceTest(t testutil.TestingT) (context.Context, *WorkspaceT) {
-	loadDebugEnvIfRunFromIDE(t, "workspace")
-
-	t.Log(testutil.GetEnvOrSkipTest(t, "CLOUD_ENV"))
-
 	if os.Getenv("TEST_METASTORE_ID") == "" {
 		t.Skipf("Skipping on non-UC workspaces")
 	}
@@ -57,10 +47,8 @@ func UcWorkspaceTest(t testutil.TestingT) (context.Context, *WorkspaceT) {
 
 	wt := &WorkspaceT{
 		TestingT: t,
-
-		W: w,
-
-		ctx: context.Background(),
+		W:        w,
+		ctx:      context.Background(),
 	}
 
 	return wt.ctx, wt

integration/internal/main.go

@@ -1,15 +1,59 @@
 package internal
 
 import (
+	"encoding/json"
 	"fmt"
 	"os"
+	"path"
+	"path/filepath"
+	"strings"
 	"testing"
 )
 
-// Main is the entry point for integration tests.
+// Detects if test is run from "debug test" feature in VS Code.
+func isInDebug() bool {
+	ex, _ := os.Executable()
+	return strings.HasPrefix(path.Base(ex), "__debug_bin")
+}
+
+// Loads debug environment from ~/.databricks/debug-env.json.
+func loadDebugEnvIfRunFromIDE(key string) error {
+	if !isInDebug() {
+		return nil
+	}
+	home, err := os.UserHomeDir()
+	if err != nil {
+		return fmt.Errorf("cannot find user home: %s", err)
+	}
+	raw, err := os.ReadFile(filepath.Join(home, ".databricks/debug-env.json"))
+	if err != nil {
+		return fmt.Errorf("cannot load ~/.databricks/debug-env.json: %s", err)
+	}
+	var conf map[string]map[string]string
+	err = json.Unmarshal(raw, &conf)
+	if err != nil {
+		return fmt.Errorf("cannot parse ~/.databricks/debug-env.json: %s", err)
+	}
+	vars, ok := conf[key]
+	if !ok {
+		return fmt.Errorf("%s is not configured in ~/.databricks/debug-env.json", key)
+	}
+	for k, v := range vars {
+		os.Setenv(k, v)
+	}
+	return nil
+}
+
+// WorkspaceMain is the entry point for integration tests that run against a Databricks workspace.
 // We use this for all integration tests defined in this subtree to ensure
 // they are not inadvertently executed when calling `go test ./...`.
-func Main(m *testing.M) {
+func WorkspaceMain(m *testing.M) {
+	err := loadDebugEnvIfRunFromIDE("workspace")
+	if err != nil {
+		fmt.Printf("failed to load debug env: %s\n", err)
+		return
+	}
+
 	value := os.Getenv("CLOUD_ENV")
 	if value == "" {
 		fmt.Println("CLOUD_ENV is not set, skipping integration tests")

integration/libs/filer/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/libs/git/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/libs/locker/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/libs/tags/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }

integration/python/main_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 // TestMain is the entrypoint executed by the test runner.
-// See [internal.Main] for prerequisites for running integration tests.
+// See [internal.WorkspaceMain] for prerequisites for running integration tests.
 func TestMain(m *testing.M) {
-	internal.Main(m)
+	internal.WorkspaceMain(m)
 }