README
¶
JSON assertions
This library extends awesome github.com/stretchr/testify/assert
with nice JSON equality assertions built with github.com/yudai/gojsondiff.
Also it provides JSON marshaler with compact indentation.
Usage
Default comparer is set up to ignore difference against "<ignore-diff>" values. It is accessible with package function Equal.
package my_test
import (
"testing"
"github.com/swaggest/assertjson"
)
func Test(t *testing.T) {
assertjson.Equal(t,
[]byte(`{"a": [1, {"val": "<ignore-diff>"}, 3], "b": 2, "c": 3}`),
[]byte(`{"a": [1, {"val": 123}, 3], "c": 2, "b": 3}`),
)
// Output:
// Error Trace: ....
// Error: Not equal:
// {
// "a": [
// 1,
// {
// "val": "<ignore-diff>"
// },
// 3
// ],
// - "b": 2,
// + "b": 3,
// - "c": 3
// + "c": 2
// }
}
Custom Comparer can be created and used to control ignore behavior and formatter options.
Compact Indentation
Often json.MarshalIndent produces result, that is not easy to comprehend due to high count of lines that requires
massive scrolling effort to read.
This library provides an alternative assertjson.MarshalIndentCompact which keeps indentation and line breaks only
for major part of JSON document, while compacting smaller pieces.
j, err := assertjson.MarshalIndentCompact(v, "", " ", 100) // 100 is line width limit.
{
"openapi":"3.0.2","info":{"title":"","version":""},
"paths":{
"/test/{in-path}":{
"post":{
"summary":"Title","description":"","operationId":"name",
"x-some-array":[
"abc","def",123456,7890123456,[],{"foo":"bar"},
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa!"
],
"parameters":[
{"name":"in_query","in":"query","schema":{"type":"integer"}},
{"name":"in-path","in":"path","required":true,"schema":{"type":"boolean"}},
{"name":"in_cookie","in":"cookie","schema":{"type":"number"}},
{"name":"X-In-Header","in":"header","schema":{"type":"string"}}
],
"requestBody":{
"content":{
"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/FormDataOpenapiTestInput"}}
}
},
"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}}},
"deprecated":true
}
}
},
"components":{
"schemas":{"FormDataOpenapiTestInput":{"type":"object","properties":{"in_form_data":{"type":"string"}}}}
}
}
Available as jsoncompact CLI tool.
go get github.com/swaggest/assertjson/cmd/jsoncompact
Documentation
¶
Overview ¶
Package assertjson implements JSON equality assertion for tests.
Example ¶
package main
import (
"fmt"
"github.com/swaggest/assertjson"
)
var t = testingT(func(format string, args ...interface{}) {
fmt.Printf(format, args...)
})
func main() {
assertjson.Equal(t,
[]byte(`{"a": [1, {"val": "<ignore-diff>"}, 3], "b": 2, "c": 3}`),
[]byte(`{"a": [1, {"val": 123}, 3], "c": 2, "b": 3}`),
)
}
Output: Error Trace: equal.go:48 equal.go:36 example_test.go:14 Error: Not equal: { "a": [ 1, { "val": "<ignore-diff>" }, 3 ], - "b": 2, + "b": 3, - "c": 3 + "c": 2 }
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FailNotEqual ¶ added in v1.1.0
FailNotEqual returns error if JSON payloads are different, nil otherwise.
func MarshalIndentCompact ¶ added in v1.2.0
MarshalIndentCompact applies indentation for large chunks of JSON and uses compact format for smaller ones.
Line length limits indented width of JSON structure, does not apply to long distinct scalars. This function is not optimized for performance, so it might be not a good fit for high load scenarios.
Types ¶
type Comparer ¶
type Comparer struct {
// IgnoreDiff is a value in expected document to ignore difference with actual document.
IgnoreDiff string
// FormatterConfig controls diff formatter configuration.
FormatterConfig formatter.AsciiFormatterConfig
}
Comparer compares JSON documents.
func (Comparer) FailNotEqual ¶ added in v1.1.0
FailNotEqual returns error if JSON payloads are different, nil otherwise.
Source Files
Directories