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.
https://github.com/DiUS/pact-jvm
Apache 2
Travis Dixon Ronald Holshausen
need maven using junit5 plugin assertthat providers interfaces pactconsumertestext junit5_2 points quot host pactdslwithprovider builder topact systemproperties available project system returnresponse each examples pactproviderrule providername loopback written multitest write current tell resolves define later needs either artifact getstatuscode pattern ioexception extendwith library base runs public configuration body injecting apache consumer same willrespondwith localhost values pactrunner requestresponsepact control execute replaces unsupported hostname dpact that override rootdir example does result valid existing mockserver annotated basedir especially json name pactfolder multiple interactions injected still provider junit responsetest builddirectory overwrite changing provided usage java server pacts adding bind test annotation given file only groupid central final fork groovy support forcing random interaction geturl create builddir binds articlesprovider then will some port getting examplejavaconsumerpacttest plugins link most createpact build version normally tests note similar files articles mock return true void helps machines overwritten extension directory articlestest method force follows pacttestfor used dependency tools apos request when returns writer test_consumer custom status throws class property machine systempropertyvariables default pact matching surefire gradle rest release this other javaoptions pactmethod uponreceiving state httpresponse scala artifactid parameter allows setup path with added your into getstatusline adapter interface address implementation specification target equalto group first also merged dius step
文件下载
文件名 操作
pact-jvm-consumer-junit5_2.12-3.6.8.jar 下载
pact-jvm-consumer-junit5_2.12-3.6.8.pom 下载
pact-jvm-consumer-junit5_2.12-3.6.8-sources.jar 下载
Apache Maven 
<dependency>
  <groupId>au.com.dius</groupId>
  <artifactId>pact-jvm-consumer-junit5_2.12</artifactId>
  <version>3.6.8</version>
</dependency>
Gradle Groovy 
implementation 'au.com.dius:pact-jvm-consumer-junit5_2.12:3.6.8'
Gradle Kotlin 
implementation("au.com.dius:pact-jvm-consumer-junit5_2.12:3.6.8")
Scala SBT 
libraryDependencies += "au.com.dius" % "pact-jvm-consumer-junit5_2.12" % "3.6.8"
Groovy Grape 
@Grapes(
  @Grab(group='au.com.dius', module='pact-jvm-consumer-junit5_2.12', version='3.6.8')
)
Apache Ivy 
<dependency org="au.com.dius" name="pact-jvm-consumer-junit5_2.12" rev="3.6.8" />
Leiningen 
[au.com.dius/pact-jvm-consumer-junit5_2.12 "3.6.8"]
Apache Buildr 
'au.com.dius:pact-jvm-consumer-junit5_2.12:jar:3.6.8'
本项目依赖

compile

|-- au.com.dius:pact-jvm-consumer_2.12:3.6.8

|-- org.junit.jupiter:junit-jupiter-api:5.2.0

test

|-- org.hamcrest:hamcrest:2.1

|-- org.spockframework:spock-core:1.3-groovy-2.5

|-- net.bytebuddy:byte-buddy:1.9.13

|-- org.objenesis:objenesis:3.0.1

|-- org.codehaus.groovy:groovy:2.5.6

|-- ch.qos.logback:logback-core:1.2.3

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

|-- org.codehaus.groovy.modules.http-builder:http-builder:0.7.1

|-- org.codehaus.groovy:groovy-xml:2.5.6

|-- org.apache.commons:commons-io:1.3.2

|-- org.junit.jupiter:junit-jupiter-engine:5.2.0

|-- org.junit.vintage:junit-vintage-engine:5.2.0