Skip to content
JVM version of Pact. Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project.
Groovy Java Kotlin Scala Clojure ANTLR
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create FUNDING.yml Jul 5, 2019
config Merge branch 'v3.6.x' Jun 21, 2019
consumer feat: allow expressions with @Pact annotation #989 Jan 18, 2020
core fix: Target request filter validation for MockMvcTarget #983 Jan 18, 2020
gradle/wrapper Revert "Issue#929 Added the ability to add a version for the provider… Sep 7, 2019
pact-jvm-server fix: Upgraded JUnit to 5.5.2; fixed JUnit4 tests that were not running Nov 3, 2019
pact-publish feat: Publish verification results with a version tag #823 Oct 13, 2019
pact-specification-test fix: Upgraded JUnit to 5.5.2; fixed JUnit4 tests that were not running Nov 3, 2019
provider fix: Target request filter validation for MockMvcTarget #983 Jan 18, 2020
.gitignore chore: update git ignore Jun 29, 2019
.travis.yml chore: only run on openjdk versions in travis Aug 24, 2019
CHANGELOG.md update changelog for release 4.0.4 Dec 17, 2019
LICENSE Initial commit Jan 8, 2014
README.md Update README.md Nov 9, 2019
appveyor.yml chore: upgraded Kotlin and re-enabled kotlinter Jun 21, 2019
build.gradle bump version to 4.0.5 Dec 17, 2019
gradle.properties fixes 953 by upgrading ktor to a version that uses kotlin 1.3. Nov 25, 2019
gradlew Issue #929 Fixed erroneous removal in gradlew. Aug 31, 2019
gradlew.bat Issue #929 Fixed the files automatically changed by IntelliJ on autom… Aug 31, 2019
releasePrep.groovy chore: update release script for 4.0.0 Oct 12, 2019
settings.gradle Merge branch 'master' into v4.x May 5, 2019

README.md

pact-jvm

Build Status Appveyor build status Maven Central

JVM implementation of the consumer driven contract library pact.

From the Ruby Pact website:

Define a pact between service consumers and providers, enabling "consumer driven contract" testing.

Pact provides an RSpec DSL for service consumers to define the HTTP requests they will make to a service provider and the HTTP responses they expect back. These expectations are used in the consumers specs to provide a mock service provider. The interactions are recorded, and played back in the service provider specs to ensure the service provider actually does provide the response the consumer expects.

This allows testing of both sides of an integration point using fast unit tests.

This gem is inspired by the concept of "Consumer driven contracts". See http://martinfowler.com/articles/consumerDrivenContracts.html for more information.

Read Getting started with Pact for more information on how to get going.

Contact

Links

Documentation

Additional documentation can be found at docs.pact.io, in the Pact Wiki, and in the Pact-JVM wiki. Stack Overflow is also a good source of help.

Supported JDK and specification versions:

Branch Specification JDK Scala Versions Latest Version
4.0.x V3 8-12 N/A 4.0.3
3.6.x V3 8 2.12 3.6.14
3.5.x V3 8 2.12, 2.11 3.5.25
3.5.x-jre7 V3 7 2.11 3.5.7-jre7.0
2.4.x V2 6 2.10, 2.11 2.4.20

Service Consumers

Pact-JVM has a number of ways you can write your service consumer tests.

I Use Scala

You want to look at: scala-pact or pact-jvm-consumer-specs2

I Use Java

You want to look at: pact-jvm-consumer-junit for JUnit 4 tests and pact-jvm-consumer-junit5 for JUnit 5 tests. Also, if you are using Java 8, there is an updated DSL for consumer tests.

I Use Groovy or Grails

You want to look at: pact-jvm-consumer-groovy or pact-jvm-consumer-junit

(Use Clojure I)

Clojure can call out to Java, so have a look at pact-jvm-consumer-junit. For an example look at example_clojure_consumer_pact_test.clj.

I Use some other jvm language or test framework

You want to look at: Pact Consumer

My Consumer interacts with a Message Queue

As part of the V3 pact specification, we have defined a new pact file for interactions with message queues. For an implementation of a Groovy consumer test with a message pact, have a look at PactMessageBuilderSpec.groovy.

Service Providers

Once you have run your consumer tests, you will have generated some Pact files. You can then verify your service providers with these files.

I am writing a provider and want to ...

verify pacts with SBT

You want to look at: scala-pact or pact sbt plugin

verify pacts with Gradle

You want to look at: pact gradle plugin

verify pacts with Maven

You want to look at: pact maven plugin

verify pacts with JUnit tests

You want to look at: junit provider support for JUnit 4 tests and pact-jvm-provider-junit5 for JUnit 5 tests

verify pacts with Leiningen

You want to look at: pact leiningen plugin

verify pacts with Specs2

Have a look at pact-jvm-provider-specs2

verify pacts with a Spring MVC project

Have a look at pact-jvm-provider-specs2 or Spring MVC Pact Test Runner (Not maintained).

I want to verify pacts but don't want to use sbt or gradle or leiningen

You want to look at: pact-jvm-provider

verify interactions with a message queue

As part of the V3 pact specification, we have defined a new pact file for interactions with message queues. The Gradle pact plugin supports a mechanism where you can verify V3 message pacts, have a look at pact gradle plugin. The JUnit pact library also supports verification of V3 message pacts, have a look at pact-jvm-provider-junit.

I Use Ruby or Go or something else

The pact-jvm libraries are pure jvm technologies and do not have any native dependencies.

However if you have a ruby provider, the json produced by this library is compatible with the ruby pact library. You'll want to look at: Ruby Pact.

For .Net, there is Pact-net.

For JS, there is Pact-JS.

For Go, there is Pact-go.

Have a look at implementations in other languages.

I Use something completely different

There's a limit to how much we can help, however check out pact-jvm-server

How do I transport my pacts from consumers to providers?

You want to look at: Pact Broker

Which is a project that aims at providing tooling to coordinate pact generation and delivery between projects.

I want to contribute

Documentation for contributors is on the wiki.

You can’t perform that action at this time.