Distinguish "not supported" from "not deployed" in bundle summary

.nextchanges/bundles/url-not-supported.md

@@ -0,0 +1 @@
+* CLI commands no longer imply that a resource whose type has no workspace URL is merely not deployed yet. ([#6583](https://github.com/databricks/cli/pull/6583))

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

@@ -13,7 +13,6 @@ Resources:
   Postgres databases:
     database1:
       Name: 
-      URL:  (not deployed)
 
 >>> [CLI] bundle deployment unbind database1
 
@@ -27,4 +26,3 @@ Resources:
   Postgres databases:
     database1:
       Name: 
-      URL:  (not deployed)

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

@@ -13,7 +13,6 @@ Resources:
   Postgres roles:
     role1:
       Name: 
-      URL:  (not deployed)
 
 >>> [CLI] bundle deployment unbind role1
 
@@ -27,4 +26,3 @@ Resources:
   Postgres roles:
     role1:
       Name: 
-      URL:  (not deployed)

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

@@ -13,7 +13,6 @@ Resources:
   Postgres snapshot schedules:
     schedule1:
       Name: projects/test-project/branches/main/snapshot-schedule
-      URL:  (not deployed)
 
 >>> [CLI] bundle deployment unbind schedule1
 
@@ -27,4 +26,3 @@ Resources:
   Postgres snapshot schedules:
     schedule1:
       Name: 
-      URL:  (not deployed)

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

@@ -18,11 +18,9 @@ Resources:
   Postgres branches:
     main:
       Name: 
-      URL:  (not deployed)
   Postgres projects:
     my_project:
       Name: Test Project for Branch
-      URL:  (not deployed)
 
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-branch-[UNIQUE_NAME]/default/files...
@@ -59,11 +57,9 @@ Resources:
   Postgres branches:
     main:
       Name: 
-      URL:  (not deployed)
   Postgres projects:
     my_project:
       Name: Test Project for Branch
-      URL:  (not deployed)
 
 >>> print_requests.py --del-body project_id,branch_id,endpoint_id,database_id,role_id,catalog_id,synced_table_id --keep --get //postgres ^//workspace-files/ ^//workspace/ ^//telemetry-ext ^//operations/
 

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

@@ -22,7 +22,6 @@ Resources:
   Postgres projects:
     my_project:
       Name: Test Project for Catalog
-      URL:  (not deployed)
 
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-catalog-[UNIQUE_NAME]/default/files...
@@ -56,7 +55,6 @@ Resources:
   Postgres projects:
     my_project:
       Name: Test Project for Catalog
-      URL:  (not deployed)
 
 >>> print_requests.py --del-body project_id,branch_id,endpoint_id,database_id,role_id,catalog_id,synced_table_id --keep --get //postgres ^//workspace-files/ ^//workspace/ ^//telemetry-ext ^//operations/
 

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

@@ -18,19 +18,15 @@ Resources:
   Postgres branches:
     main:
       Name: 
-      URL:  (not deployed)
   Postgres databases:
     my_database:
       Name: 
-      URL:  (not deployed)
   Postgres projects:
     my_project:
       Name: Test Project for Database
-      URL:  (not deployed)
   Postgres roles:
     owner:
       Name: 
-      URL:  (not deployed)
 
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-database-[UNIQUE_NAME]/default/files...
@@ -63,19 +59,15 @@ Resources:
   Postgres branches:
     main:
       Name: 
-      URL:  (not deployed)
   Postgres databases:
     my_database:
       Name: 
-      URL:  (not deployed)
   Postgres projects:
     my_project:
       Name: Test Project for Database
-      URL:  (not deployed)
   Postgres roles:
     owner:
       Name: 
-      URL:  (not deployed)
 
 >>> print_requests.py --del-body project_id,branch_id,endpoint_id,database_id,role_id,catalog_id,synced_table_id --keep --get //postgres ^//workspace-files/ ^//workspace/ ^//telemetry-ext ^//operations/
 

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

@@ -18,15 +18,12 @@ Resources:
   Postgres branches:
     main:
       Name: 
-      URL:  (not deployed)
   Postgres endpoints:
     custom:
       Name: 
-      URL:  (not deployed)
   Postgres projects:
     my_project:
       Name: Test Project for Endpoint
-      URL:  (not deployed)
 
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-endpoint-[UNIQUE_NAME]/default/files...
@@ -61,15 +58,12 @@ Resources:
   Postgres branches:
     main:
       Name: 
-      URL:  (not deployed)
   Postgres endpoints:
     custom:
       Name: 
-      URL:  (not deployed)
   Postgres projects:
     my_project:
       Name: Test Project for Endpoint
-      URL:  (not deployed)
 
 >>> print_requests.py --del-body project_id,branch_id,endpoint_id,database_id,role_id,catalog_id,synced_table_id --keep --get //postgres ^//workspace-files/ ^//workspace/ ^//telemetry-ext ^//operations/
 

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

@@ -18,7 +18,6 @@ Resources:
   Postgres projects:
     my_project:
       Name: Test Postgres Project
-      URL:  (not deployed)
 
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-single-project-[UNIQUE_NAME]/default/files...
@@ -59,7 +58,6 @@ Resources:
   Postgres projects:
     my_project:
       Name: Test Postgres Project
-      URL:  (not deployed)
 
 >>> print_requests.py --del-body project_id,branch_id,endpoint_id,database_id,role_id,catalog_id,synced_table_id --keep --get //postgres ^//workspace-files/ ^//workspace/ ^//telemetry-ext ^//operations/
 

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

@@ -18,15 +18,12 @@ Resources:
   Postgres branches:
     main:
       Name: 
-      URL:  (not deployed)
   Postgres projects:
     my_project:
       Name: Test Project for Role
-      URL:  (not deployed)
   Postgres roles:
     my_role:
       Name: 
-      URL:  (not deployed)
 
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-role-[UNIQUE_NAME]/default/files...
@@ -54,6 +51,9 @@ Resources: 3 created, 0 changed, 0 deleted, 0 unchanged
   }
 }
 
