4.0.0 au.com.dius pact-jvm-provider-spring_2.12 3.5.5 pact-jvm-provider-spring_2.12 # 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 http://www.apache.org/licenses/LICENSE-2.0.txt repo thetrav Travis Dixon the.trav@gmail.com rholshausen Ronald Holshausen rholshausen@dius.com.au https://github.com/DiUS/pact-jvm.git https://github.com/DiUS/pact-jvm org.jetbrains.kotlin kotlin-stdlib-jre8 1.1.4-2 compile org.jetbrains.kotlin kotlin-reflect 1.1.4-2 compile org.slf4j slf4j-api 1.7.21 compile org.codehaus.groovy groovy-all 2.4.11 indy compile io.github.microutils kotlin-logging 1.4.4 compile com.github.zafarkhaja java-semver 0.9.0 compile org.scala-lang scala-library 2.12.3 compile org.scala-lang scala-compiler 2.12.3 compile com.typesafe.scala-logging scala-logging_2.12 3.7.2 compile au.com.dius pact-jvm-provider-junit_2.12 3.5.5 compile org.springframework.boot spring-boot-starter-test 1.4.2.RELEASE compile org.springframework spring-web 4.2.0.RELEASE compile org.springframework spring-webmvc 4.2.0.RELEASE compile javax.servlet javax.servlet-api 3.1.0 compile org.specs2 specs2-core_2.12 3.9.4 test org.specs2 specs2-junit_2.12 3.9.4 test org.hamcrest hamcrest-all 1.3 test org.mockito mockito-core 1.10.19 test junit junit 4.12 test org.spockframework spock-core 1.1-groovy-2.4 test * org.codehaus.groovy cglib cglib 3.2.4 test org.objenesis objenesis 2.4 test