The library is available on maven central using:
- group-id =
au.com.dius.pact.provider - artifact-id =
junit - version-id =
4.6.x
Library provides ability to play contract tests against a provider service in JUnit fashionable way.
Supports:
-
Out-of-the-box convenient ways to load pacts
-
Easy way to change assertion strategy
-
org.junit.BeforeClass, org.junit.AfterClass and org.junit.ClassRule JUnit annotations, that will be run once - before/after whole contract test suite.
-
org.junit.Before, org.junit.After and org.junit.Rule JUnit annotations, that will be run before/after each test of an interaction.
-
au.com.dius.pact.provider.junit.State custom annotation - before each interaction that requires a state change, all methods annotated by
@Statewith appropriate the state listed will be invoked. These methods must either take no parameters or a single Map parameter.
@RunWith(PactRunner.class) // Say JUnit to run tests with custom Runner
@Provider("myAwesomeService") // Set up name of tested provider
@PactFolder("pacts") // Point where to find pacts (See also section Pacts source in documentation)
public class ContractTest {
// NOTE: this is just an example of embedded service that listens to requests, you should start here real service
@ClassRule //Rule will be applied once: before/after whole contract test suite
public static final ClientDriverRule embeddedService = new ClientDriverRule(8332);
@BeforeClass //Method will be run once: before whole contract test suite
public static void setUpService() {
//Run DB, create schema
//Run service
//...
}
@Before //Method will be run before each test of interaction
public void before() {
// Rest data
// Mock dependent service responses
// ...
embeddedService.addExpectation(
onRequestTo("/data"), giveEmptyResponse()
);
}
@State({"default", "no-data"}) // Method will be run before testing interactions that require "default" or "no-data" state
public void toDefaultState() {
// Prepare service before interaction that require "default" state
// ...
System.out.println("Now service in default state");
}
@State("with-data") // Method will be run before testing interactions that require "with-data" state
public void toStateWithData(Map data) {
// Prepare service before interaction that require "with-data" state. The provider state data will be passed
// in the data parameter
// ...
System.out.println("Now service in state using data " + data);
}
@TestTarget // Annotation denotes Target that will be used for tests
public final Target target = new HttpTarget(8332); // Out-of-the-box implementation of Target (for more information take a look at Test Target section)
} @RunWith(PactRunner.class) // Say JUnit to run tests with custom Runner
@Provider("myAwesomeService") // Set up name of tested provider
@PactBroker(host="pactbroker", port = "80")
public class ConfirmationKafkaContractTest {
@TestTarget // Annotation denotes Target that will be used for tests
public final Target target = new MessageTarget(); // Out-of-the-box implementation of Target (for more information take a look at Test Target section)
@BeforeClass //Method will be run once: before whole contract test suite
public static void setUpService() {
//Run DB, create schema
//Run service
//...
}
@Before //Method will be run before each test of interaction
public void before() {
// Message data preparation
// ...
}
@PactVerifyProvider('an order confirmation message')
String verifyMessageForOrder() {
Order order = new Order()
order.setId(10000004)
order.setPrice(BigDecimal.TEN)
order.setUnits(15)
def message = new ConfirmationKafkaMessageBuilder()
.withOrder(order)
.build()
JsonOutput.toJson(message)
}
}To have the message metadata - such as the topic - also verified you need to return a MessageAndMetadata from
the invoked method that contains the payload and metadata to be validation. For example, to verify the metadata of an
integration using the Spring Message interface,
you can do something like the following:
...
@PactVerifyProvider("a product event update")
public MessageAndMetadata verifyMessageForOrder() {
ProductEvent product = new ProductEvent("id1", "product name", "product type", "v1", EventType.CREATED);
Message<String> message = new ProductMessageBuilder().withProduct(product).build();
return generateMessageAndMetadata(message);
}
private MessageAndMetadata generateMessageAndMetadata(Message<String> message) {
HashMap<String, Object> metadata = new HashMap<String, Object>();
message.getHeaders().forEach((k, v) -> metadata.put(k, v));
return new MessageAndMetadata(message.getPayload().getBytes(), metadata);
}NOTE: this requires you to add medadata expections in your consumer test
For the provider states in the pact being verified, you can define methods to be invoked to setup the correct state
for each interaction. Just annotate a method with the au.com.dius.pact.provider.junit.State annotation and the
method will be invoked before the interaction is verified.
For example:
@State("SomeProviderState") // Must match the state description in the pact file
public void someProviderState() {
// Do what you need to set the correct state
}If there are parameters in the pact file, just add a Map parameter to the method to be able to access those parameters.
@State("SomeProviderState")
public void someProviderState(Map<String, Object> providerStateParameters) {
// Do what you need to set the correct state
}If you need to tear down your provider state, you can annotate a method with the @State annotation with the action
set to StateChangeAction.TEARDOWN and it will be invoked after the interaction is verified.
@State("SomeProviderState", action = StateChangeAction.TEARDOWN)
public void someProviderStateCleanup() {
// Do what you need to to teardown the state
}You can have values from the provider state callbacks be injected into most places (paths, query parameters, headers, bodies, etc.). This works by using the V3 spec generators with provider state callbacks that return values. One example of where this would be useful is API calls that require an ID which would be auto-generated by the database on the provider side, so there is no way to know what the ID would be beforehand.
There are methods on the consumer DSLs that can provider an expression that contains variables (like '/api/user/${id}'
for the path). The provider state callback can then return a map for values, and the id attribute from the map will
be expanded in the expression. For this to work, just make your provider state method return a Map of the values.
The injected values will fall back to the provider state parameters if the state change method does not return a value.
If you have a large number of state change methods, you can split things up by moving them to other classes. There are two ways you can do this:
You can put the state change methods on interfaces and then have your test class implement those interfaces. See StateAnnotationsOnInterfaceTest for an example.
You can provide the additional classes to the test target with the withStateHandler or setStateHandlers methods. See
BooksPactProviderTest for an example.
The Pact runner will automatically collect pacts based on annotations on the test class. For this purpose there are 3 out-of-the-box options (files from a directory, files from a set of URLs or a pact broker) or you can easily add your own Pact source.
If you need to load a single pact file from the file system, use the PactUrl with the URL set to the file path.
Note: You can only define one source of pacts per test class.
To use pacts from a Pact Broker, annotate the test class with @PactBroker(host="host.of.pact.broker.com", port = "80").
You can also specify the protocol, which defaults to "http".
The pact broker will be queried for all pacts with the same name as the provider annotation.
For example, test all pacts for the "Activity Service" in the pact broker:
@RunWith(PactRunner.class)
@Provider("Activity Service")
@PactBroker(host = "localhost", port = "80")
public class PactJUnitTest {
@TestTarget
public final Target target = new HttpTarget(5050);
}The pact broker loader was updated to allow system properties to be used for the hostname, port or protocol. The port was changed to a string to allow expressions to be set.
To use a system property or environment variable, you can place the property name in ${} expression de-markers:
@PactBroker(host="${pactbroker.hostname}", port = "80")You can provide a default value by separating the property name with a colon (:):
@PactBroker(host="${pactbroker.hostname:localhost}", port = "80")The default values of the @PactBroker annotation now enable variable interpolation.
The following keys may be managed through the environment
pactbroker.hostpactbroker.portpactbroker.schemepactbroker.tags(comma separated)pactbroker.auth.username(for basic auth)pactbroker.auth.password(for basic auth)pactbroker.auth.token(for bearer auth)pactbroker.consumers(comma separated list to filter pacts by consumer; if not provided, will fetch all pacts for the provider)pactbroker.consumerversionselectors.rawjson(overrides the selectors with the RAW JSON)
You can select the Pacts to verify using Consumer Version Selectors. There are a few ways to do this.
You can add a public static method to your test class annotated with au.com.dius.pact.provider.junitsupport.loader.PactBrokerConsumerVersionSelectors
which returns a SelectorBuilder. The builder will allow you to specify the selectors to use in a type-safe manner.
For example:
@au.com.dius.pact.provider.junitsupport.loader.PactBrokerConsumerVersionSelectors
public static SelectorBuilder consumerVersionSelectors() {
// Select Pacts for consumers deployed to production with branch 'FEAT-123'
return new SelectorBuilder()
.environment('production')
.branch('FEAT-123');
}Or for example where the branch is set with the BRANCH_NAME environment variable:
@au.com.dius.pact.provider.junitsupport.loader.PactBrokerConsumerVersionSelectors
public static SelectorBuilder consumerVersionSelectors() {
// Select Pacts for consumers deployed to production with branch from CI build
return new SelectorBuilder()
.environment('production')
.branch(System.getenv('BRANCH_NAME'));
}The builder has the following methods:
mainBranch()- The latest version from the main branch of each consumer, as specified by the consumer's mainBranch property.branch(name: String, consumer: String? = null, fallback: String? = null)- The latest version from a particular branch of each consumer, or for a particular consumer if the second parameter is provided. If fallback is provided, falling back to the fallback branch if none is found from the specified branch.matchingBranch()- The latest version from any branch of the consumer that has the same name as the current branch of the provider. Used for coordinated development between consumer and provider teams using matching feature branch names.deployedOrReleased()- All the currently deployed and currently released and supported versions of each consumer.matchingBranch()- The latest version from any branch of the consumer that has the same name as the current branch of the provider. Used for coordinated development between consumer and provider teams using matching feature branch names.deployedTo(environment: String)- Any versions currently deployed to the specified environment.releasedTo(environment: String)- Any versions currently released and supported in the specified environment.environment(environment: String)- Any versions currently deployed or released and supported in the specified environment.tag(name: String)- All versions with the specified tag. Tags are deprecated in favor of branches.latestTag(name: String)- The latest version for each consumer with the specified tag. Tags are deprecated in favor of branches.rawSelectorJson(json: String)- You can also provide the raw JSON snippets for selectors.
If you require more control, your selector method can also return a list of au.com.dius.pact.core.pactbroker.ConsumerVersionSelectors
instead of the builder class.
You can also set the consumer versions selectors as raw JSON with the pactbroker.consumerversionselectors.rawjson JVM
system property or environment variable. This will allow you to pass the selectors in from a CI build.
IMPORTANT NOTE: JVM system properties needs to be set on the test JVM if your build is running with Gradle or Maven. Just passing them in on the command line won't work, as they will not be available to the test JVM that is running your test. To set the properties, see Maven Surefire Using System Properties and Gradle Test docs.
The pact broker allows different versions to be tagged. To load all the pacts:
@PactBroker(host="pactbroker", port = "80", tags = {"latest", "dev", "prod"})The default value for tags is latest which is not actually a tag but instead corresponds to the latest version ignoring the tags. If there are multiple consumers matching the name specified in the provider annotation then the latest pact for each of the consumers is loaded.
For any other value the latest pact tagged with the specified tag is loaded.
Specifying multiple tags is an OR operation. For example if you specify tags = {"dev", "prod"} then both the latest pact file tagged with dev and the latest pact file taggged with prod is loaded.
In 4.1.4+, tags was deprecated in favor of consumerVersionSelectors. Consumer version selectors give you the ability to include pacts for the latest version of a tag, or all versions of a tag.
@PactBroker(
host="pactbroker",
port="80",
consumerVersionSelectors={
@ConsumerVersionSelector(tag = "dev"), // Verify the latest version tagged with dev
@ConsumerVersionSelector(tag = "prod", latest = "false") // Verify all versions tagged with prod
}
)You can use basic authentication with the @PactBroker annotation by setting the authentication value to a @PactBrokerAuth
annotation. For example:
@PactBroker(host = "${pactbroker.url:localhost}", port = "1234", tags = {"latest", "prod", "dev"},
authentication = @PactBrokerAuth(username = "test", password = "test"))Bearer tokens are also supported. For example:
@PactBroker(host = "${pactbroker.url:localhost}", port = "1234", tags = {"latest", "prod", "dev"},
authentication = @PactBrokerAuth(token = "test"))Customise the authentication header from the default Authorization with headerName property of @PactBrokerAuth:
@PactBrokerAuth(token = "test", headerName = "custom-auth-header")The token, username and password values also take Java system property expressions.
Preemptive Authentication can be enabled by setting the pact.pactbroker.httpclient.usePreemptiveAuthentication Java
system property to true.
When a consumer publishes a new version of a pact file, the Pact broker can fire off a webhook with the URL of the changed
pact file. To allow only the changed pact file to be verified, you can override the URL by adding the annotation
@AllowOverridePactUrl to your test class and then setting using the pact.filter.consumers and pact.filter.pacturl
values as either Java system properties or environment variables. If you have annotated your test class with @Consumer
you don't need to provide pact.filter.consumers.
NOTE: If you use different tests for different consumers, you need to annotate each test with @Consumer and
@IgnoreNoPactsToVerify. Otherwise, all the tests will run with the provided Pact from the URL.
To use pacts from urls annotate the test class with
@PactUrl(urls = {"http://build.server/zoo_app-animal_service.json"})If you need to load a single pact file from the file system, you can use the PactUrl with the URL set to the file path.
For authenticated URLs, specify the authentication on the annotation
@PactUrl(urls = {"http://build.server/zoo_app-animal_service.json"}, authentication = @Authentication(token = "1234ABCD"))You can use either bearer token scheme (by setting the token), or basic auth by setting the username and password.
JVM system properties or environment variables can also be used by placing the property/variable name in ${} expressions.
@PactUrl(urls = {"http://build.server/zoo_app-animal_service.json"}, authentication = @Authentication(token = "${TOKEN}"))To use pacts from a resource folder of the project annotate test class with
@PactFolder("subfolder/in/resource/directory")It's possible to use a custom Pact source. For this, implement interface au.com.dius.pact.provider.junit.loader.PactLoader
and annotate the test class with @PactSource(MyOwnPactLoader.class). Note: class MyOwnPactLoader must have a default empty constructor or a constructor with one argument of class Class which at runtime will be the test class so you can get custom annotations of test class.
By default, the pact runner will verify all pacts for the given provider. You can filter the pacts and interactions by the following methods.
You can run only those pacts for a particular consumer by adding a @Consumer annotation to the test class.
For example:
@RunWith(PactRunner.class)
@Provider("Activity Service")
@Consumer("Activity Consumer")
@PactBroker(host = "localhost", port = "80")
public class PactJUnitTest {
@TestTarget
public final Target target = new HttpTarget(5050);
}You can filter the interactions that are executed by adding a @PactFilter annotation to your test class. The pact
filter annotation will then only verify interactions that have a matching value, by default provider state.
You can provide multiple values to match with.
The filter criteria is defined by the filter property. The filter must implement the
au.com.dius.pact.provider.junit.filter.InteractionFilter interface. Also check the InteractionFilter interface
for default filter implementations.
For example:
@RunWith(PactRunner.class)
@PactFilter("Activity 100 exists in the database")
public class PactJUnitTest {
}You can also use regular expressions with the filter. For example:
@RunWith(PactRunner.class)
@PactFilter(values = {"^\\/somepath.*"}, filter = InteractionFilter.ByRequestPath.class)
public class PactJUnitTest {
}NOTE! You will only be able to publish the verification results if all interactions have been verified. If an interaction is not covered because it was filtered out, you will not be able to publish.
(version 4.1.2+)
You can filter the interactions that are run by setting the JVM system property pact.filter.description. This propery
takes a regular expression to match against the interaction description.
NOTE! this property needs to be set on the test JVM if your build is running with Gradle or Maven.
By default the pact runner will fail the verification test if no pact files are found to verify. To change the
failure into a warning, add a @IgnoreNoPactsToVerify annotation to your test class.
You can also set the test to ignore any IO and parser exceptions when loading the pact files by setting the
ignoreIoErrors attribute on the annotation to "true" or setting the JVM system property pact.verification.ignoreIoErrors
to true.
** WARNING! Do not enable this on your CI server, as this could result in your build passing with no providers having been verified due to a configuration error. **
NOTE: version 4.1.3+
By default, bodies will be handled based on their content types. For binary contents, the bodies will be base64
encoded when written to the Pact file and then decoded again when the file is loaded. You can change this with
an override property: pact.content_type.override.<TYPE>.<SUBTYPE>=text|json|binary. For instance, setting
pact.content_type.override.application.pdf=text will treat PDF bodies as a text type and not encode/decode them.
NOTE: version 4.2.7+
When there are mismatches with large bodies the calculation of the diff can take a long time . You can turn off the
generation of the diffs with the JVM system property: pact.verifier.generateDiff=true|false|<dataSize>, where
dataSize, if specified, must be a valid data size (for instance 100kb or 1mb). This will turn off the diff
calculation for payloads that exceed this size.
For instance, setting pact.verifier.generateDiff=false will turn off the generation of diffs for all bodies, while
pact.verifier.generateDiff=512kb will only turn off the diffs if the actual or expected body is larger than 512kb.
The field in test class of type au.com.dius.pact.provider.junit.target.Target annotated with au.com.dius.pact.provider.junit.target.TestTarget
will be used for actual Interaction execution and asserting of contract.
Note: there must be exactly 1 such field, otherwise an InitializationException will be thrown.
au.com.dius.pact.provider.junit.target.HttpTarget - out-of-the-box implementation of au.com.dius.pact.provider.junit.target.Target
that will play pacts as http request and assert response from service by matching rules from pact.
You can also specify the protocol, defaults to "http".
au.com.dius.pact.provider.junit.target.MessageTarget - out-of-the-box implementation of au.com.dius.pact.provider.junit.target.Target
that will play pacts as an message and assert response from service by matching rules from pact.
Note for Maven users: If you use Maven to run your tests, you will have to make sure that the Maven Surefire plugin is at least version 2.22.1 uses an isolated classpath.
For example, configure it by adding the following to your POM:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.1</version>
<configuration>
<useSystemClassLoader>false</useSystemClassLoader>
</configuration>
</plugin>NOTE: @TargetRequestFilter is only for JUnit 4. For JUnit 5 see JUnit 5 docs.
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 HttpTarget supports request filters by annotating methods
on the test class with @TargetRequestFilter. These methods must be public void methods that take a single HttpRequest
parameter of type org.apache.http.HttpRequest (4.2.x and before) or org.apache.hc.core5.http.HttpRequest (4.3.0+).
For example:
@TargetRequestFilter
public void exampleRequestFilter(HttpRequest request) {
request.addHeader("Authorization", "OAUTH hdsagasjhgdjashgdah...");
}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!
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.
It's possible to use custom Target, for that interface Target should be implemented and this class can be used instead of HttpTarget.
The default test behaviour is to display the verification being done to the console, and pass or fail the test via the normal JUnit mechanism. Additional reports can be generated from the tests.
A @VerificationReports annotation can be added to any pact test class which will control the verification output. The
annotation takes a list report types and an optional report directory (defaults to "target/pact/reports").
The currently supported report types are console, markdown and json.
For example:
@VerificationReports({"console", "markdown"})
public class MyPactTest {will enable the markdown report in addition to the normal console output. And,
@VerificationReports(value = {"markdown"}, reportDir = "/myreports")
public class MyPactTest {will disable the normal console output and write the markdown reports to "/myreports".
The additional reports can also be enabled with Java System properties or environment variables. The following two
properties have been introduced: pact.verification.reports and pact.verification.reportDir.
pact.verification.reports is the comma separated list of report types to enable (e.g. console,json,markdown).
pact.verification.reportDir is the directory to write reports to (defaults to "target/pact/reports").
The following report types are available in addition to console output (console, which is enabled by default):
markdown, json.
You can also provide a fully qualified classname as report so custom reports are also supported.
This class must implement au.com.dius.pact.provider.reporters.VerifierReporter interface in order to be correct custom implementation of a report.
For pacts that are loaded from a Pact Broker, the results of running the verification can 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. You need to
set the version of the provider that is verified using the pact.provider.version system property.
To enable publishing of results, set the Java system property or environment variable pact.verifier.publishResults to true.
IMPORTANT NOTE!!!: this property needs to be set on the test JVM if your build is running with Gradle or Maven.
Gradle and Maven do not pass in the system properties in to the test JVM from the command line. The system properties specified on the command line only control the build JVM (the one that runs Gradle or Maven), but the tests will run in a new JVM. See Maven Surefire Using System Properties and Gradle Test docs.
You can have a tag pushed against the provider version before the verification results are published. To do this
you need set the pact.provider.tag JVM system property to the tag value.
From 4.1.8+, you can specify multiple tags with a comma separated string for the pact.provider.tag
system property.
Pact Broker version 2.86.0 or later
You can have a branch pushed against the provider version before the verification results are published. To do this
you need set the pact.provider.branch JVM system property to the branch value.
You can specify a URL to link to your CI build output. To do this you need to set the pact.verifier.buildUrl JVM
system property to the URL value.
If your Pact broker supports pending pacts, you can enable support for that by enabling that on your Pact broker annotation or with JVM system properties. You also need to provide the tags that will be published with your provider's verification results. The broker will then label any pacts found that don't have a successful verification result as pending. That way, if they fail verification, the verifier will ignore those failures and not fail the build.
For example, with annotation:
@Provider("Activity Service")
@PactBroker(host = "test.pactflow.io", tags = {"test"}, scheme = "https",
enablePendingPacts = "true",
providerTags = "master"
)
public class PactJUnitTest {You can also use the pactbroker.enablePending and pactbroker.providerTags JVM system properties.
Then any pending pacts will not cause a build failure.
If your Pact broker supports wip pacts, you can enable support by enabling it on your Pact broker annotation, or with JVM system properties. You also need to enable pending pacts. Once enabled, your provider will verify any "work in progress" pacts that have been published since a given date. A WIP pact is a pact that is the latest for its tag that does not have any successful verification results with the provider tag.
@Provider("Activity Service")
@PactBroker(host = "test.pactflow.io", tags = {"test"}, scheme = "https",
enablePendingPacts = "true",
providerTags = "master"
includeWipPactsSince = "2020-06-19"
)
public class PactJUnitTest {You can also use the pactbroker.includeWipPactsSince JVM system property.
Since all WIP pacts are also pending pacts, failed verifications will not cause a build failure.
Pact files that require plugins can be verified with version 4.3.0+. For details on how plugins work, see the Pact plugin project.
Each required plugin is defined in the plugins section in the Pact metadata in the Pact file. The plugins will be
loaded from the plugin directory. By default, this is ~/.pact/plugins or the value of the PACT_PLUGIN_DIR environment
variable. Each plugin required by the Pact file must be installed there. You will need to follow the installation
instructions for each plugin, but the default is to unpack the plugin into a sub-directory <plugin-name>-<plugin-version>
(i.e., for the Protobuf plugin 0.0.0 it will be protobuf-0.0.0). The plugin manifest file must be present for the
plugin to be able to be loaded.
We are tracking anonymous analytics to gather important usage statistics like JVM version and operating system. To disable tracking, set the 'pact_do_not_track' system property or environment variable to 'true'.