p

pact-jvm-provider-spring_2.11

# Pact Spring/JUnit runner ## Overview Library provides ability to play contract tests against a provider using Spring & JUnit. This library is based on and references the JUnit package, so see [junit provider support](pact-jvm-provider-junit) for more details regarding configuration using JUnit. Supports: - Standard ways to load pacts from folders and broker - Easy way to change assertion strategy - Spring Test MockMVC Controllers and ControllerAdvice using MockMvc standalone setup. - MockMvc debugger output - Multiple @State runs to test a particular Provider State multiple times - **au.com.dius.pact.provider.junit.State** custom annotation - before each interaction that requires a state change, all methods annotated by `@State` with appropriate the state listed will be invoked. **NOTE:** For publishing provider verification results to a pact broker, make sure the Java system property `pact.provider.version` is set with the version of your provider. ## Example of MockMvc test ```java @RunWith(RestPactRunner.class) // Custom pact runner, child of PactRunner which runs only REST tests @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 { //Create an instance of your controller. We cannot autowire this as we're not using (and don't want to use) a Spring test runner. @InjectMocks private AwesomeController awesomeController = new AwesomeController(); //Mock your service logic class. We'll use this to create scenarios for respective provider states. @Mock private AwesomeBusinessLogic awesomeBusinessLogic; //Create an instance of your controller advice (if you have one). This will be passed to the MockMvcTarget constructor to be wired up with MockMvc. @InjectMocks private AwesomeControllerAdvice awesomeControllerAdvice = new AwesomeControllerAdvice(); //Create a new instance of the MockMvcTarget and annotate it as the TestTarget for PactRunner @TestTarget public final MockMvcTarget target = new MockMvcTarget(); @Before //Method will be run before each test of interaction public void before() { //initialize your mocks using your mocking framework MockitoAnnotations.initMocks(this); //configure the MockMvcTarget with your controller and controller advice target.setControllers(awesomeController); target.setControllerAdvice(awesomeControllerAdvice); } @State("default", "no-data") // Method will be run before testing interactions that require "default" or "no-data" state public void toDefaultState() { target.setRunTimes(3); //let's loop through this state a few times for a 3 data variants when(awesomeBusinessLogic.getById(any(UUID.class))) .thenReturn(myTestHelper.generateRandomReturnData(UUID.randomUUID(), ExampleEnum.ONE)) .thenReturn(myTestHelper.generateRandomReturnData(UUID.randomUUID(), ExampleEnum.TWO)) .thenReturn(myTestHelper.generateRandomReturnData(UUID.randomUUID(), ExampleEnum.THREE)); } @State("error-case") public void SingleUploadExistsState_Success() { target.setRunTimes(1); //tell the runner to only loop one time for this state //you might want to throw exceptions to be picked off by your controller advice when(awesomeBusinessLogic.getById(any(UUID.class))) .then(i -> { throw new NotCoolException(i.getArgumentAt(0, UUID.class).toString()); }); } } ``` ## Using a Spring runner (version 3.5.7+) You can use `SpringRestPactRunner` instead of the default Pact runner to use the Spring test annotations. This will allow you to inject or mock spring beans. For example: ```java @RunWith(SpringRestPactRunner.class) @Provider("pricing") @PactBroker(protocol = "https", host = "${pactBrokerHost}", port = "443", authentication = @PactBrokerAuth(username = "${pactBrokerUser}", password = "${pactBrokerPassword}")) @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT) public class PricingServiceProviderPactTest { @MockBean private ProductClient productClient; // This will replace the bean with a mock in the application context @TestTarget @SuppressWarnings(value = "VisibilityModifier") public final Target target = new HttpTarget(8091); @State("Product X010000021 exists") public void setupProductX010000021() throws IOException { reset(productClient); ProductBuilder product = new ProductBuilder() .withProductCode("X010000021"); when(productClient.fetch((Set<String>) argThat(contains("X010000021")), any())).thenReturn(product); } @State("the product code X00001 can be priced") public void theProductCodeX00001CanBePriced() throws IOException { reset(productClient); ProductBuilder product = new ProductBuilder() .withProductCode("X00001"); when(productClient.find((Set<String>) argThat(contains("X00001")), any())).thenReturn(product); } } ``` ### Using Spring Context Properties (version 3.5.14+) From version 3.5.14 onwards, the SpringRestPactRunner will look up any annotation expressions (like `${pactBrokerHost}`) above) from the Spring context. For Springboot, this will allow you to define the properties in the application test properties. For instance, if you create the following `application.yml` in the test resources: ```yaml pactbroker: host: "your.broker.local" port: "443" protocol: "https" auth: username: "<your broker username>" password: "<your broker password>" ``` Then you can use the defaults on the `@PactBroker` annotation. ```java @RunWith(SpringRestPactRunner.class) @Provider("My Service") @PactBroker( authentication = @PactBrokerAuth(username = "${pactbroker.auth.username}", password = "${pactbroker.auth.password}") ) @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) public class PactVerificationTest { ``` ### Using a random port with a Springboot test (version 3.5.14+) If you use a random port in a springboot test (by setting `SpringBootTest.WebEnvironment.RANDOM_PORT`), you can use the `SpringBootHttpTarget` which will get the application port from the spring application context. For example: ```java @RunWith(SpringRestPactRunner.class) @Provider("My Service") @PactBroker @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) public class PactVerificationTest { @TestTarget public final Target target = new SpringBootHttpTarget(); } ```
https://github.com/DiUS/pact-jvm
Apache 2
Travis Dixon Ronald Holshausen
using passed runwith particular supports visibilitymodifier springboottest defaults references time username beans variants autowire quot host mockmvc pricing system load uuid each ways yaml singleuploadexistsstate_success before data states folders spring scenarios easy times loop tell notcoolexception ability look https define onwards bean cannot replace controllers picked initmocks overview setcontrollers ioexception string debugger library myawesomeservice documentation exists testing annotations runs configuration public advice publishing methods resources getbyid change setupproductx010000021 mockmvctarget instance initialize x010000021 pactrunner code logic that mockitoannotations pactbrokerauth setcontrolleradvice against require case example make exampleenum testtarget invoked annotated 8091 tostring through awesomecontrolleradvice tested mocking child setting throw random_port following springrestpactrunner pactbrokeruser name pactfolder above multiple interactions protocol injectmocks provides provider junit assertion annotate which source authentication service java pacts awesomecontroller test generaterandomreturndata package springboot annotation getargumentat randomuuid reset only configure argthat listed fetch final awesomebusinesslogic support random interaction like regarding create productclient verification then will auth port might version private exceptions pactbrokerhost tests respective httptarget wired note want mock void framework product point pactbrokerpassword method thenreturn broker based setruntimes contains where defined_port password priced theproductcodex00001canbepriced more results apos when value three pactbroker contracttest controlleradvice sure custom appropriate contract throws class property properties requires expressions webenvironment default pact todefaultstate controller rest output this mockbean allow have restpactrunner state from withproductcode standalone springboothttptarget details setup suppresswarnings mytesthelper find constructor with application error standard your inject play strategy section mocks pricingserviceproviderpacttest x00001 pactverificationtest instead target context runner productbuilder local also dius
Files download
File Operation
pact-jvm-provider-spring_2.11-3.5.24.jar download
pact-jvm-provider-spring_2.11-3.5.24.pom download
pact-jvm-provider-spring_2.11-3.5.24-sources.jar download
Apache Maven 
<dependency>
  <groupId>au.com.dius</groupId>
  <artifactId>pact-jvm-provider-spring_2.11</artifactId>
  <version>3.5.24</version>
