Fix workspace path normalization to prevent inconsistent plan errors #5130
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #4672 This commit addresses the issue where Databricks API may add or remove the /Workspace prefix in paths depending on workspace configuration, causing Terraform to detect false changes and produce 'inconsistent final plan' errors. Changes: - Added NormalizeWorkspacePath() function in workspace/file_resource.go to normalize path returned from API to match configured path - Updated workspace resources (databricks_workspace_file, databricks_notebook, databricks_directory) to use path normalization in Read operations - Updated SQL resources (databricks_query, databricks_alert) to use path normalization for parent_path field - Fixed bugs in sql/resource_query.go and sql/resource_alert.go where wrong variable was used in path normalization - Added comprehensive unit tests (8 test cases) for path normalization - Added integration test for workspace prefix normalization The fix handles both directions: - Strips /Workspace when API adds it but config doesn't have it - Adds /Workspace when config has it but API doesn't have it This ensures the path in state always matches what user configured, preventing Terraform from detecting drift when there is none.
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
tanmay-db
reviewed
Dec 3, 2025
| } | ||
|
|
||
| // NormalizeWorkspacePath normalizes the path returned from the API to match the configured path. | ||
| // The Databricks API may add or remove the "/Workspace" prefix depending on the workspace configuration. |
Contributor
Author
There was a problem hiding this comment.
I saw it in cases when user edit a job (even without changing anything)
Comment on lines
+211
to
+219
| // Case 1: API added /Workspace prefix, but config doesn't have it | ||
| if strings.HasPrefix(apiPath, "/Workspace") && !strings.HasPrefix(configuredPath, "/Workspace") { | ||
| return strings.TrimPrefix(apiPath, "/Workspace") | ||
| } | ||
|
|
||
| // Case 2: Config has /Workspace prefix, but API doesn't have it | ||
| if !strings.HasPrefix(apiPath, "/Workspace") && strings.HasPrefix(configuredPath, "/Workspace") { | ||
| return "/Workspace" + apiPath | ||
| } |
Contributor
There was a problem hiding this comment.
In both of these cases, shouldn't we ask users to update the config with proper paths?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Fixes #4672
This commit addresses the issue where Databricks API may add or remove the /Workspace prefix in paths depending on workspace configuration, causing Terraform to detect false changes and produce 'inconsistent final plan' errors.
Changes:
The fix handles both directions:
This ensures the path in state always matches what user configured, preventing Terraform from detecting drift when there is none.
Tests
make testrun locallydocs/folderinternal/acceptanceNEXT_CHANGELOG.mdfile