Request field matchersΒΆ

Hoverfly-Java abstracts away some of the complexity of building the request field matchers supported by Hoverfly.

By default, the DSL request builder assumes exact matching when you pass in a string.

You can also pass in a matcher created by the HoverflyMatchers factory class.

Here are some examples:

SimulationSource.dsl(

    service(matches("www.*-test.com"))          // Matches url with wildcard
        .get(startsWith("/api/bookings/"))      // Matches request path that starts with /api/bookings/
        .queryParam("page", any())              // Matches page query with any value
        .willReturn(success(json(booking)))

        .put("/api/bookings/1")
        .body(equalsToJson(json(booking)))      // Matches body which equals to a JSON Object
        .willReturn(success())

        .post("/api/bookings")
        .body(matchesJsonPath("$.flightId"))    // Matches body with a JSON path expression
        .willReturn(created("http://localhost/api/bookings/1"))

        .put("/api/bookings/1")
        .body(equalsToXml(xml(booking)))        // Matches body which equals to a XML object
        .willReturn(success())

        // XmlPath Matcher
        .post("/api/bookings")
        .body(matchesXPath("/flightId"))        // Matches body with a xpath expression
        .willReturn(created("http://localhost/api/bookings/1"))
)

HoverflyMatchers also provides the following matching methods:

HoverflyMatchers.contains("foo")
HoverflyMatchers.endsWith("foo")
HoverflyMatchers.startsWith("foo")

// Special matchers
HoverflyMatchers.matches("*foo*") // matches GLOB pattern
HoverflyMatchers.matchesGoRegex("[xyz]") // matches Golang regex pattern

Fuzzy matching is possible for request method, query and body with these simple built-in DSL methods:

SimulationSource.dsl(
    service("www.booking-is-down.com")
        .anyMethod(any())
        .anyQueryParams()
        .anyBody()
        .willReturn(serverError().body("booking is down"))
)

Headers are not used for matching unless they are specified. If you need to set a header to match on, use the header method:

SimulationSource.dsl(
    service("www.my-test.com")
        .post("/api/bookings")
        .body("{\"flightId\": \"1\"}")
        .header("Content-Type", any())     // Count as a match when request contains this Content-Type header
        .willReturn(created("http://localhost/api/bookings/1"))
}

When you supply a simulation source to the HoverflyRule, you can enable the printSimulationData option to help debugging. This will print the simulation JSON data used by Hoverfly to stdout:

@ClassRule
public static HoverflyRule hoverflyRule = HoverflyRule.inSimulationMode(simulationSource)
    .printSimulationData();