com.github.restdriver.serverdriver

Class Matchers

java.lang.Object

com.github.restdriver.serverdriver.Matchers

public final class Matchers
extends Object

Class to help easy & fluent use of our matchers.

Method Summary

Methods

Modifier and Type	Method and Description
static org.hamcrest.TypeSafeMatcher<Response>	hasHeader(Header header) Creates a new instance of HasHeader.
static org.hamcrest.TypeSafeMatcher<Response>	hasHeader(String header) Creates a new instance of HasHeader.
static org.hamcrest.TypeSafeMatcher<Response>	hasHeader(String name, org.hamcrest.Matcher<String> valueMatcher) Synonym for HasHeaderWithValue, using matcher for the value.
static org.hamcrest.TypeSafeMatcher<Response>	hasHeader(String name, String value) Synonym for HasHeaderWithValue, using exact match for the value.
static org.hamcrest.TypeSafeMatcher<Response>	hasHeaderWithValue(String name, org.hamcrest.Matcher<String> valueMatcher) Creates a new instance of HasHeaderWithValue.
static <T> org.hamcrest.TypeSafeMatcher<com.fasterxml.jackson.databind.JsonNode>	hasJsonPath(String jsonPath) Checks whether the given JSON object matches the JSONpath.
static <T> org.hamcrest.TypeSafeMatcher<com.fasterxml.jackson.databind.JsonNode>	hasJsonPath(String jsonPath, org.hamcrest.Matcher<T> matcher) Checks whether the given JSON object matches the JSONpath.
static org.hamcrest.TypeSafeMatcher<Response>	hasResponseBody(org.hamcrest.Matcher<String> bodyMatcher) Creates a new instance of HasResponseBody.
static org.hamcrest.TypeSafeMatcher<Response>	hasStatusCode(int statusCode) Creates a new instance of HasStatusCode.
static org.hamcrest.TypeSafeMatcher<Response>	hasStatusCode(org.hamcrest.Matcher<Integer> statusCodeMatcher) Creates a new instance of HasStatusCode.
static org.hamcrest.TypeSafeMatcher<Header>	isRfc1123Compliant() Checks whether a header's value is a valid date according to RFC1123.
static org.hamcrest.TypeSafeMatcher<Header>	isValidDateHeader() Checks whether a header's value is a valid date according to RFC1123.

Methods inherited from class java.lang.Object

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

Method Detail

hasStatusCode

public static org.hamcrest.TypeSafeMatcher<Response> hasStatusCode(int statusCode)

Creates a new instance of HasStatusCode.

Parameters:

statusCode - The status code to match

Returns:

The new matcher

hasStatusCode

public static org.hamcrest.TypeSafeMatcher<Response> hasStatusCode(org.hamcrest.Matcher<Integer> statusCodeMatcher)

Creates a new instance of HasStatusCode.

Parameters:

statusCodeMatcher - The matcher against which the status code will be evaluated

Returns:

The new matcher

hasResponseBody

public static org.hamcrest.TypeSafeMatcher<Response> hasResponseBody(org.hamcrest.Matcher<String> bodyMatcher)

Creates a new instance of HasResponseBody.

Parameters:

bodyMatcher - The matcher against which the response body will be evaluated

Returns:

The new matcher

hasHeader

public static org.hamcrest.TypeSafeMatcher<Response> hasHeader(String header)

Creates a new instance of HasHeader.

Parameters:

header - The name of the header to check for the presence of - or name and value separated by ":"

Returns:

The new matcher

hasHeader

public static org.hamcrest.TypeSafeMatcher<Response> hasHeader(Header header)

Creates a new instance of HasHeader.

Parameters:

header - The header to check for the presence of

Returns:

The new matcher

hasHeader

public static org.hamcrest.TypeSafeMatcher<Response> hasHeader(String name,
                                               String value)

Synonym for HasHeaderWithValue, using exact match for the value.

Parameters:

name - The name of the header to check for the presence of

value - The the header value to check

Returns:

The new matcher

hasHeader

public static org.hamcrest.TypeSafeMatcher<Response> hasHeader(String name,
                                               org.hamcrest.Matcher<String> valueMatcher)

Synonym for HasHeaderWithValue, using matcher for the value.

Parameters:

name - The name of the header to check for the presence and value of

valueMatcher - The matcher against which the header value will be evaluated

Returns:

The new matcher

hasHeaderWithValue

public static org.hamcrest.TypeSafeMatcher<Response> hasHeaderWithValue(String name,
                                                        org.hamcrest.Matcher<String> valueMatcher)

Creates a new instance of HasHeaderWithValue.

Parameters:

name - The name of the header to check for the presence and value of

valueMatcher - The matcher against which the header value will be evaluated

Returns:

The new matcher

isValidDateHeader

public static org.hamcrest.TypeSafeMatcher<Header> isValidDateHeader()

Checks whether a header's value is a valid date according to RFC1123. All headers containing dates (Date, Expires, etc) should be valid.

Returns:

The new matcher.

isRfc1123Compliant

public static org.hamcrest.TypeSafeMatcher<Header> isRfc1123Compliant()

Checks whether a header's value is a valid date according to RFC1123. All headers containing dates (Date, Expires, etc) should be valid.

Returns:

The new matcher.

hasJsonPath

public static <T> org.hamcrest.TypeSafeMatcher<com.fasterxml.jackson.databind.JsonNode> hasJsonPath(String jsonPath)

Checks whether the given JSON object matches the JSONpath. No matcher is used on the matched value. It is based only on the existence of something at the given JSONpath.

Type Parameters:

T - The type of the matcher.

Parameters:

jsonPath - The JSONpath to match.

Returns:

The new matcher.

hasJsonPath

public static <T> org.hamcrest.TypeSafeMatcher<com.fasterxml.jackson.databind.JsonNode> hasJsonPath(String jsonPath,
                                                                                    org.hamcrest.Matcher<T> matcher)

Checks whether the given JSON object matches the JSONpath. NB when asserting on numeric values you will *have* to use Longs and Doubles, or face the wrath of the ClassCastException!

Type Parameters:

T - The type of the matcher.

Parameters:

jsonPath - The JSONpath to match.

matcher - The matcher to apply to the result of the JSONpath.

Returns:

The new matcher.