Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .nextchanges/bundles/apps-user-api-scopes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Do not send an app's `user_api_scopes` in update requests unless the bundle declares or removes them, so scopes added outside the bundle are not cleared. ([#7193](https://github.com/databricks/cli/pull/7193))
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Resources: 0 created, 1 changed, 0 deleted, 0 unchanged
"description": "MY_APP_DESCRIPTION_2",
"name": "[UNIQUE_NAME]"
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
"update_mask": "description,budget_policy_id,usage_policy_id,resources,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}

Expand Down Expand Up @@ -124,7 +124,7 @@ Resources: 0 created, 1 changed, 0 deleted, 0 unchanged
"description": "MY_APP_DESCRIPTION_3",
"name": "[UNIQUE_NAME]"
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
"update_mask": "description,budget_policy_id,usage_policy_id,resources,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Exit code: 1
"description": "MY_APP_DESCRIPTION",
"name": "myappname"
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
"update_mask": "description,budget_policy_id,usage_policy_id,resources,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ Resources: 0 created, 1 changed, 0 deleted, 0 unchanged
"description": "MY_APP_DESCRIPTION",
"name": "test-app-source-code-path-update"
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
"update_mask": "description,budget_policy_id,usage_policy_id,resources,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"description": "MY_APP_DESCRIPTION",
"name": "myappname"
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_size,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
"update_mask": "description,budget_policy_id,usage_policy_id,resources,compute_size,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}
{
Expand All @@ -31,6 +31,6 @@
"description": "MY_APP_DESCRIPTION_2",
"name": "myappname"
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
"update_mask": "description,budget_policy_id,usage_policy_id,resources,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
print("Hello world!")
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
bundle:
name: test-bundle

resources:
apps:
mykey:
name: myappname
description: my_app_description
source_code_path: ./app
user_api_scopes: [sql, files.files]
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"method": "POST",
"path": "/api/2.0/apps/myappname/update",
"body": {
"app": {
"description": "MY_APP_DESCRIPTION",
"name": "myappname",
"user_api_scopes": [
"sql",
"files.files"
]
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"method": "POST",
"path": "/api/2.0/apps/myappname/update",
"body": {
"app": {
"description": "MY_APP_DESCRIPTION",
"name": "myappname",
"user_api_scopes": [
"sql",
"iam.access-control:read"
]
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Cloud = false
EnvMatrix.DMS = ["", "true"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@

>>> [CLI] bundle deploy
Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
Created apps.mykey
Files: 2 uploaded, 0 deleted
Resources: 1 created, 0 changed, 0 deleted, 0 unchanged

=== Out-of-band: add a scope the bundle cannot declare (e.g. via account-level update)

>>> MSYS_NO_PATHCONV=1 [CLI] api post /api/2.0/apps/myappname/update --json {"app": {"name": "myappname", "user_api_scopes": ["sql", "files.files", "jobs"]}, "update_mask": "user_api_scopes"}

>>> [CLI] apps get myappname
[
"sql",
"files.files",
"jobs"
]

=== Plan after out-of-band change

>>> [CLI] bundle plan
Plan: 0 to add, 0 to change, 0 to delete, 1 unchanged

=== Change description and re-deploy; declared scopes are in the mask, so the remote value is replaced

>>> update_file.py databricks.yml my_app_description MY_APP_DESCRIPTION

>>> [CLI] bundle deploy
Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
Updated apps.mykey
Files: 1 uploaded, 0 deleted
Resources: 0 created, 1 changed, 0 deleted, 0 unchanged

>>> print_requests

>>> [CLI] apps get myappname
{
"description": "MY_APP_DESCRIPTION",
"user_api_scopes": [
"sql",
"files.files"
]
}

=== Change the declared scopes

>>> update_file.py databricks.yml [sql, files.files] [sql, iam.access-control:read]

>>> [CLI] bundle deploy
Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
Updated apps.mykey
Files: 2 uploaded, 0 deleted
Resources: 0 created, 1 changed, 0 deleted, 0 unchanged

>>> print_requests

>>> [CLI] apps get myappname
[
"sql",
"iam.access-control:read"
]

>>> [CLI] bundle destroy --auto-approve
The following resources will be deleted:
delete resources.apps.mykey

All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/test-bundle/default

Destroy: 1 deleted
28 changes: 28 additions & 0 deletions acceptance/bundle/resources/apps/update-declared-scopes/script
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
print_requests() {
print_requests.py //apps '^//api/2.0/bundle' --del-body url
}

trace $CLI bundle deploy
rm "$OUT_REQUESTS"

title "Out-of-band: add a scope the bundle cannot declare (e.g. via account-level update)"
trace MSYS_NO_PATHCONV=1 $CLI api post /api/2.0/apps/myappname/update --json '{"app": {"name": "myappname", "user_api_scopes": ["sql", "files.files", "jobs"]}, "update_mask": "user_api_scopes"}' > /dev/null
trace $CLI apps get myappname | jq .user_api_scopes
rm "$OUT_REQUESTS"

title "Plan after out-of-band change"
trace $CLI bundle plan

title "Change description and re-deploy; declared scopes are in the mask, so the remote value is replaced"
trace update_file.py databricks.yml my_app_description MY_APP_DESCRIPTION
trace $CLI bundle deploy
trace print_requests > out.description.requests.json
trace $CLI apps get myappname | jq '{description, user_api_scopes}'

title "Change the declared scopes"
trace update_file.py databricks.yml "[sql, files.files]" "[sql, iam.access-control:read]"
trace $CLI bundle deploy
trace print_requests > out.scopes.requests.json
trace $CLI apps get myappname | jq .user_api_scopes

trace $CLI bundle destroy --auto-approve
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Cloud = false # jobs scope can only be added with account-admin privileges
Ignore = [".databricks", "databricks.yml"]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
print("Hello world!")
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
bundle:
name: test-bundle

resources:
apps:
mykey:
name: myappname
description: my_app_description
source_code_path: ./app
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"method": "POST",
"path": "/api/2.0/apps/myappname/update",
"body": {
"app": {
"description": "MY_APP_DESCRIPTION",
"name": "myappname"
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Cloud = false
EnvMatrix.DMS = ["", "true"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

>>> [CLI] bundle deploy
Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
Created apps.mykey
Files: 2 uploaded, 0 deleted
Resources: 1 created, 0 changed, 0 deleted, 0 unchanged

=== Out-of-band: set scopes on an app whose bundle does not declare any

>>> MSYS_NO_PATHCONV=1 [CLI] api post /api/2.0/apps/myappname/update --json {"app": {"name": "myappname", "user_api_scopes": ["sql", "jobs"]}, "update_mask": "user_api_scopes"}

=== Change description and re-deploy; user_api_scopes must not be in the update mask

>>> update_file.py databricks.yml my_app_description MY_APP_DESCRIPTION

>>> [CLI] bundle deploy
Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
Updated apps.mykey
Files: 1 uploaded, 0 deleted
Resources: 0 created, 1 changed, 0 deleted, 0 unchanged

>>> print_requests

>>> [CLI] apps get myappname
{
"description": "MY_APP_DESCRIPTION",
"user_api_scopes": [
"sql",
"jobs"
]
}

>>> [CLI] bundle destroy --auto-approve
The following resources will be deleted:
delete resources.apps.mykey

All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/test-bundle/default

Destroy: 1 deleted
18 changes: 18 additions & 0 deletions acceptance/bundle/resources/apps/update-omitted-scopes/script
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
print_requests() {
print_requests.py //apps '^//api/2.0/bundle' --del-body url
}

trace $CLI bundle deploy
rm "$OUT_REQUESTS"

title "Out-of-band: set scopes on an app whose bundle does not declare any"
trace MSYS_NO_PATHCONV=1 $CLI api post /api/2.0/apps/myappname/update --json '{"app": {"name": "myappname", "user_api_scopes": ["sql", "jobs"]}, "update_mask": "user_api_scopes"}' > /dev/null
rm "$OUT_REQUESTS"

title "Change description and re-deploy; user_api_scopes must not be in the update mask"
trace update_file.py databricks.yml my_app_description MY_APP_DESCRIPTION
trace $CLI bundle deploy
trace print_requests > out.deploy.requests.json
trace $CLI apps get myappname | jq '{description, user_api_scopes}'

trace $CLI bundle destroy --auto-approve
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Cloud = false # jobs scope can only be added with account-admin privileges
Ignore = [".databricks", "databricks.yml"]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
print("Hello world!")
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
bundle:
name: test-bundle

resources:
apps:
mykey:
name: myappname
description: my_app_description
source_code_path: ./app
user_api_scopes: [sql, files.files]
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"method": "POST",
"path": "/api/2.0/apps/myappname/update",
"body": {
"app": {
"description": "my_app_description",
"name": "myappname"
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Cloud = false
EnvMatrix.DMS = ["", "true"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

>>> [CLI] bundle deploy
Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
Created apps.mykey
Files: 2 uploaded, 0 deleted
Resources: 1 created, 0 changed, 0 deleted, 0 unchanged

=== Remove user_api_scopes from the config; the mask must include it with no value in the body

>>> update_file.py databricks.yml user_api_scopes: [sql, files.files]

>>> [CLI] bundle plan
update apps.mykey

Plan: 0 to add, 1 to change, 0 to delete, 0 unchanged

>>> [CLI] bundle deploy
Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
Updated apps.mykey
Files: 1 uploaded, 0 deleted
Resources: 0 created, 1 changed, 0 deleted, 0 unchanged

>>> print_requests

>>> [CLI] apps get myappname
null

>>> [CLI] bundle destroy --auto-approve
The following resources will be deleted:
delete resources.apps.mykey

All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/test-bundle/default

Destroy: 1 deleted
15 changes: 15 additions & 0 deletions acceptance/bundle/resources/apps/update-removed-scopes/script
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
print_requests() {
print_requests.py //apps '^//api/2.0/bundle' --del-body url
}

trace $CLI bundle deploy
rm "$OUT_REQUESTS"

title "Remove user_api_scopes from the config; the mask must include it with no value in the body"
trace update_file.py databricks.yml "user_api_scopes: [sql, files.files]" ""
trace $CLI bundle plan
trace $CLI bundle deploy
trace print_requests > out.deploy.requests.json
trace $CLI apps get myappname | jq .user_api_scopes

trace $CLI bundle destroy --auto-approve
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Cloud = false
Ignore = [".databricks", "databricks.yml"]
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"description": "MY_APP_DESCRIPTION",
"name": "myappname"
},
"update_mask": "description,budget_policy_id,usage_policy_id,resources,user_api_scopes,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
"update_mask": "description,budget_policy_id,usage_policy_id,resources,compute_min_instances,compute_max_instances,git_repository,git_source,telemetry_export_destinations"
}
}
{
Expand Down
Loading
Loading