net.javacrumbs.jsonunit

Class JsonAssert

java.lang.Object

net.javacrumbs.jsonunit.JsonAssert

public class JsonAssert
extends Object

Assertions for comparing JSON. The comparison ignores white-spaces and order of nodes. All the methods accept Objects as parameters. The supported types are:

1. Jackson JsonNode
2. Numbers, booleans and any other type parseable by Jackson's ObjectMapper.convertValue
3. String is parsed as JSON. For expected values the string is quoted if it contains obviously invalid JSON.
4. Reader similarly to String
5. null as null Node

Author:

Lukas Krecan

Method Summary

Modifier and Type	Method and Description
static void	assertJsonEquals(Object expected, Object actual) Compares to JSON documents.
static void	assertJsonEquals(Object expected, Object actual, Configuration configuration) Compares to JSON documents.
static void	assertJsonNodeAbsent(Object actual, String path) Fails if node in given path exists.
static void	assertJsonNodePresent(Object actual, String path) Fails if node in given does not exist.
static void	assertJsonNotEquals(Object expected, Object fullJson) Compares JSONs and fails if they are equal.
static void	assertJsonNotEquals(Object expected, Object fullJson, Configuration configuration) Compares JSONs and fails if they are equal.
static void	assertJsonPartEquals(Object expected, Object fullJson, String path) Compares part of the JSON.
static void	assertJsonPartEquals(Object expected, Object fullJson, String path, Configuration configuration) Compares part of the JSON.
static void	assertJsonPartNotEquals(Object expected, Object fullJson, String path) Compares part of the JSON and fails if they are equal.
static void	assertJsonPartNotEquals(Object expected, Object fullJson, String path, Configuration configuration) Compares part of the JSON and fails if they are equal.
static void	assertJsonPartStructureEquals(Object expected, Object fullJson, String path) Compares structure of part of the JSON.
static void	assertJsonStructureEquals(Object expected, Object actual) Compares structures of two JSON documents.
static String	getIgnorePlaceholder()
static BigDecimal	getTolerance()
static boolean	getTreatNullAsAbsent() Deprecated. use getOptions().contains(Option.TREATING_NULL_AS_ABSENT)
static void	resetOptions() Cleans all options.
static void	setIgnorePlaceholder(String ignorePlaceholder) Set's string that will be ignored in comparison.
static void	setOptions(Option firstOption, Option... rest) Sets options changing comparison behavior.
static void	setTolerance(BigDecimal numericComparisonTolerance) Sets the tolerance for floating number comparison.
static void	setTolerance(double numberComparisonTolerance) Sets the tolerance for floating number comparison.
static void	setTreatNullAsAbsent(boolean treatNullAsAbsent) Deprecated. use setOptions(Option.TREATING_NULL_AS_ABSENT)
static Configuration	when(Option first, Option... next) Creates empty configuration and sets options.
static Configuration	withTolerance(BigDecimal tolerance) Creates empty configuration and sets numerical comparison tolerance.
static Configuration	withTolerance(double tolerance) Creates empty configuration and sets numerical comparison tolerance.

Methods inherited from class java.lang.Object

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

Method Detail

assertJsonEquals

public static void assertJsonEquals(Object expected,
                                    Object actual)

Compares to JSON documents. Throws AssertionError if they are different.

assertJsonEquals

public static void assertJsonEquals(Object expected,
                                    Object actual,
                                    Configuration configuration)

Compares to JSON documents. Throws AssertionError if they are different.

assertJsonPartEquals

public static void assertJsonPartEquals(Object expected,
                                        Object fullJson,
                                        String path)

Compares part of the JSON. Path has this format "root.array[0].value".

assertJsonPartEquals

public static void assertJsonPartEquals(Object expected,
                                        Object fullJson,
                                        String path,
                                        Configuration configuration)

Compares part of the JSON. Path has this format "root.array[0].value".

assertJsonNotEquals

public static void assertJsonNotEquals(Object expected,
                                       Object fullJson)

Compares JSONs and fails if they are equal.

assertJsonNotEquals

public static void assertJsonNotEquals(Object expected,
                                       Object fullJson,
                                       Configuration configuration)

Compares JSONs and fails if they are equal.

assertJsonPartNotEquals

public static void assertJsonPartNotEquals(Object expected,
                                           Object fullJson,
                                           String path)

Compares part of the JSON and fails if they are equal. Path has this format "root.array[0].value".

assertJsonPartNotEquals

public static void assertJsonPartNotEquals(Object expected,
                                           Object fullJson,
                                           String path,
                                           Configuration configuration)

Compares part of the JSON and fails if they are equal. Path has this format "root.array[0].value".

assertJsonStructureEquals

public static void assertJsonStructureEquals(Object expected,
                                             Object actual)

Compares structures of two JSON documents. Is too lenient, ignores types, prefer IGNORING_VALUES option instead. Throws AssertionError if they are different.

assertJsonPartStructureEquals

public static void assertJsonPartStructureEquals(Object expected,
                                                 Object fullJson,
                                                 String path)

Compares structure of part of the JSON. Path has this format "root.array[0].value". Is too lenient, ignores types, prefer IGNORING_VALUES option instead.

assertJsonNodeAbsent

public static void assertJsonNodeAbsent(Object actual,
                                        String path)

Fails if node in given path exists.

assertJsonNodePresent

public static void assertJsonNodePresent(Object actual,
                                         String path)

Fails if node in given does not exist.

setIgnorePlaceholder

public static void setIgnorePlaceholder(String ignorePlaceholder)

Set's string that will be ignored in comparison. Default value is "${json-unit.ignore}"

getIgnorePlaceholder

public static String getIgnorePlaceholder()

setTolerance

public static void setTolerance(BigDecimal numericComparisonTolerance)

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.

setTolerance

public static void setTolerance(double numberComparisonTolerance)

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.

getTolerance

public static BigDecimal getTolerance()

setTreatNullAsAbsent

@Deprecated
public static void setTreatNullAsAbsent(boolean treatNullAsAbsent)

Deprecated. use setOptions(Option.TREATING_NULL_AS_ABSENT)

When set to true, treats null nodes in actual value as absent. In other words if you expect {"test":{"a":1}} this {"test":{"a":1, "b": null}} will pass the test.

getTreatNullAsAbsent

@Deprecated
public static boolean getTreatNullAsAbsent()

Deprecated. use getOptions().contains(Option.TREATING_NULL_AS_ABSENT)

setOptions

public static void setOptions(Option firstOption,
                              Option... rest)

Sets options changing comparison behavior. For more details see Option

See Also:

Option

resetOptions

public static void resetOptions()

Cleans all options.

withTolerance

public static Configuration withTolerance(double tolerance)

Creates empty configuration and sets numerical comparison tolerance.

withTolerance

public static Configuration withTolerance(BigDecimal tolerance)

Creates empty configuration and sets numerical comparison tolerance.

when

public static Configuration when(Option first,
                                 Option... next)

Creates empty configuration and sets options.