Switch to using `[` from `<` in text replacements (#2224)

## Changes Noticed this when working on https://github.com/databricks/cli/pull/2221. `<` is a special HTML character that is encoded during text replacement when using `AssertEqualTexts`. ## Tests N/A
2025-01-28 16:24:23 +05:30 · 2025-01-28 16:24:23 +05:30 · 65e4f79dfe
parent 3ffac80007
commit 65e4f79dfe
13 changed files with 24 additions and 24 deletions
--- a/acceptance/bundle/templates/dbt-sql/output/my_dbt_sql/databricks.yml
+++ b/acceptance/bundle/templates/dbt-sql/output/my_dbt_sql/databricks.yml
@ -3,7 +3,7 @@
 # See https://docs.databricks.com/dev-tools/bundles/index.html for documentation.
 bundle:
  name: my_dbt_sql
-  uuid: <UUID>
+  uuid: [UUID]

 include:
  - resources/*.yml
--- a/acceptance/bundle/templates/default-python/output/my_default_python/databricks.yml
+++ b/acceptance/bundle/templates/default-python/output/my_default_python/databricks.yml
@ -2,7 +2,7 @@
 # See https://docs.databricks.com/dev-tools/bundles/index.html for documentation.
 bundle:
  name: my_default_python
-  uuid: <UUID>
+  uuid: [UUID]

 include:
  - resources/*.yml
--- a/acceptance/bundle/templates/default-python/output/my_default_python/scratch/exploration.ipynb
+++ b/acceptance/bundle/templates/default-python/output/my_default_python/scratch/exploration.ipynb
@ -20,7 +20,7 @@
      "rowLimit": 10000
     },
     "inputWidgets": {},
-     "nuid": "<UUID>",
+     "nuid": "[UUID]",
     "showTitle": false,
     "title": ""
    }
--- a/acceptance/bundle/templates/default-python/output/my_default_python/src/dlt_pipeline.ipynb
+++ b/acceptance/bundle/templates/default-python/output/my_default_python/src/dlt_pipeline.ipynb
@ -6,7 +6,7 @@
    "application/vnd.databricks.v1+cell": {
     "cellMetadata": {},
     "inputWidgets": {},
-     "nuid": "<UUID>",
+     "nuid": "[UUID]",
     "showTitle": false,
     "title": ""
    }
@ -24,7 +24,7 @@
    "application/vnd.databricks.v1+cell": {
     "cellMetadata": {},
     "inputWidgets": {},
-     "nuid": "<UUID>",
+     "nuid": "[UUID]",
     "showTitle": false,
     "title": ""
    }
@ -47,7 +47,7 @@
    "application/vnd.databricks.v1+cell": {
     "cellMetadata": {},
     "inputWidgets": {},
-     "nuid": "<UUID>",
+     "nuid": "[UUID]",
     "showTitle": false,
     "title": ""
    }
--- a/acceptance/bundle/templates/default-python/output/my_default_python/src/notebook.ipynb
+++ b/acceptance/bundle/templates/default-python/output/my_default_python/src/notebook.ipynb
@ -6,7 +6,7 @@
    "application/vnd.databricks.v1+cell": {
     "cellMetadata": {},
     "inputWidgets": {},
-     "nuid": "<UUID>",
+     "nuid": "[UUID]",
     "showTitle": false,
     "title": ""
    }
@ -37,7 +37,7 @@
      "rowLimit": 10000
     },
     "inputWidgets": {},
-     "nuid": "<UUID>",
+     "nuid": "[UUID]",
     "showTitle": false,
     "title": ""
    }
--- a/acceptance/bundle/templates/default-sql/output/my_default_sql/databricks.yml
+++ b/acceptance/bundle/templates/default-sql/output/my_default_sql/databricks.yml
@ -2,7 +2,7 @@
 # See https://docs.databricks.com/dev-tools/bundles/index.html for documentation.
 bundle:
  name: my_default_sql
-  uuid: <UUID>
+  uuid: [UUID]

 include:
  - resources/*.yml
--- a/acceptance/bundle/templates/default-sql/output/my_default_sql/scratch/exploration.ipynb
+++ b/acceptance/bundle/templates/default-sql/output/my_default_sql/scratch/exploration.ipynb
@ -7,7 +7,7 @@
    "application/vnd.databricks.v1+cell": {
     "cellMetadata": {},
     "inputWidgets": {},
-     "nuid": "<UUID>",
+     "nuid": "[UUID]",
     "showTitle": false,
     "title": ""
    }
--- a/acceptance/bundle/templates/experimental-jobs-as-code/output/my_jobs_as_code/databricks.yml
+++ b/acceptance/bundle/templates/experimental-jobs-as-code/output/my_jobs_as_code/databricks.yml
@ -2,7 +2,7 @@
 # See https://docs.databricks.com/dev-tools/bundles/index.html for documentation.
 bundle:
  name: my_jobs_as_code
-  uuid: <UUID>
+  uuid: [UUID]
  databricks_cli_version: ">= 0.238.0"

 experimental:
--- a/acceptance/bundle/templates/experimental-jobs-as-code/output/my_jobs_as_code/src/notebook.ipynb
+++ b/acceptance/bundle/templates/experimental-jobs-as-code/output/my_jobs_as_code/src/notebook.ipynb
@ -6,7 +6,7 @@
    "application/vnd.databricks.v1+cell": {
     "cellMetadata": {},
     "inputWidgets": {},
-     "nuid": "<UUID>",
+     "nuid": "[UUID]",
     "showTitle": false,
     "title": ""
    }
@ -37,7 +37,7 @@
      "rowLimit": 10000
     },
     "inputWidgets": {},
-     "nuid": "<UUID>",
+     "nuid": "[UUID]",
     "showTitle": false,
     "title": ""
    }
--- a/integration/bundle/testdata/default_python/bundle_deploy.txt
+++ b/integration/bundle/testdata/default_python/bundle_deploy.txt
@ -1,5 +1,5 @@
 Building project_name_$UNIQUE_PRJ...
-Uploading project_name_$UNIQUE_PRJ-0.0.1+<NUMID>.<NUMID>-py3-none-any.whl...
+Uploading project_name_$UNIQUE_PRJ-0.0.1+[NUMID].[NUMID]-py3-none-any.whl...
 Uploading bundle files to /Workspace/Users/$USERNAME/.bundle/project_name_$UNIQUE_PRJ/dev/files...
 Deploying resources...
 Updating deployment state...
--- a/integration/bundle/testdata/default_python/bundle_summary.txt
+++ b/integration/bundle/testdata/default_python/bundle_summary.txt
@ -16,7 +16,7 @@
        "enabled": false
      }
    },
-    "uuid": "<UUID>"
+    "uuid": "[UUID]"
  },
  "include": [
    "resources/project_name_$UNIQUE_PRJ.job.yml",
@ -74,7 +74,7 @@
          ]
        },
        "format": "MULTI_TASK",
-        "id": "<NUMID>",
+        "id": "[NUMID]",
        "job_clusters": [
          {
            "job_cluster_key": "job_cluster",
@ -141,7 +141,7 @@
            "unit": "DAYS"
          }
        },
-        "url": "$DATABRICKS_URL/jobs/<NUMID>?o=<NUMID>"
+        "url": "$DATABRICKS_URL/jobs/[NUMID]?o=[NUMID]"
      }
    },
    "pipelines": {
@ -155,7 +155,7 @@
          "metadata_file_path": "/Workspace/Users/$USERNAME/.bundle/project_name_$UNIQUE_PRJ/dev/state/metadata.json"
        },
        "development": true,
-        "id": "<UUID>",
+        "id": "[UUID]",
        "libraries": [
          {
            "notebook": {
@ -165,7 +165,7 @@
        ],
        "name": "[dev $USERNAME] project_name_$UNIQUE_PRJ_pipeline",
        "target": "project_name_$UNIQUE_PRJ_dev",
-        "url": "$DATABRICKS_URL/pipelines/<UUID>?o=<NUMID>"
+        "url": "$DATABRICKS_URL/pipelines/[UUID]?o=[NUMID]"
      }
    }
  },
@ -183,4 +183,4 @@
      "dev": "$USERNAME"
    }
  }
-}
+}
--- a/libs/testdiff/replacement.go
+++ b/libs/testdiff/replacement.go
@ -201,12 +201,12 @@ func PrepareReplacementsUser(t testutil.TestingT, r *ReplacementsContext, u iam.

 func PrepareReplacementsUUID(t testutil.TestingT, r *ReplacementsContext) {
 	t.Helper()
-	r.append(uuidRegex, "<UUID>")
+	r.append(uuidRegex, "[UUID]")
 }

 func PrepareReplacementsNumber(t testutil.TestingT, r *ReplacementsContext) {
 	t.Helper()
-	r.append(numIdRegex, "<NUMID>")
+	r.append(numIdRegex, "[NUMID]")
 }

 func PrepareReplacementsTemporaryDirectory(t testutil.TestingT, r *ReplacementsContext) {
--- a/libs/testdiff/replacement_test.go
+++ b/libs/testdiff/replacement_test.go
@ -25,7 +25,7 @@ func TestReplacement_UUID(t *testing.T) {

 	PrepareReplacementsUUID(t, &repls)

-	assert.Equal(t, "<UUID>", repls.Replace("123e4567-e89b-12d3-a456-426614174000"))
+	assert.Equal(t, "[UUID]", repls.Replace("123e4567-e89b-12d3-a456-426614174000"))
 }

 func TestReplacement_Number(t *testing.T) {
@ -34,7 +34,7 @@ func TestReplacement_Number(t *testing.T) {
 	PrepareReplacementsNumber(t, &repls)

 	assert.Equal(t, "12", repls.Replace("12"))
-	assert.Equal(t, "<NUMID>", repls.Replace("123"))
+	assert.Equal(t, "[NUMID]", repls.Replace("123"))
 }

 func TestReplacement_TemporaryDirectory(t *testing.T) {