Class RestTestClientResponseAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<RestTestClientResponseAssert, RestTestClientResponse>

org.assertj.core.api.AbstractObjectAssert<RestTestClientResponseAssert, RestTestClientResponse>

org.springframework.test.web.servlet.client.assertj.RestTestClientResponseAssert

All Implemented Interfaces:

org.assertj.core.api.Assert<RestTestClientResponseAssert, RestTestClientResponse>, org.assertj.core.api.Descriptable<RestTestClientResponseAssert>, org.assertj.core.api.ExtensionPoints<RestTestClientResponseAssert, RestTestClientResponse>

public class RestTestClientResponseAssert
extends org.assertj.core.api.AbstractObjectAssert<RestTestClientResponseAssert, RestTestClientResponse>

AssertJ assertions for the result from a RestTestClient exchange.

Since:

7.0

Author:

Rossen Stoyanchev

Field Summary

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

actual, info, myself, objects, throwUnsupportedExceptionOnEquals

Method Summary

Modifier and Type	Method	Description
org.assertj.core.api.AbstractByteArrayAssert<?>	body()	Return a new assertion object that uses the response body as the object to test.
AbstractJsonContentAssert<?>	bodyJson()	Return a new assertion object that uses the response body converted to text as the object to test.
org.assertj.core.api.AbstractStringAssert<?>	bodyText()	Return a new assertion object that uses the response body converted to text as the object to test.
RestTestClientResponseAssert	containsHeader(String name)	Verify that the response contains a header with the given name.
MediaTypeAssert	contentType()	Return a new assertion object that uses the response's content type as the object to test.
CookieMapAssert	cookies()	Return a new assertion object that uses the response's cookies as the object to test.
RestTestClientResponseAssert	doesNotContainHeader(String name)	Verify that the response does not contain a header with the given name.
RestTestClientResponseAssert	hasBodyTextEqualTo(String bodyText)	Verify that the response body is equal to the given value.
RestTestClientResponseAssert	hasContentType(String contentType)	Verify that the response's Content-Type is equal to the given string representation.
RestTestClientResponseAssert	hasContentType(org.springframework.http.MediaType contentType)	Verify that the response's Content-Type is equal to the given value.
RestTestClientResponseAssert	hasContentTypeCompatibleWith(String contentType)	Verify that the response's Content-Type is compatible with the given string representation.
RestTestClientResponseAssert	hasContentTypeCompatibleWith(org.springframework.http.MediaType contentType)	Verify that the response's Content-Type is compatible with the given value.
RestTestClientResponseAssert	hasHeader(String name, String value)	Verify that the response contains a header with the given name and primary value.
RestTestClientResponseAssert	hasStatus(int status)	Verify that the HTTP status is equal to the specified status code.
RestTestClientResponseAssert	hasStatus(org.springframework.http.HttpStatus status)	Verify that the HTTP status is equal to the specified status.
RestTestClientResponseAssert	hasStatus1xxInformational()	Verify that the HTTP status code is in the 1xx range.
RestTestClientResponseAssert	hasStatus2xxSuccessful()	Verify that the HTTP status code is in the 2xx range.
RestTestClientResponseAssert	hasStatus3xxRedirection()	Verify that the HTTP status code is in the 3xx range.
RestTestClientResponseAssert	hasStatus4xxClientError()	Verify that the HTTP status code is in the 4xx range.
RestTestClientResponseAssert	hasStatus5xxServerError()	Verify that the HTTP status code is in the 5xx range.
RestTestClientResponseAssert	hasStatusOk()	Verify that the HTTP status is equal to HttpStatus.OK.
HttpHeadersAssert	headers()	Return a new assertion object that uses HttpHeaders as the object to test.

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

as, as, doesNotReturn, extracting, extracting, extracting, extracting, extracting, extracting, extractingForProxy, getComparatorsByType, hasAllNullFieldsOrProperties, hasAllNullFieldsOrPropertiesExcept, hasFieldOrProperty, hasFieldOrPropertyWithValue, hasNoNullFieldsOrProperties, hasNoNullFieldsOrPropertiesExcept, hasOnlyFields, isEqualToComparingFieldByField, isEqualToComparingFieldByFieldRecursively, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields, newObjectAssert, returns, usingComparatorForFields, usingComparatorForType, usingRecursiveAssertion, usingRecursiveAssertion, usingRecursiveComparison, usingRecursiveComparison

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

actual, areEqual, asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, doesNotHaveToString, doesNotMatch, doesNotMatch, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, hasToString, inBinary, inHexadecimal, is, isElementOfCustomAssert, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, usingEquals, usingEquals, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class Object

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

Methods inherited from interface org.assertj.core.api.Descriptable

as, describedAs, describedAs

Method Details

hasStatus

public RestTestClientResponseAssert hasStatus(int status)

Verify that the HTTP status is equal to the specified status code.

Parameters:

status - the expected HTTP status code

hasStatus

