p

pact-jvm-consumer_2.12

Pact consumer ============= Pact Consumer is used by projects that are consumers of an API. Most projects will want to use pact-consumer via one of the test framework specific projects. If your favourite framework is not implemented, this module should give you all the hooks you need. Provides a DSL for use with Java to build consumer pacts. ## Dependency The library is available on maven central using: * group-id = `au.com.dius` * artifact-id = `pact-jvm-consumer_2.11` ## DSL Usage Example in a JUnit test: ```java import au.com.dius.pact.model.MockProviderConfig; import au.com.dius.pact.model.RequestResponsePact; import org.apache.http.entity.ContentType; import org.jetbrains.annotations.NotNull; import org.junit.Test; import java.io.IOException; import java.util.HashMap; import java.util.Map; import static au.com.dius.pact.consumer.ConsumerPactRunnerKt.runConsumerTest; import static org.junit.Assert.assertEquals; public class PactTest { @Test public void testPact() { RequestResponsePact pact = ConsumerPactBuilder .consumer("Some Consumer") .hasPactWith("Some Provider") .uponReceiving("a request to say Hello") .path("/hello") .method("POST") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") .toPact(); MockProviderConfig config = MockProviderConfig.createDefault(); PactVerificationResult result = runConsumerTest(pact, config, new PactTestRun() { @Override public void run(@NotNull MockServer mockServer) throws IOException { Map expectedResponse = new HashMap(); expectedResponse.put("hello", "harry"); assertEquals(expectedResponse, new ConsumerClient(mockServer.getUrl()).post("/hello", "{\"name\": \"harry\"}", ContentType.APPLICATION_JSON)); } }); if (result instanceof PactVerificationResult.Error) { throw new RuntimeException(((PactVerificationResult.Error)result).getError()); } assertEquals(PactVerificationResult.Ok.INSTANCE, result); } } ``` The DSL has the following pattern: ```java .consumer("Some Consumer") .hasPactWith("Some Provider") .given("a certain state on the provider") .uponReceiving("a request for something") .path("/hello") .method("POST") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") .uponReceiving("another request for something") .path("/hello") .method("POST") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") . . . .toPact() ``` You can define as many interactions as required. Each interaction starts with `uponReceiving` followed by `willRespondWith`. The test state setup with `given` is a mechanism to describe what the state of the provider should be in before the provider is verified. It is only recorded in the consumer tests and used by the provider verification tasks. ### Building JSON bodies with PactDslJsonBody DSL The body method of the ConsumerPactBuilder can accept a PactDslJsonBody, which can construct a JSON body as well as define regex and type matchers. For example: ```java PactDslJsonBody body = new PactDslJsonBody() .stringType("name") .booleanType("happy") .hexValue("hexCode") .id() .ipAddress("localAddress") .numberValue("age", 100) .timestamp(); ``` #### DSL Matching methods The following matching methods are provided with the DSL. In most cases, they take an optional value parameter which will be used to generate example values (i.e. when returning a mock response). If no example value is given, a random one will be generated. | method | description | |--------|-------------| | string, stringValue | Match a string value (using string equality) | | number, numberValue | Match a number value (using Number.equals)\* | | booleanValue | Match a boolean value (using equality) | | stringType | Will match all Strings | | numberType | Will match all numbers\* | | integerType | Will match all numbers that are integers (both ints and longs)\* | | decimalType | Will match all real numbers (floating point and decimal)\* | | booleanType | Will match all boolean values (true and false) | | stringMatcher | Will match strings using the provided regular expression | | timestamp | Will match string containing timestamps. If a timestamp format is not given, will match an ISO timestamp format | | date | Will match string containing dates. If a date format is not given, will match an ISO date format | | time | Will match string containing times. If a time format is not given, will match an ISO time format | | ipAddress | Will match string containing IP4 formatted address. | | id | Will match all numbers by type | | hexValue | Will match all hexadecimal encoded strings | | uuid | Will match strings containing UUIDs | | includesStr | Will match strings containing the provided string | | equalsTo | Will match using equals | | matchUrl | Defines a matcher for URLs, given the base URL path and a sequence of path fragments. The path fragments could be strings or regular expression matchers | _\* Note:_ JSON only supports double precision floating point values. Depending on the language implementation, they may parsed as integer, floating point or decimal numbers. #### Ensuring all items in a list match an example (2.2.0+) Lots of the time you might not know the number of items that will be in a list, but you want to ensure that the list has a minimum or maximum size and that each item in the list matches a given example. You can do this with the `arrayLike`, `minArrayLike` and `maxArrayLike` functions. | function | description | |----------|-------------| | `eachLike` | Ensure that each item in the list matches the provided example | | `maxArrayLike` | Ensure that each item in the list matches the provided example and the list is no bigger than the provided max | | `minArrayLike` | Ensure that each item in the list matches the provided example and the list is no smaller than the provided min | For example: ```java DslPart body = new PactDslJsonBody() .minArrayLike("users") .id() .stringType("name") .closeObject() .closeArray(); ``` This will ensure that the users list is never empty and that each user has an identifier that is a number and a name that is a string. #### Matching JSON values at the root (Version 3.2.2/2.4.3+) For cases where you are expecting basic JSON values (strings, numbers, booleans and null) at the root level of the body and need to use matchers, you can use the `PactDslJsonRootValue` class. It has all the DSL matching methods for basic values that you can use. For example: ```java .consumer("Some Consumer") .hasPactWith("Some Provider") .uponReceiving("a request for a basic JSON value") .path("/hello") .willRespondWith() .status(200) .body(PactDslJsonRootValue.integerType()) ``` #### Root level arrays that match all items (version 2.2.11+) If the root of the body is an array, you can create PactDslJsonArray classes with the following methods: | function | description | |----------|-------------| | `arrayEachLike` | Ensure that each item in the list matches the provided example | | `arrayMinLike` | Ensure that each item in the list matches the provided example and the list is no bigger than the provided max | | `arrayMaxLike` | Ensure that each item in the list matches the provided example and the list is no smaller than the provided min | For example: ```java PactDslJsonArray.arrayEachLike() .date("clearedDate", "mm/dd/yyyy", date) .stringType("status", "STATUS") .decimalType("amount", 100.0) .closeObject() ``` This will then match a body like: ```json [ { "clearedDate" : "07/22/2015", "status" : "C", "amount" : 15.0 }, { "clearedDate" : "07/22/2015", "status" : "C", "amount" : 15.0 }, { "clearedDate" : "07/22/2015", "status" : "C", "amount" : 15.0 } ] ``` #### Matching arrays of arrays (version 3.2.12/2.4.14+) For the case where you have arrays of arrays (GeoJSON is an example), the following methods have been provided: | function | description | |----------|-------------| | `eachArrayLike` | Ensure that each item in the array is an array that matches the provided example | | `eachArrayWithMaxLike` | Ensure that each item in the array is an array that matches the provided example and the array is no bigger than the provided max | | `eachArrayWithMinLike` | Ensure that each item in the array is an array that matches the provided example and the array is no smaller than the provided min | For example (with GeoJSON structure): ```java new PactDslJsonBody() .stringType("type","FeatureCollection") .eachLike("features") .stringType("type","Feature") .object("geometry") .stringType("type","Point") .eachArrayLike("coordinates") // coordinates is an array of arrays .decimalType(-7.55717) .decimalType(49.766896) .closeArray() .closeArray() .closeObject() .object("properties") .stringType("prop0","value0") .closeObject() .closeObject() .closeArray() ``` This generated the following JSON: ```json { "features": [ { "geometry": { "coordinates": [[-7.55717, 49.766896]], "type": "Point" }, "type": "Feature", "properties": { "prop0": "value0" } } ], "type": "FeatureCollection" } ``` and will be able to match all coordinates regardless of the number of coordinates. #### Matching any key in a map (3.3.1/2.5.0+) The DSL has been extended for cases where the keys in a map are IDs. For an example of this, see [#313](https://github.com/DiUS/pact-jvm/issues/131). In this case you can use the `eachKeyLike` method, which takes an example key as a parameter. For example: ```java DslPart body = new PactDslJsonBody() .object("one") .eachKeyLike("001", PactDslJsonRootValue.id(12345L)) // key like an id mapped to a matcher .closeObject() .object("two") .eachKeyLike("001-A") // key like an id where the value is matched by the following example .stringType("description", "Some Description") .closeObject() .closeObject() .object("three") .eachKeyMappedToAnArrayLike("001") // key like an id mapped to an array where each item is matched by the following example .id("someId", 23456L) .closeObject() .closeArray() .closeObject(); ``` For an example, have a look at [WildcardKeysTest](src/test/java/au/com/dius/pact/consumer/WildcardKeysTest.java). **NOTE:** The `eachKeyLike` method adds a `*` to the matching path, so the matching definition will be applied to all keys of the map if there is not a more specific matcher defined for a particular key. Having more than one `eachKeyLike` condition applied to a map will result in only one being applied when the pact is verified (probably the last). ### Matching on paths (version 2.1.5+) You can use regular expressions to match incoming requests. The DSL has a `matchPath` method for this. You can provide a real path as a second value to use when generating requests, and if you leave it out it will generate a random one from the regular expression. For example: ```java .given("test state") .uponReceiving("a test interaction") .matchPath("/transaction/[0-9]+") // or .matchPath("/transaction/[0-9]+", "/transaction/1234567890") .method("POST") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") ``` ### Matching on headers (version 2.2.2+) You can use regular expressions to match request and response headers. The DSL has a `matchHeader` method for this. You can provide an example header value to use when generating requests and responses, and if you leave it out it will generate a random one from the regular expression. For example: ```java .given("test state") .uponReceiving("a test interaction") .path("/hello") .method("POST") .matchHeader("testreqheader", "test.*value") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") .matchHeader("Location", ".*/hello/[0-9]+", "/hello/1234") ``` ### Matching on query parameters (version 3.3.7+) You can use regular expressions to match request query parameters. The DSL has a `matchQuery` method for this. You can provide an example value to use when generating requests, and if you leave it out it will generate a random one from the regular expression. For example: ```java .given("test state") .uponReceiving("a test interaction") .path("/hello") .method("POST") .matchQuery("a", "\\d+", "100") .matchQuery("b", "[A-Z]", "X") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") ```
https://github.com/DiUS/pact-jvm
Apache 2
Travis Dixon Ronald Holshausen
matchurl need maven using matched particular supports matches time matcher eachkeymappedtoanarraylike features boolean feature someid something quot 12345l stringvalue static defined 2015 number topact available consumerclient header projects geojson defines hexadecimal uuid each array runtimeexception minimum give before date dslpart timestamp leave could times numbers happy depending ensure classes https look define integer keys implemented stringmatcher equalsto artifact starts pattern what consumer_2 ioexception includesstr sequence string library base assert closearray having construct annotations public expression methods body harry both provide root entity arraylike apache consumer willrespondwith amount takes values maxarraylike basic description optional parameters instance requestresponsepact timestamps condition cleareddate assertequals haspactwith double eacharraywithminlike size that items maximum override generated than containing minarraylike case example eacharraywithmaxlike identifier result jetbrains model generate arrayminlike matchers mockserver strings well arraymaxlike response throw following json pactdsljsonbody name eachkeylike interactions wildcardkeystest functions precision regular urls extended provides provider junit hexvalue expecting hello never which pacttest fragments take there usage provided java certain github pacts arrays they test accept mechanism contenttype ipaddress 1234567890 given longs verified describe empty config only false import central favourite formatted structure equals prop0 regex random interaction like geturl create responses geometry many http verification mockproviderconfig uuids then recorded will yyyy bodies language some mapped might incoming bigger query most build ensuring followed version tests dates probably want note "null" regardless consumerpactbuilder 766896 module arrayeachlike post mock cases pactdsljsonrootvalue true void framework should point value0 hexcode item method decimaltype headers integers users last second transaction location eachlike testpact being geterror adds type used where been function dependency requests level more consumerpactrunnerkt testreqheader when request value three required 55717 returning lots status throws consumers class format properties booleans expressions integertype 23456l 1234 matching pact parsed instanceof issues floating match createdefault this util application_json specific hooks pacttestrun expectedresponse have state uponreceiving localaddress object from encoded numbervalue pactverificationresult smaller matchquery real another parameter paths equality able setup path pactdsljsonarray notnull featurecollection coordinates building with booleanvalue error definition your matchheader list generating tasks ints decimal know booleantype numbertype closeobject address implementation applied eacharraylike hashmap group matchpath stringtype user dius runconsumertest
Files download
File Operation
pact-jvm-consumer_2.12-3.5.11.jar download
pact-jvm-consumer_2.12-3.5.11.pom download
pact-jvm-consumer_2.12-3.5.11-sources.jar download
Apache Maven 
<dependency>
  <groupId>au.com.dius</groupId>
  <artifactId>pact-jvm-consumer_2.12</artifactId>
  <version>3.5.11</version>
