add RequireOutputJQ - WIP, just prints patches for now

Author: denik

go.mod

@@ -25,6 +25,7 @@ require (
 	github.com/spf13/cobra v1.8.1 // Apache 2.0
 	github.com/spf13/pflag v1.0.5 // BSD-3-Clause
 	github.com/stretchr/testify v1.10.0 // MIT
+	github.com/wI2L/jsondiff v0.6.1 // MIT
 	golang.org/x/exp v0.0.0-20240222234643-814bf88cf225
 	golang.org/x/mod v0.22.0
 	golang.org/x/oauth2 v0.24.0
@@ -58,6 +59,10 @@ require (
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/stretchr/objx v0.5.2 // indirect
+	github.com/tidwall/gjson v1.18.0 // indirect
+	github.com/tidwall/match v1.1.1 // indirect
+	github.com/tidwall/pretty v1.2.1 // indirect
+	github.com/tidwall/sjson v1.2.5 // indirect
 	github.com/zclconf/go-cty v1.15.0 // indirect
 	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect

go.sum

@@ -110,5 +110,5 @@ func testDefaultPython(t *testing.T, pythonVersion string) {
 		testcli.RequireSuccessfulRun(t, ctx, "bundle", "destroy", "--auto-approve")
 	})
 
-	testcli.RequireOutput(t, ctx, []string{"bundle", "summary", "--output", "json"}, "testdata/default_python/bundle_summary.txt")
+	testcli.RequireOutputJQ(t, ctx, []string{"bundle", "summary", "--output", "json"}, "testdata/default_python/bundle_summary.txt", []string{"/hello"})
 }

integration/bundle/init_default_python_test.go

@@ -17,6 +17,7 @@ import (
 	"github.com/elliotchance/orderedmap/v3"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"github.com/wI2L/jsondiff"
 )
 
 func ReadFile(t testutil.TestingT, ctx context.Context, filename string) string {
@@ -34,28 +35,62 @@ func WriteFile(t testutil.TestingT, ctx context.Context, filename, data string)
 	require.NoError(t, err)
 }
 
-func RequireOutput(t testutil.TestingT, ctx context.Context, args []string, expectedFilename string) {
-	_, filename, _, _ := runtime.Caller(1)
-	dir := filepath.Dir(filename)
-	expected := ReadFile(t, ctx, filepath.Join(dir, expectedFilename))
-
+func captureOutput(t testutil.TestingT, ctx context.Context, args []string) string {
 	t.Logf("run args: [%s]", strings.Join(args, ", "))
 	r := NewRunner(t, ctx, args...)
 	stdout, stderr, err := r.Run()
 	require.NoError(t, err)
 	out := stderr.String() + stdout.String()
+	return ReplaceOutput(t, ctx, out)
+}
 
-	out = ReplaceOutput(t, ctx, out)
+func assertEqualTexts(t testutil.TestingT, filename1, filename2, expected, out string) {
+	if len(out) < 1000 && len(expected) < 1000 {
+		// This shows full strings + diff which could be useful when debugging newlines
+		assert.Equal(t, expected, out)
+	} else {
+		// only show diff for large texts
+		diff := testutil.Diff(filename1, filename2, expected, out)
+		t.Errorf("Diff:\n" + diff)
+	}
+}
+
+func RequireOutput(t testutil.TestingT, ctx context.Context, args []string, expectedFilename string) {
+	_, filename, _, _ := runtime.Caller(1)
+	dir := filepath.Dir(filename)
+	expectedPath := filepath.Join(dir, expectedFilename)
+	expected := ReadFile(t, ctx, expectedPath)
+
+	out := captureOutput(t, ctx, args)
 
 	if out != expected {
-		if len(out) < 1000 && len(expected) < 1000 {
-			// This shows full strings + diff which could be useful when debugging newlines
-			assert.Equal(t, expected, out)
-		} else {
-			// only show diff for large texts
+		actual := fmt.Sprintf("Output from %v", args)
+		assertEqualTexts(t, expectedFilename, actual, expected, out)
+
+		if os.Getenv("TESTS_OUTPUT") == "OVERWRITE" {
+			WriteFile(t, ctx, expectedPath, out)
+		}
+	}
+}
+
+func RequireOutputJQ(t testutil.TestingT, ctx context.Context, args []string, expectedFilename string, ignorePaths []string) {
+	_, filename, _, _ := runtime.Caller(1)
+	dir := filepath.Dir(filename)
+	expectedPath := filepath.Join(dir, expectedFilename)
+	expected := ReadFile(t, ctx, expectedPath)
+
+	out := captureOutput(t, ctx, args)
+
+	if out != expected {
+		patch, err := jsondiff.CompareJSON([]byte(expected), []byte(out))
+		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)
-			diff := testutil.Diff(expectedFilename, actual, expected, out)
-			t.Errorf("Diff:\n" + diff)
+			assertEqualTexts(t, expectedFilename, actual, expected, out)
+		} else {
+			for _, op := range patch {
+				t.Errorf("PATCH %s %s: %s", args, expectedFilename, op)
+			}
 		}
 
 		if os.Getenv("TESTS_OUTPUT") == "OVERWRITE" {