hbakkum / pact-jvm

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.

pact-jvm

JVM implementation of the consumer driven contract library (pact)[https://github.com/bethesque/pact_specification]

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.

Contact

• Twitter: @pact_up
• Google users group: https://groups.google.com/forum/#!forum/pact-support

Links

• For an example of using pact-jvm with spring boot, have a look at https://github.com/mstine/microservices-pact

Note about artifact names and versions

Pact-JVM is written in Scala. As Scala does not provide binary compatibility between major versions, all the Pact-JVM artifacts have the version of Scala they were built with in the artifact name. So, for example, the pact-jvm-consumer-junit module has a Jar file named pact-jvm-consumer_2.10. The full name of the file is pact-jvm-consumer_2.10-2.0.x.jar.

We currently cross-compile all the artifacts against 2.10 and 2.11 versions of Scala, except for the SBT modules.

Service Consumers

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

I Use Scala and Specs 2

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

I Use Java

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

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 ExampleClojureConsumerPactTest.clj.

I Use some other jvm language or test framework

You want to look at: Pact Consumer

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: pact sbt plugin

verify pacts with Gradle

You want to look at: pact gradle plugin

verify pacts with Maven [version 2.1.9+]

You want to look at: pact maven plugin

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

You want to look at: pact-jvm-provider

I Use Ruby

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: pact

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

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Building the library

Most of Pact-JVM is written in Scala and is built with Gradle.

To build the libraries:

$ ./gradlew clean build

You can publish pact-jvm to your local maven repo using:

$ ./gradlew clean install

To publish to a nexus repo:

$ ./gradlew clean check uploadArchives

You will have to change the nexus URL and username/password in build.gradle and you must be added to the nexus project to be able to do this

Using SBT (the old way)

The SBT project files still remain for those who want to build it with SBT. Note, however, that this is unmaintained as there is no custodian for the SBT build.

Note on building pact JVM with Java 6 or 7

Scala requires a lot of permgen space to compile. If you're using Java 6 or 7, use the following java and sbt options:

export JAVA_OPTS='-Xmx2048m -XX:MaxPermSize=1024m -XX:PermSize=1024m'
export SBT_OPTS='-Xmx2048m -XX:MaxPermSize=1024m -XX:PermSize=1024m'

To build the libraries:

$ sbt clean test install

You can publish pacts to your local maven repo using:

$ sbt clean test publishLocal

To publish to a nexus repo, change the url in project/Build.scala then run:

$ sbt clean test publish