package terraform import ( "context" "os" "os/exec" "path/filepath" "runtime" "strings" "testing" "github.com/databricks/cli/bundle" "github.com/databricks/cli/bundle/config" "github.com/databricks/cli/bundle/internal/tf/schema" "github.com/databricks/cli/internal/testutil" "github.com/databricks/cli/libs/env" "github.com/hashicorp/hc-install/product" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "golang.org/x/exp/maps" ) func unsetEnv(t *testing.T, name string) { t.Setenv(name, "") err := os.Unsetenv(name) require.NoError(t, err) } func TestInitEnvironmentVariables(t *testing.T) { _, err := exec.LookPath("terraform") if err != nil { t.Skipf("cannot find terraform binary: %s", err) } b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", Terraform: &config.Terraform{ ExecPath: "terraform", }, }, }, } // Trigger initialization of workspace client. // TODO(pietern): create test fixture that initializes a mocked client. t.Setenv("DATABRICKS_HOST", "https://x") t.Setenv("DATABRICKS_TOKEN", "foobar") b.WorkspaceClient() diags := bundle.Apply(context.Background(), b, Initialize()) require.NoError(t, diags.Error()) } func TestSetTempDirEnvVarsForUnixWithTmpDirSet(t *testing.T) { if runtime.GOOS != "darwin" && runtime.GOOS != "linux" { t.SkipNow() } b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", }, }, } // Set TMPDIR environment variable t.Setenv("TMPDIR", "/foo/bar") // compute env env := make(map[string]string, 0) err := setTempDirEnvVars(context.Background(), env, b) require.NoError(t, err) // Assert that we pass through TMPDIR. assert.Equal(t, map[string]string{ "TMPDIR": "/foo/bar", }, env) } func TestSetTempDirEnvVarsForUnixWithTmpDirNotSet(t *testing.T) { if runtime.GOOS != "darwin" && runtime.GOOS != "linux" { t.SkipNow() } b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", }, }, } // Unset TMPDIR environment variable confirm it's not set unsetEnv(t, "TMPDIR") // compute env env := make(map[string]string, 0) err := setTempDirEnvVars(context.Background(), env, b) require.NoError(t, err) // Assert that we don't pass through TMPDIR. assert.Equal(t, map[string]string{}, env) } func TestSetTempDirEnvVarsForWindowWithAllTmpDirEnvVarsSet(t *testing.T) { if runtime.GOOS != "windows" { t.SkipNow() } b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", }, }, } // Set environment variables t.Setenv("TMP", "c:\\foo\\a") t.Setenv("TEMP", "c:\\foo\\b") t.Setenv("USERPROFILE", "c:\\foo\\c") // compute env env := make(map[string]string, 0) err := setTempDirEnvVars(context.Background(), env, b) require.NoError(t, err) // assert that we pass through the highest priority env var value assert.Equal(t, map[string]string{ "TMP": "c:\\foo\\a", }, env) } func TestSetTempDirEnvVarsForWindowWithUserProfileAndTempSet(t *testing.T) { if runtime.GOOS != "windows" { t.SkipNow() } b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", }, }, } // Set environment variables unsetEnv(t, "TMP") t.Setenv("TEMP", "c:\\foo\\b") t.Setenv("USERPROFILE", "c:\\foo\\c") // compute env env := make(map[string]string, 0) err := setTempDirEnvVars(context.Background(), env, b) require.NoError(t, err) // assert that we pass through the highest priority env var value assert.Equal(t, map[string]string{ "TEMP": "c:\\foo\\b", }, env) } func TestSetTempDirEnvVarsForWindowsWithoutAnyTempDirEnvVarsSet(t *testing.T) { if runtime.GOOS != "windows" { t.SkipNow() } b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", }, }, } // unset all env vars unsetEnv(t, "TMP") unsetEnv(t, "TEMP") unsetEnv(t, "USERPROFILE") // compute env env := make(map[string]string, 0) err := setTempDirEnvVars(context.Background(), env, b) require.NoError(t, err) // assert TMP is set to b.CacheDir("tmp") tmpDir, err := b.CacheDir(context.Background(), "tmp") require.NoError(t, err) assert.Equal(t, map[string]string{ "TMP": tmpDir, }, env) } func TestSetProxyEnvVars(t *testing.T) { b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", }, }, } // Temporarily clear environment variables. clearEnv := func() { for _, v := range []string{"http_proxy", "https_proxy", "no_proxy"} { for _, v := range []string{strings.ToUpper(v), strings.ToLower(v)} { t.Setenv(v, "foo") os.Unsetenv(v) } } } // No proxy env vars set. clearEnv() env := make(map[string]string, 0) err := setProxyEnvVars(context.Background(), env, b) require.NoError(t, err) assert.Len(t, env, 0) // Lower case set. clearEnv() t.Setenv("http_proxy", "foo") t.Setenv("https_proxy", "foo") t.Setenv("no_proxy", "foo") env = make(map[string]string, 0) err = setProxyEnvVars(context.Background(), env, b) require.NoError(t, err) assert.ElementsMatch(t, []string{"HTTP_PROXY", "HTTPS_PROXY", "NO_PROXY"}, maps.Keys(env)) // Upper case set. clearEnv() t.Setenv("HTTP_PROXY", "foo") t.Setenv("HTTPS_PROXY", "foo") t.Setenv("NO_PROXY", "foo") env = make(map[string]string, 0) err = setProxyEnvVars(context.Background(), env, b) require.NoError(t, err) assert.ElementsMatch(t, []string{"HTTP_PROXY", "HTTPS_PROXY", "NO_PROXY"}, maps.Keys(env)) } func TestSetUserAgentExtraEnvVar(t *testing.T) { b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Experimental: &config.Experimental{ PyDABs: config.PyDABs{ Enabled: true, }, }, }, } env := make(map[string]string, 0) err := setUserAgentExtraEnvVar(env, b) require.NoError(t, err) assert.Equal(t, map[string]string{ "DATABRICKS_USER_AGENT_EXTRA": "databricks-pydabs/0.0.0", }, env) } func TestInheritEnvVars(t *testing.T) { env := map[string]string{} t.Setenv("HOME", "/home/testuser") t.Setenv("PATH", "/foo:/bar") t.Setenv("TF_CLI_CONFIG_FILE", "/tmp/config.tfrc") err := inheritEnvVars(context.Background(), env) require.NoError(t, err) require.Equal(t, env["HOME"], "/home/testuser") require.Equal(t, env["PATH"], "/foo:/bar") require.Equal(t, env["TF_CLI_CONFIG_FILE"], "/tmp/config.tfrc") } func TestSetUserProfileFromInheritEnvVars(t *testing.T) { t.Setenv("USERPROFILE", "c:\\foo\\c") env := make(map[string]string, 0) err := inheritEnvVars(context.Background(), env) require.NoError(t, err) assert.Contains(t, env, "USERPROFILE") assert.Equal(t, env["USERPROFILE"], "c:\\foo\\c") } func TestInheritEnvVarsWithAbsentTFConfigFile(t *testing.T) { ctx := context.Background() envMap := map[string]string{} ctx = env.Set(ctx, "DATABRICKS_TF_PROVIDER_VERSION", schema.ProviderVersion) ctx = env.Set(ctx, "DATABRICKS_TF_CLI_CONFIG_FILE", "/tmp/config.tfrc") err := inheritEnvVars(ctx, envMap) require.NoError(t, err) require.NotContains(t, envMap, "TF_CLI_CONFIG_FILE") } func TestInheritEnvVarsWithWrongTFProviderVersion(t *testing.T) { ctx := context.Background() envMap := map[string]string{} configFile := createTempFile(t, t.TempDir(), "config.tfrc", false) ctx = env.Set(ctx, "DATABRICKS_TF_PROVIDER_VERSION", "wrong") ctx = env.Set(ctx, "DATABRICKS_TF_CLI_CONFIG_FILE", configFile) err := inheritEnvVars(ctx, envMap) require.NoError(t, err) require.NotContains(t, envMap, "TF_CLI_CONFIG_FILE") } func TestInheritEnvVarsWithCorrectTFCLIConfigFile(t *testing.T) { ctx := context.Background() envMap := map[string]string{} configFile := createTempFile(t, t.TempDir(), "config.tfrc", false) ctx = env.Set(ctx, "DATABRICKS_TF_PROVIDER_VERSION", schema.ProviderVersion) ctx = env.Set(ctx, "DATABRICKS_TF_CLI_CONFIG_FILE", configFile) err := inheritEnvVars(ctx, envMap) require.NoError(t, err) require.Contains(t, envMap, "TF_CLI_CONFIG_FILE") require.Equal(t, configFile, envMap["TF_CLI_CONFIG_FILE"]) } func TestFindExecPathFromEnvironmentWithWrongVersion(t *testing.T) { ctx := context.Background() m := &initialize{} b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", Terraform: &config.Terraform{}, }, }, } // Create a pre-existing terraform bin to avoid downloading it cacheDir, _ := b.CacheDir(ctx, "bin") existingExecPath := createTempFile(t, cacheDir, product.Terraform.BinaryName(), true) // Create a new terraform binary and expose it through env vars tmpBinPath := createTempFile(t, t.TempDir(), "terraform-bin", true) ctx = env.Set(ctx, "DATABRICKS_TF_VERSION", "1.2.3") ctx = env.Set(ctx, "DATABRICKS_TF_EXEC_PATH", tmpBinPath) _, err := m.findExecPath(ctx, b, b.Config.Bundle.Terraform) require.NoError(t, err) require.Equal(t, existingExecPath, b.Config.Bundle.Terraform.ExecPath) } func TestFindExecPathFromEnvironmentWithCorrectVersionAndNoBinary(t *testing.T) { ctx := context.Background() m := &initialize{} b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", Terraform: &config.Terraform{}, }, }, } // Create a pre-existing terraform bin to avoid downloading it cacheDir, _ := b.CacheDir(ctx, "bin") existingExecPath := createTempFile(t, cacheDir, product.Terraform.BinaryName(), true) ctx = env.Set(ctx, "DATABRICKS_TF_VERSION", TerraformVersion.String()) ctx = env.Set(ctx, "DATABRICKS_TF_EXEC_PATH", "/tmp/terraform") _, err := m.findExecPath(ctx, b, b.Config.Bundle.Terraform) require.NoError(t, err) require.Equal(t, existingExecPath, b.Config.Bundle.Terraform.ExecPath) } func TestFindExecPathFromEnvironmentWithCorrectVersionAndBinary(t *testing.T) { ctx := context.Background() m := &initialize{} b := &bundle.Bundle{ RootPath: t.TempDir(), Config: config.Root{ Bundle: config.Bundle{ Target: "whatever", Terraform: &config.Terraform{}, }, }, } // Create a pre-existing terraform bin to avoid downloading it cacheDir, _ := b.CacheDir(ctx, "bin") createTempFile(t, cacheDir, product.Terraform.BinaryName(), true) // Create a new terraform binary and expose it through env vars tmpBinPath := createTempFile(t, t.TempDir(), "terraform-bin", true) ctx = env.Set(ctx, "DATABRICKS_TF_VERSION", TerraformVersion.String()) ctx = env.Set(ctx, "DATABRICKS_TF_EXEC_PATH", tmpBinPath) _, err := m.findExecPath(ctx, b, b.Config.Bundle.Terraform) require.NoError(t, err) require.Equal(t, tmpBinPath, b.Config.Bundle.Terraform.ExecPath) } func createTempFile(t *testing.T, dest string, name string, executable bool) string { binPath := filepath.Join(dest, name) f, err := os.Create(binPath) require.NoError(t, err) defer func() { err = f.Close() require.NoError(t, err) }() if executable { err = f.Chmod(0777) require.NoError(t, err) } return binPath } func TestGetEnvVarWithMatchingVersion(t *testing.T) { envVarName := "FOO" versionVarName := "FOO_VERSION" tmp := t.TempDir() file := testutil.Touch(t, tmp, "bar") var tc = []struct { envValue string versionValue string currentVersion string expected string }{ { envValue: file, versionValue: "1.2.3", currentVersion: "1.2.3", expected: file, }, { envValue: "does-not-exist", versionValue: "1.2.3", currentVersion: "1.2.3", expected: "", }, { envValue: file, versionValue: "1.2.3", currentVersion: "1.2.4", expected: "", }, { envValue: "", versionValue: "1.2.3", currentVersion: "1.2.3", expected: "", }, { envValue: file, versionValue: "", currentVersion: "1.2.3", expected: file, }, } for _, c := range tc { t.Run("", func(t *testing.T) { t.Setenv(envVarName, c.envValue) t.Setenv(versionVarName, c.versionValue) actual, err := getEnvVarWithMatchingVersion(context.Background(), envVarName, versionVarName, c.currentVersion) require.NoError(t, err) assert.Equal(t, c.expected, actual) }) } }