pipelines: Add auto-selection for single pipeline in pipelines run and dry-run commands (#3243)

alyssa-db · web-flow · commit 74b4c29d8d19 · 2025-07-16T19:10:11.000Z
### **Changes** Enhanced `pipelines run` and `dry-run` commands to automatically select a pipeline when only one pipeline exists in the bundle and no arguments are specified. **Key changes in `cmd/pipelines/utils.go`:** - Modified `resolveRunArgument` function to auto-select pipeline when `len(args) == 0` and only one runnable resource (pipeline) exists - Maintains existing behavior for multiple resources (prompts for selection) and explicit arguments - Based on existing `resolveRunArgument` from `cmd/bundle/run.go` but tailored for pipeline workflows ### **Tests** Tests added to auto-select the single pipeline in the resources file in the tests Kept tests to still run both with and without specifying KEY (with and without auto-selection) Follow-up for pipeline open auto-selection: #3258
diff --git a/acceptance/pipelines/dry-run/dry-run-pipeline/output.txt b/acceptance/pipelines/dry-run/dry-run-pipeline/output.txt
@@ -6,6 +6,18 @@ Updating deployment state...
 Deployment complete!
 
 === Dry running pipeline, should have validate_only set to true
+>>> [PIPELINES] dry-run
+Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
+
+{
+  "body": {
+    "validate_only": true
+  },
+  "method": "POST",
+  "path": "/api/2.0/pipelines/[UUID]/updates"
+}
+
+=== Dry running pipeline with KEY, expect same output as without KEY
 >>> [PIPELINES] dry-run my_pipeline
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
diff --git a/acceptance/pipelines/dry-run/dry-run-pipeline/script b/acceptance/pipelines/dry-run/dry-run-pipeline/script
@@ -6,5 +6,9 @@ print_requests() {
 trace $PIPELINES deploy
 rm out.requests.txt
 title "Dry running pipeline, should have validate_only set to true"
+trace $PIPELINES dry-run
+print_requests
+
+title "Dry running pipeline with KEY, expect same output as without KEY"
 trace $PIPELINES dry-run my_pipeline
 print_requests
diff --git a/acceptance/pipelines/dry-run/no-wait/output.txt b/acceptance/pipelines/dry-run/no-wait/output.txt
@@ -6,7 +6,7 @@ Updating deployment state...
 Deployment complete!
 
 === Dry running pipeline with --no-wait flag
->>> [PIPELINES] dry-run my_pipeline --no-wait
+>>> [PIPELINES] dry-run --no-wait
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 <EOL>
diff --git a/acceptance/pipelines/dry-run/no-wait/script b/acceptance/pipelines/dry-run/no-wait/script
@@ -1,5 +1,5 @@
 trace $PIPELINES deploy
 title "Dry running pipeline with --no-wait flag"
-trace $PIPELINES dry-run my_pipeline --no-wait
+trace $PIPELINES dry-run --no-wait
 # This printf is here to fix the whitespace linter error (ensures exactly one newline at end)
 printf "<EOL>\n"
diff --git a/acceptance/pipelines/dry-run/restart/output.txt b/acceptance/pipelines/dry-run/restart/output.txt
@@ -6,7 +6,7 @@ Updating deployment state...
 Deployment complete!
 
 === Dry running pipeline with --restart flag, should stop the current pipeline and start a new run
->>> [PIPELINES] dry-run my_pipeline --restart
+>>> [PIPELINES] dry-run --restart
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 
diff --git a/acceptance/pipelines/dry-run/restart/script b/acceptance/pipelines/dry-run/restart/script
@@ -7,5 +7,5 @@ trace $PIPELINES deploy
 rm out.requests.txt
 
 title "Dry running pipeline with --restart flag, should stop the current pipeline and start a new run"
-trace $PIPELINES dry-run my_pipeline --restart
+trace $PIPELINES dry-run --restart
 trace print_requests
diff --git a/acceptance/pipelines/run/no-wait/output.txt b/acceptance/pipelines/run/no-wait/output.txt
@@ -6,7 +6,7 @@ Updating deployment state...
 Deployment complete!
 
 === test --no-wait flag
->>> [PIPELINES] run my_pipeline --no-wait
+>>> [PIPELINES] run --no-wait
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 <EOL>
diff --git a/acceptance/pipelines/run/no-wait/script b/acceptance/pipelines/run/no-wait/script
@@ -1,5 +1,5 @@
 trace $PIPELINES deploy
 title "test --no-wait flag"
-trace $PIPELINES run my_pipeline --no-wait
+trace $PIPELINES run --no-wait
 # This printf is here to fix the whitespace linter error (ensures exactly one newline at end)
 printf "<EOL>\n"
diff --git a/acceptance/pipelines/run/refresh-flags/output.txt b/acceptance/pipelines/run/refresh-flags/output.txt
@@ -6,7 +6,7 @@ Updating deployment state...
 Deployment complete!
 
 === Running pipeline with --refresh-all flag
->>> [PIPELINES] run my_pipeline --refresh-all
+>>> [PIPELINES] run --refresh-all
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 
@@ -18,7 +18,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 }
 
 === Running pipeline with --refresh flag and specific tables
->>> [PIPELINES] run my_pipeline --refresh table1,table2
+>>> [PIPELINES] run --refresh table1,table2
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 
@@ -35,7 +35,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 }
 
 === Running pipeline with --full-refresh-all flag
