github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/test/diff.go (about)

     1  // Copyright (c) 2017 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package test
    22  
    23  import (
    24  	"encoding/json"
    25  
    26  	"github.com/sergi/go-diff/diffmatchpatch"
    27  	"github.com/stretchr/testify/require"
    28  
    29  	xjson "github.com/m3db/m3/src/x/json"
    30  )
    31  
    32  // Diff is a helper method to print a terminal pretty diff of two strings
    33  // for test output purposes.
    34  func Diff(expected, actual string) string {
    35  	dmp := diffmatchpatch.New()
    36  	diffs := dmp.DiffMain(expected, actual, false)
    37  	return dmp.DiffPrettyText(diffs)
    38  }
    39  
    40  // MustPrettyJSONMap returns an indented JSON string of the object.
    41  func MustPrettyJSONMap(t require.TestingT, value xjson.Map) string {
    42  	pretty, err := json.MarshalIndent(value, "", "  ")
    43  	require.NoError(t, err)
    44  	return string(pretty)
    45  }
    46  
    47  // MustPrettyJSONArray returns an indented JSON string of the object.
    48  func MustPrettyJSONArray(t require.TestingT, value xjson.Array) string {
    49  	pretty, err := json.MarshalIndent(value, "", "  ")
    50  	require.NoError(t, err)
    51  	return string(pretty)
    52  }
    53  
    54  // MustPrettyJSONObject returns an indented JSON string of the object.
    55  func MustPrettyJSONObject(t require.TestingT, value interface{}) string {
    56  	pretty, err := json.MarshalIndent(value, "", "  ")
    57  	require.NoError(t, err)
    58  	return string(pretty)
    59  }
    60  
    61  // MustPrettyJSONString returns an indented version of the JSON.
    62  func MustPrettyJSONString(t require.TestingT, str string) string {
    63  	var unmarshalled map[string]interface{}
    64  	err := json.Unmarshal([]byte(str), &unmarshalled)
    65  	require.NoError(t, err)
    66  	pretty, err := json.MarshalIndent(unmarshalled, "", "  ")
    67  	require.NoError(t, err)
    68  	return string(pretty)
    69  }