Added warning when trying to deploy bundle with `--fail-if-running` and running resources by andrewnester · Pull Request #1163 · databricks/cli

andrewnester · 2024-01-29T16:18:26Z

Changes

Deploying bundle when there are bundle resources running at the same time can be disruptive for jobs and pipelines in progress.

With this change during deployment phase (before uploading any resources) if there is --fail-if-running specified DABs will check if there are any resources running and if so, will fail the deployment

Tests

Manual + add tests

codecov-commenter · 2024-01-29T16:20:10Z

Codecov Report

Attention: 47 lines in your changes are missing coverage. Please review.

Comparison is base (2f1b81c) 51.51% compared to head (30c3176) 51.42%.
Report is 6 commits behind head on main.

Files	Patch %	Lines
bundle/deploy/check_running_resources.go	54.02%	34 Missing and 6 partials ⚠️
cmd/bundle/deploy.go	0.00%	6 Missing ⚠️
cmd/bundle/destroy.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #1163 +/- ##
==========================================
- Coverage 51.51% 51.42% -0.09% 
==========================================
Files 292 293 +1 Lines 16322 16455 +133 ==========================================
+ Hits 8408 8462 +54 - Misses 7308 7377 +69 - Partials 606 616 +10

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pietern

What should we do for continuous jobs/pipelines?

pietern

If a job/pipeline is deleted from the bundle before a deploy I suspect we'll error out because we cannot pull the state for the job/pipeline. If we get a not found error on these API calls we should return that they're not running.

pietern · 2024-02-01T12:52:36Z

+
+	// FailIfRunning specifies whether to fail the deployment if there are
+	// running jobs or pipelines in the workspace. Defaults to false.
+	FailIfRunning bool `json:"fail_if_running,omitempty"`


The place of this field in the overall config seems odd:
bundle: fail_if_running: true
It's not clear what this pertains to. What would be a location to make its use more clear?

@pietern we can have a Deployment similar to Lock one we have and put it under there?

Sounds good -- we can consider moving the lock related fields there as well.
W.r.t. the name itself, it is ambiguous what is running: jobs or the deployment itself.
Alternative: fail_on_active_runs or fail_if_runs_active or something.

andrewnester · 2024-02-01T14:03:50Z

If a job/pipeline is deleted from the bundle before a deploy I suspect we'll error out because we cannot pull the state for the job/pipeline. If we get a not found error on these API calls we should return that they're not running.

This is already handled when we call isJobRunning and isPipelineRunning, if they are returning an error we skip it and assume job/pipeline are not running