+>>> musterr [CLI] bundle open my_role
+Error: this resource type does not have a URL
+
 >>> [CLI] bundle summary
 Name: deploy-postgres-role-[UNIQUE_NAME]
 Target: default
@@ -64,15 +64,12 @@ Resources:
   Postgres branches:
     main:
       Name: 
-      URL:  (not deployed)
   Postgres projects:
     my_project:
       Name: Test Project for Role
-      URL:  (not deployed)
   Postgres roles:
     my_role:
       Name: 
-      URL:  (not deployed)
 
 >>> print_requests.py --del-body project_id,branch_id,endpoint_id,database_id,role_id,catalog_id,synced_table_id --keep --get //postgres ^//workspace-files/ ^//workspace/ ^//telemetry-ext ^//operations/
 

acceptance/bundle/resources/postgres_roles/basic/script

@@ -19,6 +19,10 @@ branch_name="${project_name}/branches/main"
 role_name="${branch_name}/roles/test-role"
 trace $CLI postgres get-role "${role_name}" | role_fields
 
+# Postgres roles have no workspace URL, so opening one reports that rather than
+# suggesting a deploy.
+trace musterr $CLI bundle open my_role
+
 trace $CLI bundle summary
 
 # Filter requests to only show postgres operations (exclude workspace, telemetry, and operation polling)

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

@@ -26,7 +26,6 @@ Resources:
   Postgres projects:
     my_project:
       Name: Test Project for Synced Table
-      URL:  (not deployed)
   Postgres synced tables:
     my_table:
       Name: ${resources.postgres_catalogs.my_catalog.catalog_id}.public.trips_synced
@@ -65,7 +64,6 @@ Resources:
   Postgres projects:
     my_project:
       Name: Test Project for Synced Table
-      URL:  (not deployed)
   Postgres synced tables:
     my_table:
       Name: lakebase_test_[UNIQUE_NAME].public.trips_synced

bundle/config/mutator/initialize_urls_test.go

@@ -124,7 +124,8 @@ func TestInitializeURLs(t *testing.T) {
 
 	for _, group := range b.Config.Resources.AllResources() {
 		for key, r := range group.Resources {
-			require.Equal(t, expectedURLs[key], r.GetURL(), "Unexpected URL for "+key)
+			url, _ := r.GetURL()
+			require.Equal(t, expectedURLs[key], url, "Unexpected URL for "+key)
 		}
 	}
 }

bundle/config/resources.go