</dependency>
Gradle Groovy 
implementation 'au.com.dius:pact-jvm-provider-spring_2.11:3.5.24'
Gradle Kotlin 
implementation("au.com.dius:pact-jvm-provider-spring_2.11:3.5.24")
Scala SBT 
libraryDependencies += "au.com.dius" % "pact-jvm-provider-spring_2.11" % "3.5.24"
Groovy Grape 
@Grapes(
  @Grab(group='au.com.dius', module='pact-jvm-provider-spring_2.11', version='3.5.24')
)
Apache Ivy 
<dependency org="au.com.dius" name="pact-jvm-provider-spring_2.11" rev="3.5.24" />
Leiningen 
[au.com.dius/pact-jvm-provider-spring_2.11 "3.5.24"]
Apache Buildr 
'au.com.dius:pact-jvm-provider-spring_2.11:jar:3.5.24'
Dependencies

compile

|-- org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.2.51

|-- org.jetbrains.kotlin:kotlin-reflect:1.2.51

|-- org.slf4j:slf4j-api:1.7.25

|-- org.codehaus.groovy:groovy-all:2.4.12

|-- io.github.microutils:kotlin-logging:1.4.4

|-- org.scala-lang:scala-library:2.11.8

|-- com.typesafe.scala-logging:scala-logging_2.11:3.7.2

|-- au.com.dius:pact-jvm-provider-junit_2.11:3.5.24

|-- org.springframework.boot:spring-boot-starter-test:1.5.14.RELEASE

|-- org.springframework:spring-web:4.3.18.RELEASE

|-- org.springframework:spring-webmvc:4.3.18.RELEASE

|-- javax.servlet:javax.servlet-api:3.1.0

|-- com.fasterxml.jackson.datatype:jackson-datatype-joda:2.6.4

test

|-- org.specs2:specs2-core_2.11:3.9.4

|-- org.specs2:specs2-junit_2.11:3.9.4

|-- org.hamcrest:hamcrest-all:1.3

|-- org.mockito:mockito-core:1.10.19

|-- junit:junit:4.12

|-- org.spockframework:spock-core:1.1-groovy-2.4

|-- cglib:cglib:3.2.4

|-- org.objenesis:objenesis:2.6

|-- io.kotlintest:kotlintest:2.0.7

|-- org.springframework.boot:spring-boot-starter-web:1.5.14.RELEASE