</dependency>
Gradle Groovy 
implementation 'au.com.dius:pact-jvm-consumer_2.12:3.5.11'
Gradle Kotlin 
implementation("au.com.dius:pact-jvm-consumer_2.12:3.5.11")
Scala SBT 
libraryDependencies += "au.com.dius" % "pact-jvm-consumer_2.12" % "3.5.11"
Groovy Grape 
@Grapes(
  @Grab(group='au.com.dius', module='pact-jvm-consumer_2.12', version='3.5.11')
)
Apache Ivy 
<dependency org="au.com.dius" name="pact-jvm-consumer_2.12" rev="3.5.11" />
Leiningen 
[au.com.dius/pact-jvm-consumer_2.12 "3.5.11"]
Apache Buildr 
'au.com.dius:pact-jvm-consumer_2.12:jar:3.5.11'
Dependencies

compile

|-- org.jetbrains.kotlin:kotlin-stdlib-jre8:1.2.0

|-- org.jetbrains.kotlin:kotlin-reflect:1.2.0

|-- org.slf4j:slf4j-api:1.7.25

|-- org.codehaus.groovy:groovy-all:2.4.12

|-- io.github.microutils:kotlin-logging:1.4.4

|-- org.scala-lang:scala-library:2.12.3

|-- org.scala-lang:scala-compiler:2.12.3

