au.com.dius.pact.provider.ResponseComparison.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pact-jvm-provider Show documentation
Show all versions of pact-jvm-provider Show documentation
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<>()
verifier.verifyResponseFromProvider(serviceProvider, interaction, interaction.getDescription(), failures, client)
// normally assert all good, but in this example it will fail
assertThat(failures, is(not(empty())))
verifier.displayFailures(failures)
}
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).empty
where:
consumer << serviceProvider.consumers
}
private Map verifyConsumerPact(ConsumerInfo consumer) {
Map failures = [:]
verifier.initialiseReporters(serviceProvider)
verifier.runVerificationForConsumer(failures, serviceProvider, consumer)
if (!failures.empty) {
verifier.displayFailures(failures)
}
failures
}
}
```
package au.com.dius.pact.provider
import arrow.core.Either
import arrow.core.left
import arrow.core.right
import au.com.dius.pact.core.matchers.BodyMismatch
import au.com.dius.pact.core.matchers.BodyTypeMismatch
import au.com.dius.pact.core.matchers.HeaderMismatch
import au.com.dius.pact.core.matchers.Matching
import au.com.dius.pact.core.matchers.MatchingConfig
import au.com.dius.pact.core.matchers.MetadataMismatch
import au.com.dius.pact.core.matchers.Mismatch
import au.com.dius.pact.core.matchers.ResponseMatching
import au.com.dius.pact.core.matchers.StatusMismatch
import au.com.dius.pact.core.matchers.generateDiff
import au.com.dius.pact.core.model.OptionalBody
import au.com.dius.pact.core.model.Response
import au.com.dius.pact.core.model.isNullOrEmpty
import au.com.dius.pact.core.model.messaging.Message
import au.com.dius.pact.core.support.Json
import com.google.gson.JsonParser
import mu.KLogging
import org.apache.http.entity.ContentType
import java.nio.charset.Charset
data class BodyComparisonResult(
val mismatches: Map> = emptyMap(),
val diff: List = emptyList()
)
data class ComparisonResult(
val statusMismatch: StatusMismatch? = null,
val headerMismatches: Map> = emptyMap(),
val bodyMismatches: Either = Either.Right(BodyComparisonResult()),
val metadataMismatches: Map> = emptyMap()
)
/**
* Utility class to compare responses
*/
class ResponseComparison(
val expectedHeaders: Map>,
val expectedBody: OptionalBody,
val isJsonBody: Boolean,
val actualResponseContentType: ContentType,
val actualBody: String?
) {
fun statusResult(mismatches: List) = mismatches.filterIsInstance().firstOrNull()
fun headerResult(mismatches: List): Map> {
val headerMismatchers = mismatches.filterIsInstance()
.groupBy { it.headerKey }
return if (headerMismatchers.isEmpty()) {
emptyMap()
} else {
expectedHeaders.entries.associate { (headerKey, _) ->
headerKey to headerMismatchers[headerKey].orEmpty()
}
}
}
fun bodyResult(mismatches: List): Either {
val bodyTypeMismatch = mismatches.filterIsInstance().firstOrNull()
return if (bodyTypeMismatch != null) {
bodyTypeMismatch.left()
} else {
val bodyMismatches = mismatches
.filterIsInstance()
.groupBy { bm -> bm.path }
val contentType = this.actualResponseContentType
val diff = generateFullDiff(actualBody.orEmpty(), contentType.mimeType.toString(),
expectedBody.valueAsString(), isJsonBody)
BodyComparisonResult(bodyMismatches, diff).right()
}
}
companion object : KLogging() {
private fun generateFullDiff(actual: String, mimeType: String, response: String, jsonBody: Boolean): List {
var actualBodyString = ""
if (actual.isNotEmpty()) {
actualBodyString = if (mimeType.matches(Regex("application/.*json"))) {
Json.gsonPretty.toJson(JsonParser().parse(actual))
} else {
actual
}
}
var expectedBodyString = ""
if (response.isNotEmpty()) {
expectedBodyString = if (jsonBody) {
Json.gsonPretty.toJson(JsonParser().parse(response))
} else {
response
}
}
return generateDiff(expectedBodyString, actualBodyString)
}
@JvmStatic
fun compareResponse(
response: Response,
actualResponse: Map,
actualStatus: Int,
actualHeaders: Map>,
actualBody: String?
): ComparisonResult {
val actualResponseContentType = actualResponse["contentType"] as ContentType
val comparison = ResponseComparison(response.headers, response.body, response.jsonBody(),
actualResponseContentType, actualBody)
val mismatches = ResponseMatching.responseMismatches(response, Response(actualStatus,
actualHeaders.toMutableMap(), OptionalBody.body(actualBody?.toByteArray(
actualResponseContentType.charset ?: Charset.defaultCharset()))), true)
return ComparisonResult(comparison.statusResult(mismatches), comparison.headerResult(mismatches),
comparison.bodyResult(mismatches))
}
@JvmStatic
@JvmOverloads
fun compareMessage(message: Message, actual: OptionalBody, metadata: Map? = null): ComparisonResult {
val bodyMismatches = compareMessageBody(message, actual)
val metadataMismatches = when (metadata) {
null -> emptyList()
else -> Matching.compareMessageMetadata(message.metaData, metadata, message.matchingRules)
}
val contentType = message.getParsedContentType()!!
val responseComparison = ResponseComparison(
mapOf("Content-Type" to listOf(message.getContentType())), message.contents,
contentType.mimeType == ContentType.APPLICATION_JSON.mimeType,
contentType, actual.valueAsString())
return ComparisonResult(bodyMismatches = responseComparison.bodyResult(bodyMismatches),
metadataMismatches = metadataMismatches.groupBy { it.key })
}
@JvmStatic
private fun compareMessageBody(message: Message, actual: OptionalBody): MutableList {
val result = MatchingConfig.lookupBodyMatcher(message.getParsedContentType()?.mimeType.orEmpty())
var bodyMismatches = mutableListOf()
if (result != null) {
bodyMismatches = result.matchBody(message.contents, actual, true, message.matchingRules)
.toMutableList()
} else {
val expectedBody = message.contents.valueAsString()
if (expectedBody.isNotEmpty() && actual.isNullOrEmpty()) {
bodyMismatches.add(BodyMismatch(expectedBody, null, "Expected body '$expectedBody' but was missing"))
} else if (actual.valueAsString() != expectedBody) {
bodyMismatches.add(BodyMismatch(expectedBody, actual.valueAsString(),
"Actual body '${actual.valueAsString()}' is not equal to the expected body '$expectedBody'"))
}
}
return bodyMismatches
}
}
}