@@ -63,8 +63,10 @@ type ConfigResource interface {
 	// GetName returns the in-product name of the resource.
 	GetName() string
 
-	// GetURL returns the URL of the resource.
-	GetURL() string
+	// GetURL returns the resource's workspace URL and whether this resource type
+	// has one at all. A supported type that is not deployed yet returns ("", true);
+	// a type that never has a URL returns ("", false).
+	GetURL() (string, bool)
 
 	// InitializeURL initializes the URL field of the resource.
 	InitializeURL(baseURL url.URL)

bundle/config/resources/alerts.go

@@ -59,7 +59,3 @@ func (a *Alert) InitializeURL(baseURL url.URL) {
 func (a *Alert) GetName() string {
 	return a.DisplayName
 }
-
-func (a *Alert) GetURL() string {
-	return a.URL
-}

bundle/config/resources/apps.go

@@ -102,7 +102,3 @@ func (a *App) GetName() string {
 	}
 	return a.Name
 }
-
-func (a *App) GetURL() string {
-	return a.URL
-}

bundle/config/resources/base.go

@@ -12,3 +12,9 @@ type BaseResource struct {
 func (b *BaseResource) GetLifecycle() LifecycleConfig {
 	return b.Lifecycle
 }
+
+// GetURL returns the resource's workspace URL and true. Resource types whose
+// IDs don't map to a web UI page override this to return ("", false).
+func (b *BaseResource) GetURL() (string, bool) {
+	return b.URL, true
+}

bundle/config/resources/catalog.go

@@ -51,10 +51,6 @@ func (c *Catalog) InitializeURL(baseURL url.URL) {
 	c.URL = workspaceurls.ResourceURL(baseURL, "catalogs", c.ID)
 }
 
-func (c *Catalog) GetURL() string {
-	return c.URL
-}
-
 func (c *Catalog) GetName() string {
 	return c.Name
 }

bundle/config/resources/cluster_policy.go

@@ -63,7 +63,3 @@ func (s *ClusterPolicy) InitializeURL(baseURL url.URL) {
 func (s *ClusterPolicy) GetName() string {
 	return s.Name
 }
-
-func (s *ClusterPolicy) GetURL() string {
-	return s.URL
-}

bundle/config/resources/clusters.go

@@ -65,7 +65,3 @@ func (s *Cluster) InitializeURL(baseURL url.URL) {
 func (s *Cluster) GetName() string {
 	return s.ClusterName
 }
-
-func (s *Cluster) GetURL() string {
-	return s.URL
-}

bundle/config/resources/dashboard.go

@@ -128,7 +128,3 @@ func (r *Dashboard) InitializeURL(baseURL url.URL) {
 func (r *Dashboard) GetName() string {
 	return r.DisplayName
 }
-
-func (r *Dashboard) GetURL() string {
-	return r.URL
-}

bundle/config/resources/database_catalog.go

@@ -47,10 +47,6 @@ func (d *DatabaseCatalog) GetName() string {
 	return d.Name
 }
 
-func (d *DatabaseCatalog) GetURL() string {
-	return d.URL
-}
-
 func (d *DatabaseCatalog) InitializeURL(baseURL url.URL) {
 	if d.Name == "" {
 		return

bundle/config/resources/database_instance.go

@@ -49,10 +49,6 @@ func (d *DatabaseInstance) GetName() string {
 	return d.Name
 }
 
-func (d *DatabaseInstance) GetURL() string {
-	return d.URL
-}
-
 func (d *DatabaseInstance) InitializeURL(baseURL url.URL) {
 	if d.ModifiedStatus == ModifiedStatusCreated {
 		return

bundle/config/resources/external_location.go

@@ -53,9 +53,9 @@ func (e *ExternalLocation) InitializeURL(baseURL url.URL) {
 	// The Url field is for the storage path (s3://...), not a workspace URL
 }
 
-func (e *ExternalLocation) GetURL() string {
-	// Return empty as external locations don't have a workspace URL
-	return ""
+func (e *ExternalLocation) GetURL() (string, bool) {
+	// External locations don't have a workspace URL
+	return "", false
 }
 
 func (e *ExternalLocation) GetName() string {

bundle/config/resources/genie_space.go

@@ -104,7 +104,3 @@ func (r *GenieSpace) InitializeURL(baseURL url.URL) {
 func (r *GenieSpace) GetName() string {
 	return r.Title
 }
-
-func (r *GenieSpace) GetURL() string {
-	return r.URL
-}

bundle/config/resources/instance_pools.go

@@ -53,7 +53,3 @@ func (s *InstancePool) InitializeURL(baseURL url.URL) {
 func (s *InstancePool) GetName() string {
 	return s.InstancePoolName
 }
-
-func (s *InstancePool) GetURL() string {
-	return s.URL
-}

bundle/config/resources/job.go

@@ -61,7 +61,3 @@ func (j *Job) InitializeURL(baseURL url.URL) {
 func (j *Job) GetName() string {
 	return j.Name
 }
-
-func (j *Job) GetURL() string {
-	return j.URL
-}

bundle/config/resources/job_run.go

@@ -84,10 +84,6 @@ func (r *JobRun) GetName() string {
 	return ""
 }
 
-func (r *JobRun) GetURL() string {
-	return r.URL
-}
-
 // InitializeURL sets the run's workspace URL. The job id comes from RunNow.JobId
 // when resolved (deploy) or ResolvedJobID from state (read-only commands); if
 // either id is missing we skip rather than emit a broken jobs/0 URL.

bundle/config/resources/mlflow_experiment.go

@@ -56,7 +56,3 @@ func (s *MlflowExperiment) InitializeURL(baseURL url.URL) {
 func (s *MlflowExperiment) GetName() string {
 	return s.Name
 }
-
-func (s *MlflowExperiment) GetURL() string {
-	return s.URL
-}