org.springframework.graphql.test.tester

Interface GraphQlTester.PathSpec

All Superinterfaces:

GraphQlTester.TraverseSpec

Enclosing interface:

GraphQlTester

public static interface GraphQlTester.PathSpec
extends GraphQlTester.TraverseSpec

Declare options available to assert data at a given path.

Method Summary

Modifier and Type	Method and Description
<D> GraphQlTester.EntitySpec<D,?>	entity(Class<D> entityType) Convert the data at the given path to the target type.
<D> GraphQlTester.EntitySpec<D,?>	entity(ParameterizedTypeReference<D> entityType) Convert the data at the given path to the target type.
<D> GraphQlTester.ListEntitySpec<D>	entityList(Class<D> elementType) Convert the data at the given path to a List of the target type.
<D> GraphQlTester.ListEntitySpec<D>	entityList(ParameterizedTypeReference<D> elementType) Convert the data at the given path to a List of the target type.
GraphQlTester.TraverseSpec	matchesJson(String expectedJson) Parse the JSON at the given path and the given expected JSON and assert that the two are "similar".
GraphQlTester.TraverseSpec	matchesJsonStrictly(String expectedJson) Parse the JSON at the given path and the given expected JSON and assert that the two are "similar" so they contain the same attribute-value pairs regardless of formatting, along with lenient checking, e.g.
GraphQlTester.PathSpec	pathDoesNotExist() Assert the given path does not exist.
GraphQlTester.PathSpec	pathExists() Assert the given path exists, even if the value is null.
GraphQlTester.PathSpec	valueDoesNotExist() Assert a value does not exist at the given path.
GraphQlTester.PathSpec	valueExists() Assert a value exists at the given path where the value is any non-null value, possibly an empty array or map.
GraphQlTester.PathSpec	valueIsEmpty() Assert the value at the given path does not exist or is empty as defined in ObjectUtils.isEmpty(Object).
GraphQlTester.PathSpec	valueIsNotEmpty() Assert the value at the given path is not valueIsEmpty().

Methods inherited from interface org.springframework.graphql.test.tester.GraphQlTester.TraverseSpec

path

Method Detail

pathExists

GraphQlTester.PathSpec pathExists()

Assert the given path exists, even if the value is null.

Returns:

spec to assert the converted entity with

pathDoesNotExist

GraphQlTester.PathSpec pathDoesNotExist()

Assert the given path does not exist.

Returns:

spec to assert the converted entity with

valueExists

GraphQlTester.PathSpec valueExists()

Assert a value exists at the given path where the value is any non-null value, possibly an empty array or map.

Returns:

spec to assert the converted entity with

valueDoesNotExist

GraphQlTester.PathSpec valueDoesNotExist()

Assert a value does not exist at the given path.

Returns:

spec to assert the converted entity with

valueIsEmpty

GraphQlTester.PathSpec valueIsEmpty()

Assert the value at the given path does not exist or is empty as defined in ObjectUtils.isEmpty(Object).

Returns:

spec to assert the converted entity with

See Also:

ObjectUtils.isEmpty(Object)

valueIsNotEmpty

GraphQlTester.PathSpec valueIsNotEmpty()

Assert the value at the given path is not valueIsEmpty().

Returns:

spec to assert the converted entity with

entity

<D> GraphQlTester.EntitySpec<D,?> entity(Class<D> entityType)

Convert the data at the given path to the target type.

Type Parameters:

D - the target entity type

Parameters:

entityType - the type to convert to

Returns:

spec to assert the converted entity with

entity

<D> GraphQlTester.EntitySpec<D,?> entity(ParameterizedTypeReference<D> entityType)

Convert the data at the given path to the target type.

Type Parameters:

D - the target entity type

Parameters:

entityType - the type to convert to

Returns:

spec to assert the converted entity with

entityList

<D> GraphQlTester.ListEntitySpec<D> entityList(Class<D> elementType)

Convert the data at the given path to a List of the target type.

Type Parameters:

D - the target entity type

Parameters:

elementType - the type of element to convert to

Returns:

spec to assert the converted List of entities with

entityList

<D> GraphQlTester.ListEntitySpec<D> entityList(ParameterizedTypeReference<D> elementType)

Convert the data at the given path to a List of the target type.

Type Parameters:

D - the target entity type

Parameters:

elementType - the type to convert to

Returns:

spec to assert the converted List of entities with

matchesJson

GraphQlTester.TraverseSpec matchesJson(String expectedJson)

Parse the JSON at the given path and the given expected JSON and assert that the two are "similar".

Use of this option requires the JSONassert library on to be on the classpath.

Parameters:

expectedJson - the expected JSON

Returns:

spec to specify a different path

See Also:

JsonExpectationsHelper.assertJsonEqual(String, String)

matchesJsonStrictly

GraphQlTester.TraverseSpec matchesJsonStrictly(String expectedJson)

Parse the JSON at the given path and the given expected JSON and assert that the two are "similar" so they contain the same attribute-value pairs regardless of formatting, along with lenient checking, e.g. extensible and non-strict array ordering.

Parameters:

expectedJson - the expected JSON

Returns:

spec to specify a different path

See Also:

JsonExpectationsHelper.assertJsonEqual(String, String, boolean)