fix: json output fixed while printing warnings (#1589)

* fix: json output fixed while printing warnings

* chore: updated gdr version to v1.22.3

Author: Prashansa-K

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/fatih/color v1.18.0
 	github.com/google/go-cmp v0.7.0
 	github.com/kong/go-apiops v0.1.41
-	github.com/kong/go-database-reconciler v1.22.2
+	github.com/kong/go-database-reconciler v1.22.3
 	github.com/kong/go-kong v0.65.0
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/spf13/cobra v1.8.1

go.sum

@@ -246,8 +246,8 @@ github.com/klauspost/cpuid/v2 v2.2.5 h1:0E5MSMDEoAulmXNFquVs//DdoomxaoTY1kUhbc/q
 github.com/klauspost/cpuid/v2 v2.2.5/go.mod h1:Lcz8mBdAVJIBVzewtcLocK12l3Y+JytZYpaMropDUws=
 github.com/kong/go-apiops v0.1.41 h1:1KXbQqyhO2E4nEnXJNqUDmHZU/LQ1U7Zoi+MAlcM2P0=
 github.com/kong/go-apiops v0.1.41/go.mod h1:sATq9Tz+ivzHKZU+tDXkRtEZnf64xroU3lgv3yXqP4I=
-github.com/kong/go-database-reconciler v1.22.2 h1:YNSDkwgdLGcjHbdbNP9JW/CjhPn0NDMrnWOvG4QDmLc=
-github.com/kong/go-database-reconciler v1.22.2/go.mod h1:Jlo4eEe0/PHd2dIkWTH9tFfShydRwRxY09dZvKZBelU=
+github.com/kong/go-database-reconciler v1.22.3 h1:H7austovtuMGWnRgpP8pQPAJXknSCnTHgwRyO6ilWJg=
+github.com/kong/go-database-reconciler v1.22.3/go.mod h1:Jlo4eEe0/PHd2dIkWTH9tFfShydRwRxY09dZvKZBelU=
 github.com/kong/go-kong v0.65.0 h1:dZT+hiMhy7CQsrc9W5nHv3cFJGBGTrwlZhC5MLuf9H8=
 github.com/kong/go-kong v0.65.0/go.mod h1:sqdysTKrXIJ6mpxHwTwjgZhLW7jR1/puczTXHLUwJaE=
 github.com/kong/go-slugify v1.0.0 h1:vCFAyf2sdoSlBtLcrmDWUFn0ohlpKiKvQfXZkO5vSKY=

tests/integration/sync_test.go

@@ -6,12 +6,16 @@ import (
 	"context"
 	"crypto/tls"
 	"crypto/x509"
+	"encoding/json"
 	"errors"
 	"fmt"
+	"io"
 	"net/http"
+	"os"
 	"testing"
 	"time"
 
+	"github.com/fatih/color"
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	deckDump "github.com/kong/go-database-reconciler/pkg/dump"
@@ -7441,6 +7445,44 @@ func Test_Sync_ConsumerGroupPlugin_Policy_Overrides_34x(t *testing.T) {
 		require.Error(t, err)
 		assert.ErrorContains(t, err, errorConsumerGroupPolicies)
 	})
+
+	t.Run("checking for valid json output while using --consumer-group-policy-overrides = true", func(t *testing.T) {
+		// overwrite default standard output
+		r, w, err := os.Pipe()
+		require.NoError(t, err)
+		color.Output = w
+
+		require.NoError(t, sync(ctx, "testdata/sync/037-consumer-group-policy-overrides/kong34x-no-info.yaml",
+			"--consumer-group-policy-overrides", "--json-output"))
+
+		// read command output
+		w.Close()
+		out, err := io.ReadAll(r)
+		require.NoError(t, err)
+		require.NotNil(t, out)
+
+		var js interface{}
+		assert.NoError(t, json.Unmarshal(out, &js), "JSON validation failed")
+	})
+
+	t.Run("checking for valid json output while using consumer-group-policy-overrides in info block", func(t *testing.T) {
+		// overwrite default standard output
+		r, w, err := os.Pipe()
+		require.NoError(t, err)
+		color.Output = w
+
+		require.NoError(t, sync(ctx, "testdata/sync/037-consumer-group-policy-overrides/kong34x.yaml",
+			"--json-output"))
+
+		// read command output
+		w.Close()
+		out, err := io.ReadAll(r)
+		require.NoError(t, err)
+		require.NotNil(t, out)
+
+		var js interface{}
+		assert.NoError(t, json.Unmarshal(out, &js), "JSON validation failed")
+	})
 }
 
 // test scope:
