formatter_test.go

package jsondiffprinter_test

import (
	"bytes"
	"encoding/json"
	"fmt"
	"path/filepath"
	"testing"

	"golang.org/x/tools/txtar"

	"github.com/breml/jsondiffprinter"
	"github.com/breml/jsondiffprinter/internal/jsonpatch"
	"github.com/breml/jsondiffprinter/internal/jsonpointer"
	"github.com/breml/jsondiffprinter/internal/require"
)

type metadata struct {
	JSON struct {
		Indentation         *string `json:"indentation"`
		IndentedDiffMarkers *bool   `json:"indentedDiffMarkers"`
		Commas              *bool   `json:"commas"`
		HideUnchanged       *bool   `json:"hideUnchanged"`
		JSONInJSON          *bool   `json:"jsonInJSON"`
	} `json:"json"`
	Terraform struct {
		Indentation   *string `json:"indentation"`
		HideUnchanged *bool   `json:"hideUnchanged"`
		MetadataAdder *bool   `json:"metadataAdder"`
		JSONInJSON    *bool   `json:"jsonInJSON"`
	} `json:"terraform"`
	Metadata map[string]map[string]string `json:"metadata"`
}

func TestFormatter(t *testing.T) {
	files, err := filepath.Glob(filepath.Join("testdata", "generated", "*.txtar"))
	require.NoError(t, err)

	for _, filename := range files {
		filename := filename
		t.Run(filename, func(t *testing.T) {
			txtar, err := txtar.ParseFile(filename)
			require.NoError(t, err)

			var before any
			err = json.Unmarshal(txtarFileByName(t, txtar, "before.json").Data, &before)
			require.NoError(t, err)

			jsonInJSONInvocation := 0
			jsonInJSONCompare := func(before, after any) ([]byte, error) {
				defer func() {
					jsonInJSONInvocation++
				}()

				return txtarFileByName(t, txtar, fmt.Sprintf("jsonInJSON.%d.json", jsonInJSONInvocation)).Data, nil
			}

			if len(txtar.Comment) == 0 {
				txtar.Comment = []byte("{}")
			}

			var metadata metadata
			err = json.Unmarshal(txtar.Comment, &metadata)
			require.NoError(t, err)

			jsonOptions := append([]jsondiffprinter.Option{},
				jsondiffprinter.WithColor(false),
				jsondiffprinter.WithIndentation("  "),
			)

			terraformOptions := append([]jsondiffprinter.Option{},
				jsondiffprinter.WithColor(false),
				jsondiffprinter.WithIndentation("  "),
				jsondiffprinter.WithHideUnchanged(true),
			)

			if metadata.JSON.Indentation != nil {
				jsonOptions = append(jsonOptions, jsondiffprinter.WithIndentation(*metadata.JSON.Indentation))
			}
			if metadata.JSON.IndentedDiffMarkers != nil {
				jsonOptions = append(jsonOptions, jsondiffprinter.WithIndentedDiffMarkers(*metadata.JSON.IndentedDiffMarkers))
			}

			if metadata.JSON.Commas != nil {
				jsonOptions = append(jsonOptions, jsondiffprinter.WithCommas(*metadata.JSON.Commas))
			}

			if metadata.JSON.HideUnchanged != nil {
				jsonOptions = append(jsonOptions, jsondiffprinter.WithHideUnchanged(*metadata.JSON.HideUnchanged))
			}

			if metadata.JSON.JSONInJSON != nil && *metadata.JSON.JSONInJSON == true {
				jsonOptions = append(jsonOptions, jsondiffprinter.WithJSONinJSONCompare(jsonInJSONCompare))
			}

			if metadata.Terraform.Indentation != nil {
				terraformOptions = append(terraformOptions, jsondiffprinter.WithIndentation(*metadata.Terraform.Indentation))
			}

			if metadata.Terraform.HideUnchanged != nil {
				terraformOptions = append(terraformOptions, jsondiffprinter.WithHideUnchanged(*metadata.Terraform.HideUnchanged))
			}

			if metadata.Terraform.MetadataAdder != nil {
				terraformOptions = append(terraformOptions, jsondiffprinter.WithPatchSeriesPostProcess(metadataByJSONPointer(t, metadata.Metadata)))
			}

			if metadata.Terraform.JSONInJSON != nil && *metadata.Terraform.JSONInJSON == true {
				terraformOptions = append(terraformOptions, jsondiffprinter.WithJSONinJSONCompare(jsonInJSONCompare))
			}

			var buf bytes.Buffer
			formatters := []struct {
				name    string
				options []jsondiffprinter.Option

				wantFilename string
			}{
				{
					name:         "json",
					options:      append([]jsondiffprinter.Option{jsondiffprinter.WithWriter(&buf)}, jsonOptions...),
					wantFilename: "diff.json",
				},
				{
					name:         "terraform",
					options:      append([]jsondiffprinter.Option{jsondiffprinter.WithTerraformDefaults(), jsondiffprinter.WithWriter(&buf)}, terraformOptions...),
					wantFilename: "diff.tf",
				},
			}

			for _, formatter := range formatters {
				formatter := formatter
				t.Run(formatter.name, func(t *testing.T) {
					if txtarFileByName(t, txtar, formatter.wantFilename) == nil {
						t.Skip("no want file found")
					}
					jsonInJSONInvocation = 0
					buf.Reset()

					err := jsondiffprinter.Format(before, txtarFileByName(t, txtar, "patch.json").Data, formatter.options...)
					require.NoError(t, err)

					require.EqualStringWithTabwriter(t, string(txtarFileByName(t, txtar, formatter.wantFilename).Data), buf.String())
				})
			}
		})
	}
}

func txtarFileByName(t *testing.T, txtar *txtar.Archive, name string) *txtar.File {
	t.Helper()

	for _, f := range txtar.Files {
		if f.Name == name {
			return &f
		}
	}

	return nil
}

func metadataByJSONPointer(t *testing.T, metadata map[string]map[string]string) func(diff jsonpatch.Patch) jsonpatch.Patch {
	return func(diff jsonpatch.Patch) jsonpatch.Patch {
		for path, value := range metadata {
			ptr := jsonpointer.NewPointerFromPath(path)
			i, found := jsondiffprinter.FindPatchIndex(diff, ptr)
			if !found {
				t.Errorf("path %q not found in diff", path)
			}
			diff[i].Metadata = value

		}

		return diff
	}
}