io.specto.hoverfly.junit.dsl.matchers

Class HoverflyMatchers

java.lang.Object

io.specto.hoverfly.junit.dsl.matchers.HoverflyMatchers

public class HoverflyMatchers
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static RequestFieldMatcher	any() Create a matcher that matches on any value
static RequestFieldMatcher	contains(java.lang.String value) Create a matcher that matches on a string containing the given value
static RequestFieldMatcher	endsWith(java.lang.String value) Create a matcher that matches on a string post-fixed with the given value
static RequestFieldMatcher	equalsTo(java.lang.Object value) Create a matcher that exactly equals to the String value of the given object
static RequestFieldMatcher	equalsToJson(HttpBodyConverter converter) Create a matcher that matches on JSON serialized from a JAVA object by HttpBodyConverter
static RequestFieldMatcher	equalsToJson(java.lang.String value) Create a matcher that matches on the given JSON
static RequestFieldMatcher	equalsToXml(HttpBodyConverter converter) Create a matcher that matches on XML serialized from a JAVA object by HttpBodyConverter
static RequestFieldMatcher	equalsToXml(java.lang.String value) Create a matcher that matches on the given XML
static RequestFieldMatcher	matches(java.lang.String value) Create a matcher that matches a GLOB pattern.
static RequestFieldMatcher	matchesGoRegex(java.lang.String regexPattern) Create a matcher that matches a Golang regex pattern.
static RequestFieldMatcher	matchesJsonPath(java.lang.String expression) Create a matcher that matches on the given JsonPath expression
static RequestFieldMatcher	matchesPartialJson(HttpBodyConverter converter) Create a matcher that matches on a partial JSON document serialized from a JAVA object by HttpBodyConverter
static RequestFieldMatcher	matchesPartialJson(java.lang.String value) Create a matcher that matches on the given partial JSON document
static RequestFieldMatcher	matchesXPath(java.lang.String expression) Create a matcher that matches on the given XPath expression
static RequestFieldMatcher	startsWith(java.lang.String value) Create a matcher that matches on a string prefixed with the given value

Methods inherited from class java.lang.Object

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

Method Detail

equalsTo

public static RequestFieldMatcher equalsTo(java.lang.Object value)

Create a matcher that exactly equals to the String value of the given object

Parameters:

value - the value to match on

Returns:

an RequestFieldMatcher

matches

public static RequestFieldMatcher matches(java.lang.String value)

Create a matcher that matches a GLOB pattern. For example:

HoverflyMatchers.matches("api-v*.test-svc.*")

Parameters:

value - the GLOB pattern, use the wildcard character '*' to match any characters

Returns:

an RequestFieldMatcher

matchesGoRegex

public static RequestFieldMatcher matchesGoRegex(java.lang.String regexPattern)

Create a matcher that matches a Golang regex pattern. As the Hoverfly core project is written in Golang, this method is provided as a temporary solution to use the regex matcher using native Golang regex patterns. Although there are some variations from the Java regex, majority of the syntax is similar.

Parameters:

regexPattern - the Golang regex pattern

Returns:

an RequestFieldMatcher

See Also:

Golang regex quick reference

startsWith

public static RequestFieldMatcher startsWith(java.lang.String value)

Create a matcher that matches on a string prefixed with the given value

Parameters:

value - the value to start with

Returns:

an RequestFieldMatcher

endsWith

public static RequestFieldMatcher endsWith(java.lang.String value)

Create a matcher that matches on a string post-fixed with the given value

Parameters:

value - the value to end with

Returns:

an RequestFieldMatcher

contains

public static RequestFieldMatcher contains(java.lang.String value)

Create a matcher that matches on a string containing the given value

Parameters:

value - the value to contain

Returns:

an RequestFieldMatcher

any

public static RequestFieldMatcher any()

Create a matcher that matches on any value

Returns:

an RequestFieldMatcher

equalsToJson

public static RequestFieldMatcher equalsToJson(java.lang.String value)

Create a matcher that matches on the given JSON

Parameters:

value - the JSON string value

Returns:

an RequestFieldMatcher

equalsToJson

public static RequestFieldMatcher equalsToJson(HttpBodyConverter converter)

Create a matcher that matches on JSON serialized from a JAVA object by HttpBodyConverter

Parameters:

converter - the HttpBodyConverter with an object to be serialized to JSON

Returns:

an RequestFieldMatcher that includes jsonMatch

matchesPartialJson

public static RequestFieldMatcher matchesPartialJson(java.lang.String value)

Create a matcher that matches on the given partial JSON document

Parameters:

value - the JSON string value

Returns:

an RequestFieldMatcher

matchesPartialJson

public static RequestFieldMatcher matchesPartialJson(HttpBodyConverter converter)

Create a matcher that matches on a partial JSON document serialized from a JAVA object by HttpBodyConverter

Parameters:

converter - the HttpBodyConverter with an object to be serialized to JSON

Returns:

an RequestFieldMatcher

matchesJsonPath

public static RequestFieldMatcher matchesJsonPath(java.lang.String expression)

Create a matcher that matches on the given JsonPath expression

Parameters:

expression - the JsonPath expression

Returns:

an RequestFieldMatcher

equalsToXml

public static RequestFieldMatcher equalsToXml(java.lang.String value)

Create a matcher that matches on the given XML

Parameters:

value - the XML string value

Returns:

an RequestFieldMatcher

equalsToXml

public static RequestFieldMatcher equalsToXml(HttpBodyConverter converter)

Create a matcher that matches on XML serialized from a JAVA object by HttpBodyConverter

Parameters:

converter - the HttpBodyConverter with an object to be serialized to XML

Returns:

an RequestFieldMatcher that includes xmlMatch

matchesXPath

public static RequestFieldMatcher matchesXPath(java.lang.String expression)

Create a matcher that matches on the given XPath expression

Parameters:

expression - the XPath expression

Returns:

an RequestFieldMatcher