Add --strict to bundle validate (#4232)

Some of our warnings cause errors down the line. For example, if
required values are missing or invalid enum values are provided.

The `--strict` flag allows users to opt-in into a more strict validation
that can help them enforce our recommendations better.

Author: shreyas-goenka

acceptance/bundle/help/bundle-validate/output.txt

@@ -5,6 +5,7 @@ Validate bundle configuration for errors, warnings and recommendations.
 Run validate before deploy to catch configuration issues early:
   databricks bundle validate                  # Validate default target
   databricks bundle validate --target prod    # Validate specific target
+  databricks bundle validate --strict         # Fail on warnings
 
 Validation checks the configuration syntax and schema, permissions etc.
 
@@ -14,7 +15,8 @@ Usage:
   databricks bundle validate [flags]
 
 Flags:
-  -h, --help   help for validate
+  -h, --help     help for validate
+      --strict   Treat warnings as errors
 
 Global Flags:
       --debug            enable debug logging

acceptance/bundle/validate/strict/databricks.yml

@@ -0,0 +1,17 @@
+bundle:
+  name: test-bundle
+
+variables:
+  my_variable:
+    type: INVALID_TYPE
+    default: "value"
+
+targets:
+  foo:
+    default: true
+
+  bar:
+    artifacts:
+      my_artifact:
+        type: INVALID_TYPE
+        build: "echo 'hello'"

acceptance/bundle/validate/strict/out.test.toml

@@ -0,0 +1,49 @@
+
+>>> [CLI] bundle validate
+Warning: invalid value "INVALID_TYPE" for enum field. Valid values are [complex]
+  at variables.my_variable.type
+  in databricks.yml:6:11
+
+Name: test-bundle
+Target: foo
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/test-bundle/foo
+
+Found 1 warning
+
+>>> [CLI] bundle validate --strict
+Warning: invalid value "INVALID_TYPE" for enum field. Valid values are [complex]
+  at variables.my_variable.type
+  in databricks.yml:6:11
+
+Name: test-bundle
+Target: foo
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/test-bundle/foo
+
+Found 1 warning
+Error: 1 warning was found. Warnings are not allowed in strict mode
+
+Exit code: 1
+
+>>> [CLI] bundle validate --strict -t bar
+Warning: invalid value "INVALID_TYPE" for enum field. Valid values are [complex]
+  at variables.my_variable.type
+  in databricks.yml:6:11
+
+Warning: invalid value "INVALID_TYPE" for enum field. Valid values are [whl jar]
+  at artifacts.my_artifact.type
+  in databricks.yml:16:15
+
+Name: test-bundle
+Target: bar
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/test-bundle/bar
+
+Found 2 warnings
+Error: 2 warnings were found. Warnings are not allowed in strict mode
+
+Exit code: 1

acceptance/bundle/validate/strict/output.txt

@@ -0,0 +1,7 @@
+# Without --strict, warnings don't cause exit code 1
+trace $CLI bundle validate
+
+# With --strict, warnings cause exit code 1
+errcode trace $CLI bundle validate --strict
+
+errcode trace $CLI bundle validate --strict -t bar

acceptance/bundle/validate/strict/script

@@ -2,6 +2,7 @@ package bundle
 
 import (
 	"encoding/json"
+	"fmt"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/render"
@@ -35,6 +36,7 @@ func newValidateCommand() *cobra.Command {
 Run validate before deploy to catch configuration issues early:
   databricks bundle validate                  # Validate default target
   databricks bundle validate --target prod    # Validate specific target
+  databricks bundle validate --strict         # Fail on warnings
 
 Validation checks the configuration syntax and schema, permissions etc.
 
@@ -43,8 +45,10 @@ Please run this command before deploying to ensure configuration quality.`,
 	}
 
 	var includeLocations bool
+	var strict bool
 	cmd.Flags().BoolVar(&includeLocations, "include-locations", false, "Include location information in the output")
 	cmd.Flags().MarkHidden("include-locations")
+	cmd.Flags().BoolVar(&strict, "strict", false, "Treat warnings as errors")
 
 	cmd.RunE = func(cmd *cobra.Command, args []string) error {
 		b, err := utils.ProcessBundle(cmd, utils.ProcessOptions{
@@ -74,6 +78,18 @@ Please run this command before deploying to ensure configuration quality.`,
 			}
 		}
 
+		// In strict mode, treat warnings as errors.
+		numWarnings := logdiag.NumWarnings(ctx)
+		if err == nil && strict && numWarnings > 0 {
+			prefix := ""
+			if numWarnings == 1 {
+				prefix = "1 warning was found"
+			} else {
+				prefix = fmt.Sprintf("%d warnings were found", numWarnings)
+			}
+			return fmt.Errorf("%s. Warnings are not allowed in strict mode", prefix)
+		}
+
 		return err
 	}
 

cmd/bundle/validate.go

@@ -75,6 +75,14 @@ func HasError(ctx context.Context) bool {
 	return val.Errors > 0
 }
 
+func NumWarnings(ctx context.Context) int {
+	val := read(ctx)
+	val.mu.Lock()
+	defer val.mu.Unlock()
+
+	return val.Warnings
+}
+
 func SetSeverity(ctx context.Context, target diag.Severity) {
 	val := read(ctx)
 	val.mu.Lock()