From 7970910ef25f780c8aeaffacae630e8a837eefb1 Mon Sep 17 00:00:00 2001 From: Ronald Holshausen Date: Sun, 22 Apr 2018 14:43:01 +1000 Subject: [PATCH] Corrected the readme for JUnit 5 tests #576 --- README.md | 3 ++- pact-jvm-consumer-junit5/README.md | 9 +++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3cec183fb3..facd3185d4 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,8 @@ You want to look at: [scala-pact](https://github.com/ITV/scala-pact) or [pact-jv ### I Use Java -You want to look at: [pact-jvm-consumer-junit](pact-jvm-consumer-junit). Also, if you are using Java 8, there is [an +You want to look at: [pact-jvm-consumer-junit](pact-jvm-consumer-junit) for JUnit 4 tests and +[pact-jvm-consumer-junit5](pact-jvm-consumer-junit5) for JUnit 5 tests. Also, if you are using Java 8, there is [an updated DSL for consumer tests](pact-jvm-consumer-java8). ### I Use Groovy or Grails diff --git a/pact-jvm-consumer-junit5/README.md b/pact-jvm-consumer-junit5/README.md index 230c45090a..0c51fa361d 100644 --- a/pact-jvm-consumer-junit5/README.md +++ b/pact-jvm-consumer-junit5/README.md @@ -48,7 +48,7 @@ interactions for the test. 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](/home/ronald/Development/Projects/Pact/pact-jvm/pact-jvm-consumer-junit5/src/test/groovy/au/com/dius/pact/consumer/junit5/MultiTest.groovy). +[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 @@ -63,7 +63,7 @@ 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 | @@ -72,12 +72,13 @@ public class ExampleJavaConsumerPactTest { #### 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. +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). +needs a `@Pact` annotation). See [MultiTest](src/test/groovy/au/com/dius/pact/consumer/junit5/MultiTest.groovy) for an example. ## Unsupported