Download all versions of pact-jvm-provider-maven_2.12 JAR files with all dependencies
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.13)
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.12)
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.11)
Maven plugin to verify a provider [version 2.1.9+]
==================================================
Maven plugin for verifying pacts against a provider.
The Maven plugin provides a `verify` goal which will verify all configured pacts against your provider.
## To Use It
### 1. Add the pact-jvm-provider-maven plugin to your `build` section of your pom file.
```xml
<build>
[...]
<plugins>
[...]
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
</plugin>
[...]
</plugins>
[...]
</build>
```
### 2. Define the pacts between your consumers and providers
You define all the providers and consumers within the configuration element of the maven plugin.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<consumers>
<!-- Again, you can define as many consumers for each provider as you need, but each must have a unique name -->
<consumer>
<name>consumer1</name>
<!-- currently supports a file path using pactFile or a URL using pactUrl -->
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### 3. Execute `mvn pact:verify`
You will have to have your provider running for this to pass.
## Verifying all pact files in a directory for a provider. [2.1.10+]
You can specify a directory that contains pact files, and the Pact plugin will scan for all pact files that match that
provider and define a consumer for each pact file in the directory. Consumer name is read from contents of pact file.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Enabling insecure SSL [version 2.2.8+]
For providers that are running on SSL with self-signed certificates, you need to enable insecure SSL mode by setting
`<insecure>true</insecure>` on the provider.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<insecure>true</insecure>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Specifying a custom trust store [version 2.2.8+]
For environments that are running their own certificate chains:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<trustStore>relative/path/to/trustStore.jks</trustStore>
<trustStorePassword>changeit</trustStorePassword>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
`trustStore` is either relative to the current working (build) directory. `trustStorePassword` defaults to `changeit`.
NOTE: The hostname will still be verified against the certificate.
## Modifying the requests before they are sent
Sometimes you may need to add things to the requests that can't be persisted in a pact file. Examples of these would
be authentication tokens, which have a small life span. The Pact Maven plugin provides a request filter that can be
set to a Groovy script on the provider that will be called before the request is made. This script will receive the HttpRequest
bound to a variable named `request` prior to it being executed.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<requestFilter>
// This is a Groovy script that adds an Authorization header to each request
request.addHeader('Authorization', 'oauth-token eyJhbGciOiJSUzI1NiIsIm...')
</requestFilter>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
__*Important Note:*__ You should only use this feature for things that can not be persisted in the pact file. By modifying
the request, you are potentially modifying the contract from the consumer tests!
## Modifying the HTTP Client Used [version 2.2.4+]
The default HTTP client is used for all requests to providers (created with a call to `HttpClients.createDefault()`).
This can be changed by specifying a closure assigned to createClient on the provider that returns a CloseableHttpClient.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<createClient>
// This is a Groovy script that will enable the client to accept self-signed certificates
import org.apache.http.ssl.SSLContextBuilder
import org.apache.http.conn.ssl.NoopHostnameVerifier
import org.apache.http.impl.client.HttpClients
HttpClients.custom().setSSLHostnameVerifier(new NoopHostnameVerifier())
.setSslcontext(new SSLContextBuilder().loadTrustMaterial(null, { x509Certificates, s -> true })
.build())
.build()
</createClient>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Turning off URL decoding of the paths in the pact file [version 3.3.3+]
By default the paths loaded from the pact file will be decoded before the request is sent to the provider. To turn this
behaviour off, set the system property `pact.verifier.disableUrlPathDecoding` to `true`.
__*Important Note:*__ If you turn off the url path decoding, you need to ensure that the paths in the pact files are
correctly encoded. The verifier will not be able to make a request with an invalid encoded path.
## Plugin Properties
The following plugin properties can be specified with `-Dproperty=value` on the command line or in the configuration section:
|Property|Description|
|--------|-----------|
|pact.showStacktrace|This turns on stacktrace printing for each request. It can help with diagnosing network errors|
|pact.showFullDiff|This turns on displaying the full diff of the expected versus actual bodies [version 3.3.6+]|
|pact.filter.consumers|Comma seperated list of consumer names to verify|
|pact.filter.description|Only verify interactions whose description match the provided regular expression|
|pact.filter.providerState|Only verify interactions whose provider state match the provided regular expression. An empty string matches interactions that have no state|
|pact.verifier.publishResults|Publishing of verification results will be skipped if this property is set to false|
Example in the configuration section:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<configuration>
<pact.showStacktrace>true</pact.showStacktrace>
</configuration>
</configuration>
</plugin>
```
## Provider States
For each provider you can specify a state change URL to use to switch the state of the provider. This URL will
receive the providerState description and parameters from the pact file before each interaction via a POST. The stateChangeUsesBody
controls if the state is passed in the request body or as query parameters.
These values can be set at the provider level, or for a specific consumer. Consumer values take precedent if both are given.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChangeForConsumer1</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
If the `stateChangeUsesBody` is not specified, or is set to true, then the provider state description and parameters will be sent as
JSON in the body of the request. If it is set to false, they will passed as query parameters.
As for normal requests (see Modifying the requests before they are sent), a state change request can be modified before
it is sent. Set `stateChangeRequestFilter` to a Groovy script on the provider that will be called before the request is made.
#### Teardown calls for state changes [version 3.2.5/2.4.7+]
You can enable teardown state change calls by setting the property `<stateChangeTeardown>true</stateChangeTeardown>` on the provider. This
will add an `action` parameter to the state change call. The setup call before the test will receive `action=setup`, and
then a teardown call will be made afterwards to the state change URL with `action=teardown`.
## Verifying pact files from a pact broker [version 3.1.1+/2.3.1+]
You can setup your build to validate against the pacts stored in a pact broker. The pact plugin will query
the pact broker for all consumers that have a pact with the provider based on its name. To use it, just configure the
`pactBrokerUrl` or `pactBroker` value for the provider with the base URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBrokerUrl>http://pact-broker:5000/</pactBrokerUrl>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an authenticated pact broker [version 3.3.5+]
If your pact broker requires authentication (basic authentication is only supported), you can configure the username
and password to use by configuring the `authentication` element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<authentication>
<username>test</username>
<password>test</password>
</authentication>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.12</artifactId>
<version>3.5.6</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<serverId>test-pact-broker</serverId> <!-- This must match the server id in the maven settings -->
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an pact broker that match particular tags [version 3.3.5+]
If your pacts in your pact broker have been tagged, you can set the tags to fetch by configuring the `tags`
element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<tags>
<tag>TEST</tag>
<tag>DEV</tag>
</tags>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
This example will fetch and validate the pacts for the TEST and DEV tags.
## Filtering the interactions that are verified
You can filter the interactions that are run using three properties: `pact.filter.consumers`, `pact.filter.description` and `pact.filter.providerState`.
Adding `-Dpact.filter.consumers=consumer1,consumer2` to the command line or configuration section will only run the pact files for those
consumers (consumer1 and consumer2). Adding `-Dpact.filter.description=a request for payment.*` will only run those interactions
whose descriptions start with 'a request for payment'. `-Dpact.filter.providerState=.*payment` will match any interaction that
has a provider state that ends with payment, and `-Dpact.filter.providerState=` will match any interaction that does not have a
provider state.
# Verifying a message provider [version 2.2.12+]
The Maven plugin has been updated to allow invoking test methods that can return the message contents from a message
producer. To use it, set the way to invoke the verification to `ANNOTATED_METHOD`. This will allow the pact verification
task to scan for test methods that return the message contents.
Add something like the following to your maven pom file:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<!-- packagesToScan is optional, but leaving it out will result in the entire
test classpath being scanned. Set it to the packages where your annotated test method
can be found. -->
<packagesToScan>
<packageToScan>au.com.example.messageprovider.*</packageToScan>
</packagesToScan>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
Now when the pact verify task is run, will look for methods annotated with `@PactVerifyProvider` in the test classpath
that have a matching description to what is in the pact file.
```groovy
class ConfirmationKafkaMessageBuilderTest {
@PactVerifyProvider('an order confirmation message')
String verifyMessageForOrder() {
Order order = new Order()
order.setId(10000004)
order.setExchange('ASX')
order.setSecurityCode('CBA')
order.setPrice(BigDecimal.TEN)
order.setUnits(15)
order.setGst(new BigDecimal('15.0'))
odrer.setFees(BigDecimal.TEN)
def message = new ConfirmationKafkaMessageBuilder()
.withOrder(order)
.build()
JsonOutput.toJson(message)
}
}
```
It will then validate that the returned contents matches the contents for the message in the pact file.
## Changing the class path that is scanned
By default, the test classpath is scanned for annotated methods. You can override this by setting
the `classpathElements` property:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<classpathElements>
<classpathElement>
build/classes/test
</classpathElement>
</classpathElements>
</configuration>
</plugin>
```
# Publishing pact files to a pact broker [version 3.2.0+]
The pact maven plugin provides a `publish` mojo that can publish all pact files in a directory
to a pact broker. To use it, you need to add a publish configuration to the POM that defines the
directory where the pact files are and the URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<pactDirectory>path/to/pact/files</pactDirectory> <!-- Defaults to ${project.build.directory}/pacts -->
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<projectVersion>1.0.100</projectVersion> <!-- Defaults to ${project.version} -->
<trimSnapshot>true</trimSnapshot> <!-- Defaults to false -->
</configuration>
</plugin>
```
You can now execute `mvn pact:publish` to publish the pact files.
_NOTE:_ The pact broker requires a version for all published pacts. The `publish` task will use the version of the
project by default, but can be overwritten with the `projectVersion` property. Make sure you have set one otherwise the broker will reject the pact files.
_NOTE_: By default, the pact broker has issues parsing `SNAPSHOT` versions. You can configure the publisher to
automatically remove `-SNAPSHOT` from your version number by setting `trimSnapshot` to true. This setting does not modify non-snapshot versions.
## Publishing to an authenticated pact broker [version 3.3.9+]
For an authenticated pact broker, you can pass in the credentials with the `pactBrokerUsername` and `pactBrokerPassword`
properties. Currently it only supports basic authentication.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerUsername>USERNAME</pactBrokerUsername>
<pactBrokerPassword>PASSWORD</pactBrokerPassword>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerServerId>test-pact-broker</pactBrokerServerId> <!-- This must match the server id in the maven settings -->
</configuration>
</plugin>
```
# Publishing verification results to a Pact Broker [version 3.5.4+]
For pacts that are loaded from a Pact Broker, the results of running the verification will be published back to the
broker against the URL for the pact. You will be able to see the result on the Pact Broker home screen.
To turn off the verification publishing when running from your local machine, set the system property `pact.verifier.publishResults` to `false`.
Artifact pact-jvm-provider-maven_2.12
Group au.com.dius
Version 3.5.11
Last update 18. December 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message expected 5000 entire jsonoutput which classpathelements take adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative pactverifyprovider classpath requires matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace turn ends contents decoded calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer variable publishing disableurlpathdecoding both must descriptions values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties publishresults 1234 default pact match filter call reject allow have specific behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions skipped target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 13
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
Group au.com.dius
Version 3.5.11
Last update 18. December 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message expected 5000 entire jsonoutput which classpathelements take adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative pactverifyprovider classpath requires matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace turn ends contents decoded calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer variable publishing disableurlpathdecoding both must descriptions values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties publishresults 1234 default pact match filter call reject allow have specific behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions skipped target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 13
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.10)
Maven plugin to verify a provider [version 2.1.9+]
==================================================
Maven plugin for verifying pacts against a provider.
The Maven plugin provides a `verify` goal which will verify all configured pacts against your provider.
## To Use It
### 1. Add the pact-jvm-provider-maven plugin to your `build` section of your pom file.
```xml
<build>
[...]
<plugins>
[...]
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
</plugin>
[...]
</plugins>
[...]
</build>
```
### 2. Define the pacts between your consumers and providers
You define all the providers and consumers within the configuration element of the maven plugin.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<consumers>
<!-- Again, you can define as many consumers for each provider as you need, but each must have a unique name -->
<consumer>
<name>consumer1</name>
<!-- currently supports a file path using pactFile or a URL using pactUrl -->
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### 3. Execute `mvn pact:verify`
You will have to have your provider running for this to pass.
## Verifying all pact files in a directory for a provider. [2.1.10+]
You can specify a directory that contains pact files, and the Pact plugin will scan for all pact files that match that
provider and define a consumer for each pact file in the directory. Consumer name is read from contents of pact file.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Enabling insecure SSL [version 2.2.8+]
For providers that are running on SSL with self-signed certificates, you need to enable insecure SSL mode by setting
`<insecure>true</insecure>` on the provider.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<insecure>true</insecure>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Specifying a custom trust store [version 2.2.8+]
For environments that are running their own certificate chains:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<trustStore>relative/path/to/trustStore.jks</trustStore>
<trustStorePassword>changeit</trustStorePassword>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
`trustStore` is either relative to the current working (build) directory. `trustStorePassword` defaults to `changeit`.
NOTE: The hostname will still be verified against the certificate.
## Modifying the requests before they are sent
Sometimes you may need to add things to the requests that can't be persisted in a pact file. Examples of these would
be authentication tokens, which have a small life span. The Pact Maven plugin provides a request filter that can be
set to a Groovy script on the provider that will be called before the request is made. This script will receive the HttpRequest
bound to a variable named `request` prior to it being executed.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<requestFilter>
// This is a Groovy script that adds an Authorization header to each request
request.addHeader('Authorization', 'oauth-token eyJhbGciOiJSUzI1NiIsIm...')
</requestFilter>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
__*Important Note:*__ You should only use this feature for things that can not be persisted in the pact file. By modifying
the request, you are potentially modifying the contract from the consumer tests!
## Modifying the HTTP Client Used [version 2.2.4+]
The default HTTP client is used for all requests to providers (created with a call to `HttpClients.createDefault()`).
This can be changed by specifying a closure assigned to createClient on the provider that returns a CloseableHttpClient.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<createClient>
// This is a Groovy script that will enable the client to accept self-signed certificates
import org.apache.http.ssl.SSLContextBuilder
import org.apache.http.conn.ssl.NoopHostnameVerifier
import org.apache.http.impl.client.HttpClients
HttpClients.custom().setSSLHostnameVerifier(new NoopHostnameVerifier())
.setSslcontext(new SSLContextBuilder().loadTrustMaterial(null, { x509Certificates, s -> true })
.build())
.build()
</createClient>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Turning off URL decoding of the paths in the pact file [version 3.3.3+]
By default the paths loaded from the pact file will be decoded before the request is sent to the provider. To turn this
behaviour off, set the system property `pact.verifier.disableUrlPathDecoding` to `true`.
__*Important Note:*__ If you turn off the url path decoding, you need to ensure that the paths in the pact files are
correctly encoded. The verifier will not be able to make a request with an invalid encoded path.
## Plugin Properties
The following plugin properties can be specified with `-Dproperty=value` on the command line or in the configuration section:
|Property|Description|
|--------|-----------|
|pact.showStacktrace|This turns on stacktrace printing for each request. It can help with diagnosing network errors|
|pact.showFullDiff|This turns on displaying the full diff of the expected versus actual bodies [version 3.3.6+]|
|pact.filter.consumers|Comma seperated list of consumer names to verify|
|pact.filter.description|Only verify interactions whose description match the provided regular expression|
|pact.filter.providerState|Only verify interactions whose provider state match the provided regular expression. An empty string matches interactions that have no state|
|pact.verifier.publishResults|Publishing of verification results will be skipped if this property is set to false|
Example in the configuration section:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<configuration>
<pact.showStacktrace>true</pact.showStacktrace>
</configuration>
</configuration>
</plugin>
```
## Provider States
For each provider you can specify a state change URL to use to switch the state of the provider. This URL will
receive the providerState description and parameters from the pact file before each interaction via a POST. The stateChangeUsesBody
controls if the state is passed in the request body or as query parameters.
These values can be set at the provider level, or for a specific consumer. Consumer values take precedent if both are given.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChangeForConsumer1</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
If the `stateChangeUsesBody` is not specified, or is set to true, then the provider state description and parameters will be sent as
JSON in the body of the request. If it is set to false, they will passed as query parameters.
As for normal requests (see Modifying the requests before they are sent), a state change request can be modified before
it is sent. Set `stateChangeRequestFilter` to a Groovy script on the provider that will be called before the request is made.
#### Teardown calls for state changes [version 3.2.5/2.4.7+]
You can enable teardown state change calls by setting the property `<stateChangeTeardown>true</stateChangeTeardown>` on the provider. This
will add an `action` parameter to the state change call. The setup call before the test will receive `action=setup`, and
then a teardown call will be made afterwards to the state change URL with `action=teardown`.
## Verifying pact files from a pact broker [version 3.1.1+/2.3.1+]
You can setup your build to validate against the pacts stored in a pact broker. The pact plugin will query
the pact broker for all consumers that have a pact with the provider based on its name. To use it, just configure the
`pactBrokerUrl` or `pactBroker` value for the provider with the base URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBrokerUrl>http://pact-broker:5000/</pactBrokerUrl>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an authenticated pact broker [version 3.3.5+]
If your pact broker requires authentication (basic authentication is only supported), you can configure the username
and password to use by configuring the `authentication` element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<authentication>
<username>test</username>
<password>test</password>
</authentication>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.12</artifactId>
<version>3.5.6</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<serverId>test-pact-broker</serverId> <!-- This must match the server id in the maven settings -->
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an pact broker that match particular tags [version 3.3.5+]
If your pacts in your pact broker have been tagged, you can set the tags to fetch by configuring the `tags`
element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<tags>
<tag>TEST</tag>
<tag>DEV</tag>
</tags>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
This example will fetch and validate the pacts for the TEST and DEV tags.
## Filtering the interactions that are verified
You can filter the interactions that are run using three properties: `pact.filter.consumers`, `pact.filter.description` and `pact.filter.providerState`.
Adding `-Dpact.filter.consumers=consumer1,consumer2` to the command line or configuration section will only run the pact files for those
consumers (consumer1 and consumer2). Adding `-Dpact.filter.description=a request for payment.*` will only run those interactions
whose descriptions start with 'a request for payment'. `-Dpact.filter.providerState=.*payment` will match any interaction that
has a provider state that ends with payment, and `-Dpact.filter.providerState=` will match any interaction that does not have a
provider state.
# Verifying a message provider [version 2.2.12+]
The Maven plugin has been updated to allow invoking test methods that can return the message contents from a message
producer. To use it, set the way to invoke the verification to `ANNOTATED_METHOD`. This will allow the pact verification
task to scan for test methods that return the message contents.
Add something like the following to your maven pom file:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<!-- packagesToScan is optional, but leaving it out will result in the entire
test classpath being scanned. Set it to the packages where your annotated test method
can be found. -->
<packagesToScan>
<packageToScan>au.com.example.messageprovider.*</packageToScan>
</packagesToScan>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
Now when the pact verify task is run, will look for methods annotated with `@PactVerifyProvider` in the test classpath
that have a matching description to what is in the pact file.
```groovy
class ConfirmationKafkaMessageBuilderTest {
@PactVerifyProvider('an order confirmation message')
String verifyMessageForOrder() {
Order order = new Order()
order.setId(10000004)
order.setExchange('ASX')
order.setSecurityCode('CBA')
order.setPrice(BigDecimal.TEN)
order.setUnits(15)
order.setGst(new BigDecimal('15.0'))
odrer.setFees(BigDecimal.TEN)
def message = new ConfirmationKafkaMessageBuilder()
.withOrder(order)
.build()
JsonOutput.toJson(message)
}
}
```
It will then validate that the returned contents matches the contents for the message in the pact file.
## Changing the class path that is scanned
By default, the test classpath is scanned for annotated methods. You can override this by setting
the `classpathElements` property:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<classpathElements>
<classpathElement>
build/classes/test
</classpathElement>
</classpathElements>
</configuration>
</plugin>
```
# Publishing pact files to a pact broker [version 3.2.0+]
The pact maven plugin provides a `publish` mojo that can publish all pact files in a directory
to a pact broker. To use it, you need to add a publish configuration to the POM that defines the
directory where the pact files are and the URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<pactDirectory>path/to/pact/files</pactDirectory> <!-- Defaults to ${project.build.directory}/pacts -->
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<projectVersion>1.0.100</projectVersion> <!-- Defaults to ${project.version} -->
<trimSnapshot>true</trimSnapshot> <!-- Defaults to false -->
</configuration>
</plugin>
```
You can now execute `mvn pact:publish` to publish the pact files.
_NOTE:_ The pact broker requires a version for all published pacts. The `publish` task will use the version of the
project by default, but can be overwritten with the `projectVersion` property. Make sure you have set one otherwise the broker will reject the pact files.
_NOTE_: By default, the pact broker has issues parsing `SNAPSHOT` versions. You can configure the publisher to
automatically remove `-SNAPSHOT` from your version number by setting `trimSnapshot` to true. This setting does not modify non-snapshot versions.
## Publishing to an authenticated pact broker [version 3.3.9+]
For an authenticated pact broker, you can pass in the credentials with the `pactBrokerUsername` and `pactBrokerPassword`
properties. Currently it only supports basic authentication.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerUsername>USERNAME</pactBrokerUsername>
<pactBrokerPassword>PASSWORD</pactBrokerPassword>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerServerId>test-pact-broker</pactBrokerServerId> <!-- This must match the server id in the maven settings -->
</configuration>
</plugin>
```
# Publishing verification results to a Pact Broker [version 3.5.4+]
For pacts that are loaded from a Pact Broker, the results of running the verification will be published back to the
broker against the URL for the pact. You will be able to see the result on the Pact Broker home screen.
To turn off the verification publishing when running from your local machine, set the system property `pact.verifier.publishResults` to `false`.
Artifact pact-jvm-provider-maven_2.12
Group au.com.dius
Version 3.5.10
Last update 20. November 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message expected 5000 entire jsonoutput which classpathelements take adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative pactverifyprovider classpath requires matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace turn ends contents decoded calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer variable publishing disableurlpathdecoding both must descriptions values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties publishresults 1234 default pact match filter call reject allow have specific behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions skipped target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 13
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
Group au.com.dius
Version 3.5.10
Last update 20. November 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message expected 5000 entire jsonoutput which classpathelements take adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative pactverifyprovider classpath requires matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace turn ends contents decoded calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer variable publishing disableurlpathdecoding both must descriptions values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties publishresults 1234 default pact match filter call reject allow have specific behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions skipped target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 13
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.9)
Maven plugin to verify a provider [version 2.1.9+]
==================================================
Maven plugin for verifying pacts against a provider.
The Maven plugin provides a `verify` goal which will verify all configured pacts against your provider.
## To Use It
### 1. Add the pact-jvm-provider-maven plugin to your `build` section of your pom file.
```xml
<build>
[...]
<plugins>
[...]
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
</plugin>
[...]
</plugins>
[...]
</build>
```
### 2. Define the pacts between your consumers and providers
You define all the providers and consumers within the configuration element of the maven plugin.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<consumers>
<!-- Again, you can define as many consumers for each provider as you need, but each must have a unique name -->
<consumer>
<name>consumer1</name>
<!-- currently supports a file path using pactFile or a URL using pactUrl -->
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### 3. Execute `mvn pact:verify`
You will have to have your provider running for this to pass.
## Verifying all pact files in a directory for a provider. [2.1.10+]
You can specify a directory that contains pact files, and the Pact plugin will scan for all pact files that match that
provider and define a consumer for each pact file in the directory. Consumer name is read from contents of pact file.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Enabling insecure SSL [version 2.2.8+]
For providers that are running on SSL with self-signed certificates, you need to enable insecure SSL mode by setting
`<insecure>true</insecure>` on the provider.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<insecure>true</insecure>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Specifying a custom trust store [version 2.2.8+]
For environments that are running their own certificate chains:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<trustStore>relative/path/to/trustStore.jks</trustStore>
<trustStorePassword>changeit</trustStorePassword>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
`trustStore` is either relative to the current working (build) directory. `trustStorePassword` defaults to `changeit`.
NOTE: The hostname will still be verified against the certificate.
## Modifying the requests before they are sent
Sometimes you may need to add things to the requests that can't be persisted in a pact file. Examples of these would
be authentication tokens, which have a small life span. The Pact Maven plugin provides a request filter that can be
set to a Groovy script on the provider that will be called before the request is made. This script will receive the HttpRequest
bound to a variable named `request` prior to it being executed.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<requestFilter>
// This is a Groovy script that adds an Authorization header to each request
request.addHeader('Authorization', 'oauth-token eyJhbGciOiJSUzI1NiIsIm...')
</requestFilter>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
__*Important Note:*__ You should only use this feature for things that can not be persisted in the pact file. By modifying
the request, you are potentially modifying the contract from the consumer tests!
## Modifying the HTTP Client Used [version 2.2.4+]
The default HTTP client is used for all requests to providers (created with a call to `HttpClients.createDefault()`).
This can be changed by specifying a closure assigned to createClient on the provider that returns a CloseableHttpClient.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<createClient>
// This is a Groovy script that will enable the client to accept self-signed certificates
import org.apache.http.ssl.SSLContextBuilder
import org.apache.http.conn.ssl.NoopHostnameVerifier
import org.apache.http.impl.client.HttpClients
HttpClients.custom().setSSLHostnameVerifier(new NoopHostnameVerifier())
.setSslcontext(new SSLContextBuilder().loadTrustMaterial(null, { x509Certificates, s -> true })
.build())
.build()
</createClient>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Turning off URL decoding of the paths in the pact file [version 3.3.3+]
By default the paths loaded from the pact file will be decoded before the request is sent to the provider. To turn this
behaviour off, set the system property `pact.verifier.disableUrlPathDecoding` to `true`.
__*Important Note:*__ If you turn off the url path decoding, you need to ensure that the paths in the pact files are
correctly encoded. The verifier will not be able to make a request with an invalid encoded path.
## Plugin Properties
The following plugin properties can be specified with `-Dproperty=value` on the command line or in the configuration section:
|Property|Description|
|--------|-----------|
|pact.showStacktrace|This turns on stacktrace printing for each request. It can help with diagnosing network errors|
|pact.showFullDiff|This turns on displaying the full diff of the expected versus actual bodies [version 3.3.6+]|
|pact.filter.consumers|Comma seperated list of consumer names to verify|
|pact.filter.description|Only verify interactions whose description match the provided regular expression|
|pact.filter.providerState|Only verify interactions whose provider state match the provided regular expression. An empty string matches interactions that have no state|
|pact.verifier.publishResults|Publishing of verification results will be skipped if this property is set to false|
Example in the configuration section:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<configuration>
<pact.showStacktrace>true</pact.showStacktrace>
</configuration>
</configuration>
</plugin>
```
## Provider States
For each provider you can specify a state change URL to use to switch the state of the provider. This URL will
receive the providerState description and parameters from the pact file before each interaction via a POST. The stateChangeUsesBody
controls if the state is passed in the request body or as query parameters.
These values can be set at the provider level, or for a specific consumer. Consumer values take precedent if both are given.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChangeForConsumer1</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
If the `stateChangeUsesBody` is not specified, or is set to true, then the provider state description and parameters will be sent as
JSON in the body of the request. If it is set to false, they will passed as query parameters.
As for normal requests (see Modifying the requests before they are sent), a state change request can be modified before
it is sent. Set `stateChangeRequestFilter` to a Groovy script on the provider that will be called before the request is made.
#### Teardown calls for state changes [version 3.2.5/2.4.7+]
You can enable teardown state change calls by setting the property `<stateChangeTeardown>true</stateChangeTeardown>` on the provider. This
will add an `action` parameter to the state change call. The setup call before the test will receive `action=setup`, and
then a teardown call will be made afterwards to the state change URL with `action=teardown`.
## Verifying pact files from a pact broker [version 3.1.1+/2.3.1+]
You can setup your build to validate against the pacts stored in a pact broker. The pact plugin will query
the pact broker for all consumers that have a pact with the provider based on its name. To use it, just configure the
`pactBrokerUrl` or `pactBroker` value for the provider with the base URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBrokerUrl>http://pact-broker:5000/</pactBrokerUrl>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an authenticated pact broker [version 3.3.5+]
If your pact broker requires authentication (basic authentication is only supported), you can configure the username
and password to use by configuring the `authentication` element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<authentication>
<username>test</username>
<password>test</password>
</authentication>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.12</artifactId>
<version>3.5.6</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<serverId>test-pact-broker</serverId> <!-- This must match the server id in the maven settings -->
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an pact broker that match particular tags [version 3.3.5+]
If your pacts in your pact broker have been tagged, you can set the tags to fetch by configuring the `tags`
element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<tags>
<tag>TEST</tag>
<tag>DEV</tag>
</tags>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
This example will fetch and validate the pacts for the TEST and DEV tags.
## Filtering the interactions that are verified
You can filter the interactions that are run using three properties: `pact.filter.consumers`, `pact.filter.description` and `pact.filter.providerState`.
Adding `-Dpact.filter.consumers=consumer1,consumer2` to the command line or configuration section will only run the pact files for those
consumers (consumer1 and consumer2). Adding `-Dpact.filter.description=a request for payment.*` will only run those interactions
whose descriptions start with 'a request for payment'. `-Dpact.filter.providerState=.*payment` will match any interaction that
has a provider state that ends with payment, and `-Dpact.filter.providerState=` will match any interaction that does not have a
provider state.
# Verifying a message provider [version 2.2.12+]
The Maven plugin has been updated to allow invoking test methods that can return the message contents from a message
producer. To use it, set the way to invoke the verification to `ANNOTATED_METHOD`. This will allow the pact verification
task to scan for test methods that return the message contents.
Add something like the following to your maven pom file:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<!-- packagesToScan is optional, but leaving it out will result in the entire
test classpath being scanned. Set it to the packages where your annotated test method
can be found. -->
<packagesToScan>
<packageToScan>au.com.example.messageprovider.*</packageToScan>
</packagesToScan>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
Now when the pact verify task is run, will look for methods annotated with `@PactVerifyProvider` in the test classpath
that have a matching description to what is in the pact file.
```groovy
class ConfirmationKafkaMessageBuilderTest {
@PactVerifyProvider('an order confirmation message')
String verifyMessageForOrder() {
Order order = new Order()
order.setId(10000004)
order.setExchange('ASX')
order.setSecurityCode('CBA')
order.setPrice(BigDecimal.TEN)
order.setUnits(15)
order.setGst(new BigDecimal('15.0'))
odrer.setFees(BigDecimal.TEN)
def message = new ConfirmationKafkaMessageBuilder()
.withOrder(order)
.build()
JsonOutput.toJson(message)
}
}
```
It will then validate that the returned contents matches the contents for the message in the pact file.
## Changing the class path that is scanned
By default, the test classpath is scanned for annotated methods. You can override this by setting
the `classpathElements` property:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<classpathElements>
<classpathElement>
build/classes/test
</classpathElement>
</classpathElements>
</configuration>
</plugin>
```
# Publishing pact files to a pact broker [version 3.2.0+]
The pact maven plugin provides a `publish` mojo that can publish all pact files in a directory
to a pact broker. To use it, you need to add a publish configuration to the POM that defines the
directory where the pact files are and the URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<pactDirectory>path/to/pact/files</pactDirectory> <!-- Defaults to ${project.build.directory}/pacts -->
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<projectVersion>1.0.100</projectVersion> <!-- Defaults to ${project.version} -->
<trimSnapshot>true</trimSnapshot> <!-- Defaults to false -->
</configuration>
</plugin>
```
You can now execute `mvn pact:publish` to publish the pact files.
_NOTE:_ The pact broker requires a version for all published pacts. The `publish` task will use the version of the
project by default, but can be overwritten with the `projectVersion` property. Make sure you have set one otherwise the broker will reject the pact files.
_NOTE_: By default, the pact broker has issues parsing `SNAPSHOT` versions. You can configure the publisher to
automatically remove `-SNAPSHOT` from your version number by setting `trimSnapshot` to true. This setting does not modify non-snapshot versions.
## Publishing to an authenticated pact broker [version 3.3.9+]
For an authenticated pact broker, you can pass in the credentials with the `pactBrokerUsername` and `pactBrokerPassword`
properties. Currently it only supports basic authentication.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerUsername>USERNAME</pactBrokerUsername>
<pactBrokerPassword>PASSWORD</pactBrokerPassword>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerServerId>test-pact-broker</pactBrokerServerId> <!-- This must match the server id in the maven settings -->
</configuration>
</plugin>
```
# Publishing verification results to a Pact Broker [version 3.5.4+]
For pacts that are loaded from a Pact Broker, the results of running the verification will be published back to the
broker against the URL for the pact. You will be able to see the result on the Pact Broker home screen.
To turn off the verification publishing when running from your local machine, set the system property `pact.verifier.publishResults` to `false`.
Artifact pact-jvm-provider-maven_2.12
Group au.com.dius
Version 3.5.9
Last update 15. November 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message expected 5000 entire jsonoutput which classpathelements take adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative pactverifyprovider classpath requires matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace turn ends contents decoded calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer variable publishing disableurlpathdecoding both must descriptions values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties publishresults 1234 default pact match filter call reject allow have specific behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions skipped target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 13
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
Group au.com.dius
Version 3.5.9
Last update 15. November 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message expected 5000 entire jsonoutput which classpathelements take adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative pactverifyprovider classpath requires matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace turn ends contents decoded calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer variable publishing disableurlpathdecoding both must descriptions values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties publishresults 1234 default pact match filter call reject allow have specific behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions skipped target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 13
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.8)
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.7)
Maven plugin to verify a provider [version 2.1.9+]
==================================================
Maven plugin for verifying pacts against a provider.
The Maven plugin provides a `verify` goal which will verify all configured pacts against your provider.
## To Use It
### 1. Add the pact-jvm-provider-maven plugin to your `build` section of your pom file.
```xml
<build>
[...]
<plugins>
[...]
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
</plugin>
[...]
</plugins>
[...]
</build>
```
### 2. Define the pacts between your consumers and providers
You define all the providers and consumers within the configuration element of the maven plugin.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<consumers>
<!-- Again, you can define as many consumers for each provider as you need, but each must have a unique name -->
<consumer>
<name>consumer1</name>
<!-- currently supports a file path using pactFile or a URL using pactUrl -->
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### 3. Execute `mvn pact:verify`
You will have to have your provider running for this to pass.
## Verifying all pact files in a directory for a provider. [2.1.10+]
You can specify a directory that contains pact files, and the Pact plugin will scan for all pact files that match that
provider and define a consumer for each pact file in the directory. Consumer name is read from contents of pact file.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Enabling insecure SSL [version 2.2.8+]
For providers that are running on SSL with self-signed certificates, you need to enable insecure SSL mode by setting
`<insecure>true</insecure>` on the provider.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<insecure>true</insecure>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Specifying a custom trust store [version 2.2.8+]
For environments that are running their own certificate chains:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<trustStore>relative/path/to/trustStore.jks</trustStore>
<trustStorePassword>changeit</trustStorePassword>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
`trustStore` is either relative to the current working (build) directory. `trustStorePassword` defaults to `changeit`.
NOTE: The hostname will still be verified against the certificate.
## Modifying the requests before they are sent
Sometimes you may need to add things to the requests that can't be persisted in a pact file. Examples of these would
be authentication tokens, which have a small life span. The Pact Maven plugin provides a request filter that can be
set to a Groovy script on the provider that will be called before the request is made. This script will receive the HttpRequest
bound to a variable named `request` prior to it being executed.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<requestFilter>
// This is a Groovy script that adds an Authorization header to each request
request.addHeader('Authorization', 'oauth-token eyJhbGciOiJSUzI1NiIsIm...')
</requestFilter>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
__*Important Note:*__ You should only use this feature for things that can not be persisted in the pact file. By modifying
the request, you are potentially modifying the contract from the consumer tests!
## Modifying the HTTP Client Used [version 2.2.4+]
The default HTTP client is used for all requests to providers (created with a call to `HttpClients.createDefault()`).
This can be changed by specifying a closure assigned to createClient on the provider that returns a CloseableHttpClient.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<createClient>
// This is a Groovy script that will enable the client to accept self-signed certificates
import org.apache.http.ssl.SSLContextBuilder
import org.apache.http.conn.ssl.NoopHostnameVerifier
import org.apache.http.impl.client.HttpClients
HttpClients.custom().setSSLHostnameVerifier(new NoopHostnameVerifier())
.setSslcontext(new SSLContextBuilder().loadTrustMaterial(null, { x509Certificates, s -> true })
.build())
.build()
</createClient>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Turning off URL decoding of the paths in the pact file [version 3.3.3+]
By default the paths loaded from the pact file will be decoded before the request is sent to the provider. To turn this
behaviour off, set the system property `pact.verifier.disableUrlPathDecoding` to `true`.
__*Important Note:*__ If you turn off the url path decoding, you need to ensure that the paths in the pact files are
correctly encoded. The verifier will not be able to make a request with an invalid encoded path.
## Plugin Properties
The following plugin properties can be specified with `-Dproperty=value` on the command line or in the configuration section:
|Property|Description|
|--------|-----------|
|pact.showStacktrace|This turns on stacktrace printing for each request. It can help with diagnosing network errors|
|pact.showFullDiff|This turns on displaying the full diff of the expected versus actual bodies [version 3.3.6+]|
|pact.filter.consumers|Comma seperated list of consumer names to verify|
|pact.filter.description|Only verify interactions whose description match the provided regular expression|
|pact.filter.providerState|Only verify interactions whose provider state match the provided regular expression. An empty string matches interactions that have no state|
|pact.verifier.publishResults|Publishing of verification results will be skipped if this property is set to false|
Example in the configuration section:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<configuration>
<pact.showStacktrace>true</pact.showStacktrace>
</configuration>
</configuration>
</plugin>
```
## Provider States
For each provider you can specify a state change URL to use to switch the state of the provider. This URL will
receive the providerState description and parameters from the pact file before each interaction via a POST. The stateChangeUsesBody
controls if the state is passed in the request body or as query parameters.
These values can be set at the provider level, or for a specific consumer. Consumer values take precedent if both are given.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChangeForConsumer1</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
If the `stateChangeUsesBody` is not specified, or is set to true, then the provider state description and parameters will be sent as
JSON in the body of the request. If it is set to false, they will passed as query parameters.
As for normal requests (see Modifying the requests before they are sent), a state change request can be modified before
it is sent. Set `stateChangeRequestFilter` to a Groovy script on the provider that will be called before the request is made.
#### Teardown calls for state changes [version 3.2.5/2.4.7+]
You can enable teardown state change calls by setting the property `<stateChangeTeardown>true</stateChangeTeardown>` on the provider. This
will add an `action` parameter to the state change call. The setup call before the test will receive `action=setup`, and
then a teardown call will be made afterwards to the state change URL with `action=teardown`.
## Verifying pact files from a pact broker [version 3.1.1+/2.3.1+]
You can setup your build to validate against the pacts stored in a pact broker. The pact plugin will query
the pact broker for all consumers that have a pact with the provider based on its name. To use it, just configure the
`pactBrokerUrl` or `pactBroker` value for the provider with the base URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBrokerUrl>http://pact-broker:5000/</pactBrokerUrl>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an authenticated pact broker [version 3.3.5+]
If your pact broker requires authentication (basic authentication is only supported), you can configure the username
and password to use by configuring the `authentication` element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<authentication>
<username>test</username>
<password>test</password>
</authentication>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.12</artifactId>
<version>3.5.6</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<serverId>test-pact-broker</serverId> <!-- This must match the server id in the maven settings -->
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an pact broker that match particular tags [version 3.3.5+]
If your pacts in your pact broker have been tagged, you can set the tags to fetch by configuring the `tags`
element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<tags>
<tag>TEST</tag>
<tag>DEV</tag>
</tags>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
This example will fetch and validate the pacts for the TEST and DEV tags.
## Filtering the interactions that are verified
You can filter the interactions that are run using three properties: `pact.filter.consumers`, `pact.filter.description` and `pact.filter.providerState`.
Adding `-Dpact.filter.consumers=consumer1,consumer2` to the command line or configuration section will only run the pact files for those
consumers (consumer1 and consumer2). Adding `-Dpact.filter.description=a request for payment.*` will only run those interactions
whose descriptions start with 'a request for payment'. `-Dpact.filter.providerState=.*payment` will match any interaction that
has a provider state that ends with payment, and `-Dpact.filter.providerState=` will match any interaction that does not have a
provider state.
# Verifying a message provider [version 2.2.12+]
The Maven plugin has been updated to allow invoking test methods that can return the message contents from a message
producer. To use it, set the way to invoke the verification to `ANNOTATED_METHOD`. This will allow the pact verification
task to scan for test methods that return the message contents.
Add something like the following to your maven pom file:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<!-- packagesToScan is optional, but leaving it out will result in the entire
test classpath being scanned. Set it to the packages where your annotated test method
can be found. -->
<packagesToScan>
<packageToScan>au.com.example.messageprovider.*</packageToScan>
</packagesToScan>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
Now when the pact verify task is run, will look for methods annotated with `@PactVerifyProvider` in the test classpath
that have a matching description to what is in the pact file.
```groovy
class ConfirmationKafkaMessageBuilderTest {
@PactVerifyProvider('an order confirmation message')
String verifyMessageForOrder() {
Order order = new Order()
order.setId(10000004)
order.setExchange('ASX')
order.setSecurityCode('CBA')
order.setPrice(BigDecimal.TEN)
order.setUnits(15)
order.setGst(new BigDecimal('15.0'))
odrer.setFees(BigDecimal.TEN)
def message = new ConfirmationKafkaMessageBuilder()
.withOrder(order)
.build()
JsonOutput.toJson(message)
}
}
```
It will then validate that the returned contents matches the contents for the message in the pact file.
## Changing the class path that is scanned
By default, the test classpath is scanned for annotated methods. You can override this by setting
the `classpathElements` property:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<classpathElements>
<classpathElement>
build/classes/test
</classpathElement>
</classpathElements>
</configuration>
</plugin>
```
# Publishing pact files to a pact broker [version 3.2.0+]
The pact maven plugin provides a `publish` mojo that can publish all pact files in a directory
to a pact broker. To use it, you need to add a publish configuration to the POM that defines the
directory where the pact files are and the URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<pactDirectory>path/to/pact/files</pactDirectory> <!-- Defaults to ${project.build.directory}/pacts -->
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<projectVersion>1.0.100</projectVersion> <!-- Defaults to ${project.version} -->
<trimSnapshot>true</trimSnapshot> <!-- Defaults to false -->
</configuration>
</plugin>
```
You can now execute `mvn pact:publish` to publish the pact files.
_NOTE:_ The pact broker requires a version for all published pacts. The `publish` task will use the version of the
project by default, but can be overwritten with the `projectVersion` property. Make sure you have set one otherwise the broker will reject the pact files.
_NOTE_: By default, the pact broker has issues parsing `SNAPSHOT` versions. You can configure the publisher to
automatically remove `-SNAPSHOT` from your version number by setting `trimSnapshot` to true. This setting does not modify non-snapshot versions.
## Publishing to an authenticated pact broker [version 3.3.9+]
For an authenticated pact broker, you can pass in the credentials with the `pactBrokerUsername` and `pactBrokerPassword`
properties. Currently it only supports basic authentication.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerUsername>USERNAME</pactBrokerUsername>
<pactBrokerPassword>PASSWORD</pactBrokerPassword>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerServerId>test-pact-broker</pactBrokerServerId> <!-- This must match the server id in the maven settings -->
</configuration>
</plugin>
```
# Publishing verification results to a Pact Broker [version 3.5.4+]
For pacts that are loaded from a Pact Broker, the results of running the verification will be published back to the
broker against the URL for the pact. You will be able to see the result on the Pact Broker home screen.
Note: be aware that there is not yet a configuration option to turn off the verification publishing when running from your local machine, so make sure that your CI always runs after your local tests. This feature will be added soon.
Artifact pact-jvm-provider-maven_2.12
Group au.com.dius
Version 3.5.7
Last update 02. October 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent aware apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message entire expected 5000 jsonoutput which classpathelements take there adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative classpath requires pactverifyprovider matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those added impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace option turn ends contents decoded always calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer runs variable publishing disableurlpathdecoding both must descriptions after values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider soon annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties publishresults 1234 default pact match filter call reject allow specific have behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions skipped target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 14
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, java-semver, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
Group au.com.dius
Version 3.5.7
Last update 02. October 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent aware apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message entire expected 5000 jsonoutput which classpathelements take there adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative classpath requires pactverifyprovider matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those added impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace option turn ends contents decoded always calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer runs variable publishing disableurlpathdecoding both must descriptions after values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider soon annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties publishresults 1234 default pact match filter call reject allow specific have behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions skipped target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 14
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, java-semver, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.6)
Maven plugin to verify a provider [version 2.1.9+]
==================================================
Maven plugin for verifying pacts against a provider.
The Maven plugin provides a `verify` goal which will verify all configured pacts against your provider.
## To Use It
### 1. Add the pact-jvm-provider-maven plugin to your `build` section of your pom file.
```xml
<build>
[...]
<plugins>
[...]
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
</plugin>
[...]
</plugins>
[...]
</build>
```
### 2. Define the pacts between your consumers and providers
You define all the providers and consumers within the configuration element of the maven plugin.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<consumers>
<!-- Again, you can define as many consumers for each provider as you need, but each must have a unique name -->
<consumer>
<name>consumer1</name>
<!-- currently supports a file path using pactFile or a URL using pactUrl -->
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### 3. Execute `mvn pact:verify`
You will have to have your provider running for this to pass.
## Verifying all pact files in a directory for a provider. [2.1.10+]
You can specify a directory that contains pact files, and the Pact plugin will scan for all pact files that match that
provider and define a consumer for each pact file in the directory. Consumer name is read from contents of pact file.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Enabling insecure SSL [version 2.2.8+]
For providers that are running on SSL with self-signed certificates, you need to enable insecure SSL mode by setting
`<insecure>true</insecure>` on the provider.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<insecure>true</insecure>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Specifying a custom trust store [version 2.2.8+]
For environments that are running their own certificate chains:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<trustStore>relative/path/to/trustStore.jks</trustStore>
<trustStorePassword>changeit</trustStorePassword>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
`trustStore` is either relative to the current working (build) directory. `trustStorePassword` defaults to `changeit`.
NOTE: The hostname will still be verified against the certificate.
## Modifying the requests before they are sent
Sometimes you may need to add things to the requests that can't be persisted in a pact file. Examples of these would
be authentication tokens, which have a small life span. The Pact Maven plugin provides a request filter that can be
set to a Groovy script on the provider that will be called before the request is made. This script will receive the HttpRequest
bound to a variable named `request` prior to it being executed.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<requestFilter>
// This is a Groovy script that adds an Authorization header to each request
request.addHeader('Authorization', 'oauth-token eyJhbGciOiJSUzI1NiIsIm...')
</requestFilter>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
__*Important Note:*__ You should only use this feature for things that can not be persisted in the pact file. By modifying
the request, you are potentially modifying the contract from the consumer tests!
## Modifying the HTTP Client Used [version 2.2.4+]
The default HTTP client is used for all requests to providers (created with a call to `HttpClients.createDefault()`).
This can be changed by specifying a closure assigned to createClient on the provider that returns a CloseableHttpClient.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<createClient>
// This is a Groovy script that will enable the client to accept self-signed certificates
import org.apache.http.ssl.SSLContextBuilder
import org.apache.http.conn.ssl.NoopHostnameVerifier
import org.apache.http.impl.client.HttpClients
HttpClients.custom().setSSLHostnameVerifier(new NoopHostnameVerifier())
.setSslcontext(new SSLContextBuilder().loadTrustMaterial(null, { x509Certificates, s -> true })
.build())
.build()
</createClient>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Turning off URL decoding of the paths in the pact file [version 3.3.3+]
By default the paths loaded from the pact file will be decoded before the request is sent to the provider. To turn this
behaviour off, set the system property `pact.verifier.disableUrlPathDecoding` to `true`.
__*Important Note:*__ If you turn off the url path decoding, you need to ensure that the paths in the pact files are
correctly encoded. The verifier will not be able to make a request with an invalid encoded path.
## Plugin Properties
The following plugin properties can be specified with `-Dproperty=value` on the command line or in the configuration section:
|Property|Description|
|--------|-----------|
|pact.showStacktrace|This turns on stacktrace printing for each request. It can help with diagnosing network errors|
|pact.showFullDiff|This turns on displaying the full diff of the expected versus actual bodies [version 3.3.6+]|
|pact.filter.consumers|Comma seperated list of consumer names to verify|
|pact.filter.description|Only verify interactions whose description match the provided regular expression|
|pact.filter.providerState|Only verify interactions whose provider state match the provided regular expression. An empty string matches interactions that have no state|
Example in the configuration section:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<configuration>
<pact.showStacktrace>true</pact.showStacktrace>
</configuration>
</configuration>
</plugin>
```
## Provider States
For each provider you can specify a state change URL to use to switch the state of the provider. This URL will
receive the providerState description and parameters from the pact file before each interaction via a POST. The stateChangeUsesBody
controls if the state is passed in the request body or as query parameters.
These values can be set at the provider level, or for a specific consumer. Consumer values take precedent if both are given.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChangeForConsumer1</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
If the `stateChangeUsesBody` is not specified, or is set to true, then the provider state description and parameters will be sent as
JSON in the body of the request. If it is set to false, they will passed as query parameters.
As for normal requests (see Modifying the requests before they are sent), a state change request can be modified before
it is sent. Set `stateChangeRequestFilter` to a Groovy script on the provider that will be called before the request is made.
#### Teardown calls for state changes [version 3.2.5/2.4.7+]
You can enable teardown state change calls by setting the property `<stateChangeTeardown>true</stateChangeTeardown>` on the provider. This
will add an `action` parameter to the state change call. The setup call before the test will receive `action=setup`, and
then a teardown call will be made afterwards to the state change URL with `action=teardown`.
## Verifying pact files from a pact broker [version 3.1.1+/2.3.1+]
You can setup your build to validate against the pacts stored in a pact broker. The pact plugin will query
the pact broker for all consumers that have a pact with the provider based on its name. To use it, just configure the
`pactBrokerUrl` or `pactBroker` value for the provider with the base URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBrokerUrl>http://pact-broker:5000/</pactBrokerUrl>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an authenticated pact broker [version 3.3.5+]
If your pact broker requires authentication (basic authentication is only supported), you can configure the username
and password to use by configuring the `authentication` element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<authentication>
<username>test</username>
<password>test</password>
</authentication>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.12</artifactId>
<version>3.5.6</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<serverId>test-pact-broker</serverId> <!-- This must match the server id in the maven settings -->
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an pact broker that match particular tags [version 3.3.5+]
If your pacts in your pact broker have been tagged, you can set the tags to fetch by configuring the `tags`
element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<tags>
<tag>TEST</tag>
<tag>DEV</tag>
</tags>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
This example will fetch and validate the pacts for the TEST and DEV tags.
## Filtering the interactions that are verified
You can filter the interactions that are run using three properties: `pact.filter.consumers`, `pact.filter.description` and `pact.filter.providerState`.
Adding `-Dpact.filter.consumers=consumer1,consumer2` to the command line or configuration section will only run the pact files for those
consumers (consumer1 and consumer2). Adding `-Dpact.filter.description=a request for payment.*` will only run those interactions
whose descriptions start with 'a request for payment'. `-Dpact.filter.providerState=.*payment` will match any interaction that
has a provider state that ends with payment, and `-Dpact.filter.providerState=` will match any interaction that does not have a
provider state.
# Verifying a message provider [version 2.2.12+]
The Maven plugin has been updated to allow invoking test methods that can return the message contents from a message
producer. To use it, set the way to invoke the verification to `ANNOTATED_METHOD`. This will allow the pact verification
task to scan for test methods that return the message contents.
Add something like the following to your maven pom file:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<!-- packagesToScan is optional, but leaving it out will result in the entire
test classpath being scanned. Set it to the packages where your annotated test method
can be found. -->
<packagesToScan>
<packageToScan>au.com.example.messageprovider.*</packageToScan>
</packagesToScan>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
Now when the pact verify task is run, will look for methods annotated with `@PactVerifyProvider` in the test classpath
that have a matching description to what is in the pact file.
```groovy
class ConfirmationKafkaMessageBuilderTest {
@PactVerifyProvider('an order confirmation message')
String verifyMessageForOrder() {
Order order = new Order()
order.setId(10000004)
order.setExchange('ASX')
order.setSecurityCode('CBA')
order.setPrice(BigDecimal.TEN)
order.setUnits(15)
order.setGst(new BigDecimal('15.0'))
odrer.setFees(BigDecimal.TEN)
def message = new ConfirmationKafkaMessageBuilder()
.withOrder(order)
.build()
JsonOutput.toJson(message)
}
}
```
It will then validate that the returned contents matches the contents for the message in the pact file.
## Changing the class path that is scanned
By default, the test classpath is scanned for annotated methods. You can override this by setting
the `classpathElements` property:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<classpathElements>
<classpathElement>
build/classes/test
</classpathElement>
</classpathElements>
</configuration>
</plugin>
```
# Publishing pact files to a pact broker [version 3.2.0+]
The pact maven plugin provides a `publish` mojo that can publish all pact files in a directory
to a pact broker. To use it, you need to add a publish configuration to the POM that defines the
directory where the pact files are and the URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<pactDirectory>path/to/pact/files</pactDirectory> <!-- Defaults to ${project.build.directory}/pacts -->
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<projectVersion>1.0.100</projectVersion> <!-- Defaults to ${project.version} -->
<trimSnapshot>true</trimSnapshot> <!-- Defaults to false -->
</configuration>
</plugin>
```
You can now execute `mvn pact:publish` to publish the pact files.
_NOTE:_ The pact broker requires a version for all published pacts. The `publish` task will use the version of the
project by default, but can be overwritten with the `projectVersion` property. Make sure you have set one otherwise the broker will reject the pact files.
_NOTE_: By default, the pact broker has issues parsing `SNAPSHOT` versions. You can configure the publisher to
automatically remove `-SNAPSHOT` from your version number by setting `trimSnapshot` to true. This setting does not modify non-snapshot versions.
## Publishing to an authenticated pact broker [version 3.3.9+]
For an authenticated pact broker, you can pass in the credentials with the `pactBrokerUsername` and `pactBrokerPassword`
properties. Currently it only supports basic authentication.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerUsername>USERNAME</pactBrokerUsername>
<pactBrokerPassword>PASSWORD</pactBrokerPassword>
</configuration>
</plugin>
```
#### Using the Maven servers configuration [version 3.5.6+]
From version 3.5.6, you can use the servers setup in the Maven settings. To do this, setup a server as per the
[Maven Server Settings](https://maven.apache.org/settings.html#Servers). Then set the server ID in the pact broker
configuration in your POM.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerServerId>test-pact-broker</pactBrokerServerId> <!-- This must match the server id in the maven settings -->
</configuration>
</plugin>
```
# Publishing verification results to a Pact Broker [version 3.5.4+]
For pacts that are loaded from a Pact Broker, the results of running the verification will be published back to the
broker against the URL for the pact. You will be able to see the result on the Pact Broker home screen.
Note: be aware that there is not yet a configuration option to turn off the verification publishing when running from your local machine, so make sure that your CI always runs after your local tests. This feature will be added soon.
Artifact pact-jvm-provider-maven_2.12
Group au.com.dius
Version 3.5.6
Last update 27. September 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent aware apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message entire expected 5000 jsonoutput which classpathelements take there adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative classpath requires pactverifyprovider matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those added impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace option turn ends contents decoded always calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer runs variable publishing disableurlpathdecoding both must descriptions after values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider soon annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties 1234 default pact match filter call reject allow specific have behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 14
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, java-semver, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
Group au.com.dius
Version 3.5.6
Last update 27. September 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header serverid project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal settings precedent aware apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name pactbrokerserverid assigned still 8080 showfulldiff tojson message entire expected 5000 jsonoutput which classpathelements take there adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory machine setgst relative classpath requires pactverifyprovider matching issues called createdefault addheader this verifying from artifactid network setunits paths automatically able below path read receive between those added impl important task your modify createclient list section pass messageprovider local things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace option turn ends contents decoded always calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish https statechangeteardown payment trust back either pactbrokerurl string producer runs variable publishing disableurlpathdecoding both must descriptions after values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json servers provider1 interactions protocol regular provides provider soon annotated_method statechangeurl authentication invoke changing actual provided scan server html verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties 1234 default pact match filter call reject allow specific have behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 14
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, java-semver, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, maven-core, jansi,
There are maybe transitive dependencies!
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.5)
pact-jvm-provider-maven_2.12 from group au.com.dius (version 3.5.4-rc.1)
Maven plugin to verify a provider [version 2.1.9+]
==================================================
Maven plugin for verifying pacts against a provider.
The Maven plugin provides a `verify` goal which will verify all configured pacts against your provider.
## To Use It
### 1. Add the pact-jvm-provider-maven plugin to your `build` section of your pom file.
```xml
<build>
[...]
<plugins>
[...]
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
</plugin>
[...]
</plugins>
[...]
</build>
```
### 2. Define the pacts between your consumers and providers
You define all the providers and consumers within the configuration element of the maven plugin.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<consumers>
<!-- Again, you can define as many consumers for each provider as you need, but each must have a unique name -->
<consumer>
<name>consumer1</name>
<!-- currently supports a file path using pactFile or a URL using pactUrl -->
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### 3. Execute `mvn pact:verify`
You will have to have your provider running for this to pass.
## Verifying all pact files in a directory for a provider. [2.1.10+]
You can specify a directory that contains pact files, and the Pact plugin will scan for all pact files that match that
provider and define a consumer for each pact file in the directory. Consumer name is read from contents of pact file.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<!-- You can define as many as you need, but each must have a unique name -->
<serviceProvider>
<name>provider1</name>
<!-- All the provider properties are optional, and have sensible defaults (shown below) -->
<protocol>http</protocol>
<host>localhost</host>
<port>8080</port>
<path>/</path>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Enabling insecure SSL [version 2.2.8+]
For providers that are running on SSL with self-signed certificates, you need to enable insecure SSL mode by setting
`<insecure>true</insecure>` on the provider.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<insecure>true</insecure>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Specifying a custom trust store [version 2.2.8+]
For environments that are running their own certificate chains:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<pactFileDirectory>path/to/pacts</pactFileDirectory>
<trustStore>relative/path/to/trustStore.jks</trustStore>
<trustStorePassword>changeit</trustStorePassword>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
`trustStore` is either relative to the current working (build) directory. `trustStorePassword` defaults to `changeit`.
NOTE: The hostname will still be verified against the certificate.
## Modifying the requests before they are sent
Sometimes you may need to add things to the requests that can't be persisted in a pact file. Examples of these would
be authentication tokens, which have a small life span. The Pact Maven plugin provides a request filter that can be
set to a Groovy script on the provider that will be called before the request is made. This script will receive the HttpRequest
bound to a variable named `request` prior to it being executed.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<requestFilter>
// This is a Groovy script that adds an Authorization header to each request
request.addHeader('Authorization', 'oauth-token eyJhbGciOiJSUzI1NiIsIm...')
</requestFilter>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
__*Important Note:*__ You should only use this feature for things that can not be persisted in the pact file. By modifying
the request, you are potentially modifying the contract from the consumer tests!
## Modifying the HTTP Client Used [version 2.2.4+]
The default HTTP client is used for all requests to providers (created with a call to `HttpClients.createDefault()`).
This can be changed by specifying a closure assigned to createClient on the provider that returns a CloseableHttpClient.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<createClient>
// This is a Groovy script that will enable the client to accept self-signed certificates
import org.apache.http.ssl.SSLContextBuilder
import org.apache.http.conn.ssl.NoopHostnameVerifier
import org.apache.http.impl.client.HttpClients
HttpClients.custom().setSSLHostnameVerifier(new NoopHostnameVerifier())
.setSslcontext(new SSLContextBuilder().loadTrustMaterial(null, { x509Certificates, s -> true })
.build())
.build()
</createClient>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
## Turning off URL decoding of the paths in the pact file [version 3.3.3+]
By default the paths loaded from the pact file will be decoded before the request is sent to the provider. To turn this
behaviour off, set the system property `pact.verifier.disableUrlPathDecoding` to `true`.
__*Important Note:*__ If you turn off the url path decoding, you need to ensure that the paths in the pact files are
correctly encoded. The verifier will not be able to make a request with an invalid encoded path.
## Plugin Properties
The following plugin properties can be specified with `-Dproperty=value` on the command line or in the configuration section:
|Property|Description|
|--------|-----------|
|pact.showStacktrace|This turns on stacktrace printing for each request. It can help with diagnosing network errors|
|pact.showFullDiff|This turns on displaying the full diff of the expected versus actual bodies [version 3.3.6+]|
|pact.filter.consumers|Comma seperated list of consumer names to verify|
|pact.filter.description|Only verify interactions whose description match the provided regular expression|
|pact.filter.providerState|Only verify interactions whose provider state match the provided regular expression. An empty string matches interactions that have no state|
Example in the configuration section:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<configuration>
<pact.showStacktrace>true</pact.showStacktrace>
</configuration>
</configuration>
</plugin>
```
## Provider States
For each provider you can specify a state change URL to use to switch the state of the provider. This URL will
receive the providerState description and parameters from the pact file before each interaction via a POST. The stateChangeUsesBody
controls if the state is passed in the request body or as query parameters.
These values can be set at the provider level, or for a specific consumer. Consumer values take precedent if both are given.
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/provider1-consumer1-pact.json</pactFile>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChangeForConsumer1</stateChangeUrl>
<stateChangeUsesBody>false</stateChangeUsesBody> <!-- defaults to true -->
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
If the `stateChangeUsesBody` is not specified, or is set to true, then the provider state description and parameters will be sent as
JSON in the body of the request. If it is set to false, they will passed as query parameters.
As for normal requests (see Modifying the requests before they are sent), a state change request can be modified before
it is sent. Set `stateChangeRequestFilter` to a Groovy script on the provider that will be called before the request is made.
#### Teardown calls for state changes [version 3.2.5/2.4.7+]
You can enable teardown state change calls by setting the property `<stateChangeTeardown>true</stateChangeTeardown>` on the provider. This
will add an `action` parameter to the state change call. The setup call before the test will receive `action=setup`, and
then a teardown call will be made afterwards to the state change URL with `action=teardown`.
## Verifying pact files from a pact broker [version 3.1.1+/2.3.1+]
You can setup your build to validate against the pacts stored in a pact broker. The pact plugin will query
the pact broker for all consumers that have a pact with the provider based on its name. To use it, just configure the
`pactBrokerUrl` or `pactBroker` value for the provider with the base URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBrokerUrl>http://pact-broker:5000/</pactBrokerUrl>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an authenticated pact broker [version 3.3.5+]
If your pact broker requires authentication (basic authentication is only supported), you can configure the username
and password to use by configuring the `authentication` element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<authentication>
<username>test</username>
<password>test</password>
</authentication>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
### Verifying pacts from an pact broker that match particular tags [version 3.3.5+]
If your pacts in your pact broker have been tagged, you can set the tags to fetch by configuring the `tags`
element of the `pactBroker` element of your provider.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>provider1</name>
<stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
<pactBroker>
<url>http://pactbroker:1234</url>
<tags>
<tag>TEST</tag>
<tag>DEV</tag>
</tags>
</pactBroker>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
This example will fetch and validate the pacts for the TEST and DEV tags.
## Filtering the interactions that are verified
You can filter the interactions that are run using three properties: `pact.filter.consumers`, `pact.filter.description` and `pact.filter.providerState`.
Adding `-Dpact.filter.consumers=consumer1,consumer2` to the command line or configuration section will only run the pact files for those
consumers (consumer1 and consumer2). Adding `-Dpact.filter.description=a request for payment.*` will only run those interactions
whose descriptions start with 'a request for payment'. `-Dpact.filter.providerState=.*payment` will match any interaction that
has a provider state that ends with payment, and `-Dpact.filter.providerState=` will match any interaction that does not have a
provider state.
# Verifying a message provider [version 2.2.12+]
The Maven plugin has been updated to allow invoking test methods that can return the message contents from a message
producer. To use it, set the way to invoke the verification to `ANNOTATED_METHOD`. This will allow the pact verification
task to scan for test methods that return the message contents.
Add something like the following to your maven pom file:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<!-- packagesToScan is optional, but leaving it out will result in the entire
test classpath being scanned. Set it to the packages where your annotated test method
can be found. -->
<packagesToScan>
<packageToScan>au.com.example.messageprovider.*</packageToScan>
</packagesToScan>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
</configuration>
</plugin>
```
Now when the pact verify task is run, will look for methods annotated with `@PactVerifyProvider` in the test classpath
that have a matching description to what is in the pact file.
```groovy
class ConfirmationKafkaMessageBuilderTest {
@PactVerifyProvider('an order confirmation message')
String verifyMessageForOrder() {
Order order = new Order()
order.setId(10000004)
order.setExchange('ASX')
order.setSecurityCode('CBA')
order.setPrice(BigDecimal.TEN)
order.setUnits(15)
order.setGst(new BigDecimal('15.0'))
odrer.setFees(BigDecimal.TEN)
def message = new ConfirmationKafkaMessageBuilder()
.withOrder(order)
.build()
JsonOutput.toJson(message)
}
}
```
It will then validate that the returned contents matches the contents for the message in the pact file.
## Changing the class path that is scanned
By default, the test classpath is scanned for annotated methods. You can override this by setting
the `classpathElements` property:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<serviceProviders>
<serviceProvider>
<name>messageProvider</name>
<verificationType>ANNOTATED_METHOD</verificationType>
<consumers>
<consumer>
<name>consumer1</name>
<pactFile>path/to/messageprovider-consumer1-pact.json</pactFile>
</consumer>
</consumers>
</serviceProvider>
</serviceProviders>
<classpathElements>
<classpathElement>
build/classes/test
</classpathElement>
</classpathElements>
</configuration>
</plugin>
```
# Publishing pact files to a pact broker [version 3.2.0+]
The pact maven plugin provides a `publish` mojo that can publish all pact files in a directory
to a pact broker. To use it, you need to add a publish configuration to the POM that defines the
directory where the pact files are and the URL to the pact broker.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.8</version>
<configuration>
<pactDirectory>path/to/pact/files</pactDirectory> <!-- Defaults to ${project.build.directory}/pacts -->
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<projectVersion>1.0.100</projectVersion> <!-- Defaults to ${project.version} -->
<trimSnapshot>true</trimSnapshot> <!-- Defaults to false -->
</configuration>
</plugin>
```
You can now execute `mvn pact:publish` to publish the pact files.
_NOTE:_ The pact broker requires a version for all published pacts. The `publish` task will use the version of the
project by default, but can be overwritten with the `projectVersion` property. Make sure you have set one otherwise the broker will reject the pact files.
_NOTE_: By default, the pact broker has issues parsing `SNAPSHOT` versions. You can configure the publisher to automatically remove `-SNAPSHOT` from your version number by setting `trimSnapshot` to true. This setting does not modify non-snapshot versions.
## Publishing to an authenticated pact broker [version 3.3.9+]
For an authenticated pact broker, you can pass in the credentials with the `pactBrokerUsername` and `pactBrokerPassword`
properties. Currently it only supports basic authentication.
For example:
```xml
<plugin>
<groupId>au.com.dius</groupId>
<artifactId>pact-jvm-provider-maven_2.11</artifactId>
<version>3.3.9</version>
<configuration>
<pactBrokerUrl>http://pactbroker:1234</pactBrokerUrl>
<pactBrokerUsername>USERNAME</pactBrokerUsername>
<pactBrokerPassword>PASSWORD</pactBrokerPassword>
</configuration>
</plugin>
```
# Publishing verification results to a Pact Broker [version 3.5.4+]
For pacts that are loaded from a Pact Broker, the results of running the verification will be published back to the
broker against the URL for the pact. You will be able to see the result on the Pact Broker home screen.
Artifact pact-jvm-provider-maven_2.12
Group au.com.dius
Version 3.5.4-rc.1
Last update 06. September 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal precedent apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name assigned still 8080 showfulldiff tojson message expected 5000 entire which jsonoutput classpathelements take adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory setgst relative pactverifyprovider classpath requires matching issues called createdefault addheader this verifying from artifactid network setunits paths able automatically below path read receive between those impl important task your modify createclient list section pass messageprovider things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace turn ends contents decoded calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish statechangeteardown payment trust back either pactbrokerurl string producer variable publishing disableurlpathdecoding both must descriptions values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json provider1 interactions protocol regular provides provider annotated_method statechangeurl authentication invoke changing actual provided scan verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties 1234 default pact match filter call reject allow have specific behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 13
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, java-semver, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, jansi,
There are maybe transitive dependencies!
Group au.com.dius
Version 3.5.4-rc.1
Last update 06. September 2017
Tags: need using maven requestfilter store diff particular supports username pactstatechange truststorepassword created something these oauth host httpclients shown number header project withorder each pactfiledirectory serviceproviders unique before made seperated packagetoscan token current setfees noophostnameverifier ensure classes look tags define consumer1 what consumer2 base configuration returned bound methods expression body client change versus normal precedent apache consumer localhost would invalid basic updated description optional setexchange bigdecimal verificationtype execute comma packages environments hostname dpact script mojo names override against example make span named does basedir following name assigned still 8080 showfulldiff tojson message expected 5000 entire which jsonoutput classpathelements take adding statechangerequestfilter pacts they filtering configured verify otherwise verifier insecure modifying help errors given verified confirmation empty tokens only import groupid configure fetch element screen sslcontextbuilder truststore sensible enabling x509certificates pactbrokerusername verification http then will bodies small teardown pactstatechangeforconsumer1 home setsecuritycode build 10000004 publisher _note_ tests configuring supported published note "null" files snapshot true persisted specified setid method within tagged projectversion eyjhbgcioijsuzi1niisim sometimes being contains authorization where displaying prior changed scanned potentially level results when statechangeusesbody request action value closeablehttpclient classpathelement contract consumers printing pactdirectory setgst relative pactverifyprovider classpath requires matching issues called createdefault addheader this verifying from artifactid network setunits paths able automatically below path read receive between those impl important task your modify createclient list section pass messageprovider things _note dius changes found showstacktrace passed packagestoscan plugin validate turning defaults matches providers pacturl feature stacktrace turn ends contents decoded calls loaded system defines examples specify diagnosing conn specifying serviceprovider states running executed decoding life loadtrustmaterial publish statechangeteardown payment trust back either pactbrokerurl string producer variable publishing disableurlpathdecoding both must descriptions values parameters maven_2 whose modified that changeit result annotated setprice setsslcontext leaving setting setsslhostnameverifier json provider1 interactions protocol regular provides provider annotated_method statechangeurl authentication invoke changing actual provided scan verifymessagefororder httprequest confirmationkafkamessagebuildertest test accept confirmationkafkamessagebuilder certificate file false credentials working groovy again interaction pactfile like goal many start closure port invoking remove plugins query dproperty line self switch providerstate version mode trimsnapshot command just post signed correctly return stored should overwritten pactbrokerpassword directory broker based afterwards enable adds used password been requests sent apos pactbroker three returns custom sure odrer class property properties 1234 default pact match filter call reject allow have specific behaviour state currently encoded turns controls parameter order full setup parsing certificates with authenticated chains tasks versions target their
Organization not specified
URL https://github.com/DiUS/pact-jvm
License Apache 2
Dependencies amount 13
Dependencies kotlin-stdlib-jre8, kotlin-reflect, slf4j-api, groovy-all, kotlin-logging, java-semver, scala-library, scala-compiler, scala-logging_2.12, pact-jvm-provider_2.12, maven-plugin-api, maven-plugin-annotations, jansi,
There are maybe transitive dependencies!
Page 4 from 5 (items total 41)