github.com/m3db/m3@v1.5.0/src/x/json/json.go (about)

     1  // Copyright (c) 2020 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 json allows for easy duck typing of JSON, i.e. for test stubs
    22  // to compare JSON output against (such as src/x/test.MustPrettyJSON).
    23  package json
    24  
    25  import (
    26  	"bytes"
    27  	"encoding/json"
    28  	"io"
    29  	"testing"
    30  
    31  	"github.com/stretchr/testify/require"
    32  )
    33  
    34  // Map is an untyped JSON map representation.
    35  type Map map[string]interface{}
    36  
    37  // Array is an untyped JSON array representation.
    38  type Array []interface{}
    39  
    40  // MustNewTestReader returns a io.Reader reader to the JSON value.
    41  func MustNewTestReader(t *testing.T, value interface{}) io.Reader {
    42  	reader := bytes.NewBuffer(nil)
    43  	require.NoError(t, json.NewEncoder(reader).Encode(value))
    44  	return reader
    45  }