Bundles: * Allow specifying executable in artifact section and skip bash from WSL ([#1169](#1169)). * Added warning when trying to deploy bundle with `--fail-if-running` and running resources ([#1163](#1163)). * Group bundle run flags by job and pipeline types ([#1174](#1174)). * Make sure grouped flags are added to the command flag set ([#1180](#1180)). * Add short_name helper function to bundle init templates ([#1167](#1167)). Internal: * Fix dynamic representation of zero values in maps and slices ([#1154](#1154)). * Refactor library to artifact matching to not use pointers ([#1172](#1172)). * Harden `dyn.Value` equality check ([#1173](#1173)). * Ensure every variable reference is passed to lookup function ([#1176](#1176)). * Empty struct should yield empty map in `convert.FromTyped` ([#1177](#1177)). * Zero destination struct in `convert.ToTyped` ([#1178](#1178)). * Fix integration test with invalid configuration ([#1182](#1182)). * Use `acc.WorkspaceTest` helper from bundle integration tests ([#1181](#1181)).

…atabricks#5044) Since databricks#1163, the pipeline branch of `checkAnyResourceRunning` has swallowed errors while the jobs branch propagated them — an asymmetry with no apparent reasoning for it. databricks#4997 flagged this with `nilerr` and annotated it as intentional, but it reads as a latent bug. This PR replaces the `//nolint` with what the original comments probably meant: `apierr.IsMissing` maps 404s to "not running" in both `IsJobRunning` and `IsPipelineRunning`, and genuine errors propagate on both branches. This pull request and its description were written by Isaac.

…nd running resources (#1163) ## Changes Deploying bundle when there are bundle resources running at the same time can be disruptive for jobs and pipelines in progress. With this change during deployment phase (before uploading any resources) if there is `--fail-if-running` specified DABs will check if there are any resources running and if so, will fail the deployment ## Tests Manual + add tests

Bundles: * Allow specifying executable in artifact section and skip bash from WSL ([#1169](#1169)). * Added warning when trying to deploy bundle with `--fail-if-running` and running resources ([#1163](#1163)). * Group bundle run flags by job and pipeline types ([#1174](#1174)). * Make sure grouped flags are added to the command flag set ([#1180](#1180)). * Add short_name helper function to bundle init templates ([#1167](#1167)). Internal: * Fix dynamic representation of zero values in maps and slices ([#1154](#1154)). * Refactor library to artifact matching to not use pointers ([#1172](#1172)). * Harden `dyn.Value` equality check ([#1173](#1173)). * Ensure every variable reference is passed to lookup function ([#1176](#1176)). * Empty struct should yield empty map in `convert.FromTyped` ([#1177](#1177)). * Zero destination struct in `convert.ToTyped` ([#1178](#1178)). * Fix integration test with invalid configuration ([#1182](#1182)). * Use `acc.WorkspaceTest` helper from bundle integration tests ([#1181](#1181)).

…5044) Since #1163, the pipeline branch of `checkAnyResourceRunning` has swallowed errors while the jobs branch propagated them — an asymmetry with no apparent reasoning for it. #4997 flagged this with `nilerr` and annotated it as intentional, but it reads as a latent bug. This PR replaces the `//nolint` with what the original comments probably meant: `apierr.IsMissing` maps 404s to "not running" in both `IsJobRunning` and `IsPipelineRunning`, and genuine errors propagate on both branches. This pull request and its description were written by Isaac.

Added warning when trying to deploy bundle with running resources
9c63a97

andrewnester requested review from pietern and shreyas-goenka January 29, 2024 16:18

pietern reviewed Jan 29, 2024
View reviewed changes

andrewnester added 2 commits January 31, 2024 10:17

add --fail-if-running flag
d9a289b

do not ask for input
2f1f6bf

andrewnester changed the title ~~Added warning when trying to deploy bundle with running resources~~Added warning when trying to deploy bundle with --fail-if-running and running resourcesJan 31, 2024

andrewnester requested a review from pietern January 31, 2024 10:21

pietern reviewed Jan 31, 2024
View reviewed changes

Comment threadbundle/phases/deploy.go

move state pull earlier in chain
c72662f

andrewnester requested a review from pietern January 31, 2024 12:23

shreyas-goenka reviewed Jan 31, 2024
View reviewed changes

Comment threadbundle/deploy/check_running_resources.go Outdated

return error
fdcf66d

andrewnester requested a review from shreyas-goenka February 1, 2024 10:48

pietern reviewed Feb 1, 2024
View reviewed changes

fixes
30c3176

andrewnester requested a review from pietern February 1, 2024 14:19

andrewnester enabled auto-merge February 1, 2024 19:20

pietern approved these changes Feb 7, 2024
View reviewed changes

andrewnester added this pull request to the merge queue Feb 7, 2024

Merged via the queue into main with commit 6edab93Feb 7, 2024

andrewnester deleted the warning-on-deploy-running-resources branch February 7, 2024 11:27

andrewnester mentioned this pull request Feb 7, 2024
Release v0.212.4 #1183
Merged

denik mentioned this pull request Jul 11, 2025
pipelines: update deploy.go and add fail-on-active-runs flag #3235
Merged

pietern mentioned this pull request Apr 21, 2026
Treat deleted resources as not running in fail-on-active-runs check #5044
Merged

Navigation Menu

Uh oh!

Added warning when trying to deploy bundle with `--fail-if-running` and running resources - #1163

Added warning when trying to deploy bundle with `--fail-if-running` and running resources#1163
andrewnester merged 6 commits into
mainfrom
warning-on-deploy-running-resources

andrewnester commented Jan 29, 2024•
edited
Loading

Uh oh!

codecov-commenter commented Jan 29, 2024•
edited
Loading

Uh oh!

pietern left a comment

Uh oh!

Uh oh!

Uh oh!

pietern left a comment

Uh oh!

pieternFeb 1, 2024

Uh oh!

andrewnesterFeb 1, 2024

Uh oh!

pieternFeb 1, 2024

Uh oh!

Uh oh!

Uh oh!

andrewnester commented Feb 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

andrewnester commented Jan 29, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Uh oh!

codecov-commenter commented Jan 29, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pietern left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pietern left a comment

Choose a reason for hiding this comment

Uh oh!

pieternFeb 1, 2024

Choose a reason for hiding this comment

Uh oh!

andrewnesterFeb 1, 2024

Choose a reason for hiding this comment

Uh oh!

pieternFeb 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

andrewnester commented Feb 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

andrewnester commented Jan 29, 2024•
edited
Loading

codecov-commenter commented Jan 29, 2024•
edited
Loading