github.com/m3db/m3@v1.5.0/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  	"testing"
    26  
    27  	xjson "github.com/m3db/m3/src/x/json"
    28  
    29  	"github.com/sergi/go-diff/diffmatchpatch"
    30  	"github.com/stretchr/testify/require"
    31  )
    32  
    33  // Diff is a helper method to print a terminal pretty diff of two strings
    34  // for test output purposes.
    35  func Diff(expected, actual string) string {
    36  	dmp := diffmatchpatch.New()
    37  	diffs := dmp.DiffMain(expected, actual, false)
    38  	return dmp.DiffPrettyText(diffs)
    39  }
    40  
    41  // MustPrettyJSONMap returns an indented JSON string of the object.
    42  func MustPrettyJSONMap(t *testing.T, value xjson.Map) string {
    43  	pretty, err := json.MarshalIndent(value, "", "  ")
    44  	require.NoError(t, err)
    45  	return string(pretty)
    46  }
    47  
    48  // MustPrettyJSONArray returns an indented JSON string of the object.
    49  func MustPrettyJSONArray(t *testing.T, value xjson.Array) string {
    50  	pretty, err := json.MarshalIndent(value, "", "  ")
    51  	require.NoError(t, err)
    52  	return string(pretty)
    53  }
    54  
    55  // MustPrettyJSONString returns an indented version of the JSON.
    56  func MustPrettyJSONString(t *testing.T, str string) string {
    57  	var unmarshalled map[string]interface{}
    58  	err := json.Unmarshal([]byte(str), &unmarshalled)
    59  	require.NoError(t, err)
    60  	pretty, err := json.MarshalIndent(unmarshalled, "", "  ")
    61  	require.NoError(t, err)
    62  	return string(pretty)
    63  }