net.javacrumbs.jsonunit.assertj

Class JsonAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<JsonAssert,org.codehaus.jackson.JsonNode>

net.javacrumbs.jsonunit.assertj.JsonAssert

All Implemented Interfaces:

org.assertj.core.api.Assert<JsonAssert,org.codehaus.jackson.JsonNode>, org.assertj.core.api.Descriptable<JsonAssert>, org.assertj.core.api.ExtensionPoints<JsonAssert,org.codehaus.jackson.JsonNode>

public class JsonAssert
extends org.assertj.core.api.AbstractAssert<JsonAssert,org.codehaus.jackson.JsonNode>

Contains JSON related assertions. Typical usage is:

assertThatJson("{\"test\":1}").isEqualTo("{\"test\":2}"); assertThatJson("{\"test\":1}").hasSameStructureAs("{\"test\":21}"); assertThatJson("{\"root\":{\"test\":1}}").node("root.test").isEqualTo("2");

Please note that the method name is assertThatJson and not assertThat. The reason is that we need to accept String parameter and do not want to override standard FEST assertThat(String) method.

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonAssert(org.codehaus.jackson.JsonNode actual, String path)

Method Summary

Methods

Modifier and Type	Method and Description
static JsonAssert	assertThatJson(org.codehaus.jackson.JsonNode json) Creates a new instance of JsonAssert.
static JsonAssert	assertThatJson(Object json) Creates a new instance of JsonAssert.
static String	getIgnorePlaceholder()
JsonAssert	hasSameStructureAs(org.codehaus.jackson.JsonNode expected) Compares JSON structure.
JsonAssert	hasSameStructureAs(Object expected) Compares JSON structure.
JsonAssert	isEqualTo(org.codehaus.jackson.JsonNode expected) Compares JSON for equality.
JsonAssert	isEqualTo(Object expected) Compares JSON for equality.
JsonAssert	isIn(Iterable<?> values)
JsonAssert	isIn(Object... values)
JsonAssert	isNotEqualTo(org.codehaus.jackson.JsonNode expected) Fails if compared documents are equal.
JsonAssert	isNotEqualTo(Object expected) Fails if compared documents are equal.
JsonAssert	isNotIn(Iterable<?> values)
JsonAssert	isNotIn(Object... values)
JsonAssert	node(String path) Creates an assert object that only compares given node.
static void	setIgnorePlaceholder(String ignorePlaceholder) Set's string that will be ignored in comparison.

Methods inherited from class org.assertj.core.api.AbstractAssert

as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, is, isExactlyInstanceOf, isInstanceOf, isInstanceOfAny, isNot, isNotExactlyInstanceOf, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage, usingComparator, usingDefaultComparator

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonAssert

protected JsonAssert(org.codehaus.jackson.JsonNode actual,
          String path)

Method Detail

assertThatJson

public static JsonAssert assertThatJson(org.codehaus.jackson.JsonNode json)

Creates a new instance of JsonAssert. It is not called assertThat to not clash with StringAssert.

Parameters:

json -

Returns:

new JsonAssert object.

assertThatJson

public static JsonAssert assertThatJson(Object json)

Creates a new instance of JsonAssert. It is not called assertThat to not clash with StringAssert. The json parameter is converted to JSON using ObjectMapper.

Parameters:

json -

Returns:

new JsonAssert object.

isEqualTo

public JsonAssert isEqualTo(org.codehaus.jackson.JsonNode expected)

Compares JSON for equality. Ignores order of sibling nodes and whitespaces.

Parameters:

expected -

Returns:

this object.

isEqualTo

public JsonAssert isEqualTo(Object expected)

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

Specified by:

isEqualTo in interface org.assertj.core.api.Assert<JsonAssert,org.codehaus.jackson.JsonNode>

Overrides:

isEqualTo in class org.assertj.core.api.AbstractAssert<JsonAssert,org.codehaus.jackson.JsonNode>

Parameters:

expected -

Returns:

this object.

isNotEqualTo

public JsonAssert isNotEqualTo(org.codehaus.jackson.JsonNode expected)

Fails if compared documents are equal.

Parameters:

expected -

Returns:

this object.

isNotEqualTo

public JsonAssert isNotEqualTo(Object expected)

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

Specified by:

isNotEqualTo in interface org.assertj.core.api.Assert<JsonAssert,org.codehaus.jackson.JsonNode>

Overrides:

isNotEqualTo in class org.assertj.core.api.AbstractAssert<JsonAssert,org.codehaus.jackson.JsonNode>

Parameters:

expected -

Returns:

this object.

hasSameStructureAs

public JsonAssert hasSameStructureAs(org.codehaus.jackson.JsonNode expected)

Compares JSON structure. Ignores values, only compares shape of the document and key names.

Parameters:

expected -

Returns:

this object.

hasSameStructureAs

public JsonAssert hasSameStructureAs(Object expected)

Compares JSON structure. Ignores values, only compares shape of the document and key names.

Parameters:

expected -

Returns:

this object.

node

public JsonAssert node(String path)

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

assertThatJson("{\"root\":{\"test\":[1,2,3]}}").node("root.test[0]").isEqualTo("1");

Parameters:

path -

Returns:

object comparing only node given by path.

isIn

public JsonAssert isIn(Object... values)

Specified by:

isIn in interface org.assertj.core.api.Assert<JsonAssert,org.codehaus.jackson.JsonNode>

Overrides:

isIn in class org.assertj.core.api.AbstractAssert<JsonAssert,org.codehaus.jackson.JsonNode>

isIn

public JsonAssert isIn(Iterable<?> values)

Specified by:

isIn in interface org.assertj.core.api.Assert<JsonAssert,org.codehaus.jackson.JsonNode>

Overrides:

isIn in class org.assertj.core.api.AbstractAssert<JsonAssert,org.codehaus.jackson.JsonNode>

isNotIn

public JsonAssert isNotIn(Object... values)

Specified by:

isNotIn in interface org.assertj.core.api.Assert<JsonAssert,org.codehaus.jackson.JsonNode>

Overrides:

isNotIn in class org.assertj.core.api.AbstractAssert<JsonAssert,org.codehaus.jackson.JsonNode>

isNotIn

public JsonAssert isNotIn(Iterable<?> values)

Specified by:

isNotIn in interface org.assertj.core.api.Assert<JsonAssert,org.codehaus.jackson.JsonNode>

Overrides:

isNotIn in class org.assertj.core.api.AbstractAssert<JsonAssert,org.codehaus.jackson.JsonNode>

setIgnorePlaceholder

public static void setIgnorePlaceholder(String ignorePlaceholder)

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

Parameters:

ignorePlaceholder -

getIgnorePlaceholder

public static String getIgnorePlaceholder()