@@ -7563,6 +7605,44 @@ func Test_Sync_ConsumerGroupPlugin_Policy_Overrides_38x(t *testing.T) {
 		require.Error(t, err)
 		assert.ErrorContains(t, err, errorConsumerGroupPolicies)
 	})
+
+	t.Run("checking for valid json output while using --consumer-group-policy-overrides = true", func(t *testing.T) {
+		// overwrite default standard output
+		r, w, err := os.Pipe()
+		require.NoError(t, err)
+		color.Output = w
+
+		require.NoError(t, sync(ctx, "testdata/sync/037-consumer-group-policy-overrides/kong38x-no-info.yaml",
+			"--consumer-group-policy-overrides", "--json-output"))
+
+		// read command output
+		w.Close()
+		out, err := io.ReadAll(r)
+		require.NoError(t, err)
+		require.NotNil(t, out)
+
+		var js interface{}
+		assert.NoError(t, json.Unmarshal(out, &js), "JSON validation failed")
+	})
+
+	t.Run("checking for valid json output while using consumer-group-policy-overrides in info block", func(t *testing.T) {
+		// overwrite default standard output
+		r, w, err := os.Pipe()
+		require.NoError(t, err)
+		color.Output = w
+
+		require.NoError(t, sync(ctx, "testdata/sync/037-consumer-group-policy-overrides/kong38x.yaml",
+			"--json-output"))
+
+		// read command output
+		w.Close()
+		out, err := io.ReadAll(r)
+		require.NoError(t, err)
+		require.NotNil(t, out)
+
+		var js interface{}
+		assert.NoError(t, json.Unmarshal(out, &js), "JSON validation failed")
+	})
 }
 
 // test scope:
@@ -7688,6 +7768,44 @@ func Test_Sync_ConsumerGroupPlugin_Policy_Overrides_39x(t *testing.T) {
 		require.Error(t, err)
 		assert.ErrorContains(t, err, errorConsumerGroupPolicies)
 	})
+
+	t.Run("checking for valid json output while using --consumer-group-policy-overrides = true", func(t *testing.T) {
+		// overwrite default standard output
+		r, w, err := os.Pipe()
+		require.NoError(t, err)
+		color.Output = w
+
+		require.NoError(t, sync(ctx, "testdata/sync/037-consumer-group-policy-overrides/kong39x-no-info.yaml",
+			"--consumer-group-policy-overrides", "--json-output"))
+
+		// read command output
+		w.Close()
+		out, err := io.ReadAll(r)
+		require.NoError(t, err)
+		require.NotNil(t, out)
+
+		var js interface{}
+		assert.NoError(t, json.Unmarshal(out, &js), "JSON validation failed")
+	})
+
+	t.Run("checking for valid json output while using consumer-group-policy-overrides in info block", func(t *testing.T) {
+		// overwrite default standard output
+		r, w, err := os.Pipe()
+		require.NoError(t, err)
+		color.Output = w
+
+		require.NoError(t, sync(ctx, "testdata/sync/037-consumer-group-policy-overrides/kong39x.yaml",
+			"--json-output"))
+
+		// read command output
+		w.Close()
+		out, err := io.ReadAll(r)
+		require.NoError(t, err)
+		require.NotNil(t, out)
+
+		var js interface{}
+		assert.NoError(t, json.Unmarshal(out, &js), "JSON validation failed")
+	})
 }
 
 func Test_Sync_SkipConsumersWithConsumerGroups(t *testing.T) {