[Internal] Make test utils public and move integration test for quali…

…ty monitor (#3993)

## Changes
<!-- Summary of your changes that are easy to understand -->
- Make `Step`, `WorkspaceLevel`, `AccountLevel`, `UnityWorkspaceLevel`,
`UnityAccountLevel` public
- Rename `init_test.go` to `init.go` because variables exported from
files ending with `_test` cannot be imported
- Moved integration test for quality monitor next to the resource
definition

## Tests
<!-- 
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->

- [x] `make test` run locally
- [x] relevant change in `docs/` folder
- [x] covered with integration tests in `internal/acceptance`
- [x] relevant acceptance tests are passing
- [x] using Go SDK

CONTRIBUTING.md

@@ -333,7 +333,7 @@ func TestExampleResourceCreate(t *testing.T) {
 
 ```go
 func TestAccSecretAclResource(t *testing.T) {
- workspaceLevel(t, step{
+ WorkspaceLevel(t, Step{
   Template: `
   resource "databricks_group" "ds" {
    display_name = "data-scientists-{var.RANDOM}"

internal/acceptance/acceptance_test.go

@@ -50,7 +50,7 @@ func TestRunningRealTerraformWithFixtureBackend(t *testing.T) {
 			t.Setenv("DATABRICKS_HOST", client.Config.Host)
 			t.Setenv("DATABRICKS_TOKEN", client.Config.Token)
 
-			workspaceLevel(t, step{
+			WorkspaceLevel(t, Step{
 				Template: `resource "databricks_token" "this" {
 					lifetime_seconds = 6000
 					comment = "Testing token"

internal/acceptance/account_rule_set_test.go

@@ -32,7 +32,7 @@ func getServicePrincipalResource(t *testing.T) string {
 func TestMwsAccAccountServicePrincipalRuleSetsFullLifeCycle(t *testing.T) {
 	loadAccountEnv(t)
 	spResource := getServicePrincipalResource(t)
-	accountLevel(t, step{
+	AccountLevel(t, Step{
 		Template: spResource + `
 		resource "databricks_group" "this" {
 			display_name = "Group {var.RANDOM}"
@@ -69,7 +69,7 @@ func TestMwsAccAccountServicePrincipalRuleSetsFullLifeCycle(t *testing.T) {
 
 func TestMwsAccAccountGroupRuleSetsFullLifeCycle(t *testing.T) {
 	username := qa.RandomEmail()
-	accountLevel(t, step{
+	AccountLevel(t, Step{
 		Template: `
 		resource "databricks_user" "this" {
 			user_name = "` + username + `"

internal/acceptance/artifact_allowlist_test.go

@@ -5,7 +5,7 @@ import (
 )
 
 func TestUcAccArtifactAllowlistResourceFullLifecycle(t *testing.T) {
-	unityWorkspaceLevel(t, step{
+	UnityWorkspaceLevel(t, Step{
 		Template: `
 		resource "databricks_artifact_allowlist" "init" {
 			artifact_type = "INIT_SCRIPT"

internal/acceptance/catalog_test.go

@@ -7,7 +7,7 @@ import (
 
 func TestUcAccCatalog(t *testing.T) {
 	loadUcwsEnv(t)
-	unityWorkspaceLevel(t, step{
+	UnityWorkspaceLevel(t, Step{
 		Template: fmt.Sprintf(`
 		resource "databricks_catalog" "sandbox" {
 			name         = "sandbox{var.RANDOM}"
@@ -21,7 +21,7 @@ func TestUcAccCatalog(t *testing.T) {
 }
 
 func TestUcAccCatalogIsolated(t *testing.T) {
-	unityWorkspaceLevel(t, step{
+	UnityWorkspaceLevel(t, Step{
 		Template: `
 		resource "databricks_catalog" "sandbox" {
 			name           = "sandbox{var.STICKY_RANDOM}"
@@ -30,7 +30,7 @@ func TestUcAccCatalogIsolated(t *testing.T) {
 				purpose = "testing"
 			}
 		}`,
-	}, step{
+	}, Step{
 		Template: `
 		resource "databricks_catalog" "sandbox" {
 			name           = "sandbox{var.STICKY_RANDOM}"
@@ -40,7 +40,7 @@ func TestUcAccCatalogIsolated(t *testing.T) {
 				purpose = "testing"
 			}
 		}`,
-	}, step{
+	}, Step{
 		Template: `
 		resource "databricks_catalog" "sandbox" {
 			name           = "sandbox{var.STICKY_RANDOM}"
@@ -55,7 +55,7 @@ func TestUcAccCatalogIsolated(t *testing.T) {
 
 func TestUcAccCatalogUpdate(t *testing.T) {
 	loadUcwsEnv(t)
-	unityWorkspaceLevel(t, step{
+	UnityWorkspaceLevel(t, Step{
 		Template: fmt.Sprintf(`
 		resource "databricks_catalog" "sandbox" {
 			name           = "sandbox{var.STICKY_RANDOM}"
@@ -65,7 +65,7 @@ func TestUcAccCatalogUpdate(t *testing.T) {
 			}
 			%s
 		}`, getPredictiveOptimizationSetting(t, true)),
-	}, step{
+	}, Step{
 		Template: fmt.Sprintf(`
 		resource "databricks_catalog" "sandbox" {
 			name           = "sandbox{var.STICKY_RANDOM}"
@@ -76,7 +76,7 @@ func TestUcAccCatalogUpdate(t *testing.T) {
 			%s
 			owner = "account users"
 		}`, getPredictiveOptimizationSetting(t, true)),
-	}, step{
+	}, Step{
 		Template: fmt.Sprintf(`
 		resource "databricks_catalog" "sandbox" {
 			name           = "sandbox{var.STICKY_RANDOM}"
@@ -87,7 +87,7 @@ func TestUcAccCatalogUpdate(t *testing.T) {
 			%s
 			owner = "{env.TEST_DATA_ENG_GROUP}"
 		}`, getPredictiveOptimizationSetting(t, true)),
-	}, step{
+	}, Step{
 		Template: fmt.Sprintf(`
 		resource "databricks_catalog" "sandbox" {
 			name           = "sandbox{var.STICKY_RANDOM}"

internal/acceptance/cluster_policy_test.go

@@ -5,7 +5,7 @@ import (
 )
 
 func TestAccClusterPolicyResourceFullLifecycle(t *testing.T) {
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: `resource "databricks_cluster_policy" "external_metastore" {
 			name = "Terraform policy {var.RANDOM}"
 			definition = jsonencode({
@@ -15,7 +15,7 @@ func TestAccClusterPolicyResourceFullLifecycle(t *testing.T) {
 				}
 			})
 		}`,
-	}, step{
+	}, Step{
 		// renaming to a new random name
 		Template: `resource "databricks_cluster_policy" "external_metastore" {
 			name = "Terraform policy {var.RANDOM}"
@@ -30,7 +30,7 @@ func TestAccClusterPolicyResourceFullLifecycle(t *testing.T) {
 }
 
 func TestAccClusterPolicyResourceOverrideBuiltIn(t *testing.T) {
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: `resource "databricks_cluster_policy" "personal_vm" {
 			name = "Personal Compute"
 			policy_family_id = "personal-vm"
@@ -46,7 +46,7 @@ func TestAccClusterPolicyResourceOverrideBuiltIn(t *testing.T) {
 }
 
 func TestAccClusterPolicyResourceOverrideNew(t *testing.T) {
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: `resource "databricks_cluster_policy" "policyoverrideempty" {
 			policy_family_id = "personal-vm"
 			name             = "Policy Override {var.RANDOM}"

internal/acceptance/cluster_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 func TestAccClusterResource_CreateClusterWithLibraries(t *testing.T) {
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: `data "databricks_spark_version" "latest" {
 		}
 		resource "databricks_cluster" "this" {
@@ -73,9 +73,9 @@ func singleNodeClusterTemplate(autoTerminationMinutes string) string {
 }
 
 func TestAccClusterResource_CreateSingleNodeCluster(t *testing.T) {
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: singleNodeClusterTemplate("10"),
-	}, step{
+	}, Step{
 		Template: singleNodeClusterTemplate("20"),
 	})
 }
@@ -103,16 +103,16 @@ func awsClusterTemplate(availability string) string {
 func TestAccClusterResource_CreateAndUpdateAwsAttributes(t *testing.T) {
 	loadWorkspaceEnv(t)
 	if isAws(t) {
-		workspaceLevel(t, step{
+		WorkspaceLevel(t, Step{
 			Template: awsClusterTemplate("SPOT"),
-		}, step{
+		}, Step{
 			Template: awsClusterTemplate("SPOT_WITH_FALLBACK"),
 		})
 	}
 }
 
 func TestAccClusterResource_CreateAndNoWait(t *testing.T) {
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: `data "databricks_spark_version" "latest" {
 		}
 		resource "databricks_cluster" "this" {
@@ -133,9 +133,9 @@ func TestAccClusterResource_CreateAndNoWait(t *testing.T) {
 }
 
 func TestAccClusterResource_WorkloadType(t *testing.T) {
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: testAccClusterResourceWorkloadTypeTemplate(""),
-	}, step{
+	}, Step{
 		Template: testAccClusterResourceWorkloadTypeTemplate(`
 		workload_type {
 		    clients {
@@ -147,7 +147,7 @@ func TestAccClusterResource_WorkloadType(t *testing.T) {
 			resource.TestCheckResourceAttr("databricks_cluster.this", "workload_type.0.clients.0.jobs", "true"),
 			resource.TestCheckResourceAttr("databricks_cluster.this", "workload_type.0.clients.0.notebooks", "true"),
 		),
-	}, step{
+	}, Step{
 		Template: testAccClusterResourceWorkloadTypeTemplate(`
 		workload_type {
 		    clients {
@@ -159,7 +159,7 @@ func TestAccClusterResource_WorkloadType(t *testing.T) {
 			resource.TestCheckResourceAttr("databricks_cluster.this", "workload_type.0.clients.0.jobs", "false"),
 			resource.TestCheckResourceAttr("databricks_cluster.this", "workload_type.0.clients.0.notebooks", "false"),
 		),
-	}, step{
+	}, Step{
 		Template: testAccClusterResourceWorkloadTypeTemplate(`
 		workload_type {
 		    clients { }
@@ -168,7 +168,7 @@ func TestAccClusterResource_WorkloadType(t *testing.T) {
 			resource.TestCheckResourceAttr("databricks_cluster.this", "workload_type.0.clients.0.jobs", "true"),
 			resource.TestCheckResourceAttr("databricks_cluster.this", "workload_type.0.clients.0.notebooks", "true"),
 		),
-	}, step{
+	}, Step{
 		Template: testAccClusterResourceWorkloadTypeTemplate(``),
 		Check: resource.ComposeAggregateTestCheckFunc(
 			resource.TestCheckResourceAttr("databricks_cluster.this", "workload_type.#", "0"),

internal/acceptance/connection_test.go

@@ -49,19 +49,19 @@ func connectionTemplateWithoutOwner() string {
 	`
 }
 func TestUcAccConnectionsResourceFullLifecycle(t *testing.T) {
-	unityWorkspaceLevel(t, step{
+	UnityWorkspaceLevel(t, Step{
 		Template: connectionTemplateWithOwner("test.mysql.database.azure.com", "account users"),
-	}, step{
+	}, Step{
 		Template: connectionTemplateWithOwner("test.mysql.database.aws.com", "account users"),
-	}, step{
+	}, Step{
 		Template: connectionTemplateWithOwner("test.mysql.database.azure.com", "{env.TEST_METASTORE_ADMIN_GROUP_NAME}"),
 	})
 }
 
 func TestUcAccConnectionsWithoutOwnerResourceFullLifecycle(t *testing.T) {
-	unityWorkspaceLevel(t, step{
+	UnityWorkspaceLevel(t, Step{
 		Template: connectionTemplateWithoutOwner(),
-	}, step{
+	}, Step{
 		Template: connectionTemplateWithoutOwner(),
 	})
 }

internal/acceptance/dashboard_test.go

@@ -89,7 +89,7 @@ func (t *templateStruct) SetAttributes(mapper map[string]string) templateStruct
 func TestAccBasicDashboard(t *testing.T) {
 	var template templateStruct
 	displayName := fmt.Sprintf("Test Dashboard - %s", qa.RandomName())
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: makeTemplate(template.SetAttributes(map[string]string{
 			"display_name":         displayName,
 			"warehouse_id":         "{env.TEST_DEFAULT_WAREHOUSE_ID}",
@@ -119,7 +119,7 @@ func TestAccBasicDashboard(t *testing.T) {
 func TestAccDashboardWithSerializedJSON(t *testing.T) {
 	var template templateStruct
 	displayName := fmt.Sprintf("Test Dashboard - %s", qa.RandomName())
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: makeTemplate(template.SetAttributes(map[string]string{
 			"display_name":         displayName,
 			"warehouse_id":         "{env.TEST_DEFAULT_WAREHOUSE_ID}",
@@ -142,7 +142,7 @@ func TestAccDashboardWithSerializedJSON(t *testing.T) {
 			require.NoError(t, err)
 			return nil
 		}),
-	}, step{
+	}, Step{
 		Template: makeTemplate(template.SetAttributes(map[string]string{
 			"serialized_dashboard": `{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page Modified\"}]}`,
 			"embed_credentials":    "true",
@@ -174,7 +174,7 @@ func TestAccDashboardWithFilePath(t *testing.T) {
 	fileName := tmpDir + "/Dashboard.json"
 	var template templateStruct
 	displayName := fmt.Sprintf("Test Dashboard - %s", qa.RandomName())
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		PreConfig: func() {
 			os.Mkdir(tmpDir, 0755)
 			os.WriteFile(fileName, []byte("{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page\"}]}"), 0644)
@@ -200,7 +200,7 @@ func TestAccDashboardWithFilePath(t *testing.T) {
 			require.NoError(t, err)
 			return nil
 		}),
-	}, step{
+	}, Step{
 		PreConfig: func() {
 			os.WriteFile(fileName, []byte("{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page Modified\"}]}"), 0644)
 		},
@@ -231,7 +231,7 @@ func TestAccDashboardWithNoChange(t *testing.T) {
 	initial_update_time := ""
 	var template templateStruct
 	displayName := fmt.Sprintf("Test Dashboard - %s", qa.RandomName())
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: makeTemplate(template.SetAttributes(map[string]string{
 			"display_name":         displayName,
 			"warehouse_id":         "{env.TEST_DEFAULT_WAREHOUSE_ID}",
@@ -254,7 +254,7 @@ func TestAccDashboardWithNoChange(t *testing.T) {
 			initial_update_time = dashboard.UpdateTime
 			return nil
 		}),
-	}, step{
+	}, Step{
 		Template: makeTemplate(template),
 		Check: resourceCheck("databricks_dashboard.d1", func(ctx context.Context, client *common.DatabricksClient, id string) error {
 			w, err := client.WorkspaceClient()
@@ -284,7 +284,7 @@ func TestAccDashboardWithRemoteChange(t *testing.T) {
 	etag := ""
 	var template templateStruct
 	displayName := fmt.Sprintf("Test Dashboard - %s", qa.RandomName())
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		Template: makeTemplate(template.SetAttributes(map[string]string{
 			"display_name":         displayName,
 			"warehouse_id":         "{env.TEST_DEFAULT_WAREHOUSE_ID}",
@@ -310,7 +310,7 @@ func TestAccDashboardWithRemoteChange(t *testing.T) {
 			etag = dashboard.Etag
 			return nil
 		}),
-	}, step{
+	}, Step{
 		PreConfig: func() {
 			w, err := databricks.NewWorkspaceClient(&databricks.Config{})
 			require.NoError(t, err)
@@ -355,7 +355,7 @@ func TestAccDashboardTestAll(t *testing.T) {
 	fileName := tmpDir + "/Dashboard.json"
 	var template templateStruct
 	displayName := fmt.Sprintf("Test Dashboard - %s", qa.RandomName())
-	workspaceLevel(t, step{
+	WorkspaceLevel(t, Step{
 		PreConfig: func() {
 			os.Mkdir(tmpDir, 0755)
 			os.WriteFile(fileName, []byte("{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page in file\"}]}"), 0644)
@@ -388,7 +388,7 @@ func TestAccDashboardTestAll(t *testing.T) {
 			require.Equal(t, publish_dash.EmbedCredentials, false)
 			return nil
 		}),
-	}, step{
+	}, Step{
 		PreConfig: func() {
 			os.WriteFile(fileName, []byte("{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page Modified\"}]}"), 0644)
 		},
@@ -414,7 +414,7 @@ func TestAccDashboardTestAll(t *testing.T) {
 			assert.NotEqual(t, "", dashboard.SerializedDashboard)
 			return nil
 		}),
-	}, step{
+	}, Step{
 		PreConfig: func() {
 			w, err := databricks.NewWorkspaceClient(&databricks.Config{})
 			require.NoError(t, err)
@@ -444,7 +444,7 @@ func TestAccDashboardTestAll(t *testing.T) {
 			require.NoError(t, err)
 			return nil
 		}),
-	}, step{
+	}, Step{
 		Template: makeTemplate(template.SetAttributes(map[string]string{
 			"embed_credentials": "true",
 			"parent_path":       "/Shared/Teams",
@@ -466,7 +466,7 @@ func TestAccDashboardTestAll(t *testing.T) {
 			assert.NotEqual(t, "", dashboard.SerializedDashboard)
 			return nil
 		}),
-	}, step{
+	}, Step{
 		PreConfig: func() {
 			os.WriteFile(fileName, []byte("{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page Modified again\"}]}"), 0644)
 		},

internal/acceptance/data_aws_crossaccount_policy_test.go

@@ -9,7 +9,7 @@ import (
 
 func TestMwsAccDataSourceAwsCrossaccountPolicy(t *testing.T) {
 	GetEnvOrSkipTest(t, "TEST_ROOT_BUCKET") // marker for AWS test env
-	accountLevel(t, step{
+	AccountLevel(t, Step{
 		Template: `
 		data "databricks_aws_crossaccount_policy" "this" {
 		}`,