p

pact-jvm-consumer-junit_2.11

pact-jvm-consumer-junit ======================= Provides a DSL and a base test class for use with Junit to build consumer tests. ##Dependency The library is available on maven central using: * group-id = `au.com.dius` * artifact-id = `pact-jvm-consumer-junit_2.11` * version-id = `2.1.x` ##Usage ### Using the base ConsumerPactTest To write a pact spec extend ConsumerPactTest. This base class defines the following four methods which must be overridden in your test class. * *providerName:* Returns the name of the API provider that Pact will mock * *consumerName:* Returns the name of the API consumer that we are testing. * *createFragment:* Returns the PactFrament containing the interactions that the test setup using the ConsumerPactBuilder DSL * *runTest:* The actual test run. It receives the URL to the mock server as a parameter. Here is an example: ```java import au.com.dius.pact.model.PactFragment; import java.util.HashMap; import java.util.Map; import static org.junit.Assert.assertEquals; public class ExampleJavaConsumerPactTest extends ConsumerPactTest { @Override protected PactFragment createFragment(ConsumerPactBuilder.PactDslWithProvider builder) { Map headers = new HashMap(); headers.put("testreqheader", "testreqheadervalue"); return builder .given("test state") // NOTE: Using provider states are optional, you can leave it out .uponReceiving("a request for something") .path("/") .method("GET") .headers(headers) .body("{\"test\":true}") .willRespondWith() .status(200) .headers(headers) .body("{\"responsetest\":true}").toFragment(); } @Override protected String providerName() { return "Some Provider"; } @Override protected String consumerName() { return "Some Consumer"; } @Override protected void runTest(String url) { try { assertEquals(new ProviderClient(url).getSomething(), "{\"responsetest\":true}"); } catch (Exception e) { // NOTE: if you want to see any pact failure, do not throw an exception here. This should be // fixed at some point (see Issue #40 https://github.com/DiUS/pact-jvm/issues/40) throw new RuntimeException(e); } } } ``` ### Using the Pact DSL directly Sometimes it is not convenient to use the ConsumerPactTest as it only allows one test per test class. The DSL can be used directly in this case. Example: ```java import au.com.dius.pact.model.MockProviderConfig; import au.com.dius.pact.model.PactFragment; import org.junit.Test; import java.io.IOException; import java.util.HashMap; import java.util.Map; import static org.junit.Assert.assertEquals; public class PactTest { @Test public void testPact() { PactFragment pactFragment = ConsumerPactBuilder .consumer("Some Consumer") .hasPactWith("Some Provider") .uponReceiving("a request to say Hello") .path("/hello") .method("POST") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") .toFragment(); MockProviderConfig config = MockProviderConfig.createDefault(); VerificationResult result = pactFragment.runConsumer(config, new TestRun() { @Override public void run(MockProviderConfig config) { Map expectedResponse = new HashMap(); expectedResponse.put("hello", "harry"); try { assertEquals(new ProviderClient(config.url()).hello("{\"name\": \"harry\"}"), expectedResponse); } catch (IOException e) {} } }); if (result instanceof PactError) { throw new RuntimeException(((PactError)result).error()); } assertEquals(ConsumerPactTest.PACT_VERIFIED, result); } } ``` ### The Pact JUnit DSL The DSL has the following pattern: ```java .consumer("Some Consumer") .hasPactWith("Some Provider") .given("a certain state on the provider") .uponReceiving("a request for something") .path("/hello") .method("POST") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") .uponReceiving("another request for something") .path("/hello") .method("POST") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") . . . .toFragment() ``` You can define as many interactions as required. Each interaction starts with `uponReceiving` followed by `willRespondWith`. The test state setup with `given` is a mechanism to describe what the state of the provider should be in before the provider is verified. It is only recorded in the consumer tests and used by the provider verification tasks. ### Building JSON bodies with PactDslJsonBody DSL The body method of the ConsumerPactBuilder can accept a PactDslJsonBody, which can construct a JSON body as well as define regex and type matchers. For example: ```java PactDslJsonBody body = new PactDslJsonBody() .stringType("name") .booleanType("happy") .hexValue("hexCode") .id() .ipAddress("localAddress") .numberValue("age", 100) .timestamp(); ``` ### Matching on paths (version 2.1.5+) You can use regular expressions to match incoming requests. The DSL has a `matchPath` method for this. You can provide a real path as a second value to use when generating requests, and if you leave it out it will generate a random one from the regular expression. For example: ```java .given("test state") .uponReceiving("a test interaction") .matchPath("/transaction/[0-9]+") // or .matchPath("/transaction/[0-9]+", "/transaction/1234567890") .method("POST") .body("{\"name\": \"harry\"}") .willRespondWith() .status(200) .body("{\"hello\": \"harry\"}") ``` ## Debugging pact failures When the test runs, Pact will start a mock provider that will listen for requests and match them against the expectations you setup in `createFragment`. If the request does not match, it will return a 500 error response. Each request received and the generated response is logged using [SLF4J](http://www.slf4j.org/). Just enable debug level logging for au.com.dius.pact.consumer.UnfilteredMockProvider. Most failures tend to be mismatched headers or bodies.
https://github.com/DiUS/pact-jvm
Apache 2
Travis Dixon Ronald Holshausen Ken Scambler
using maven tend received consumername receives something static pactdslwithprovider builder available defines each runtimeexception spec before states logged debug timestamp providername leave happy write debugging https define artifact testrun starts pattern ioexception what string base library assert testing slf4j runs construct public methods expression body harry provide exception pactfragment consumer willrespondwith must unfilteredmockprovider optional assertequals haspactwith that failure override generated against containing case example does result model generate matchers catch well response throw following json pactdsljsonbody name four testreqheadervalue interactions regular provides provider junit hexvalue responsetest hello which pacttest usage actual server java certain github tofragment test accept mechanism ipaddress fixed 1234567890 given junit_2 verified describe expectations only config import central pact_verified pacterror regex random interaction many http start verification them mockproviderconfig will recorded bodies some incoming examplejavaconsumerpacttest most build followed version tests listen note want just consumerpactbuilder failures post mock return void true verificationresult should point runtest hexcode method headers second transaction overridden sometimes testpact enable used type dependency requests providerclient level testreqheader request when value returns directly required status extends here class logging expressions pact matching instanceof issues createdefault match getsomething this util expectedresponse issue uponreceiving state localaddress from numbervalue real another paths parameter protected allows pactframent setup path building with error extend consumerpacttest your runconsumer generating tasks mismatched booleantype createfragment convenient hashmap matchpath group stringtype dius
文件下载
文件名 操作
pact-jvm-consumer-junit_2.11-2.1.7.jar 下载
pact-jvm-consumer-junit_2.11-2.1.7.pom 下载
pact-jvm-consumer-junit_2.11-2.1.7-sources.jar 下载
Apache Maven 
<dependency>
  <groupId>au.com.dius</groupId>
  <artifactId>pact-jvm-consumer-junit_2.11</artifactId>
  <version>2.1.7</version>
