README
¶
JSON assertions
This library extends awesome github.com/stretchr/testify/assert
with nice JSON equality assertions built with github.com/yudai/gojsondiff.
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.
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.
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
Click to show internal directories.
Click to hide internal directories.