p

pact-jvm-consumer-junit5_2.12

pact-jvm-consumer-junit5 ======================== JUnit 5 support for Pact consumer tests ## Dependency The library is available on maven central using: * group-id = `au.com.dius` * artifact-id = `pact-jvm-consumer-junit5_2.12` * version-id = `3.6.x` ## Usage ### 1. Add the Pact consumer test extension to the test class. To write Pact consumer tests with JUnit 5, you need to add `@ExtendWith(PactConsumerTestExt)` to your test class. This replaces the `PactRunner` used for JUnit 4 tests. The rest of the test follows a similar pattern as for JUnit 4 tests. ```java @ExtendWith(PactConsumerTestExt.class) class ExampleJavaConsumerPactTest { ``` ### 2. create a method annotated with `@Pact` that returns the interactions for the test For each test (as with JUnit 4), you need to define a method annotated with the `@Pact` annotation that returns the interactions for the test. ```java @Pact(provider="ArticlesProvider", consumer="test_consumer") public RequestResponsePact createPact(PactDslWithProvider builder) { return builder .given("test state") .uponReceiving("ExampleJavaConsumerPactTest test interaction") .path("/articles.json") .method("GET") .willRespondWith() .status(200) .body("{\"responsetest\": true}") .toPact(); } ``` ### 3. Link the mock server with the interactions for the test with `@PactTestFor` Then the final step is to use the `@PactTestFor` annotation to tell the Pact extension how to setup the Pact test. You can either put this annotation on the test class, or on the test method. For examples see [ArticlesTest](src/test/java/au/com/dius/pact/consumer/junit5/ArticlesTest.java) and [MultiTest](src/test/groovy/au/com/dius/pact/consumer/junit5/MultiTest.groovy). The `@PactTestFor` annotation allows you to control the mock server in the same way as the JUnit 4 `PactProviderRule`. It allows you to set the hostname to bind to (default is `localhost`) and the port (default is to use a random port). You can also set the Pact specification version to use (default is V3). ```java @ExtendWith(PactConsumerTestExt.class) @PactTestFor(providerName = "ArticlesProvider") public class ExampleJavaConsumerPactTest { ``` **NOTE on the hostname**: The mock server runs in the same JVM as the test, so the only valid values for hostname are: | hostname | result | | -------- | ------ | | `localhost` | binds to the address that localhost points to (normally the loopback adapter) | | `127.0.0.1` or `::1` | binds to the loopback adapter | | host name | binds to the default interface that the host machines DNS name resolves to | | `0.0.0.0` or `::` | binds to the all interfaces on the host machine | #### Matching the interactions by provider name If you set the `providerName` on the `@PactTestFor` annotation, then the first method with a `@Pact` annotation with the same provider name will be used. See [ArticlesTest](src/test/java/au/com/dius/pact/consumer/junit5/ArticlesTest.java) for an example. #### Matching the interactions by method name If you set the `pactMethod` on the `@PactTestFor` annotation, then the method with the provided name will be used (it still needs a `@Pact` annotation). See [MultiTest](src/test/groovy/au/com/dius/pact/consumer/junit5/MultiTest.groovy) for an example. ### Injecting the mock server into the test You can get the mock server injected into the test method by adding a `MockServer` parameter to the test method. ```java @Test void test(MockServer mockServer) throws IOException { HttpResponse httpResponse = Request.Get(mockServer.getUrl() + "/articles.json").execute().returnResponse(); assertThat(httpResponse.getStatusLine().getStatusCode(), is(equalTo(200))); } ``` This helps with getting the base URL of the mock server, especially when a random port is used. ## Changing the directory pact files are written to By default, pact files are written to `target/pacts` (or `build/pacts` if you use Gradle), but this can be overwritten with the `pact.rootDir` system property. This property needs to be set on the test JVM as most build tools will fork a new JVM to run the tests. For Gradle, add this to your build.gradle: ```groovy test { systemProperties['pact.rootDir'] = "$buildDir/custom-pacts-directory" } ``` For maven, use the systemPropertyVariables configuration: ```xml <project> [...] <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.18</version> <configuration> <systemPropertyVariables> <pact.rootDir>some/other/directory</pact.rootDir> <buildDirectory>${project.build.directory}</buildDirectory> [...] </systemPropertyVariables> </configuration> </plugin> </plugins> </build> [...] </project> ``` For SBT: ```scala fork in Test := true, javaOptions in Test := Seq("-Dpact.rootDir=some/other/directory") ``` ### Using `@PactFolder` annotation [3.6.2+] You can override the directory the pacts are written in a test by adding the `@PactFolder` annotation to the test class. ## Forcing pact files to be overwritten (3.6.5+) By default, when the pact file is written, it will be merged with any existing pact file. To force the file to be overwritten, set the Java system property `pact.writer.overwrite` to `true`. ## Unsupported The current implementation does not support tests with multiple providers. This will be added in a later release. # Having values injected from provider state callbacks (3.6.11+) You can have values from the provider state callbacks be injected into most places (paths, query parameters, headers, bodies, etc.). This works by using the V3 spec generators with provider state callbacks that return values. One example of where this would be useful is API calls that require an ID which would be auto-generated by the database on the provider side, so there is no way to know what the ID would be beforehand. The following DSL methods all you to set an expression that will be parsed with the values returned from the provider states: For JSON bodies, use `valueFromProviderState`.<br/> For headers, use `headerFromProviderState`.<br/> For query parameters, use `queryParameterFromProviderState`.<br/> For paths, use `pathFromProviderState`. For example, assume that an API call is made to get the details of a user by ID. A provider state can be defined that specifies that the user must be exist, but the ID will be created when the user is created. So we can then define an expression for the path where the ID will be replaced with the value returned from the provider state callback. ```java .pathFromProviderState("/api/users/${id}", "/api/users/100") ``` You can also just use the key instead of an expression: ```java .valueFromProviderState('userId', 'userId', 100) // will look value using userId as the key ```
https://github.com/DiUS/pact-jvm
Apache 2
Travis Dixon Ronald Holshausen
need maven using junit5 userid plugin assertthat providers created interfaces pactconsumertestext junit5_2 points quot host defined pactdslwithprovider builder topact systemproperties available calls project system headerfromproviderstate returnresponse each examples spec pactproviderrule made states providername loopback side written multitest write current tell resolves look define later needs works either artifact getstatuscode pattern ioexception what base library extendwith having runs configuration public returned methods expression body pathfromproviderstate injecting apache consumer same willrespondwith localhost must values would parameters pactrunner requestresponsepact control execute replaces unsupported hostname dpact places replaced that override generated rootdir queryparameterfromproviderstate require example does valuefromproviderstate result valid existing mockserver annotated basedir following json especially callbacks name pactfolder multiple interactions injected provider still junit responsetest builddirectory which there changing overwrite usage provided server java bind adding pacts test annotation given file only groupid central final fork groovy support forcing random interaction geturl create builddir binds articlesprovider then will auto bodies some generators port getting examplejavaconsumerpacttest plugins query link most createpact build version normally tests note similar just files articles mock return true void helps machines overwritten extension directory beforehand articlestest callback method specifies force headers follows users pacttestfor where used dependency tools apos request when value useful returns writer test_consumer custom status throws class property machine systempropertyvariables surefire matching pact default parsed gradle rest this release call other javaoptions pactmethod have state uponreceiving httpresponse from scala artifactid parameter paths details allows setup path exist with added your into getstatusline interface adapter know database address implementation target specification instead equalto assume group first also user merged dius step
Aggregated version Version Update time
3.6 3.6.15 Apr 29, 2020
3.6.14 Sep 28, 2019
3.6.13 Sep 08, 2019
3.6.12 Jul 21, 2019
3.6.11 Jul 07, 2019
3.6.10 Jun 26, 2019
3.6.9 Jun 20, 2019
3.6.8 Jun 15, 2019
3.6.7 May 12, 2019
3.6.6 May 05, 2019
3.6.5 Apr 21, 2019
3.6.4 Apr 14, 2019
3.6.3 Mar 31, 2019
3.6.2 Feb 17, 2019
3.6.1 Dec 16, 2018
3.6.0 Dec 02, 2018
3.6.0-rc.1 Oct 21, 2018
3.6.0-rc.0 Sep 22, 2018
3.5 3.5.25 Apr 14, 2019
3.5.24 Nov 04, 2018
3.5.23 Sep 23, 2018
3.5.22 Sep 09, 2018
3.5.21 Aug 12, 2018
3.5.20 Jul 28, 2018
3.5.19 Jul 01, 2018
3.5.18 Jun 17, 2018
3.5.17 Jun 03, 2018
3.5.16 May 06, 2018
3.5.15 Apr 22, 2018
29 Records