|-- com.typesafe.scala-logging:scala-logging_2.12:3.7.2

|-- au.com.dius:pact-jvm-model:3.5.11

|-- au.com.dius:pact-jvm-matchers_2.12:3.5.11

|-- com.googlecode.java-diff-utils:diffutils:1.3.0

|-- dk.brics.automaton:automaton:1.11-8

|-- org.apache.httpcomponents:httpclient:4.5.3

|-- com.fasterxml.jackson.core:jackson-databind:2.8.1

|-- ws.unfiltered:unfiltered-netty-server_2.12:0.9.1

|-- org.apache.httpcomponents:fluent-hc:4.5.3

|-- org.scala-lang.modules:scala-java8-compat_2.12:0.8.0

test

|-- org.specs2:specs2-core_2.12:3.9.4

|-- org.specs2:specs2-junit_2.12:3.9.4

|-- org.hamcrest:hamcrest-all:1.3

|-- org.mockito:mockito-core:1.10.19

|-- junit:junit:4.12

|-- org.spockframework:spock-core:1.1-groovy-2.4

|-- cglib:cglib:3.2.4

|-- org.objenesis:objenesis:2.4

|-- io.kotlintest:kotlintest:2.0.7

|-- ch.qos.logback:logback-classic:1.1.7

|-- org.specs2:specs2-mock_2.12:3.9.4

|-- org.cthul:cthul-matchers:1.1.0