</dependency>
Gradle Groovy 
implementation 'au.com.dius:pact-jvm-consumer-junit_2.11:2.1.7'
Gradle Kotlin 
implementation("au.com.dius:pact-jvm-consumer-junit_2.11:2.1.7")
Scala SBT 
libraryDependencies += "au.com.dius" % "pact-jvm-consumer-junit_2.11" % "2.1.7"
Groovy Grape 
@Grapes(
  @Grab(group='au.com.dius', module='pact-jvm-consumer-junit_2.11', version='2.1.7')
)
Apache Ivy 
<dependency org="au.com.dius" name="pact-jvm-consumer-junit_2.11" rev="2.1.7" />
Leiningen 
[au.com.dius/pact-jvm-consumer-junit_2.11 "2.1.7"]
Apache Buildr 
'au.com.dius:pact-jvm-consumer-junit_2.11:jar:2.1.7'
本项目依赖

compile

|-- net.databinder:unfiltered-netty-server_2.11:0.8.2

|-- org.apache.httpcomponents:fluent-hc:4.3.5

|-- junit:junit:4.11

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

|-- org.json:json:20140107

|-- org.json4s:json4s-native_2.11:3.2.10

|-- net.databinder.dispatch:dispatch-core_2.11:0.11.0

|-- org.apache.commons:commons-lang3:3.3.2

|-- org.json4s:json4s-jackson_2.11:3.2.10

|-- org.scala-lang.modules:scala-xml_2.11:1.0.2

|-- com.typesafe.scala-logging:scala-logging-slf4j_2.11:2.1.2

|-- org.slf4j:slf4j-api:1.7.5

|-- au.com.dius:pact-jvm-consumer_2.11:2.1.7

test

|-- org.specs2:specs2_2.11:2.3.13

|-- ch.qos.logback:logback-core:1.1.2

|-- org.mockito:mockito-all:1.9.5

|-- ch.qos.logback:logback-classic:1.1.2