p

provider

Pact provider ============= sub project of https://github.com/DiUS/pact-jvm The pact provider is responsible for verifying that an API provider adheres to a number of pacts authored by its clients This library provides the basic tools required to automate the process, and should be usable on its own in many instances. Framework and build tool specific bindings will be provided in separate libraries that build on top of this core functionality. ### Provider State Before each interaction is executed, the provider under test will have the opportunity to enter a state. Generally the state maps to a set of fixture data for mocking out services that the provider is a consumer of (they will have their own pacts) The pact framework will instruct the test server to enter that state by sending: POST "${config.stateChangeUrl.url}/setup" { "state" : "${interaction.stateName}" } ### An example of running provider verification with junit This example uses Groovy, JUnit 4 and Hamcrest matchers to run the provider verification. As the provider service is a DropWizard application, it uses the DropwizardAppRule to startup the service before running any test. **Warning:** It only grabs the first interaction from the pact file with the consumer, where there could be many. (This could possibly be solved with a parameterized test) ```groovy class ReadmeExamplePactJVMProviderJUnitTest { @ClassRule public static final TestRule startServiceRule = new DropwizardAppRule<DropwizardConfiguration>( TestDropwizardApplication, ResourceHelpers.resourceFilePath('dropwizard/test-config.yaml')) private static ProviderInfo serviceProvider private static Pact<RequestResponseInteraction> testConsumerPact private static ConsumerInfo consumer @BeforeClass static void setupProvider() { serviceProvider = new ProviderInfo('Dropwizard App') serviceProvider.setProtocol('http') serviceProvider.setHost('localhost') serviceProvider.setPort(8080) serviceProvider.setPath('/') consumer = new ConsumerInfo() consumer.setName('test_consumer') consumer.setPactSource(new UrlSource( ReadmeExamplePactJVMProviderJUnitTest.getResource('/pacts/zoo_app-animal_service.json').toString())) testConsumerPact = DefaultPactReader.INSTANCE.loadPact(consumer.getPactSource()) as Pact<RequestResponseInteraction> } @Test void runConsumerPacts() { // grab the first interaction from the pact with consumer Interaction interaction = testConsumerPact.interactions.get(0) // setup the verifier ProviderVerifier verifier = setupVerifier(interaction, serviceProvider, consumer) // setup any provider state // setup the client and interaction to fire against the provider ProviderClient client = new ProviderClient(serviceProvider, new HttpClientFactory()) Map<String, Object> failures = new HashMap<>() VerificationResult result = verifier.verifyResponseFromProvider(serviceProvider, interaction, interaction.getDescription(), failures, client) // normally assert all good, but in this example it will fail assertThat(failures, is(instanceOf(VerificationResult.Failed))) verifier.displayFailures(result) } private ProviderVerifier setupVerifier(Interaction interaction, ProviderInfo provider, ConsumerInfo consumer) { ProviderVerifier verifier = new ProviderVerifier() verifier.initialiseReporters(provider) verifier.reportVerificationForConsumer(consumer, provider, new UrlSource('http://example.example')) if (!interaction.getProviderStates().isEmpty()) { for (ProviderState providerState: interaction.getProviderStates()) { verifier.reportStateForInteraction(providerState.getName(), provider, consumer, true) } } verifier.reportInteractionDescription(interaction) return verifier } } ``` ### An example of running provider verification with spock This example uses groovy and spock to run the provider verification. Again the provider service is a DropWizard application, and is using the DropwizardAppRule to startup the service. This example runs all interactions using spocks Unroll feature ```groovy class ReadmeExamplePactJVMProviderSpockSpec extends Specification { @ClassRule @Shared TestRule startServiceRule = new DropwizardAppRule<DropwizardConfiguration>(TestDropwizardApplication, ResourceHelpers.resourceFilePath('dropwizard/test-config.yaml')) @Shared ProviderInfo serviceProvider ProviderVerifier verifier def setupSpec() { serviceProvider = new ProviderInfo('Dropwizard App') serviceProvider.protocol = 'http' serviceProvider.host = 'localhost' serviceProvider.port = 8080 serviceProvider.path = '/' serviceProvider.hasPactWith('zoo_app') { consumer -> consumer.pactSource = new FileSource(new File(ResourceHelpers.resourceFilePath('pacts/zoo_app-animal_service.json'))) } } def setup() { verifier = new ProviderVerifier() } def cleanup() { // cleanup provider state // ie. db.truncateAllTables() } def cleanupSpec() { // cleanup provider } @Unroll def "Provider Pact - With Consumer #consumer"() { expect: verifyConsumerPact(consumer) instanceof VerificationResult.Ok where: consumer << serviceProvider.consumers } private VerificationResult verifyConsumerPact(ConsumerInfo consumer) { verifier.initialiseReporters(serviceProvider) def result = verifier.runVerificationForConsumer([:], serviceProvider, consumer) if (result instanceof VerificationResult.Failed) { verifier.displayFailures([result]) } result } } ```
https://github.com/DiUS/pact-jvm
Apache 2
Travis Dixon Ronald Holshausen
authored setpactsource loadpact isempty path pact fire state verificationresult hashmap they resourcehelpers providerstate github verifying using instruct opportunity each groovy matchers resourcefilepath object shared haspactwith grabs executed consumerinfo example result where readmeexamplepactjvmproviderjunittest verifyconsumerpact failures setupverifier services many under grab config apos spocks separate bindings project solved dropwizard good post startup warning requestresponseinteraction possibly yaml static test maps this extends port final http private string pacts dropwizardconfiguration provided getresource usable provider provides responsible json client class junit getpactsource again libraries specification runconsumerpacts defaultpactreader instanceof with reportverificationforconsumer service there automate setup hamcrest tostring serviceprovider reportinteractiondescription test_consumer classrule required mocking testdropwizardapplication providerinfo number spock httpclientfactory https enter providerverifier getproviderstates statename filesource fail setprotocol quot truncatealltables testrule testconsumerpact server assertthat clients getdescription against functionality tools library file sethost feature setupprovider assert setupspec zoo_app have sending could animal_service generally getname expect framework urlsource readmeexamplepactjvmproviderspockspec dropwizardapprule unroll runs first startservicerule return instance data before adheres that protocol should only host from verification localhost void runverificationforconsumer beforeclass failed tool fixture core setname cleanup true pactsource basic setport verifyresponsefromprovider instances their dius interactions running public parameterized displayfailures setpath consumers consumer providerclient process will statechangeurl reportstateforinteraction 8080 specific cleanupspec initialisereporters application build verifier interaction uses normally
Files download
File Operation
provider-4.1.35.jar download
provider-4.1.35.pom download
provider-4.1.35-sources.jar download
Apache Maven 
<dependency>
  <groupId>au.com.dius.pact</groupId>
  <artifactId>provider</artifactId>
  <version>4.1.35</version>
