Error when bundle root path contains glob (#3096)

## Changes
This PR adds an error when the bundle root path contains a glob
character.

```
Error: Bundle root path contains glob pattern characters

The path to the bundle root [TEST_TMP_DIR]/[abc] contains glob pattern character "[". Please remove the character from this path to use bundle commands.


Found 1 error
```

## Why
We provide full paths to `filepath.Glob` to figure out which paths to
include. If the file path itself happens to contain a glob pattern, then
`filepath.Glob` interprets that as a glob pattern, even though we should
not be parsing glob patterns there.

Escaping those glob patterns is also not possible because escaping is
not supported on windows. ref: https://pkg.go.dev/path/filepath#Match

Thus, we error here to inform users to modify their root paths before
doing a bundle deployment.

Note:
1. We could support this but that would mean writing our own glob
function. We can use the `filepath.Match` function to match the patterns
themselves but we would have to walk the paths. The ROI for this option
is low at the moment because our custom function would have to have the
same semantics as the `filepath.Glob` function which would take some
time to get right.
2. This PR does not completely solve the problem since there are some
other places as well where glob patterns might be accidentally parsed.
However, this PR addresses the most important usecase i.e. making during
the `includes` are correct and complete. Other usecases like libraries
not being uploaded correctly are less important and even those will be
very likely caught by this PR unless the user only has a single
`databricks.yml` in their bundle. refs:
https://github.com/databricks/cli/blob/d177292b5b2e5ce779c5d6c5d42feeec00cc533a/bundle/artifacts/expand_globs.go#L68

https://github.com/databricks/cli/blob/d177292b5b2e5ce779c5d6c5d42feeec00cc533a/bundle/libraries/expand_glob_references.go#L42

## Tests
New unit and acceptance tests.

Author: shreyas-goenka

NEXT_CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Release v0.259.0
 
 ### Notable Changes
+* Error when the absolute path to `databricks.yml` contains a glob character. These are: `*`, `?`, `[`, `]` and `^`. If the path to the `databricks.yml` file on your local filesystem contains one of these characters, that could lead to incorrect computation of glob patterns for the `includes` block and might cause resources to be deleted. After this patch users will not be at risk for unexpected deletions due to this issue. ([#3096](https://github.com/databricks/cli/pull/3096))
 * Diagnostics messages are no longer buffered to be printed at the end of command, flushed after every mutator ([#3175](https://github.com/databricks/cli/pull/3175))
 * Diagnostics are now always rendered with forward slashes in file paths, even on Windows ([#3175](https://github.com/databricks/cli/pull/3175))
 * "bundle summary" now prints diagnostics to stderr instead of stdout in text output mode ([#3175](https://github.com/databricks/cli/pull/3175))

acceptance/bundle/includes/glob_in_root_path/[abc]/databricks.yml

@@ -0,0 +1,5 @@
+Local = true
+Cloud = false
+
+[EnvMatrix]
+  DATABRICKS_CLI_DEPLOYMENT = ["terraform", "direct-exp"]

acceptance/bundle/includes/glob_in_root_path/out.test.toml

@@ -0,0 +1,10 @@
+
+>>> [CLI] bundle validate
+Error: Bundle root path contains glob pattern characters
+
+The path to the bundle root [TEST_TMP_DIR]/[abc] contains glob pattern character "[". Please remove the character from this path to use bundle commands.
+
+
+Found 1 error
+
+Exit code: 1

acceptance/bundle/includes/glob_in_root_path/output.txt

@@ -0,0 +1,2 @@
+cd [abc]
+trace $CLI bundle validate

acceptance/bundle/includes/glob_in_root_path/script

@@ -0,0 +1,3 @@
+[[Repls]]
+Old = '\\'
+New = '/'

acceptance/bundle/includes/glob_in_root_path/test.toml

@@ -24,6 +24,18 @@ func (m *processRootIncludes) Name() string {
 	return "ProcessRootIncludes"
 }
 
+// hasGlobCharacters checks if a path contains any glob characters.
+func hasGlobCharacters(path string) (string, bool) {
+	// List of glob characters supported by the filepath package in [filepath.Match]
+	globCharacters := []string{"*", "?", "[", "]", "^"}
+	for _, char := range globCharacters {
+		if strings.Contains(path, char) {
+			return char, true
+		}
+	}
+	return "", false
+}
+
 func (m *processRootIncludes) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
 	var out []bundle.Mutator
 
@@ -39,6 +51,24 @@ func (m *processRootIncludes) Apply(ctx context.Context, b *bundle.Bundle) diag.
 	var files []string
 	var diags diag.Diagnostics
 
+	// We error on glob characters in the bundle root path since they are
+	// parsed by [filepath.Glob] as being glob patterns and thus can cause
+	// unexpected behavior.
+	//
+	// The standard library does not support globbing relative paths from a specified
+	// base directory. To support this, we can either:
+	// 1. Change CWD to the bundle root path before calling [filepath.Glob]
+	// 2. Implement our own custom globbing function. We can use [filepath.Match] to do so.
+	if char, ok := hasGlobCharacters(b.BundleRootPath); ok {
+		diags = diags.Append(diag.Diagnostic{
+			Severity: diag.Error,
+			Summary:  "Bundle root path contains glob pattern characters",
+			Detail:   fmt.Sprintf("The path to the bundle root %s contains glob pattern character %q. Please remove the character from this path to use bundle commands.", b.BundleRootPath, char),
+		})
+
+		return diags
+	}
+
 	// For each glob, find all files to load.
 	// Ordering of the list of globs is maintained in the output.
 	// For matches that appear in multiple globs, only the first is kept.

bundle/config/loader/process_root_includes.go

@@ -9,6 +9,7 @@ import (
 	"github.com/databricks/cli/bundle/config"
 	"github.com/databricks/cli/bundle/config/loader"
 	"github.com/databricks/cli/internal/testutil"
+	"github.com/databricks/cli/libs/diag"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -111,3 +112,70 @@ func TestProcessRootIncludesNotExists(t *testing.T) {
 	require.True(t, diags.HasError())
 	assert.ErrorContains(t, diags.Error(), "notexist.yml defined in 'include' section does not match any files")
 }
+
+func TestProcessRootIncludesGlobInRootPath(t *testing.T) {
+	tests := []struct {
+		name string
+		root string
+		diag diag.Diagnostic
+	}{
+		{
+			name: "star",
+			root: "foo/a*",
+			diag: diag.Diagnostic{
+				Severity: diag.Error,
+				Summary:  "Bundle root path contains glob pattern characters",
+				Detail:   `The path to the bundle root foo/a* contains glob pattern character "*". Please remove the character from this path to use bundle commands.`,
+			},
+		},
+		{
+			name: "question mark",
+			root: "bar/?b",
+			diag: diag.Diagnostic{
+				Severity: diag.Error,
+				Summary:  "Bundle root path contains glob pattern characters",
+				Detail:   `The path to the bundle root bar/?b contains glob pattern character "?". Please remove the character from this path to use bundle commands.`,
+			},
+		},
+		{
+			name: "left bracket",
+			root: "[ab",
+			diag: diag.Diagnostic{
+				Severity: diag.Error,
+				Summary:  "Bundle root path contains glob pattern characters",
+				Detail:   `The path to the bundle root [ab contains glob pattern character "[". Please remove the character from this path to use bundle commands.`,
+			},
+		},
+		{
+			name: "right bracket",
+			root: "ab]/bax",
+			diag: diag.Diagnostic{
+				Severity: diag.Error,
+				Summary:  "Bundle root path contains glob pattern characters",
+				Detail:   `The path to the bundle root ab]/bax contains glob pattern character "]". Please remove the character from this path to use bundle commands.`,
+			},
+		},
+		{
+			name: "hat",
+			root: "ab^bax",
+			diag: diag.Diagnostic{
+				Severity: diag.Error,
+				Summary:  "Bundle root path contains glob pattern characters",
+				Detail:   `The path to the bundle root ab^bax contains glob pattern character "^". Please remove the character from this path to use bundle commands.`,
+			},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			b := &bundle.Bundle{
+				BundleRootPath: test.root,
+			}
+
+			diags := bundle.Apply(context.Background(), b, loader.ProcessRootIncludes())
+			require.True(t, diags.HasError())
+			assert.Len(t, diags, 1)
+			assert.Equal(t, test.diag, diags[0])
+		})
+	}
+}