Consolidate helper functions to internal/testutil package (#2002)

## Changes

This is one step (of many) toward moving the integration tests around.

This change consolidates the following functions:

* `ReadFile` / `WriteFile`
* `GetEnvOrSkipTest`
* `RandomName`

## Tests

n/a

Author: pietern

bundle/config/validate/files_to_sync_test.go

@@ -2,6 +2,7 @@ package validate
 
 import (
 	"context"
+	"path/filepath"
 	"testing"
 
 	"github.com/databricks/cli/bundle"
@@ -81,7 +82,7 @@ func TestFilesToSync_EverythingIgnored(t *testing.T) {
 	b := setupBundleForFilesToSyncTest(t)
 
 	// Ignore all files.
-	testutil.WriteFile(t, "*\n.*\n", b.BundleRootPath, ".gitignore")
+	testutil.WriteFile(t, filepath.Join(b.BundleRootPath, ".gitignore"), "*\n.*\n")
 
 	ctx := context.Background()
 	rb := bundle.ReadOnly(b)

bundle/deploy/terraform/check_dashboards_modified_remotely_test.go

@@ -139,7 +139,7 @@ func writeFakeDashboardState(t *testing.T, ctx context.Context, b *bundle.Bundle
 	require.NoError(t, err)
 
 	// Write fake state file.
-	testutil.WriteFile(t, `
+	testutil.WriteFile(t, filepath.Join(tfDir, TerraformStateFileName), `
     {
       "version": 4,
       "terraform_version": "1.5.5",
@@ -187,5 +187,5 @@ func writeFakeDashboardState(t *testing.T, ctx context.Context, b *bundle.Bundle
         }
       ]
     }
-	`, filepath.Join(tfDir, TerraformStateFileName))
+	`)
 }

internal/acc/workspace.go

@@ -6,6 +6,7 @@ import (
 	"os"
 	"testing"
 
+	"github.com/databricks/cli/internal/testutil"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/apierr"
 	"github.com/databricks/databricks-sdk-go/service/compute"
@@ -26,7 +27,7 @@ type WorkspaceT struct {
 func WorkspaceTest(t *testing.T) (context.Context, *WorkspaceT) {
 	loadDebugEnvIfRunFromIDE(t, "workspace")
 
-	t.Log(GetEnvOrSkipTest(t, "CLOUD_ENV"))
+	t.Log(testutil.GetEnvOrSkipTest(t, "CLOUD_ENV"))
 
 	w, err := databricks.NewWorkspaceClient()
 	require.NoError(t, err)
@@ -46,7 +47,7 @@ func WorkspaceTest(t *testing.T) (context.Context, *WorkspaceT) {
 func UcWorkspaceTest(t *testing.T) (context.Context, *WorkspaceT) {
 	loadDebugEnvIfRunFromIDE(t, "workspace")
 
-	t.Log(GetEnvOrSkipTest(t, "CLOUD_ENV"))
+	t.Log(testutil.GetEnvOrSkipTest(t, "CLOUD_ENV"))
 
 	if os.Getenv("TEST_METASTORE_ID") == "" {
 		t.Skipf("Skipping on non-UC workspaces")
@@ -70,7 +71,7 @@ func UcWorkspaceTest(t *testing.T) (context.Context, *WorkspaceT) {
 }
 
 func (t *WorkspaceT) TestClusterID() string {
-	clusterID := GetEnvOrSkipTest(t.T, "TEST_BRICKS_CLUSTER_ID")
+	clusterID := testutil.GetEnvOrSkipTest(t.T, "TEST_BRICKS_CLUSTER_ID")
 	err := t.W.Clusters.EnsureClusterIsRunning(t.ctx, clusterID)
 	require.NoError(t, err)
 	return clusterID
@@ -103,7 +104,7 @@ func (t *WorkspaceT) TemporaryWorkspaceDir(name ...string) string {
 	me, err := t.W.CurrentUser.Me(ctx)
 	require.NoError(t, err)
 
-	basePath := fmt.Sprintf("/Users/%s/%s", me.UserName, RandomName(name...))
+	basePath := fmt.Sprintf("/Users/%s/%s", me.UserName, testutil.RandomName(name...))
 
 	t.Logf("Creating %s", basePath)
 	err = t.W.Workspace.MkdirsByPath(ctx, basePath)

internal/alerts_test.go

@@ -3,11 +3,12 @@ package internal
 import (
 	"testing"
 
+	"github.com/databricks/cli/internal/testutil"
 	"github.com/stretchr/testify/assert"
 )
 
 func TestAccAlertsCreateErrWhenNoArguments(t *testing.T) {
-	t.Log(GetEnvOrSkipTest(t, "CLOUD_ENV"))
+	t.Log(testutil.GetEnvOrSkipTest(t, "CLOUD_ENV"))
 
 	_, _, err := RequireErrorRun(t, "alerts-legacy", "create")
 	assert.Equal(t, "please provide command input in JSON format by specifying the --json flag", err.Error())

internal/api_test.go

@@ -4,16 +4,18 @@ import (
 	"encoding/json"
 	"fmt"
 	"path"
+	"path/filepath"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	_ "github.com/databricks/cli/cmd/api"
+	"github.com/databricks/cli/internal/testutil"
 )
 
 func TestAccApiGet(t *testing.T) {
-	t.Log(GetEnvOrSkipTest(t, "CLOUD_ENV"))
+	t.Log(testutil.GetEnvOrSkipTest(t, "CLOUD_ENV"))
 
 	stdout, _ := RequireSuccessfulRun(t, "api", "get", "/api/2.0/preview/scim/v2/Me")
 
@@ -28,14 +30,15 @@ func TestAccApiGet(t *testing.T) {
 }
 
 func TestAccApiPost(t *testing.T) {
-	env := GetEnvOrSkipTest(t, "CLOUD_ENV")
+	env := testutil.GetEnvOrSkipTest(t, "CLOUD_ENV")
 	t.Log(env)
 	if env == "gcp" {
 		t.Skip("DBFS REST API is disabled on gcp")
 	}
 
-	dbfsPath := path.Join("/tmp/databricks/integration", RandomName("api-post"))
-	requestPath := writeFile(t, "body.json", fmt.Sprintf(`{
+	dbfsPath := path.Join("/tmp/databricks/integration", testutil.RandomName("api-post"))
+	requestPath := filepath.Join(t.TempDir(), "body.json")
+	testutil.WriteFile(t, requestPath, fmt.Sprintf(`{
 		"path": "%s"
 	}`, dbfsPath))
 

internal/auth_describe_test.go

@@ -5,12 +5,13 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/databricks/cli/internal/testutil"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/stretchr/testify/require"
 )
 
 func TestAuthDescribeSuccess(t *testing.T) {
-	t.Log(GetEnvOrSkipTest(t, "CLOUD_ENV"))
+	t.Log(testutil.GetEnvOrSkipTest(t, "CLOUD_ENV"))
 
 	stdout, _ := RequireSuccessfulRun(t, "auth", "describe")
 	outStr := stdout.String()
@@ -31,7 +32,7 @@ func TestAuthDescribeSuccess(t *testing.T) {
 }
 
 func TestAuthDescribeFailure(t *testing.T) {
-	t.Log(GetEnvOrSkipTest(t, "CLOUD_ENV"))
+	t.Log(testutil.GetEnvOrSkipTest(t, "CLOUD_ENV"))
 
 	stdout, _ := RequireSuccessfulRun(t, "auth", "describe", "--profile", "nonexistent")
 	outStr := stdout.String()

internal/bundle/artifacts_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/databricks/cli/bundle/libraries"
 	"github.com/databricks/cli/internal"
 	"github.com/databricks/cli/internal/acc"
+	"github.com/databricks/cli/internal/testutil"
 	"github.com/databricks/databricks-sdk-go/service/catalog"
 	"github.com/databricks/databricks-sdk-go/service/compute"
 	"github.com/databricks/databricks-sdk-go/service/jobs"
@@ -234,7 +235,7 @@ func TestAccUploadArtifactFileToVolumeThatDoesNotExist(t *testing.T) {
 	ctx, wt := acc.UcWorkspaceTest(t)
 	w := wt.W
 
-	schemaName := internal.RandomName("schema-")
+	schemaName := testutil.RandomName("schema-")
 
 	_, err := w.Schemas.Create(ctx, catalog.CreateSchema{
 		CatalogName: "main",
@@ -271,7 +272,7 @@ func TestAccUploadArtifactToVolumeNotYetDeployed(t *testing.T) {
 	ctx, wt := acc.UcWorkspaceTest(t)
 	w := wt.W
 
-	schemaName := internal.RandomName("schema-")
+	schemaName := testutil.RandomName("schema-")
 
 	_, err := w.Schemas.Create(ctx, catalog.CreateSchema{
 		CatalogName: "main",

internal/bundle/bind_resource_test.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/databricks/cli/internal"
 	"github.com/databricks/cli/internal/acc"
+	"github.com/databricks/cli/internal/testutil"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/service/jobs"
 	"github.com/google/uuid"
@@ -16,7 +17,7 @@ import (
 )
 
 func TestAccBindJobToExistingJob(t *testing.T) {
-	env := internal.GetEnvOrSkipTest(t, "CLOUD_ENV")
+	env := testutil.GetEnvOrSkipTest(t, "CLOUD_ENV")
 	t.Log(env)
 
 	ctx, wt := acc.WorkspaceTest(t)
@@ -81,7 +82,7 @@ func TestAccBindJobToExistingJob(t *testing.T) {
 }
 
 func TestAccAbortBind(t *testing.T) {
-	env := internal.GetEnvOrSkipTest(t, "CLOUD_ENV")
+	env := testutil.GetEnvOrSkipTest(t, "CLOUD_ENV")
 	t.Log(env)
 
 	ctx, wt := acc.WorkspaceTest(t)
@@ -130,7 +131,7 @@ func TestAccAbortBind(t *testing.T) {
 }
 
 func TestAccGenerateAndBind(t *testing.T) {
-	env := internal.GetEnvOrSkipTest(t, "CLOUD_ENV")
+	env := testutil.GetEnvOrSkipTest(t, "CLOUD_ENV")
 	t.Log(env)
 
 	ctx, wt := acc.WorkspaceTest(t)

internal/bundle/dashboards_test.go

@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/databricks/cli/internal/acc"
+	"github.com/databricks/cli/internal/testutil"
 	"github.com/databricks/databricks-sdk-go/service/dashboards"
 	"github.com/databricks/databricks-sdk-go/service/workspace"
 	"github.com/google/uuid"
@@ -15,7 +16,7 @@ import (
 func TestAccDashboards(t *testing.T) {
 	ctx, wt := acc.WorkspaceTest(t)
 
-	warehouseID := acc.GetEnvOrSkipTest(t, "TEST_DEFAULT_WAREHOUSE_ID")
+	warehouseID := testutil.GetEnvOrSkipTest(t, "TEST_DEFAULT_WAREHOUSE_ID")
 	uniqueID := uuid.New().String()
 	root, err := initTestTemplate(t, ctx, "dashboards", map[string]any{
 		"unique_id":    uniqueID,

internal/bundle/deployment_state_test.go

@@ -9,12 +9,13 @@ import (
 	"github.com/databricks/cli/bundle/deploy"
 	"github.com/databricks/cli/internal"
 	"github.com/databricks/cli/internal/acc"
+	"github.com/databricks/cli/internal/testutil"
 	"github.com/google/uuid"
 	"github.com/stretchr/testify/require"
 )
 
 func TestAccFilesAreSyncedCorrectlyWhenNoSnapshot(t *testing.T) {
-	env := internal.GetEnvOrSkipTest(t, "CLOUD_ENV")
+	env := testutil.GetEnvOrSkipTest(t, "CLOUD_ENV")
 	t.Log(env)
 
 	ctx, wt := acc.WorkspaceTest(t)