These matchers are for matching JSON documents: they use Jackson to parse JSON bytes/text to an AST, and can match against that.
Match some text as JSON:
// matches despite spaces
assertThat("""{"a":1,"b":2}""", equivalentTo("""{ "a" : 1, "b" : 2 }"""))// matches despite fields in other order
assertThat("""{"b":2,"a":1}""", equivalentTo("""{ "a" : 1, "b" : 2 }"""))// pattern specified in matcher can be written more loosely
assertThat("""{"a":1,"b":"foo"}""", equivalentTo("""{ a: 1, b: 'foo' }"""))Match a sequence of bytes:
assertThat("""{"a":1,"b":2}""".toByteArray(), bytesEquivalentTo("""{ "a" : 1, "b" : 2 }"""))Match AST nodes by specifying either the expected value or a matcher:
assertThat("""42""", json(jsonInt(42)))
assertThat("""42""", json(jsonInt(equalTo(42))))
assertThat(""""xyzzy"""", json(jsonString("xyzzy")))
assertThat(""""xyzzy"""", json(jsonString(anything)))Build matchers for objects:
assertThat("""{ "a": 1, "b": 2 }""", json(jsonObject()
.withProperty("a", 1)
.withProperty("b", 2)
))By default an object matcher will mismatch if the input contains additional properties, but they can be allowed:
assertThat("""{ "a": 1, "b": 2, "foo": "bar" }""", json(jsonObject()
.withProperty("a", 1)
.withProperty("b", 2)
.withAnyOtherProperties()
))In general, withProperty accepts either values as the second argument (and infers a
likely node type) or a matcher of JsonNode (such as jsonInt() etc or another jsonObject())
Shorthand for switching to an equivalence matcher:
assertThat("""{ "a": { "b" : 1 } }""", json(jsonObject()
.withPropertyJSON("a", """{ b : 1}""")
))By default, jsonArray() will match only an empty array (change in future?)
Match contents exactly:
assertThat("""[1, 2, 3]""", json(jsonArray().of(jsonInt(1), jsonInt(2), jsonInt(3))))Match any element:
assertThat("""[1, 2, 3]""", json(jsonArray().including(jsonInt(2))))Match elements in any order:
assertThat("""[1, 2, 3]""", json(jsonArray().inAnyOrder(jsonInt(2), jsonInt(1), jsonInt(3))))Hamkrest-JSON is published on Maven Central. You need something like this in
build.gradle or build.gradle.kts:
repositories {
mavenCentral()
}
dependencies {
testImplementation("org.araqnid.hamkrest:hamkrest-json:1.1.2")
}