->>> [PIPELINES] run my_pipeline --full-refresh-all
+>>> [PIPELINES] run --full-refresh-all
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 
@@ -49,7 +49,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 }
 
 === Running pipeline with --full-refresh flag and specific tables
->>> [PIPELINES] run my_pipeline --full-refresh table1,table2
+>>> [PIPELINES] run --full-refresh table1,table2
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 
diff --git a/acceptance/pipelines/run/refresh-flags/script b/acceptance/pipelines/run/refresh-flags/script
@@ -8,20 +8,20 @@ rm out.requests.txt
 
 title "Running pipeline with --refresh-all flag"
 # Should perform a full graph update (empty refresh_selection and full_refresh_selection implies refresh_all)
-trace $PIPELINES run my_pipeline --refresh-all
+trace $PIPELINES run --refresh-all
 trace print_requests
 
 title "Running pipeline with --refresh flag and specific tables"
 # Should refresh only the specified tables
-trace $PIPELINES run my_pipeline --refresh table1,table2
+trace $PIPELINES run --refresh table1,table2
 trace print_requests
 
 title "Running pipeline with --full-refresh-all flag"
 # Should have full refresh set to true
-trace $PIPELINES run my_pipeline --full-refresh-all
+trace $PIPELINES run --full-refresh-all
 trace print_requests
 
 title "Running pipeline with --full-refresh flag and specific tables"
 # Should reset and recompute only the specified tables
-trace $PIPELINES run my_pipeline --full-refresh table1,table2
+trace $PIPELINES run --full-refresh table1,table2
 trace print_requests
diff --git a/acceptance/pipelines/run/restart/output.txt b/acceptance/pipelines/run/restart/output.txt
@@ -6,7 +6,7 @@ Updating deployment state...
 Deployment complete!
 
 === Running pipeline with --restart flag
->>> [PIPELINES] run my_pipeline --restart
+>>> [PIPELINES] run --restart
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 
diff --git a/acceptance/pipelines/run/restart/script b/acceptance/pipelines/run/restart/script
@@ -8,5 +8,5 @@ rm out.requests.txt
 
 title "Running pipeline with --restart flag"
 # Should stop the current pipeline and start a new update
-trace $PIPELINES run my_pipeline --restart
+trace $PIPELINES run --restart
 trace print_requests
diff --git a/acceptance/pipelines/run/run-pipeline/output.txt b/acceptance/pipelines/run/run-pipeline/output.txt
@@ -5,7 +5,12 @@ Deploying resources...
 Updating deployment state...
 Deployment complete!
 
