ignore fields that current mismatch

Author: denik

integration/bundle/init_default_python_test.go

@@ -122,5 +122,16 @@ func testDefaultPython(t *testing.T, pythonVersion string) {
 		testcli.RequireSuccessfulRun(t, ctx, "bundle", "destroy", "--auto-approve")
 	})
 
-	testcli.RequireOutputJQ(t, ctx, []string{"bundle", "summary", "--output", "json"}, "testdata/default_python/bundle_summary.txt", []string{"/hello"})
+	ignoredFields := []string{
+		"/resources/jobs/project_name_$UNIQUE_PRJ_job/email_notifications",
+		"/resources/jobs/project_name_$UNIQUE_PRJ_job/job_clusters/0/new_cluster/node_type_id",
+		"/resources/jobs/project_name_$UNIQUE_PRJ_job/url",
+		"/resources/pipelines/project_name_$UNIQUE_PRJ_pipeline/catalog",
+		"/resources/pipelines/project_name_$UNIQUE_PRJ_pipeline/url",
+		"/workspace/current_user/externalId",
+		"/workspace/current_user/groups",
+		"/workspace/current_user/name/familyName",
+	}
+
+	testcli.RequireOutputJQ(t, ctx, []string{"bundle", "summary", "--output", "json"}, "testdata/default_python/bundle_summary.txt", ignoredFields)
 }

internal/testcli/golden.go

@@ -55,6 +55,11 @@ func assertEqualTexts(t testutil.TestingT, filename1, filename2, expected, out s
 	}
 }
 
+func logDiff(t testutil.TestingT, filename1, filename2, expected, out string) {
+	diff := testutil.Diff(filename1, filename2, expected, out)
+	t.Logf("Diff:\n" + diff)
+}
+
 func RequireOutput(t testutil.TestingT, ctx context.Context, args []string, expectedFilename string) {
 	_, filename, _, _ := runtime.Caller(1)
 	dir := filepath.Dir(filename)
@@ -83,13 +88,26 @@ func RequireOutputJQ(t testutil.TestingT, ctx context.Context, args []string, ex
 
 	if out != expected {
 		patch, err := jsondiff.CompareJSON([]byte(expected), []byte(out))
+		actual := fmt.Sprintf("Output from %v", args)
 		if err != nil {
 			t.Logf("CompareJSON error for %s vs %s: %s (fallback to textual comparison)", args, expectedFilename, err)
-			actual := fmt.Sprintf("Output from %v", args)
 			assertEqualTexts(t, expectedFilename, actual, expected, out)
 		} else {
+			logDiff(t, expectedFilename, actual, expected, out)
+			ignoredDiffs := []string{}
+			erroredDiffs := []string{}
 			for _, op := range patch {
-				t.Errorf("PATCH %s %s: %s", args, expectedFilename, op)
+				if matchesPrefixes(ignorePaths, op.Path) {
+					ignoredDiffs = append(ignoredDiffs, fmt.Sprintf("%7s %s %v", op.Type, op.Path, op.Value))
+				} else {
+					erroredDiffs = append(erroredDiffs, fmt.Sprintf("%7s %s %v", op.Type, op.Path, op.Value))
+				}
+			}
+			if len(ignoredDiffs) > 0 {
+				t.Logf("Ignored differences between %s and %s:\n ==> %s", expectedFilename, args, strings.Join(ignoredDiffs, "\n ==> "))
+			}
+			if len(erroredDiffs) > 0 {
+				t.Errorf("Unexpected differences between %s and %s:\n ==> %s", expectedFilename, args, strings.Join(erroredDiffs, "\n ==> "))
 			}
 		}
 
@@ -99,6 +117,18 @@ func RequireOutputJQ(t testutil.TestingT, ctx context.Context, args []string, ex
 	}
 }
 
+func matchesPrefixes(prefixes []string, path string) bool {
+	for _, p := range prefixes {
+		if p == path {
+			return true
+		}
+		if strings.HasPrefix(path, p+"/") {
+			return true
+		}
+	}
+	return false
+}
+
 var (
 	uuidRegex        = regexp.MustCompile(`[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}`)
 	numIdRegex       = regexp.MustCompile(`[0-9]{3,}`)
@@ -158,18 +188,6 @@ func setKV(replacements *orderedmap.OrderedMap[string, string], key, value strin
 	replacements.Set(key, value)
 }
 
-/*
-func setMissing(replacements *orderedmap.OrderedMap[string, string], key, value string) {
-	if key == "" || value == "" {
-		return
-	}
-	_, exists := replacements.Get(key)
-	if !exists {
-		replacements.Set(key, value)
-	}
-}
-*/
-
 func PrepareReplacements(t testutil.TestingT, replacements *orderedmap.OrderedMap[string, string], w *databricks.WorkspaceClient) {
 	// in some clouds (gcp) w.Config.Host includes "https://" prefix in others it's really just a host (azure)
 	host := strings.TrimPrefix(strings.TrimPrefix(w.Config.Host, "http://"), "https://")
@@ -233,10 +251,6 @@ func PrepareReplacementsUser(t testutil.TestingT, replacements *orderedmap.Order
 		setKV(replacements, val.Value, fmt.Sprintf("$USER.Roles[%d]", ind))
 	}
 
-	for key, val := range replacements.AllFromFront() {
-		fmt.Printf("REPL %v=%v\n", key, val)
-	}
-
 	// Schemas []UserSchema `json:"schemas,omitempty"`
 }
 

internal/testcli/golden_test.go

@@ -11,3 +11,10 @@ func TestSort(t *testing.T) {
 	stableSortReverseLength(input)
 	assert.Equal(t, []string{"bc", "cd", "a"}, input)
 }
+
+func TestMatchesPrefixes(t *testing.T) {
+	assert.False(t, matchesPrefixes([]string{}, ""))
+	assert.False(t, matchesPrefixes([]string{"/hello", "/hello/world"}, ""))
+	assert.True(t, matchesPrefixes([]string{"/hello", "/a/b"}, "/hello"))
+	assert.True(t, matchesPrefixes([]string{"/hello", "/a/b"}, "/a/b/c"))
+}

libs/python/detect.go

@@ -37,9 +37,11 @@ func DetectExecutable(ctx context.Context) (string, error) {
 	if err != nil && !errors.Is(err, exec.ErrNotFound) {
 		return "", err
 	}
+
 	if out != "" {
 		return out, nil
 	}
+
 	// otherwise, detect all interpreters and pick the least that satisfies
 	// minimal version requirements
 	all, err := DetectInterpreters(ctx)