Package net.javacrumbs.jsonunit.spring

Class JsonUnitResultMatchers

java.lang.Object

net.javacrumbs.jsonunit.spring.JsonUnitResultMatchers

public class JsonUnitResultMatchers
extends Object

Matchers compatible with Spring MVC test framework.

Sample usage:

this.mockMvc.perform(get("/sample").accept(MediaType.APPLICATION_JSON)).andExpect(json().isEqualTo(CORRECT_JSON));

Method Summary

Modifier and Type	Method	Description
ME	ignoring(@NotNull String ignorePlaceholder)	Sets the placeholder that can be used to ignore values.
MATCHER	isAbsent()	Fails if the node exists.
MATCHER	isArray()	Fails if the selected JSON is not an Array or is not present.
MATCHER	isEqualTo(@Nullable Object expected)	Compares JSON for equality.
MATCHER	isFalse()	Fails if selected JSON is not false.
MATCHER	isNotEqualTo(@Nullable Object expected)	Fails if compared documents are equal.
MATCHER	isNotNull()	Fails if selected JSON is null.
MATCHER	isNull()	Fails if selected JSON is not null.
MATCHER	isObject()	Fails if the selected JSON is not an Object or is not present.
MATCHER	isPresent()	Fails if the node is missing.
MATCHER	isString()	Fails if the selected JSON is not a String or is not present.
MATCHER	isStringEqualTo(@Nullable String expected)	Fails if the selected JSON is not a String or is not present or the value is not equal to expected value.
MATCHER	isTrue()	Fails if selected JSON is not true.
static JsonUnitResultMatchers	json()	Creates JsonUnitResultMatchers to be used for JSON assertions.
MATCHER	matches(@NotNull org.hamcrest.Matcher<?> matcher)	Matches the node using Hamcrest matcher.
ME	node(String newPath)	Creates a matcher object that only compares given node.
ME	when(@NotNull net.javacrumbs.jsonunit.core.Option firstOption, @NotNull net.javacrumbs.jsonunit.core.Option... otherOptions)	Sets options changing comparison behavior.
ME	withDifferenceListener(@NotNull net.javacrumbs.jsonunit.core.listener.DifferenceListener differenceListener)
ME	withTolerance(double tolerance)	Sets the tolerance for floating number comparison.
ME	withTolerance(@Nullable BigDecimal tolerance)	Sets the tolerance for floating number comparison.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

json

public static JsonUnitResultMatchers json()

Creates JsonUnitResultMatchers to be used for JSON assertions.

node

@NotNull
public ME node(String newPath)

Creates a matcher object that only compares given node. The path is denoted by JSON path, for example.

this.mockMvc.perform(get("/sample").accept(MediaType.APPLICATION_JSON)).andExpect(json().node("root.test[0]").isEqualTo("1"));

Parameters:

newPath -

Returns:

object comparing only node given by path.

ignoring

@NotNull
public ME ignoring(@NotNull
                   @NotNull String ignorePlaceholder)

Sets the placeholder that can be used to ignore values. The default value is ${json-unit.ignore}

withTolerance

@NotNull
public ME withTolerance(double tolerance)

Sets the tolerance for floating number comparison. If set to null, requires exact match of the values. For example, if set to 0.01, ignores all differences lower than 0.01, so 1 and 0.9999 are considered equal.

withTolerance

@NotNull
public ME withTolerance(@Nullable
                        @Nullable BigDecimal tolerance)

Sets the tolerance for floating number comparison. If set to null, requires exact match of the values. For example, if set to 0.01, ignores all differences lower than 0.01, so 1 and 0.9999 are considered equal.

withDifferenceListener

@NotNull
public ME withDifferenceListener(@NotNull
                                 @NotNull net.javacrumbs.jsonunit.core.listener.DifferenceListener differenceListener)

when

@NotNull
public ME when(@NotNull
               @NotNull net.javacrumbs.jsonunit.core.Option firstOption,
               @NotNull
               @NotNull net.javacrumbs.jsonunit.core.Option... otherOptions)

Sets options changing comparison behavior. For more details see Option

See Also:

Option

isEqualTo

@NotNull
public MATCHER isEqualTo(@Nullable
                         @Nullable Object expected)

Compares JSON for equality. The expected object is converted to JSON before comparison. Ignores order of sibling nodes and whitespaces.

Please note that if you pass a String, it's parsed as JSON which can lead to an unexpected behavior. If you pass in "1" it is parsed as a JSON containing integer 1. If you compare it with a string it fails due to a different type. If you want to pass in real string you have to quote it "\"1\"" or use isStringEqualTo(String).

If the string parameter is not a valid JSON, it is quoted automatically.

Parameters:

expected -

Returns:

this object.

See Also:

isStringEqualTo(String)

isStringEqualTo

@NotNull
public MATCHER isStringEqualTo(@Nullable
                               @Nullable String expected)

Fails if the selected JSON is not a String or is not present or the value is not equal to expected value.

isNotEqualTo

@NotNull
public MATCHER isNotEqualTo(@Nullable
                            @Nullable Object expected)

Fails if compared documents are equal. The expected object is converted to JSON before comparison. Ignores order of sibling nodes and whitespaces.

isAbsent

@NotNull
public MATCHER isAbsent()

Fails if the node exists.

isPresent

@NotNull
public MATCHER isPresent()

Fails if the node is missing.

isArray

@NotNull
public MATCHER isArray()

Fails if the selected JSON is not an Array or is not present.

isObject

@NotNull
public MATCHER isObject()

Fails if the selected JSON is not an Object or is not present.

isString

@NotNull
public MATCHER isString()

Fails if the selected JSON is not a String or is not present.

isNull

@NotNull
public MATCHER isNull()

Fails if selected JSON is not null.

isNotNull

@NotNull
public MATCHER isNotNull()

Fails if selected JSON is null.

matches

@NotNull
public MATCHER matches(@NotNull
                       @NotNull org.hamcrest.Matcher<?> matcher)

Matches the node using Hamcrest matcher.

• Numbers are mapped to BigDecimal
• Arrays are mapped to a Collection
• Objects are mapped to a map so you can use json(Part)Equals or a Map matcher

Parameters:

matcher -

Returns:

isTrue

@NotNull
public MATCHER isTrue()

Fails if selected JSON is not true.

isFalse

@NotNull
public MATCHER isFalse()

Fails if selected JSON is not false.