public RestTestClientResponseAssert hasStatus(org.springframework.http.HttpStatus status)

Verify that the HTTP status is equal to the specified status.

Parameters:

status - the expected HTTP status code

hasStatusOk

public RestTestClientResponseAssert hasStatusOk()

Verify that the HTTP status is equal to HttpStatus.OK.

See Also:

• hasStatus(HttpStatus)

hasStatus1xxInformational

public RestTestClientResponseAssert hasStatus1xxInformational()

Verify that the HTTP status code is in the 1xx range.

See Also:

• RFC 2616

hasStatus2xxSuccessful

public RestTestClientResponseAssert hasStatus2xxSuccessful()

Verify that the HTTP status code is in the 2xx range.

See Also:

• RFC 2616

hasStatus3xxRedirection

public RestTestClientResponseAssert hasStatus3xxRedirection()

Verify that the HTTP status code is in the 3xx range.

See Also:

• RFC 2616

hasStatus4xxClientError

public RestTestClientResponseAssert hasStatus4xxClientError()

Verify that the HTTP status code is in the 4xx range.

See Also:

• RFC 2616

hasStatus5xxServerError

public RestTestClientResponseAssert hasStatus5xxServerError()

Verify that the HTTP status code is in the 5xx range.

See Also:

• RFC 2616

headers

public HttpHeadersAssert headers()

Return a new assertion object that uses HttpHeaders as the object to test. The returned assertion object provides all the regular map assertions, with headers mapped by header name. Examples:

// Check for the presence of the Accept header:
assertThat(response).headers().containsHeader(HttpHeaders.ACCEPT);

// Check for the absence of the Content-Length header:
assertThat(response).headers().doesNotContainsHeader(HttpHeaders.CONTENT_LENGTH);

containsHeader

public RestTestClientResponseAssert containsHeader(String name)

Verify that the response contains a header with the given name.

Parameters:

name - the name of an expected HTTP header

doesNotContainHeader

public RestTestClientResponseAssert doesNotContainHeader(String name)

Verify that the response does not contain a header with the given name.

Parameters:

name - the name of an HTTP header that should not be present

hasHeader

public RestTestClientResponseAssert hasHeader(String name,
 String value)

Verify that the response contains a header with the given name and primary value.

Parameters:

name - the name of an expected HTTP header

value - the expected value of the header

contentType

public MediaTypeAssert contentType()

Return a new assertion object that uses the response's content type as the object to test.

hasContentType

public RestTestClientResponseAssert hasContentType(org.springframework.http.MediaType contentType)

Verify that the response's Content-Type is equal to the given value.

Parameters:

contentType - the expected content type

hasContentType

public RestTestClientResponseAssert hasContentType(String contentType)

Verify that the response's Content-Type is equal to the given string representation.

Parameters:

contentType - the expected content type

hasContentTypeCompatibleWith

public RestTestClientResponseAssert hasContentTypeCompatibleWith(org.springframework.http.MediaType contentType)

Verify that the response's Content-Type is compatible with the given value.

Parameters:

contentType - the expected compatible content type

hasContentTypeCompatibleWith

public RestTestClientResponseAssert hasContentTypeCompatibleWith(String contentType)

Verify that the response's Content-Type is compatible with the given string representation.

Parameters:

contentType - the expected compatible content type

cookies

public CookieMapAssert cookies()

Return a new assertion object that uses the response's cookies as the object to test.

body

public org.assertj.core.api.AbstractByteArrayAssert<?> body()

Return a new assertion object that uses the response body as the object to test.

See Also:

• bodyText()
• bodyJson()

bodyText

public org.assertj.core.api.AbstractStringAssert<?> bodyText()

Return a new assertion object that uses the response body converted to text as the object to test.

Examples:

// Check that the response body is equal to "Hello World":
assertThat(response).bodyText().isEqualTo("Hello World");

hasBodyTextEqualTo

public RestTestClientResponseAssert hasBodyTextEqualTo(String bodyText)

Verify that the response body is equal to the given value.

bodyJson

public AbstractJsonContentAssert<?> bodyJson()

Return a new assertion object that uses the response body converted to text as the object to test. Compared to bodyText(), the assertion object provides dedicated JSON support.

Examples:

// Check that the response body is strictly equal to the content of
// "/com/acme/sample/person-created.json":
assertThat(response).bodyJson()
        .isStrictlyEqualToJson("/com/acme/sample/person-created.json");

// Check that the response is strictly equal to the content of the
// specified file located in the same package as the PersonController:
assertThat(response).bodyJson().withResourceLoadClass(PersonController.class)
        .isStrictlyEqualToJson("person-created.json");

The returned assert object also supports JSON path expressions.

Examples:

// Check that the JSON document does not have an "error" element
assertThat(response).bodyJson().doesNotHavePath("$.error");

// Check that the JSON document as a top level "message" element
assertThat(response).bodyJson()
        .extractingPath("$.message").asString().isEqualTo("hello");