Add app_spaces as a DABs resource type (direct mode only)

NEXT_CHANGELOG.md

@@ -5,5 +5,6 @@
 ### CLI
 
 ### Bundles
+* engine/direct: Added support for Databricks App Spaces (`app_spaces` resource type) ([#4982](https://github.com/databricks/cli/pull/4982))
 
 ### Dependency updates

acceptance/bundle/deployment/bind/app_space/databricks.yml.tmpl

@@ -0,0 +1,8 @@
+bundle:
+  name: test-bundle-$UNIQUE_NAME
+
+resources:
+  app_spaces:
+    foo:
+      name: test-space-$UNIQUE_NAME
+      description: This is a test app space

acceptance/bundle/deployment/bind/app_space/output.txt

@@ -0,0 +1,46 @@
+
+>>> [CLI] apps create-space test-space-[UNIQUE_NAME] --description Pre-existing space
+{
+  "name": "test-space-[UNIQUE_NAME]",
+  "description": "Pre-existing space"
+}
+
+>>> [CLI] bundle deployment bind foo test-space-[UNIQUE_NAME] --auto-approve
+Updating deployment state...
+Successfully bound app_space with an id 'test-space-[UNIQUE_NAME]'
+Run 'bundle deploy' to deploy changes to your workspace
+
+=== Deploy bundle
+>>> [CLI] bundle deploy --force-lock --auto-approve
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] apps get-space test-space-[UNIQUE_NAME]
+{
+  "name": "test-space-[UNIQUE_NAME]",
+  "description": "This is a test app space"
+}
+
+=== Unbind app space
+>>> [CLI] bundle deployment unbind foo
+Updating deployment state...
+
+=== Destroy bundle
+>>> [CLI] bundle destroy --auto-approve
+All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/default
+
+Deleting files...
+Destroy complete!
+
+=== Read the pre-defined app space again (expecting it still exists): 
+>>> [CLI] apps get-space test-space-[UNIQUE_NAME]
+{
+  "name": "test-space-[UNIQUE_NAME]",
+  "description": "This is a test app space"
+}
+
+=== Test cleanup
+>>> [CLI] apps delete-space test-space-[UNIQUE_NAME]
+0

acceptance/bundle/deployment/bind/app_space/script

@@ -0,0 +1,26 @@
+cleanup() {
+    title "Test cleanup"
+    trace $CLI apps delete-space "test-space-$UNIQUE_NAME"
+    echo $?
+}
+trap cleanup EXIT
+
+envsubst < databricks.yml.tmpl > databricks.yml
+
+trace $CLI apps create-space "test-space-$UNIQUE_NAME" --description "Pre-existing space" | jq '{name, description}'
+
+trace $CLI bundle deployment bind foo "test-space-$UNIQUE_NAME" --auto-approve
+
+title "Deploy bundle"
+trace $CLI bundle deploy --force-lock --auto-approve
+
+trace $CLI apps get-space "test-space-$UNIQUE_NAME" | jq '{name, description}'
+
+title "Unbind app space"
+trace $CLI bundle deployment unbind foo
+
+title "Destroy bundle"
+trace $CLI bundle destroy --auto-approve
+
+title "Read the pre-defined app space again (expecting it still exists): "
+trace $CLI apps get-space "test-space-$UNIQUE_NAME" | jq '{name, description}'

acceptance/bundle/deployment/bind/app_space/test.toml

@@ -0,0 +1,10 @@
+Local = true
+Cloud = true
+
+Ignore = [
+    ".databricks",
+    "databricks.yml",
+]
+
+[EnvMatrix]
+  DATABRICKS_BUNDLE_ENGINE = ["direct"]

acceptance/bundle/invariant/configs/app_space.yml.tmpl

@@ -0,0 +1,7 @@
+bundle:
+  name: test-bundle-$UNIQUE_NAME
+
+resources:
+  app_spaces:
+    foo:
+      name: app-space-$UNIQUE_NAME

acceptance/bundle/invariant/migrate/test.toml

@@ -4,6 +4,7 @@ EnvMatrixExclude.no_vector_search_endpoint = ["INPUT_CONFIG=vector_search_endpoi
 # Error: Catalog resources are only supported with direct deployment mode
 EnvMatrixExclude.no_catalog = ["INPUT_CONFIG=catalog.yml.tmpl"]
 EnvMatrixExclude.no_external_location = ["INPUT_CONFIG=external_location.yml.tmpl"]
+EnvMatrixExclude.no_app_space = ["INPUT_CONFIG=app_space.yml.tmpl"]
 
 # Cross-resource permission references (e.g. ${resources.jobs.job_b.permissions[0].level})
 # don't work in terraform mode: the terraform interpolator converts the path to

acceptance/bundle/invariant/test.toml

@@ -23,6 +23,7 @@ EnvMatrix.DATABRICKS_BUNDLE_ENGINE = [
 EnvMatrix.INPUT_CONFIG = [
     "alert.yml.tmpl",
     "app.yml.tmpl",
+    "app_space.yml.tmpl",
     "catalog.yml.tmpl",
     "cluster.yml.tmpl",
     "dashboard.yml.tmpl",

acceptance/bundle/refschema/out.fields.txt

@@ -56,6 +56,75 @@ resources.alerts.*.permissions[*].group_name	string	ALL
 resources.alerts.*.permissions[*].level	iam.PermissionLevel	ALL
 resources.alerts.*.permissions[*].service_principal_name	string	ALL
 resources.alerts.*.permissions[*].user_name	string	ALL
+resources.app_spaces.*.create_time	*time.Time	ALL
+resources.app_spaces.*.creator	string	ALL
+resources.app_spaces.*.description	string	ALL
+resources.app_spaces.*.effective_usage_policy_id	string	ALL
+resources.app_spaces.*.effective_user_api_scopes	[]string	ALL
+resources.app_spaces.*.effective_user_api_scopes[*]	string	ALL
+resources.app_spaces.*.id	string	ALL
+resources.app_spaces.*.lifecycle	resources.Lifecycle	INPUT
+resources.app_spaces.*.lifecycle.prevent_destroy	bool	INPUT
+resources.app_spaces.*.modified_status	string	INPUT
+resources.app_spaces.*.name	string	ALL
+resources.app_spaces.*.resources	[]apps.AppResource	ALL
+resources.app_spaces.*.resources[*]	apps.AppResource	ALL
+resources.app_spaces.*.resources[*].app	*apps.AppResourceApp	ALL
+resources.app_spaces.*.resources[*].app.name	string	ALL
+resources.app_spaces.*.resources[*].app.permission	apps.AppResourceAppAppPermission	ALL
+resources.app_spaces.*.resources[*].database	*apps.AppResourceDatabase	ALL
+resources.app_spaces.*.resources[*].database.database_name	string	ALL
+resources.app_spaces.*.resources[*].database.instance_name	string	ALL
+resources.app_spaces.*.resources[*].database.permission	apps.AppResourceDatabaseDatabasePermission	ALL
+resources.app_spaces.*.resources[*].description	string	ALL
+resources.app_spaces.*.resources[*].experiment	*apps.AppResourceExperiment	ALL
+resources.app_spaces.*.resources[*].experiment.experiment_id	string	ALL
+resources.app_spaces.*.resources[*].experiment.permission	apps.AppResourceExperimentExperimentPermission	ALL
+resources.app_spaces.*.resources[*].genie_space	*apps.AppResourceGenieSpace	ALL
+resources.app_spaces.*.resources[*].genie_space.name	string	ALL
+resources.app_spaces.*.resources[*].genie_space.permission	apps.AppResourceGenieSpaceGenieSpacePermission	ALL
+resources.app_spaces.*.resources[*].genie_space.space_id	string	ALL
+resources.app_spaces.*.resources[*].job	*apps.AppResourceJob	ALL
+resources.app_spaces.*.resources[*].job.id	string	ALL
+resources.app_spaces.*.resources[*].job.permission	apps.AppResourceJobJobPermission	ALL
+resources.app_spaces.*.resources[*].name	string	ALL
+resources.app_spaces.*.resources[*].postgres	*apps.AppResourcePostgres	ALL
+resources.app_spaces.*.resources[*].postgres.branch	string	ALL
+resources.app_spaces.*.resources[*].postgres.database	string	ALL
+resources.app_spaces.*.resources[*].postgres.permission	apps.AppResourcePostgresPostgresPermission	ALL
+resources.app_spaces.*.resources[*].secret	*apps.AppResourceSecret	ALL
+resources.app_spaces.*.resources[*].secret.key	string	ALL
+resources.app_spaces.*.resources[*].secret.permission	apps.AppResourceSecretSecretPermission	ALL
+resources.app_spaces.*.resources[*].secret.scope	string	ALL
+resources.app_spaces.*.resources[*].serving_endpoint	*apps.AppResourceServingEndpoint	ALL
+resources.app_spaces.*.resources[*].serving_endpoint.name	string	ALL
+resources.app_spaces.*.resources[*].serving_endpoint.permission	apps.AppResourceServingEndpointServingEndpointPermission	ALL
+resources.app_spaces.*.resources[*].sql_warehouse	*apps.AppResourceSqlWarehouse	ALL
+resources.app_spaces.*.resources[*].sql_warehouse.id	string	ALL
+resources.app_spaces.*.resources[*].sql_warehouse.permission	apps.AppResourceSqlWarehouseSqlWarehousePermission	ALL
+resources.app_spaces.*.resources[*].uc_securable	*apps.AppResourceUcSecurable	ALL
+resources.app_spaces.*.resources[*].uc_securable.permission	apps.AppResourceUcSecurableUcSecurablePermission	ALL
+resources.app_spaces.*.resources[*].uc_securable.securable_full_name	string	ALL
+resources.app_spaces.*.resources[*].uc_securable.securable_kind	string	ALL
+resources.app_spaces.*.resources[*].uc_securable.securable_type	apps.AppResourceUcSecurableUcSecurableType	ALL
+resources.app_spaces.*.service_principal_client_id	string	ALL
+resources.app_spaces.*.service_principal_id	int64	ALL
+resources.app_spaces.*.service_principal_name	string	ALL
+resources.app_spaces.*.status	*apps.SpaceStatus	ALL
+resources.app_spaces.*.status.message	string	ALL
+resources.app_spaces.*.status.state	apps.SpaceStatusSpaceState	ALL
+resources.app_spaces.*.update_time	*time.Time	ALL
+resources.app_spaces.*.updater	string	ALL
+resources.app_spaces.*.url	string	INPUT
+resources.app_spaces.*.usage_policy_id	string	ALL
+resources.app_spaces.*.user_api_scopes	[]string	ALL
+resources.app_spaces.*.user_api_scopes[*]	string	ALL
+resources.app_spaces.*.permissions.object_id	string	ALL
+resources.app_spaces.*.permissions[*]	dresources.StatePermission	ALL
+resources.app_spaces.*.permissions[*].group_name	string	ALL
+resources.app_spaces.*.permissions[*].level	iam.PermissionLevel	ALL
+resources.app_spaces.*.permissions[*].service_principal_name	string	ALL
+resources.app_spaces.*.permissions[*].user_name	string	ALL
 resources.apps.*.active_deployment	*apps.AppDeployment	ALL
 resources.apps.*.active_deployment.command	[]string	ALL
 resources.apps.*.active_deployment.command[*]	string	ALL

acceptance/bundle/resources/app_spaces/basic/databricks.yml

@@ -0,0 +1,17 @@
+bundle:
+  name: test-bundle
+
+resources:
+  app_spaces:
+    mykey:
+      name: myspacename
+      description: my_space_description
+      resources:
+        - name: my-serving-endpoint
+          serving_endpoint:
+            name: my-endpoint
+            permission: CAN_QUERY
+        - name: my-warehouse
+          sql_warehouse:
+            id: warehouse-id-1
+            permission: CAN_USE

acceptance/bundle/resources/app_spaces/basic/out.requests.direct.json

@@ -0,0 +1,28 @@
+{
+  "method": "POST",
+  "path": "/api/2.0/app-spaces",
+  "body": {
+    "description": "my_space_description",
+    "name": "myspacename",
+    "resources": [
+      {
+        "name": "my-serving-endpoint",
+        "serving_endpoint": {
+          "name": "my-endpoint",
+          "permission": "CAN_QUERY"
+        }
+      },
+      {
+        "name": "my-warehouse",
+        "sql_warehouse": {
+          "id": "warehouse-id-1",
+          "permission": "CAN_USE"
+        }
+      }
+    ]
+  }
+}
+{
+  "method": "DELETE",
+  "path": "/api/2.0/app-spaces/myspacename"
+}

acceptance/bundle/resources/app_spaces/basic/output.txt

@@ -0,0 +1,45 @@
+
+>>> [CLI] bundle validate
+Name: test-bundle
+Target: default
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/test-bundle/default
+
+Validation OK!
+
+>>> [CLI] bundle plan
+create app_spaces.mykey
+
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> print_requests.py //app-spaces
+
+>>> [CLI] bundle summary
+Name: test-bundle
+Target: default
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/test-bundle/default
+Resources:
+  App Spaces:
+    mykey:
+      Name: myspacename
+      URL:  (not deployed)
+
+>>> [CLI] bundle destroy --auto-approve
+The following resources will be deleted:
+  delete resources.app_spaces.mykey
+
+All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/test-bundle/default
+
+Deleting files...
+Destroy complete!
+
+>>> print_requests.py //app-spaces

acceptance/bundle/resources/app_spaces/basic/script

@@ -0,0 +1,7 @@
+trace $CLI bundle validate
+trace $CLI bundle plan
+trace $CLI bundle deploy
+trace print_requests.py //app-spaces > out.requests.$DATABRICKS_BUNDLE_ENGINE.json
+trace $CLI bundle summary
+trace $CLI bundle destroy --auto-approve
+trace print_requests.py //app-spaces >> out.requests.$DATABRICKS_BUNDLE_ENGINE.json

acceptance/bundle/resources/app_spaces/basic/test.toml

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

acceptance/bundle/resources/app_spaces/recreate/databricks.yml

@@ -0,0 +1,8 @@
+bundle:
+  name: test-bundle
+
+resources:
+  app_spaces:
+    mykey:
+      name: original-space-name
+      description: my_space_description

acceptance/bundle/resources/app_spaces/recreate/out.requests.direct.json

@@ -0,0 +1,24 @@
+{
+  "method": "POST",
+  "path": "/api/2.0/app-spaces",
+  "body": {
+    "description": "my_space_description",
+    "name": "original-space-name"
+  }
+}
+{
+  "method": "DELETE",
+  "path": "/api/2.0/app-spaces/original-space-name"
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/app-spaces",
+  "body": {
+    "description": "my_space_description",
+    "name": "renamed-space"
+  }
+}
+{
+  "method": "DELETE",
+  "path": "/api/2.0/app-spaces/renamed-space"
+}