-=== run pipeline
+=== Run pipeline
+>>> [PIPELINES] run
+Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
+
+
+=== Run pipeline with KEY, expect same output as without KEY
 >>> [PIPELINES] run my_pipeline
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
diff --git a/acceptance/pipelines/run/run-pipeline/script b/acceptance/pipelines/run/run-pipeline/script
@@ -1,5 +1,8 @@
 trace $PIPELINES deploy
-title "run pipeline"
+title "Run pipeline"
+trace $PIPELINES run
+
+title "Run pipeline with KEY, expect same output as without KEY"
 trace $PIPELINES run my_pipeline
 # This printf is here to fix the whitespace linter error (ensures exactly one newline at end)
 printf "<EOL>\n"
diff --git a/cmd/pipelines/utils.go b/cmd/pipelines/utils.go
@@ -6,13 +6,14 @@ import (
 	"fmt"
 
 	"github.com/databricks/cli/bundle"
+	configresources "github.com/databricks/cli/bundle/config/resources"
 	"github.com/databricks/cli/bundle/resources"
 	"github.com/databricks/cli/bundle/run"
 	"github.com/databricks/cli/libs/cmdio"
 )
 
-// promptRunArgument prompts the user to select a resource to run.
 // Copied from cmd/bundle/run.go
+// promptRunArgument prompts the user to select a resource to run.
 func promptRunArgument(ctx context.Context, b *bundle.Bundle) (string, error) {
 	// Compute map of "Human readable name of resource" -> "resource key".
 	inv := make(map[string]string)
@@ -21,25 +22,46 @@ func promptRunArgument(ctx context.Context, b *bundle.Bundle) (string, error) {
 		inv[title] = k
 	}
 
-	key, err := cmdio.Select(ctx, inv, "Resource to run")
+	key, err := cmdio.Select(ctx, inv, "Pipeline to run")
 	if err != nil {
 		return "", err
 	}
 
 	return key, nil
 }
 
-// resolveRunArgument resolves the resource key to run.
-// It returns the remaining arguments to pass to the runner, if applicable.
+// autoSelectSinglePipeline checks if there's exactly one pipeline resource in the bundle and returns its key.
+// Returns empty string if there's not exactly one pipeline.
+func autoSelectSinglePipeline(b *bundle.Bundle) string {
+	completions := resources.Completions(b, run.IsRunnable)
+	if len(completions) == 1 {
+		for key, ref := range completions {
+			if _, ok := ref.Resource.(*configresources.Pipeline); ok {
+				return key
+			}
+		}
+	}
+	return ""
+}
+
 // Copied from cmd/bundle/run.go
+// resolveRunArgument resolves the resource key to run
+// Returns the remaining arguments to pass to the runner, if applicable.
+// When no arguments are specified, auto-selects a pipeline if there's exactly one,
+// otherwise prompts the user to select a pipeline.
 func resolveRunArgument(ctx context.Context, b *bundle.Bundle, args []string) (string, []string, error) {
-	// If no arguments are specified, prompt the user to select something to run.
-	if len(args) == 0 && cmdio.IsPromptSupported(ctx) {
-		key, err := promptRunArgument(ctx, b)
-		if err != nil {
-			return "", nil, err
+	if len(args) == 0 {
+		if key := autoSelectSinglePipeline(b); key != "" {
+			return key, args, nil
+		}
+
+		if cmdio.IsPromptSupported(ctx) {
+			key, err := promptRunArgument(ctx, b)
+			if err != nil {
+				return "", nil, err
+			}
+			return key, args, nil
 		}
-		return key, args, nil
 	}
 
 	if len(args) < 1 {
@@ -49,8 +71,8 @@ func resolveRunArgument(ctx context.Context, b *bundle.Bundle, args []string) (s
 	return args[0], args[1:], nil
 }
 
-// keyToRunner converts a resource key to a runner.
 // Copied from cmd/bundle/run.go
+// keyToRunner converts a resource key to a runner.
 func keyToRunner(b *bundle.Bundle, arg string) (run.Runner, error) {
 	// Locate the resource to run.
 	ref, err := resources.Lookup(b, arg, run.IsRunnable)