</dependency>
Gradle Groovy 
implementation 'au.com.dius.pact:provider:4.1.35'
Gradle Kotlin 
implementation("au.com.dius.pact:provider:4.1.35")
Scala SBT 
libraryDependencies += "au.com.dius.pact" % "provider" % "4.1.35"
Groovy Grape 
@Grapes(
  @Grab(group='au.com.dius.pact', module='provider', version='4.1.35')
)
Apache Ivy 
<dependency org="au.com.dius.pact" name="provider" rev="4.1.35" />
Leiningen 
[au.com.dius.pact/provider "4.1.35"]
Apache Buildr 
'au.com.dius.pact:provider:jar:4.1.35'
Dependencies

compile

|-- commons-io:commons-io:2.11.0

|-- org.apache.httpcomponents:httpclient:4.5.13

|-- au.com.dius.pact.core:model:4.1.35

|-- au.com.dius.pact.core:pactbroker:4.1.35

|-- au.com.dius.pact.core:matchers:4.1.35

|-- au.com.dius.pact.core:support:4.1.35

|-- com.michael-bull.kotlin-result:kotlin-result:1.1.6

runtime

|-- org.slf4j:slf4j-api:1.7.28

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

|-- io.github.classgraph:classgraph:4.8.105

|-- org.codehaus.groovy:groovy:3.0.7

|-- com.github.ajalt:mordant:1.2.1

|-- com.vladsch.flexmark:flexmark:0.62.2

|-- com.vladsch.flexmark:flexmark-ext-tables:0.62.2