Add tests for default-python template on different Python versions (#…

…2025)

## Changes
Add new type of test helpers that run the command and compare full
output (golden files approach).

In case of JSON, there is also an option to ignore certain paths.

Add test for different versions of Python to go through bundle init
default-python / validate / deploy / summary.

## Tests
New integration tests.

NOTICE

@@ -97,3 +97,11 @@ License - https://github.com/stretchr/testify/blob/master/LICENSE
 whilp/git-urls - https://github.com/whilp/git-urls
 Copyright (c) 2020 Will Maier
 License - https://github.com/whilp/git-urls/blob/master/LICENSE
+
+github.com/wI2L/jsondiff v0.6.1
+Copyright (c) 2020-2024 William Poussier <[email protected]>
+License - https://github.com/wI2L/jsondiff/blob/master/LICENSE
+
+https://github.com/hexops/gotextdiff
+Copyright (c) 2009 The Go Authors. All rights reserved.
+License - https://github.com/hexops/gotextdiff/blob/main/LICENSE

go.mod

@@ -14,6 +14,7 @@ require (
 	github.com/hashicorp/hc-install v0.9.0 // MPL 2.0
 	github.com/hashicorp/terraform-exec v0.21.0 // MPL 2.0
 	github.com/hashicorp/terraform-json v0.23.0 // MPL 2.0
+	github.com/hexops/gotextdiff v1.0.3 // BSD 3-Clause "New" or "Revised" License
 	github.com/manifoldco/promptui v0.9.0 // BSD-3-Clause
 	github.com/mattn/go-isatty v0.0.20 // MIT
 	github.com/nwidger/jsoncolor v0.3.2 // MIT
@@ -22,6 +23,7 @@ require (
 	github.com/spf13/cobra v1.8.1 // Apache 2.0
 	github.com/spf13/pflag v1.0.5 // BSD-3-Clause
 	github.com/stretchr/testify v1.10.0 // MIT
+	github.com/wI2L/jsondiff v0.6.1 // MIT
 	golang.org/x/exp v0.0.0-20240222234643-814bf88cf225
 	golang.org/x/mod v0.22.0
 	golang.org/x/oauth2 v0.24.0
@@ -55,6 +57,10 @@ require (
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/stretchr/objx v0.5.2 // indirect
+	github.com/tidwall/gjson v1.18.0 // indirect
+	github.com/tidwall/match v1.1.1 // indirect
+	github.com/tidwall/pretty v1.2.1 // indirect
+	github.com/tidwall/sjson v1.2.5 // indirect
 	github.com/zclconf/go-cty v1.15.0 // indirect
 	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect

integration/bundle/init_default_python_test.go

@@ -0,0 +1,132 @@
+package bundle_test
+
+import (
+	"encoding/json"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"testing"
+
+	"github.com/databricks/cli/integration/internal/acc"
+	"github.com/databricks/cli/internal/testcli"
+	"github.com/databricks/cli/internal/testutil"
+	"github.com/databricks/cli/libs/python/pythontest"
+	"github.com/stretchr/testify/require"
+)
+
+var pythonVersions = []string{
+	"3.8",
+	"3.9",
+	"3.10",
+	"3.11",
+	"3.12",
+	"3.13",
+}
+
+var pythonVersionsShort = []string{
+	"3.9",
+	"3.12",
+}
+
+var extraInstalls = map[string][]string{
+	"3.12": {"setuptools"},
+	"3.13": {"setuptools"},
+}
+
+func TestDefaultPython(t *testing.T) {
+	versions := pythonVersions
+	if testing.Short() {
+		versions = pythonVersionsShort
+	}
+
+	for _, pythonVersion := range versions {
+		t.Run(pythonVersion, func(t *testing.T) {
+			testDefaultPython(t, pythonVersion)
+		})
+	}
+}
+
+func testDefaultPython(t *testing.T, pythonVersion string) {
+	ctx, wt := acc.WorkspaceTest(t)
+
+	uniqueProjectId := testutil.RandomName("")
+	ctx, replacements := testcli.WithReplacementsMap(ctx)
+	replacements.Set(uniqueProjectId, "$UNIQUE_PRJ")
+
+	user, err := wt.W.CurrentUser.Me(ctx)
+	require.NoError(t, err)
+	require.NotNil(t, user)
+	testcli.PrepareReplacementsUser(t, replacements, *user)
+	testcli.PrepareReplacements(t, replacements, wt.W)
+
+	tmpDir := t.TempDir()
+	testutil.Chdir(t, tmpDir)
+
+	opts := pythontest.VenvOpts{
+		PythonVersion: pythonVersion,
+		Dir:           tmpDir,
+	}
+
+	pythontest.RequireActivatedPythonEnv(t, ctx, &opts)
+	extras, ok := extraInstalls[pythonVersion]
+	if ok {
+		args := append([]string{"pip", "install", "--python", opts.PythonExe}, extras...)
+		cmd := exec.Command("uv", args...)
+		require.NoError(t, cmd.Run())
+	}
+
+	projectName := "project_name_" + uniqueProjectId
+
+	initConfig := map[string]string{
+		"project_name":     projectName,
+		"include_notebook": "yes",
+		"include_python":   "yes",
+		"include_dlt":      "yes",
+	}
+	b, err := json.Marshal(initConfig)
+	require.NoError(t, err)
+	err = os.WriteFile(filepath.Join(tmpDir, "config.json"), b, 0o644)
+	require.NoError(t, err)
+
+	testcli.AssertOutput(
+		t,
+		ctx,
+		[]string{"bundle", "init", "default-python", "--config-file", "config.json"},
+		testutil.TestData("testdata/default_python/bundle_init.txt"),
+	)
+	testutil.Chdir(t, projectName)
+
+	t.Cleanup(func() {
+		// Delete the stack
+		testcli.RequireSuccessfulRun(t, ctx, "bundle", "destroy", "--auto-approve")
+	})
+
+	testcli.AssertOutput(
+		t,
+		ctx,
+		[]string{"bundle", "validate"},
+		testutil.TestData("testdata/default_python/bundle_validate.txt"),
+	)
+	testcli.AssertOutput(
+		t,
+		ctx,
+		[]string{"bundle", "deploy"},
+		testutil.TestData("testdata/default_python/bundle_deploy.txt"),
+	)
+
+	testcli.AssertOutputJQ(
+		t,
+		ctx,
+		[]string{"bundle", "summary", "--output", "json"},
+		testutil.TestData("testdata/default_python/bundle_summary.txt"),
+		[]string{
+			"/bundle/terraform/exec_path",
+			"/resources/jobs/project_name_$UNIQUE_PRJ_job/email_notifications",
+			"/resources/jobs/project_name_$UNIQUE_PRJ_job/job_clusters/0/new_cluster/node_type_id",
+			"/resources/jobs/project_name_$UNIQUE_PRJ_job/url",
+			"/resources/pipelines/project_name_$UNIQUE_PRJ_pipeline/catalog",
+			"/resources/pipelines/project_name_$UNIQUE_PRJ_pipeline/url",
+			"/workspace/current_user",
+		},
+	)
+}

integration/bundle/testdata/default_python/bundle_deploy.txt

@@ -0,0 +1,6 @@
+Building project_name_$UNIQUE_PRJ...
+Uploading project_name_$UNIQUE_PRJ-0.0.1+<NUMID>.<NUMID>-py3-none-any.whl...
+Uploading bundle files to /Workspace/Users/$USERNAME/.bundle/project_name_$UNIQUE_PRJ/dev/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!

integration/bundle/testdata/default_python/bundle_init.txt

@@ -0,0 +1,8 @@
+
+Welcome to the default Python template for Databricks Asset Bundles!
+Workspace to use (auto-detected, edit in 'project_name_$UNIQUE_PRJ/databricks.yml'): https://$DATABRICKS_HOST
+
+✨ Your new project has been created in the 'project_name_$UNIQUE_PRJ' directory!
+
+Please refer to the README.md file for "getting started" instructions.
+See also the documentation at https://docs.databricks.com/dev-tools/bundles/index.html.