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 standalonesetup. - 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. ## 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()); }); } } ```
https://github.com/DiUS/pact-jvm
Apache 2
Travis Dixon Ronald Holshausen
using awesomecontroller passed test generaterandomreturndata runwith package particular supports annotation getargumentat references time randomuuid variants only autowire configure quot listed final awesomebusinesslogic standalonesetup support mockmvc interaction regarding create then will load each uuid ways might singleuploadexistsstate_success before data states folders spring scenarios private exceptions tests easy respective times loop tell wired notcoolexception ability want mock void framework cannot point picked controllers initmocks overview setcontrollers debugger library myawesomeservice documentation testing method thenreturn runs broker configuration public advice based methods getbyid change setruntimes where more apos when three mockmvctarget contracttest instance controlleradvice initialize custom pactrunner appropriate contract class requires logic that pact default mockitoannotations against setcontrolleradvice todefaultstate require controller rest example case output this exampleenum have restpactrunner testtarget invoked state annotated from awesomecontrolleradvice through tostring tested mocking child throw details name pactfolder mytesthelper multiple find interactions constructor with standard error injectmocks your play provides strategy provider junit assertion annotate section which source mocks service target java runner also pacts dius
Files download
File Operation
pact-jvm-provider-spring_2.11-3.5.0-jre7.1.jar download
pact-jvm-provider-spring_2.11-3.5.0-jre7.1.pom download
pact-jvm-provider-spring_2.11-3.5.0-jre7.1-sources.jar download
Apache Maven 
<dependency>
  <groupId>au.com.dius</groupId>
  <artifactId>pact-jvm-provider-spring_2.11</artifactId>
  <version>3.5.0-jre7.1</version>
</dependency>
Gradle Groovy 
implementation 'au.com.dius:pact-jvm-provider-spring_2.11:3.5.0-jre7.1'
Gradle Kotlin 
implementation("au.com.dius:pact-jvm-provider-spring_2.11:3.5.0-jre7.1")
Scala SBT 
libraryDependencies += "au.com.dius" % "pact-jvm-provider-spring_2.11" % "3.5.0-jre7.1"
Groovy Grape 
@Grapes(
  @Grab(group='au.com.dius', module='pact-jvm-provider-spring_2.11', version='3.5.0-jre7.1')
)
Apache Ivy 
<dependency org="au.com.dius" name="pact-jvm-provider-spring_2.11" rev="3.5.0-jre7.1" />
Leiningen 
[au.com.dius/pact-jvm-provider-spring_2.11 "3.5.0-jre7.1"]
Apache Buildr 
'au.com.dius:pact-jvm-provider-spring_2.11:jar:3.5.0-jre7.1'
Dependencies

compile

|-- org.jetbrains.kotlin:kotlin-stdlib-jre7:1.1.2-5

|-- org.jetbrains.kotlin:kotlin-reflect:1.1.2-5

|-- org.slf4j:slf4j-api:1.7.21

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

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

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

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

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

|-- au.com.dius:pact-jvm-provider-junit_2.11:3.5.0-jre7.1

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

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

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

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

test

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

|-- org.specs2:specs2-junit_2.11:3.8.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.4