Add defaults on pipelines that terraform applies (#2787)

denik · web-flow · commit cc1d3456096a · 2025-04-29T14:28:38.000Z
## Changes Set defaults for pipelines: edition and channel, same as added by terraform. ## Why See #2767 ## Tests Existing tests.
diff --git a/acceptance/bundle/override/pipeline_cluster/output.txt b/acceptance/bundle/override/pipeline_cluster/output.txt
@@ -2,6 +2,7 @@
 >>> [CLI] bundle validate -o json -t development
 {
   "foo": {
+    "channel": "CURRENT",
     "clusters": [
       {
         "label": "default",
@@ -16,6 +17,7 @@
       "kind": "BUNDLE",
       "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/override_pipeline_cluster/development/state/metadata.json"
     },
+    "edition": "ADVANCED",
     "name": "job",
     "permissions": []
   }
@@ -24,6 +26,7 @@
 >>> [CLI] bundle validate -o json -t staging
 {
   "foo": {
+    "channel": "CURRENT",
     "clusters": [
       {
         "label": "default",
@@ -38,6 +41,7 @@
       "kind": "BUNDLE",
       "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/override_pipeline_cluster/staging/state/metadata.json"
     },
+    "edition": "ADVANCED",
     "name": "job",
     "permissions": []
   }
diff --git a/acceptance/bundle/paths/invalid_pipeline_globs/output.txt b/acceptance/bundle/paths/invalid_pipeline_globs/output.txt
@@ -8,6 +8,8 @@ Exit code: 1
   "resources": {
     "pipelines": {
       "nyc_taxi_pipeline": {
+        "channel": "CURRENT",
+        "edition": "ADVANCED",
         "libraries": [
           {
             "notebook": {
diff --git a/acceptance/bundle/paths/pipeline_expected_file_got_notebook/output.txt b/acceptance/bundle/paths/pipeline_expected_file_got_notebook/output.txt
@@ -8,6 +8,8 @@ Exit code: 1
   "resources": {
     "pipelines": {
       "nyc_taxi_pipeline": {
+        "channel": "CURRENT",
+        "edition": "ADVANCED",
         "libraries": [
           {
             "file": {
diff --git a/acceptance/bundle/paths/pipeline_globs/output.txt b/acceptance/bundle/paths/pipeline_globs/output.txt
@@ -4,10 +4,12 @@
   "resources": {
     "pipelines": {
       "nyc_taxi_pipeline": {
+        "channel": "CURRENT",
         "deployment": {
           "kind": "BUNDLE",
           "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/pipeline_glob_paths/default/state/metadata.json"
         },
+        "edition": "ADVANCED",
         "libraries": [
           {
             "notebook": {
diff --git a/acceptance/bundle/python/pipelines-support/output.txt b/acceptance/bundle/python/pipelines-support/output.txt
@@ -14,18 +14,22 @@
   "resources": {
     "pipelines": {
       "my_pipeline_1": {
+        "channel": "CURRENT",
         "deployment": {
           "kind": "BUNDLE",
           "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/my_project/default/state/metadata.json"
         },
+        "edition": "ADVANCED",
         "name": "My Pipeline 1 (updated)",
         "permissions": []
       },
       "my_pipeline_2": {
+        "channel": "CURRENT",
         "deployment": {
           "kind": "BUNDLE",
           "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/my_project/default/state/metadata.json"
         },
+        "edition": "ADVANCED",
         "name": "My Pipeline 2 (updated)",
         "permissions": []
       }
diff --git a/acceptance/bundle/templates/default-python/integration_classic/out.validate.dev.json b/acceptance/bundle/templates/default-python/integration_classic/out.validate.dev.json
@@ -116,6 +116,7 @@
     },
     "pipelines": {
       "project_name_[UNIQUE_NAME]_pipeline": {
+        "channel": "CURRENT",
         "configuration": {
           "bundle.sourcePath": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/dev/files/src"
         },
@@ -124,6 +125,7 @@
           "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/dev/state/metadata.json"
         },
         "development": true,
+        "edition": "ADVANCED",
         "libraries": [
           {
             "notebook": {
diff --git a/acceptance/bundle/templates/default-python/integration_classic/output.txt b/acceptance/bundle/templates/default-python/integration_classic/output.txt
@@ -74,13 +74,13 @@ Resources:
 +        "url": "[DATABRICKS_URL]/jobs/[NUMBER]"
        }
      },
-@@ -125,4 +126,5 @@
-         },
+@@ -127,4 +128,5 @@
          "development": true,
+         "edition": "ADVANCED",
 +        "id": "[UUID]",
          "libraries": [
            {
-@@ -133,6 +135,6 @@
+@@ -135,6 +137,6 @@
          ],
          "name": "[dev [USERNAME]] project_name_[UNIQUE_NAME]_pipeline",
 -        "permissions": [],
@@ -89,7 +89,7 @@ Resources:
 +        "url": "[DATABRICKS_URL]/pipelines/[UUID]"
        }
      }
-@@ -143,5 +145,4 @@
+@@ -145,5 +147,4 @@
      ]
    },
 -  "targets": null,
@@ -197,8 +197,8 @@ Validation OK!
 +          "pause_status": "UNPAUSED",
            "periodic": {
              "interval": 1,
-@@ -118,21 +107,20 @@
-       "project_name_[UNIQUE_NAME]_pipeline": {
+@@ -119,22 +108,21 @@
+         "channel": "CURRENT",
          "configuration": {
 -          "bundle.sourcePath": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/dev/files/src"
 +          "bundle.sourcePath": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/prod/files/src"
@@ -209,6 +209,7 @@ Validation OK!
 +          "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/prod/state/metadata.json"
          },
 -        "development": true,
+         "edition": "ADVANCED",
          "libraries": [
            {
              "notebook": {
@@ -224,7 +225,7 @@ Validation OK!
 +        "schema": "project_name_[UNIQUE_NAME]_prod"
        }
      }
-@@ -145,10 +133,10 @@
+@@ -147,10 +135,10 @@
    "targets": null,
    "workspace": {
 -    "artifact_path": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/dev/artifacts",
@@ -347,8 +348,8 @@ Resources:
 +          "pause_status": "UNPAUSED",
            "periodic": {
              "interval": 1,
-@@ -119,21 +112,20 @@
-       "project_name_[UNIQUE_NAME]_pipeline": {
+@@ -120,11 +113,10 @@
+         "channel": "CURRENT",
          "configuration": {
 -          "bundle.sourcePath": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/dev/files/src"
 +          "bundle.sourcePath": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/prod/files/src"
@@ -359,8 +360,9 @@ Resources:
 +          "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/prod/state/metadata.json"
          },
 -        "development": true,
+         "edition": "ADVANCED",
          "id": "[UUID]",
-         "libraries": [
+@@ -132,10 +124,10 @@
            {
              "notebook": {
 -              "path": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/dev/files/src/dlt_pipeline"
@@ -374,7 +376,7 @@ Resources:
 +        "schema": "project_name_[UNIQUE_NAME]_prod",
          "url": "[DATABRICKS_URL]/pipelines/[UUID]"
        }
-@@ -146,10 +138,10 @@
+@@ -148,10 +140,10 @@
    },
    "workspace": {
 -    "artifact_path": "/Workspace/Users/[USERNAME]/.bundle/project_name_[UNIQUE_NAME]/dev/artifacts",
diff --git a/acceptance/bundle/templates/experimental-jobs-as-code/output.txt b/acceptance/bundle/templates/experimental-jobs-as-code/output.txt
@@ -83,6 +83,7 @@ Warning: Ignoring Databricks CLI version constraint for development build. Requi
   "pipelines": {
     "my_jobs_as_code_pipeline": {
       "catalog": "catalog_name",
+      "channel": "CURRENT",
       "configuration": {
         "bundle.sourcePath": "/Workspace/Users/[USERNAME]/.bundle/my_jobs_as_code/dev/files/src"
       },
@@ -91,6 +92,7 @@ Warning: Ignoring Databricks CLI version constraint for development build. Requi
         "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/my_jobs_as_code/dev/state/metadata.json"
       },
       "development": true,
+      "edition": "ADVANCED",
       "libraries": [
         {
           "notebook": {
diff --git a/acceptance/bundle/validate/empty_resources/empty_dict/output.txt b/acceptance/bundle/validate/empty_resources/empty_dict/output.txt
@@ -23,6 +23,12 @@
 {
   "pipelines": {
     "rname": {
+      "channel": "CURRENT",
+      "deployment": {
+        "kind": "BUNDLE",
+        "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/BUNDLE/default/state/metadata.json"
+      },
+      "edition": "ADVANCED",
       "permissions": []
     }
   }
diff --git a/acceptance/bundle/validate/empty_resources/with_grants/output.txt b/acceptance/bundle/validate/empty_resources/with_grants/output.txt
@@ -31,6 +31,12 @@ Warning: unknown field: grants
 {
   "pipelines": {
     "rname": {
+      "channel": "CURRENT",
+      "deployment": {
+        "kind": "BUNDLE",
+        "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/BUNDLE/default/state/metadata.json"
+      },
+      "edition": "ADVANCED",
       "permissions": []
     }
   }
diff --git a/acceptance/bundle/validate/empty_resources/with_permissions/output.txt b/acceptance/bundle/validate/empty_resources/with_permissions/output.txt
@@ -23,6 +23,12 @@
 {
   "pipelines": {
     "rname": {
+      "channel": "CURRENT",
+      "deployment": {
+        "kind": "BUNDLE",
+        "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/BUNDLE/default/state/metadata.json"
+      },
+      "edition": "ADVANCED",
       "permissions": []
     }
   }
diff --git a/acceptance/bundle/variables/variable_overrides_in_target/output.txt b/acceptance/bundle/variables/variable_overrides_in_target/output.txt
@@ -3,6 +3,7 @@
 {
   "pipelines": {
     "my_pipeline": {
+      "channel": "CURRENT",
       "clusters": [
         {
           "label": "default",
@@ -14,6 +15,7 @@
         "kind": "BUNDLE",
         "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/foobar/use-default-variable-values/state/metadata.json"
       },
+      "edition": "ADVANCED",
       "name": "a_string",
       "permissions": []
     }
@@ -24,6 +26,7 @@
 {
   "pipelines": {
     "my_pipeline": {
+      "channel": "CURRENT",
       "clusters": [
         {
           "label": "default",
@@ -35,6 +38,7 @@
         "kind": "BUNDLE",
         "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/foobar/override-string-variable/state/metadata.json"
       },
+      "edition": "ADVANCED",
       "name": "overridden_string",
       "permissions": []
     }
@@ -45,6 +49,7 @@
 {
   "pipelines": {
     "my_pipeline": {
+      "channel": "CURRENT",
       "clusters": [
         {
           "label": "default",
@@ -56,6 +61,7 @@
         "kind": "BUNDLE",
         "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/foobar/override-int-variable/state/metadata.json"
       },
+      "edition": "ADVANCED",
       "name": "a_string",
       "permissions": []
     }
@@ -66,6 +72,7 @@
 {
   "pipelines": {
     "my_pipeline": {
+      "channel": "CURRENT",
       "clusters": [
         {
           "label": "default",
@@ -77,6 +84,7 @@
         "kind": "BUNDLE",
         "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/foobar/override-both-bool-and-string-variables/state/metadata.json"
       },
+      "edition": "ADVANCED",
       "name": "overridden_string",
       "permissions": []
     }
diff --git a/bundle/config/mutator/resourcemutator/resource_mutator.go b/bundle/config/mutator/resourcemutator/resource_mutator.go
@@ -71,6 +71,11 @@ func applyInitializeMutators(ctx context.Context, b *bundle.Bundle) diag.Diagnos
 		//{"resources.jobs.*.job_clusters[*].new_cluster.num_workers", 0},
 		{"resources.jobs.*.job_clusters[*].new_cluster.workload_type.clients.notebooks", true},
 		{"resources.jobs.*.job_clusters[*].new_cluster.workload_type.clients.jobs", true},
+
+		// Pipelines (same as terraform)
+		// https://github.com/databricks/terraform-provider-databricks/blob/v1.75.0/pipelines/resource_pipeline.go#L253
+		{"resources.pipelines.*.edition", "ADVANCED"},
+		{"resources.pipelines.*.channel", "CURRENT"},
 	}
 
 	for _, defaultDef := range defaults {

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`>>> [CLI] bundle validate -o json -t development`
`3`	`3`	`{`
`4`	`4`	`"foo": {`
	`5`	`+ "channel": "CURRENT",`
`5`	`6`	`"clusters": [`
`6`	`7`	`{`
`7`	`8`	`"label": "default",`
`@@ -16,6 +17,7 @@`
`16`	`17`	`"kind": "BUNDLE",`
`17`	`18`	`"metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/override_pipeline_cluster/development/state/metadata.json"`
`18`	`19`	`},`
	`20`	`+ "edition": "ADVANCED",`
`19`	`21`	`"name": "job",`
`20`	`22`	`"permissions": []`
`21`	`23`	`}`
`@@ -24,6 +26,7 @@`
`24`	`26`	`>>> [CLI] bundle validate -o json -t staging`
`25`	`27`	`{`
`26`	`28`	`"foo": {`
	`29`	`+ "channel": "CURRENT",`
`27`	`30`	`"clusters": [`
`28`	`31`	`{`
`29`	`32`	`"label": "default",`
`@@ -38,6 +41,7 @@`
`38`	`41`	`"kind": "BUNDLE",`
`39`	`42`	`"metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/override_pipeline_cluster/staging/state/metadata.json"`
`40`	`43`	`},`
	`44`	`+ "edition": "ADVANCED",`
`41`	`45`	`"name": "job",`
`42`	`46`	`"permissions": []`
`43`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@ Exit code: 1`
`8`	`8`	`"resources": {`
`9`	`9`	`"pipelines": {`
`10`	`10`	`"nyc_taxi_pipeline": {`
	`11`	`+ "channel": "CURRENT",`
	`12`	`+ "edition": "ADVANCED",`
`11`	`13`	`"libraries": [`
`12`	`14`	`{`
`13`	`15`	`"notebook": {`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,12 @@`
`23`	`23`	`{`
`24`	`24`	`"pipelines": {`
`25`	`25`	`"rname": {`
	`26`	`+ "channel": "CURRENT",`
	`27`	`+ "deployment": {`
	`28`	`+ "kind": "BUNDLE",`
	`29`	`+ "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/BUNDLE/default/state/metadata.json"`
	`30`	`+ },`
	`31`	`+ "edition": "ADVANCED",`
`26`	`32`	`"permissions": []`
`27`	`33`	`}`
`28`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,12 @@ Warning: unknown field: grants`
`31`	`31`	`{`
`32`	`32`	`"pipelines": {`
`33`	`33`	`"rname": {`
	`34`	`+ "channel": "CURRENT",`
	`35`	`+ "deployment": {`
	`36`	`+ "kind": "BUNDLE",`
	`37`	`+ "metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/BUNDLE/default/state/metadata.json"`
	`38`	`+ },`
	`39`	`+ "edition": "ADVANCED",`
`34`	`40`	`"permissions": []`
`35`	`41`	`}`
`36`	`42`	`}`