From 5b8ac1783eb8e10e86548fa61cdf8c1e0f18deed Mon Sep 17 00:00:00 2001 From: Bhukya Date: Mon, 16 Nov 2026 20:50:45 +0000 Subject: [PATCH 1/3] Add the testing property of pipelines to bundles Add resources.pipelines..testing, with the test sources and test-only dependencies that databricks pipelines test runs with. The field comes from the Go SDK's CreatePipeline. The CLI adds its own descriptions for it. The property is experimental. It needs DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true. While the variable is off, bundle validate rejects testing and names the variable. Bundles without testing are not changed. Later PRs translate its paths. Co-authored-by: Isaac --- .../pipelines/testing/databricks.yml | 19 +++++++ .../resources/pipelines/testing/out.test.toml | 2 + .../resources/pipelines/testing/output.txt | 33 +++++++++++++ .../pipelines/testing/pyproject.toml | 6 +++ .../bundle/resources/pipelines/testing/script | 4 ++ .../resources/pipelines/testing/test.toml | 5 ++ .../pipelines/testing/tests/requirements.txt | 1 + .../pipelines/testing/tests/test_orders.py | 2 + .../testing/transformations/orders.py | 1 + .../validate/pipeline_testing_enabled.go | 49 +++++++++++++++++++ .../validate/pipeline_testing_enabled_test.go | 42 ++++++++++++++++ bundle/env/experimental_pipeline_testing.go | 17 +++++++ bundle/internal/schema/annotations.yml | 14 ++++++ bundle/phases/initialize.go | 4 ++ bundle/schema/jsonschema.json | 6 +-- .../bundles/pipelines/_models/pipeline.py | 4 +- .../_models/pipeline_test_environment.py | 10 +--- .../pipelines/_models/pipeline_test_source.py | 4 +- 18 files changed, 208 insertions(+), 15 deletions(-) create mode 100644 acceptance/bundle/resources/pipelines/testing/databricks.yml create mode 100644 acceptance/bundle/resources/pipelines/testing/out.test.toml create mode 100644 acceptance/bundle/resources/pipelines/testing/output.txt create mode 100644 acceptance/bundle/resources/pipelines/testing/pyproject.toml create mode 100644 acceptance/bundle/resources/pipelines/testing/script create mode 100644 acceptance/bundle/resources/pipelines/testing/test.toml create mode 100644 acceptance/bundle/resources/pipelines/testing/tests/requirements.txt create mode 100644 acceptance/bundle/resources/pipelines/testing/tests/test_orders.py create mode 100644 acceptance/bundle/resources/pipelines/testing/transformations/orders.py create mode 100644 bundle/config/validate/pipeline_testing_enabled.go create mode 100644 bundle/config/validate/pipeline_testing_enabled_test.go create mode 100644 bundle/env/experimental_pipeline_testing.go diff --git a/acceptance/bundle/resources/pipelines/testing/databricks.yml b/acceptance/bundle/resources/pipelines/testing/databricks.yml new file mode 100644 index 00000000000..346cc9d7963 --- /dev/null +++ b/acceptance/bundle/resources/pipelines/testing/databricks.yml @@ -0,0 +1,19 @@ +bundle: + name: pipeline-testing + +resources: + pipelines: + orders: + name: orders + libraries: + - glob: + include: ./transformations/** + testing: + sources: + - glob: + include: ./tests/** + environment: + dependencies: + - -e .[test] + - -r ./tests/requirements.txt + - ./dist/*.whl diff --git a/acceptance/bundle/resources/pipelines/testing/out.test.toml b/acceptance/bundle/resources/pipelines/testing/out.test.toml new file mode 100644 index 00000000000..a927a5fbc06 --- /dev/null +++ b/acceptance/bundle/resources/pipelines/testing/out.test.toml @@ -0,0 +1,2 @@ +Cloud = false +EnvMatrix.DMS = ["", "true"] diff --git a/acceptance/bundle/resources/pipelines/testing/output.txt b/acceptance/bundle/resources/pipelines/testing/output.txt new file mode 100644 index 00000000000..6133e93eb75 --- /dev/null +++ b/acceptance/bundle/resources/pipelines/testing/output.txt @@ -0,0 +1,33 @@ + +>>> [CLI] bundle validate -o json +{ + "environment": { + "dependencies": [ + "-e .[test]", + "-r ./tests/requirements.txt", + "./dist/*.whl" + ] + }, + "sources": [ + { + "glob": { + "include": "./tests/**" + } + } + ] +} + +=== Without pipeline testing, the property is an error + +>>> musterr env -u DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING [CLI] bundle validate +Error: the testing property of pipelines is experimental. Set DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true to enable it + at resources.pipelines.orders.testing + in databricks.yml:12:9 + +Name: pipeline-testing +Target: default +Workspace: + User: [USERNAME] + Path: /Workspace/Users/[USERNAME]/.bundle/pipeline-testing/default + +Found 1 error diff --git a/acceptance/bundle/resources/pipelines/testing/pyproject.toml b/acceptance/bundle/resources/pipelines/testing/pyproject.toml new file mode 100644 index 00000000000..1c198acc7cb --- /dev/null +++ b/acceptance/bundle/resources/pipelines/testing/pyproject.toml @@ -0,0 +1,6 @@ +[project] +name = "orders" +version = "0.1" + +[project.optional-dependencies] +test = ["faker"] diff --git a/acceptance/bundle/resources/pipelines/testing/script b/acceptance/bundle/resources/pipelines/testing/script new file mode 100644 index 00000000000..1dc320485b7 --- /dev/null +++ b/acceptance/bundle/resources/pipelines/testing/script @@ -0,0 +1,4 @@ +trace $CLI bundle validate -o json | jq .resources.pipelines.orders.testing + +title "Without pipeline testing, the property is an error" +trace musterr env -u DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING $CLI bundle validate diff --git a/acceptance/bundle/resources/pipelines/testing/test.toml b/acceptance/bundle/resources/pipelines/testing/test.toml new file mode 100644 index 00000000000..965c596a302 --- /dev/null +++ b/acceptance/bundle/resources/pipelines/testing/test.toml @@ -0,0 +1,5 @@ +# Runs only against the local test server. +Cloud = false +RecordRequests = true +Ignore = [".databricks"] +Env.DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING = "true" diff --git a/acceptance/bundle/resources/pipelines/testing/tests/requirements.txt b/acceptance/bundle/resources/pipelines/testing/tests/requirements.txt new file mode 100644 index 00000000000..9d7f6e827a1 --- /dev/null +++ b/acceptance/bundle/resources/pipelines/testing/tests/requirements.txt @@ -0,0 +1 @@ +faker diff --git a/acceptance/bundle/resources/pipelines/testing/tests/test_orders.py b/acceptance/bundle/resources/pipelines/testing/tests/test_orders.py new file mode 100644 index 00000000000..eb4379fd048 --- /dev/null +++ b/acceptance/bundle/resources/pipelines/testing/tests/test_orders.py @@ -0,0 +1,2 @@ +def test_orders(): + pass diff --git a/acceptance/bundle/resources/pipelines/testing/transformations/orders.py b/acceptance/bundle/resources/pipelines/testing/transformations/orders.py new file mode 100644 index 00000000000..3a22621c3bf --- /dev/null +++ b/acceptance/bundle/resources/pipelines/testing/transformations/orders.py @@ -0,0 +1 @@ +from pyspark import pipelines as dp diff --git a/bundle/config/validate/pipeline_testing_enabled.go b/bundle/config/validate/pipeline_testing_enabled.go new file mode 100644 index 00000000000..85fdb85ed4b --- /dev/null +++ b/bundle/config/validate/pipeline_testing_enabled.go @@ -0,0 +1,49 @@ +package validate + +import ( + "context" + "fmt" + "maps" + "slices" + + "github.com/databricks/cli/bundle" + "github.com/databricks/cli/bundle/env" + "github.com/databricks/cli/libs/diag" + "github.com/databricks/cli/libs/dyn" +) + +type pipelineTestingEnabled struct{ bundle.RO } + +// PipelineTestingEnabled rejects the testing property of pipelines while the experimental feature is off. +func PipelineTestingEnabled() bundle.ReadOnlyMutator { + return &pipelineTestingEnabled{} +} + +func (v *pipelineTestingEnabled) Name() string { + return "validate:pipeline_testing_enabled" +} + +func (v *pipelineTestingEnabled) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics { + if env.ExperimentalPipelineTesting(ctx) { + return nil + } + var diags diag.Diagnostics + pipelines := b.Config.Resources.Pipelines + for _, key := range slices.Sorted(maps.Keys(pipelines)) { + if pipelines[key] == nil || pipelines[key].Testing == nil { + continue + } + path := dyn.NewPath(dyn.Key("resources"), dyn.Key("pipelines"), dyn.Key(key), dyn.Key("testing")) + value, err := dyn.GetByPath(b.Config.Value(), path) + if err != nil { + return diag.FromErr(err) + } + diags = append(diags, diag.Diagnostic{ + Severity: diag.Error, + Summary: fmt.Sprintf("the testing property of pipelines is experimental. Set %s=true to enable it", env.ExperimentalPipelineTestingVariable), + Locations: value.Locations(), + Paths: dyn.ToStructPaths(path), + }) + } + return diags +} diff --git a/bundle/config/validate/pipeline_testing_enabled_test.go b/bundle/config/validate/pipeline_testing_enabled_test.go new file mode 100644 index 00000000000..126013c10fe --- /dev/null +++ b/bundle/config/validate/pipeline_testing_enabled_test.go @@ -0,0 +1,42 @@ +package validate + +import ( + "testing" + + "github.com/databricks/cli/bundle" + "github.com/databricks/cli/bundle/config" + "github.com/databricks/cli/bundle/config/resources" + "github.com/databricks/cli/bundle/env" + "github.com/databricks/cli/bundle/internal/bundletest" + "github.com/databricks/cli/libs/diag" + libsenv "github.com/databricks/cli/libs/env" + "github.com/databricks/databricks-sdk-go/service/pipelines" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestPipelineTestingEnabled(t *testing.T) { + b := &bundle.Bundle{ + Config: config.Root{ + Resources: config.Resources{ + Pipelines: map[string]*resources.Pipeline{ + "orders": {CreatePipeline: pipelines.CreatePipeline{Testing: &pipelines.PipelineTesting{}}}, + "reports": {}, + }, + }, + }, + } + loc := diag.Location{File: "databricks.yml", Line: 9, Column: 9} + bundletest.SetLocation(b, "resources.pipelines.orders.testing", []diag.Location{loc}) + + diags := PipelineTestingEnabled().Apply(t.Context(), b) + require.Len(t, diags, 1) + assert.Equal(t, diag.Error, diags[0].Severity) + assert.Contains(t, diags[0].Summary, env.ExperimentalPipelineTestingVariable) + assert.Equal(t, []diag.Location{loc}, diags[0].Locations) + require.Len(t, diags[0].Paths, 1) + assert.Equal(t, "resources.pipelines.orders.testing", diags[0].Paths[0].String()) + + ctx := libsenv.Set(t.Context(), env.ExperimentalPipelineTestingVariable, "true") + assert.Empty(t, PipelineTestingEnabled().Apply(ctx, b)) +} diff --git a/bundle/env/experimental_pipeline_testing.go b/bundle/env/experimental_pipeline_testing.go new file mode 100644 index 00000000000..b00a94176e9 --- /dev/null +++ b/bundle/env/experimental_pipeline_testing.go @@ -0,0 +1,17 @@ +package env + +import ( + "context" + + envlib "github.com/databricks/cli/libs/env" +) + +// ExperimentalPipelineTestingVariable enables the experimental testing property of pipelines. +const ExperimentalPipelineTestingVariable = "DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING" + +// ExperimentalPipelineTesting reports whether the experimental testing property of pipelines is +// enabled. While it is off, bundles deploy pipelines exactly as they did before the property existed. +func ExperimentalPipelineTesting(ctx context.Context) bool { + enabled, _ := envlib.GetBool(ctx, ExperimentalPipelineTestingVariable) + return enabled +} diff --git a/bundle/internal/schema/annotations.yml b/bundle/internal/schema/annotations.yml index 58abf721658..1a0018f2598 100644 --- a/bundle/internal/schema/annotations.yml +++ b/bundle/internal/schema/annotations.yml @@ -1465,6 +1465,20 @@ resources: "user_name": "description": |- The name of the user granted the permission level. + "testing": + "description": |- + The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. It is experimental and needs `DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true`. + "$fields": + "environment": + "$fields": + "dependencies": + "description": |- + A list of files that declare the packages the tests need: a project folder, a requirements file, or a wheel, in the workspace or a UC volume. A project folder can take `-e` and an extra, for example `-e ./project[test]`. A relative path, such as `-e ./project[test]` or `-r ./tests/requirements.txt`, is relative to the YAML file that defines it. Package names and URLs are rejected. + "sources": + "$fields": + "glob": + "description": |- + A `.py` test file, or a folder followed by `/**`. Other wildcards are rejected, and the sources must not overlap the pipeline's `libraries`. A relative path is relative to the YAML file that defines it. "trigger": "deprecation_message": |- Use continuous instead diff --git a/bundle/phases/initialize.go b/bundle/phases/initialize.go index 8c5a68d3130..b4a08596bb1 100644 --- a/bundle/phases/initialize.go +++ b/bundle/phases/initialize.go @@ -166,6 +166,10 @@ func Initialize(ctx context.Context, b *bundle.Bundle) { // Must run after PythonMutator to see development values set by Python mutators. validate.PipelineDevelopmentDeprecated(), + // Reject the experimental testing property of pipelines while it is off. Must run after + // PythonMutator, which can set testing, and before TranslatePaths and the deploy use it. + validate.PipelineTestingEnabled(), + // Compute resources.volumes.*.volume_path and resolve references to it. Must run after // PythonMutator: volume_path is computed and read-only, not declared by the PyDABs Volume // model, so exposing it to Python would fail resource loading (like "deployment" below). diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 2d5a35b5a5e..d3119d19d47 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -2454,7 +2454,7 @@ "deprecated": true }, "testing": { - "description": "[Private Preview] Test configuration for this pipeline. Used only by test-only updates.", + "description": "[Private Preview] The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. It is experimental and needs `DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineTesting", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true @@ -18261,7 +18261,7 @@ "description": "The packages that a pipeline's tests need in addition to the pipeline's environment.", "properties": { "dependencies": { - "description": "[Private Preview] A list of files that declare the packages the tests need: a project folder, a requirements\nfile, or a wheel, in the workspace or a UC volume. A project folder can take `--editable` and\nan extra, for example `--editable /Workspace/Users/someone@example.com/orders[test]`. Package\nnames, such as `faker==33.0`, and URLs are rejected.", + "description": "[Private Preview] A list of files that declare the packages the tests need: a project folder, a requirements file, or a wheel, in the workspace or a UC volume. A project folder can take `-e` and an extra, for example `-e ./project[test]`. A relative path, such as `-e ./project[test]` or `-r ./tests/requirements.txt`, is relative to the YAML file that defines it. Package names and URLs are rejected.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true @@ -18282,7 +18282,7 @@ "description": "A workspace location that holds pipeline tests.", "properties": { "glob": { - "description": "[Private Preview] An absolute workspace path to a test file, or to a folder followed by `/**`.", + "description": "[Private Preview] A `.py` test file, or a folder followed by `/**`. Other wildcards are rejected, and the sources must not overlap the pipeline's `libraries`. A relative path is relative to the YAML file that defines it.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true diff --git a/python/databricks/bundles/pipelines/_models/pipeline.py b/python/databricks/bundles/pipelines/_models/pipeline.py index c8efe551d4f..6a4551c3407 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline.py +++ b/python/databricks/bundles/pipelines/_models/pipeline.py @@ -266,7 +266,7 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - [Private Preview] Test configuration for this pipeline. Used only by test-only updates. + [Private Preview] The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. It is experimental and needs `DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true`. """ usage_policy_id: VariableOrOptional[str] = None @@ -490,7 +490,7 @@ class PipelineDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] Test configuration for this pipeline. Used only by test-only updates. + [Private Preview] The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. It is experimental and needs `DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true`. """ usage_policy_id: VariableOrOptional[str] diff --git a/python/databricks/bundles/pipelines/_models/pipeline_test_environment.py b/python/databricks/bundles/pipelines/_models/pipeline_test_environment.py index 827e30e91a4..897a1e94785 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline_test_environment.py +++ b/python/databricks/bundles/pipelines/_models/pipeline_test_environment.py @@ -23,10 +23,7 @@ class PipelineTestEnvironment: """ :meta private: [EXPERIMENTAL] - [Private Preview] A list of files that declare the packages the tests need: a project folder, a requirements - file, or a wheel, in the workspace or a UC volume. A project folder can take `--editable` and - an extra, for example `--editable /Workspace/Users/someone@example.com/orders[test]`. Package - names, such as `faker==33.0`, and URLs are rejected. + [Private Preview] A list of files that declare the packages the tests need: a project folder, a requirements file, or a wheel, in the workspace or a UC volume. A project folder can take `-e` and an extra, for example `-e ./project[test]`. A relative path, such as `-e ./project[test]` or `-r ./tests/requirements.txt`, is relative to the YAML file that defines it. Package names and URLs are rejected. """ @classmethod @@ -44,10 +41,7 @@ class PipelineTestEnvironmentDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] A list of files that declare the packages the tests need: a project folder, a requirements - file, or a wheel, in the workspace or a UC volume. A project folder can take `--editable` and - an extra, for example `--editable /Workspace/Users/someone@example.com/orders[test]`. Package - names, such as `faker==33.0`, and URLs are rejected. + [Private Preview] A list of files that declare the packages the tests need: a project folder, a requirements file, or a wheel, in the workspace or a UC volume. A project folder can take `-e` and an extra, for example `-e ./project[test]`. A relative path, such as `-e ./project[test]` or `-r ./tests/requirements.txt`, is relative to the YAML file that defines it. Package names and URLs are rejected. """ diff --git a/python/databricks/bundles/pipelines/_models/pipeline_test_source.py b/python/databricks/bundles/pipelines/_models/pipeline_test_source.py index 8abc02e9b7d..fcf4dcfc671 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline_test_source.py +++ b/python/databricks/bundles/pipelines/_models/pipeline_test_source.py @@ -27,7 +27,7 @@ class PipelineTestSource: """ :meta private: [EXPERIMENTAL] - [Private Preview] An absolute workspace path to a test file, or to a folder followed by `/**`. + [Private Preview] A `.py` test file, or a folder followed by `/**`. Other wildcards are rejected, and the sources must not overlap the pipeline's `libraries`. A relative path is relative to the YAML file that defines it. """ @classmethod @@ -45,7 +45,7 @@ class PipelineTestSourceDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] An absolute workspace path to a test file, or to a folder followed by `/**`. + [Private Preview] A `.py` test file, or a folder followed by `/**`. Other wildcards are rejected, and the sources must not overlap the pipeline's `libraries`. A relative path is relative to the YAML file that defines it. """ From b5c41ee6cb75ce09630baace75e25228dd3c287a Mon Sep 17 00:00:00 2001 From: Bhukya Date: Mon, 16 Nov 2026 23:53:48 +0000 Subject: [PATCH 2/3] Find the testing property of pipelines with a dyn pattern The check walks resources.pipelines.*.testing with dyn.MapByPattern, like the check of the development property, which gives the path and the locations directly. The acceptance test covers the error and the enabled case, so the unit test is removed. Co-authored-by: Isaac --- .../validate/pipeline_testing_enabled.go | 24 +++++------ .../validate/pipeline_testing_enabled_test.go | 42 ------------------- 2 files changed, 11 insertions(+), 55 deletions(-) delete mode 100644 bundle/config/validate/pipeline_testing_enabled_test.go diff --git a/bundle/config/validate/pipeline_testing_enabled.go b/bundle/config/validate/pipeline_testing_enabled.go index 85fdb85ed4b..8b907a7090a 100644 --- a/bundle/config/validate/pipeline_testing_enabled.go +++ b/bundle/config/validate/pipeline_testing_enabled.go @@ -3,8 +3,6 @@ package validate import ( "context" "fmt" - "maps" - "slices" "github.com/databricks/cli/bundle" "github.com/databricks/cli/bundle/env" @@ -28,22 +26,22 @@ func (v *pipelineTestingEnabled) Apply(ctx context.Context, b *bundle.Bundle) di return nil } var diags diag.Diagnostics - pipelines := b.Config.Resources.Pipelines - for _, key := range slices.Sorted(maps.Keys(pipelines)) { - if pipelines[key] == nil || pipelines[key].Testing == nil { - continue - } - path := dyn.NewPath(dyn.Key("resources"), dyn.Key("pipelines"), dyn.Key(key), dyn.Key("testing")) - value, err := dyn.GetByPath(b.Config.Value(), path) - if err != nil { - return diag.FromErr(err) + pattern := dyn.NewPattern(dyn.Key("resources"), dyn.Key("pipelines"), dyn.AnyKey(), dyn.Key("testing")) + _, err := dyn.MapByPattern(b.Config.Value(), pattern, func(p dyn.Path, v dyn.Value) (dyn.Value, error) { + // "testing:" without a value is not set, as in the typed configuration. + if v.Kind() == dyn.KindNil { + return v, nil } diags = append(diags, diag.Diagnostic{ Severity: diag.Error, Summary: fmt.Sprintf("the testing property of pipelines is experimental. Set %s=true to enable it", env.ExperimentalPipelineTestingVariable), - Locations: value.Locations(), - Paths: dyn.ToStructPaths(path), + Locations: v.Locations(), + Paths: dyn.ToStructPaths(p), }) + return v, nil + }) + if err != nil { + return diag.FromErr(err) } return diags } diff --git a/bundle/config/validate/pipeline_testing_enabled_test.go b/bundle/config/validate/pipeline_testing_enabled_test.go deleted file mode 100644 index 126013c10fe..00000000000 --- a/bundle/config/validate/pipeline_testing_enabled_test.go +++ /dev/null @@ -1,42 +0,0 @@ -package validate - -import ( - "testing" - - "github.com/databricks/cli/bundle" - "github.com/databricks/cli/bundle/config" - "github.com/databricks/cli/bundle/config/resources" - "github.com/databricks/cli/bundle/env" - "github.com/databricks/cli/bundle/internal/bundletest" - "github.com/databricks/cli/libs/diag" - libsenv "github.com/databricks/cli/libs/env" - "github.com/databricks/databricks-sdk-go/service/pipelines" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" -) - -func TestPipelineTestingEnabled(t *testing.T) { - b := &bundle.Bundle{ - Config: config.Root{ - Resources: config.Resources{ - Pipelines: map[string]*resources.Pipeline{ - "orders": {CreatePipeline: pipelines.CreatePipeline{Testing: &pipelines.PipelineTesting{}}}, - "reports": {}, - }, - }, - }, - } - loc := diag.Location{File: "databricks.yml", Line: 9, Column: 9} - bundletest.SetLocation(b, "resources.pipelines.orders.testing", []diag.Location{loc}) - - diags := PipelineTestingEnabled().Apply(t.Context(), b) - require.Len(t, diags, 1) - assert.Equal(t, diag.Error, diags[0].Severity) - assert.Contains(t, diags[0].Summary, env.ExperimentalPipelineTestingVariable) - assert.Equal(t, []diag.Location{loc}, diags[0].Locations) - require.Len(t, diags[0].Paths, 1) - assert.Equal(t, "resources.pipelines.orders.testing", diags[0].Paths[0].String()) - - ctx := libsenv.Set(t.Context(), env.ExperimentalPipelineTestingVariable, "true") - assert.Empty(t, PipelineTestingEnabled().Apply(ctx, b)) -} From 115d175d7acb284e4127db0735ae27806fa0bee9 Mon Sep 17 00:00:00 2001 From: Bhukya Date: Tue, 17 Nov 2026 15:50:16 +0000 Subject: [PATCH 3/3] Accept the testing property of pipelines without an environment variable The Go SDK now has the testing field, so the property needs no separate opt-in. Co-authored-by: Isaac --- .../resources/pipelines/testing/output.txt | 15 ------ .../bundle/resources/pipelines/testing/script | 3 -- .../resources/pipelines/testing/test.toml | 1 - .../validate/pipeline_testing_enabled.go | 47 ------------------- bundle/env/experimental_pipeline_testing.go | 17 ------- bundle/internal/schema/annotations.yml | 2 +- bundle/phases/initialize.go | 4 -- bundle/schema/jsonschema.json | 2 +- .../bundles/pipelines/_models/pipeline.py | 4 +- 9 files changed, 4 insertions(+), 91 deletions(-) delete mode 100644 bundle/config/validate/pipeline_testing_enabled.go delete mode 100644 bundle/env/experimental_pipeline_testing.go diff --git a/acceptance/bundle/resources/pipelines/testing/output.txt b/acceptance/bundle/resources/pipelines/testing/output.txt index 6133e93eb75..edb0eb1c49a 100644 --- a/acceptance/bundle/resources/pipelines/testing/output.txt +++ b/acceptance/bundle/resources/pipelines/testing/output.txt @@ -16,18 +16,3 @@ } ] } - -=== Without pipeline testing, the property is an error - ->>> musterr env -u DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING [CLI] bundle validate -Error: the testing property of pipelines is experimental. Set DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true to enable it - at resources.pipelines.orders.testing - in databricks.yml:12:9 - -Name: pipeline-testing -Target: default -Workspace: - User: [USERNAME] - Path: /Workspace/Users/[USERNAME]/.bundle/pipeline-testing/default - -Found 1 error diff --git a/acceptance/bundle/resources/pipelines/testing/script b/acceptance/bundle/resources/pipelines/testing/script index 1dc320485b7..b7f915f687c 100644 --- a/acceptance/bundle/resources/pipelines/testing/script +++ b/acceptance/bundle/resources/pipelines/testing/script @@ -1,4 +1 @@ trace $CLI bundle validate -o json | jq .resources.pipelines.orders.testing - -title "Without pipeline testing, the property is an error" -trace musterr env -u DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING $CLI bundle validate diff --git a/acceptance/bundle/resources/pipelines/testing/test.toml b/acceptance/bundle/resources/pipelines/testing/test.toml index 965c596a302..25d8c36639f 100644 --- a/acceptance/bundle/resources/pipelines/testing/test.toml +++ b/acceptance/bundle/resources/pipelines/testing/test.toml @@ -2,4 +2,3 @@ Cloud = false RecordRequests = true Ignore = [".databricks"] -Env.DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING = "true" diff --git a/bundle/config/validate/pipeline_testing_enabled.go b/bundle/config/validate/pipeline_testing_enabled.go deleted file mode 100644 index 8b907a7090a..00000000000 --- a/bundle/config/validate/pipeline_testing_enabled.go +++ /dev/null @@ -1,47 +0,0 @@ -package validate - -import ( - "context" - "fmt" - - "github.com/databricks/cli/bundle" - "github.com/databricks/cli/bundle/env" - "github.com/databricks/cli/libs/diag" - "github.com/databricks/cli/libs/dyn" -) - -type pipelineTestingEnabled struct{ bundle.RO } - -// PipelineTestingEnabled rejects the testing property of pipelines while the experimental feature is off. -func PipelineTestingEnabled() bundle.ReadOnlyMutator { - return &pipelineTestingEnabled{} -} - -func (v *pipelineTestingEnabled) Name() string { - return "validate:pipeline_testing_enabled" -} - -func (v *pipelineTestingEnabled) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics { - if env.ExperimentalPipelineTesting(ctx) { - return nil - } - var diags diag.Diagnostics - pattern := dyn.NewPattern(dyn.Key("resources"), dyn.Key("pipelines"), dyn.AnyKey(), dyn.Key("testing")) - _, err := dyn.MapByPattern(b.Config.Value(), pattern, func(p dyn.Path, v dyn.Value) (dyn.Value, error) { - // "testing:" without a value is not set, as in the typed configuration. - if v.Kind() == dyn.KindNil { - return v, nil - } - diags = append(diags, diag.Diagnostic{ - Severity: diag.Error, - Summary: fmt.Sprintf("the testing property of pipelines is experimental. Set %s=true to enable it", env.ExperimentalPipelineTestingVariable), - Locations: v.Locations(), - Paths: dyn.ToStructPaths(p), - }) - return v, nil - }) - if err != nil { - return diag.FromErr(err) - } - return diags -} diff --git a/bundle/env/experimental_pipeline_testing.go b/bundle/env/experimental_pipeline_testing.go deleted file mode 100644 index b00a94176e9..00000000000 --- a/bundle/env/experimental_pipeline_testing.go +++ /dev/null @@ -1,17 +0,0 @@ -package env - -import ( - "context" - - envlib "github.com/databricks/cli/libs/env" -) - -// ExperimentalPipelineTestingVariable enables the experimental testing property of pipelines. -const ExperimentalPipelineTestingVariable = "DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING" - -// ExperimentalPipelineTesting reports whether the experimental testing property of pipelines is -// enabled. While it is off, bundles deploy pipelines exactly as they did before the property existed. -func ExperimentalPipelineTesting(ctx context.Context) bool { - enabled, _ := envlib.GetBool(ctx, ExperimentalPipelineTestingVariable) - return enabled -} diff --git a/bundle/internal/schema/annotations.yml b/bundle/internal/schema/annotations.yml index 1a0018f2598..41a3b0084d0 100644 --- a/bundle/internal/schema/annotations.yml +++ b/bundle/internal/schema/annotations.yml @@ -1467,7 +1467,7 @@ resources: The name of the user granted the permission level. "testing": "description": |- - The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. It is experimental and needs `DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true`. + The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. "$fields": "environment": "$fields": diff --git a/bundle/phases/initialize.go b/bundle/phases/initialize.go index b4a08596bb1..8c5a68d3130 100644 --- a/bundle/phases/initialize.go +++ b/bundle/phases/initialize.go @@ -166,10 +166,6 @@ func Initialize(ctx context.Context, b *bundle.Bundle) { // Must run after PythonMutator to see development values set by Python mutators. validate.PipelineDevelopmentDeprecated(), - // Reject the experimental testing property of pipelines while it is off. Must run after - // PythonMutator, which can set testing, and before TranslatePaths and the deploy use it. - validate.PipelineTestingEnabled(), - // Compute resources.volumes.*.volume_path and resolve references to it. Must run after // PythonMutator: volume_path is computed and read-only, not declared by the PyDABs Volume // model, so exposing it to Python would fail resource loading (like "deployment" below). diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index d3119d19d47..b45eb01c7a4 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -2454,7 +2454,7 @@ "deprecated": true }, "testing": { - "description": "[Private Preview] The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. It is experimental and needs `DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true`.", + "description": "[Private Preview] The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineTesting", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true diff --git a/python/databricks/bundles/pipelines/_models/pipeline.py b/python/databricks/bundles/pipelines/_models/pipeline.py index 6a4551c3407..c33ade8cd12 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline.py +++ b/python/databricks/bundles/pipelines/_models/pipeline.py @@ -266,7 +266,7 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - [Private Preview] The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. It is experimental and needs `DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true`. + [Private Preview] The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. """ usage_policy_id: VariableOrOptional[str] = None @@ -490,7 +490,7 @@ class PipelineDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. It is experimental and needs `DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_PIPELINE_TESTING=true`. + [Private Preview] The test configuration of the pipeline. Only test-only updates, such as those started by `databricks pipelines test`, use it. """ usage_policy_id: VariableOrOptional[str]