pipelines: update deploy.go and add fail-on-active-runs flag (#3235)

## Changes
Synchronize deploy.go to cmd/bundle/deploy.go and add new
`fail-on-active-runs` flag
 
## Why
New flag is for controlling that pipelines deploy fails when the
pipeline is currently running

## Tests
Added pipeline specific test that causes deploy to fail when pipeline is
running and `fail-on-active-runs` is set

Author: alyssa-db

acceptance/pipelines/deploy/fail-on-active-runs/databricks.yml

@@ -0,0 +1,6 @@
+bundle:
+  name: pipeline-fail-on-active-runs
+resources:
+  pipelines:
+    my_pipeline:
+      name: pipeline-fail-on-active-runs

acceptance/pipelines/deploy/fail-on-active-runs/out.test.toml

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

acceptance/pipelines/deploy/fail-on-active-runs/output.txt

@@ -0,0 +1,12 @@
+
+>>> [PIPELINES] deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/pipeline-fail-on-active-runs/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> errcode [PIPELINES] deploy --fail-on-active-runs
+Error: pipeline [UUID] is running
+
+
+Exit code: 1

acceptance/pipelines/deploy/fail-on-active-runs/script

@@ -0,0 +1,4 @@
+trace $PIPELINES deploy
+
+# We deploy the bundle again to check that the deploy is failing if the job is running
+trace errcode $PIPELINES deploy --fail-on-active-runs

acceptance/pipelines/deploy/fail-on-active-runs/test.toml

@@ -0,0 +1,14 @@
+# Deploy relies on terraform.CheckRunningResource()
+EnvMatrix.DATABRICKS_CLI_DEPLOYMENT = ["terraform"]
+
+# Cycling between states not implemented yet
+# spec to avoid "pipeline spec is nil" error
+
+[[Server]]
+Pattern = "GET /api/2.0/pipelines/{pipeline_id}"
+Response.Body = '''
+{
+  "state": "RUNNING",
+  "spec": {}
+}
+'''

cmd/bundle/deploy.go

@@ -1,3 +1,5 @@
+// Copied to cmd/pipelines/deploy.go and adapted for pipelines use.
+// Consider if changes made here should be made to the pipelines counterpart as well.
 package bundle
 
 import (

cmd/pipelines/deploy.go

@@ -1,4 +1,5 @@
 // Copied from cmd/bundle/deploy.go and adapted for pipelines use.
+// Consider if changes made here should be made to the bundle counterpart as well.
 package pipelines
 
 import (
@@ -22,9 +23,11 @@ func deployCommand() *cobra.Command {
 	}
 
 	var forceLock bool
+	var failOnActiveRuns bool
 	var autoApprove bool
 	var verbose bool
 	cmd.Flags().BoolVar(&forceLock, "force-lock", false, "Force acquisition of deployment lock.")
+	cmd.Flags().BoolVar(&failOnActiveRuns, "fail-on-active-runs", false, "Fail if there are running pipelines in the deployment.")
 	cmd.Flags().BoolVar(&autoApprove, "auto-approve", false, "Skip interactive approvals that might be required for deployment.")
 	cmd.Flags().BoolVar(&verbose, "verbose", false, "Enable verbose output.")
 	// Verbose flag currently only affects file sync output, it's used by the vscode extension
@@ -33,15 +36,19 @@ func deployCommand() *cobra.Command {
 	cmd.RunE = func(cmd *cobra.Command, args []string) error {
 		ctx := logdiag.InitContext(cmd.Context())
 		cmd.SetContext(ctx)
-		b := utils.ConfigureBundleWithVariables(cmd)
 
-		if logdiag.HasError(ctx) {
+		b := utils.ConfigureBundleWithVariables(cmd)
+		if b == nil || logdiag.HasError(ctx) {
 			return root.ErrAlreadyPrinted
 		}
 
 		bundle.ApplyFuncContext(ctx, b, func(context.Context, *bundle.Bundle) {
 			b.Config.Bundle.Deployment.Lock.Force = forceLock
 			b.AutoApprove = autoApprove
+
+			if cmd.Flag("fail-on-active-runs").Changed {
+				b.Config.Bundle.Deployment.FailOnActiveRuns = failOnActiveRuns
+			}
 		})
 
 		var outputHandler sync.OutputHandler