au.com.dius.pact.provider

Interface IProviderVerifier

All Known Implementing Classes:

ProviderVerifier

public IProviderVerifier

Interface to the provider verifier

Method Summary

Modifier and Type	Method and Description
void	displayFailures(java.util.Map<java.lang.String,? extends java.lang.Object> failures) Displays all the failures from the verification run
void	finaliseReports() Finalise all the reports after verification is complete
java.util.function.Function<java.lang.Object,java.lang.Boolean>	getCheckBuildSpecificTask() Callback to determine if something is a build specific task
java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState>	getExecuteBuildSpecificTask() Consumer SAM to execute the build specific task
java.lang.Object	getPactLoadFailureMessage() Callback to display a pact load error
java.util.function.Supplier<java.util.List>	getProjectClasspath() Callback to return the project classpath to use for looking up methods
java.util.function.Function<java.lang.String,java.lang.String>	getProjectGetProperty() Callback to fetch a project property
java.util.function.Function<java.lang.String,java.lang.Boolean>	getProjectHasProperty() Callback to determine is the project has a particular property
java.util.function.Function<java.lang.reflect.Method,java.lang.Object>	getProviderMethodInstance() Callback to return the instance for the provider method to invoke
java.util.function.Supplier<java.lang.String>	getProviderTag() Callback to get the provider tag
java.util.function.Supplier<java.lang.String>	getProviderVersion() Callback to get the provider version
java.util.List<au.com.dius.pact.provider.reporters.VerifierReporter>	getReporters() List of the all reporters to report the results of the verification to
boolean	publishingResultsDisabled() If publishing of verification results has been disabled
void	reportInteractionDescription(au.com.dius.pact.core.model.Interaction interaction) Display info about the interaction about to be verified
void	reportStateForInteraction(java.lang.String state, IProviderInfo provider, IConsumerInfo consumer, boolean isSetup) Reports the state of the interaction to all the registered reporters
void	setCheckBuildSpecificTask(java.util.function.Function<java.lang.Object,java.lang.Boolean> p) Callback to determine if something is a build specific task
void	setExecuteBuildSpecificTask(java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> p) Consumer SAM to execute the build specific task
void	setPactLoadFailureMessage(java.lang.Object p) Callback to display a pact load error
void	setProjectClasspath(java.util.function.Supplier<java.util.List> p) Callback to return the project classpath to use for looking up methods
void	setProjectGetProperty(java.util.function.Function<java.lang.String,java.lang.String> p) Callback to fetch a project property
void	setProjectHasProperty(java.util.function.Function<java.lang.String,java.lang.Boolean> p) Callback to determine is the project has a particular property
void	setProviderMethodInstance(java.util.function.Function<java.lang.reflect.Method,java.lang.Object> p) Callback to return the instance for the provider method to invoke
void	setProviderTag(java.util.function.Supplier<java.lang.String> p) Callback to get the provider tag
void	setProviderVersion(java.util.function.Supplier<java.lang.String> p) Callback to get the provider version
void	setReporters(java.util.List<? extends au.com.dius.pact.provider.reporters.VerifierReporter> p) List of the all reporters to report the results of the verification to
java.util.Map<java.lang.String,java.lang.Object>	verifyProvider(ProviderInfo provider) Run the verification for the given provider and return an failures in a Map
au.com.dius.pact.core.pactbroker.TestResult	verifyRequestResponsePact(au.com.dius.pact.core.model.Response expectedResponse, java.util.Map<java.lang.String,? extends java.lang.Object> actualResponse, java.lang.String interactionMessage, java.util.Map<java.lang.String,java.lang.Object> failures, java.lang.String interactionId) Compares the expected and actual responses
au.com.dius.pact.core.pactbroker.TestResult	verifyResponseByInvokingProviderMethods(IProviderInfo providerInfo, IConsumerInfo consumer, au.com.dius.pact.core.model.Interaction interaction, java.lang.String interactionMessage, java.util.Map<java.lang.String,java.lang.Object> failures) Verifies the interaction by invoking a method on a provider test class
au.com.dius.pact.core.pactbroker.TestResult	verifyResponseFromProvider(IProviderInfo provider, au.com.dius.pact.core.model.RequestResponseInteraction interaction, java.lang.String interactionMessage, java.util.Map<java.lang.String,java.lang.Object> failures, ProviderClient client) Verifies the response from the provider against the interaction
au.com.dius.pact.core.pactbroker.TestResult	verifyResponseFromProvider(IProviderInfo provider, au.com.dius.pact.core.model.RequestResponseInteraction interaction, java.lang.String interactionMessage, java.util.Map<java.lang.String,java.lang.Object> failures, ProviderClient client, java.util.Map<java.lang.String,? extends java.lang.Object> context) Verifies the response from the provider against the interaction

Method Detail

getReporters

java.util.List<au.com.dius.pact.provider.reporters.VerifierReporter> getReporters()

List of the all reporters to report the results of the verification to

setReporters

void setReporters(java.util.List<? extends au.com.dius.pact.provider.reporters.VerifierReporter> p)

List of the all reporters to report the results of the verification to

getCheckBuildSpecificTask

java.util.function.Function<java.lang.Object,java.lang.Boolean> getCheckBuildSpecificTask()

Callback to determine if something is a build specific task

setCheckBuildSpecificTask

void setCheckBuildSpecificTask(java.util.function.Function<java.lang.Object,java.lang.Boolean> p)

Callback to determine if something is a build specific task

getExecuteBuildSpecificTask

java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> getExecuteBuildSpecificTask()

Consumer SAM to execute the build specific task

setExecuteBuildSpecificTask

void setExecuteBuildSpecificTask(java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> p)

Consumer SAM to execute the build specific task

getProjectHasProperty

java.util.function.Function<java.lang.String,java.lang.Boolean> getProjectHasProperty()

Callback to determine is the project has a particular property

setProjectHasProperty

void setProjectHasProperty(java.util.function.Function<java.lang.String,java.lang.Boolean> p)

Callback to determine is the project has a particular property

getProjectGetProperty

java.util.function.Function<java.lang.String,java.lang.String> getProjectGetProperty()

Callback to fetch a project property

setProjectGetProperty

void setProjectGetProperty(java.util.function.Function<java.lang.String,java.lang.String> p)

Callback to fetch a project property

getProviderMethodInstance

java.util.function.Function<java.lang.reflect.Method,java.lang.Object> getProviderMethodInstance()

Callback to return the instance for the provider method to invoke

setProviderMethodInstance

void setProviderMethodInstance(java.util.function.Function<java.lang.reflect.Method,java.lang.Object> p)

Callback to return the instance for the provider method to invoke

getProjectClasspath

java.util.function.Supplier<java.util.List> getProjectClasspath()

Callback to return the project classpath to use for looking up methods

setProjectClasspath

void setProjectClasspath(java.util.function.Supplier<java.util.List> p)

Callback to return the project classpath to use for looking up methods

getPactLoadFailureMessage

java.lang.Object getPactLoadFailureMessage()

Callback to display a pact load error

setPactLoadFailureMessage

void setPactLoadFailureMessage(java.lang.Object p)

Callback to display a pact load error

getProviderVersion

java.util.function.Supplier<java.lang.String> getProviderVersion()

Callback to get the provider version

setProviderVersion

void setProviderVersion(java.util.function.Supplier<java.lang.String> p)

Callback to get the provider version

getProviderTag

java.util.function.Supplier<java.lang.String> getProviderTag()

Callback to get the provider tag

setProviderTag

void setProviderTag(java.util.function.Supplier<java.lang.String> p)

Callback to get the provider tag

verifyProvider

java.util.Map<java.lang.String,java.lang.Object> verifyProvider(ProviderInfo provider)

Run the verification for the given provider and return an failures in a Map

reportStateForInteraction

void reportStateForInteraction(java.lang.String state,
                               IProviderInfo provider,
                               IConsumerInfo consumer,
                               boolean isSetup)

Reports the state of the interaction to all the registered reporters

finaliseReports

void finaliseReports()

Finalise all the reports after verification is complete

displayFailures

void displayFailures(java.util.Map<java.lang.String,? extends java.lang.Object> failures)

Displays all the failures from the verification run

verifyResponseFromProvider

au.com.dius.pact.core.pactbroker.TestResult verifyResponseFromProvider(IProviderInfo provider,
                                                                       au.com.dius.pact.core.model.RequestResponseInteraction interaction,
                                                                       java.lang.String interactionMessage,
                                                                       java.util.Map<java.lang.String,java.lang.Object> failures,
                                                                       ProviderClient client)

Verifies the response from the provider against the interaction

verifyResponseFromProvider

au.com.dius.pact.core.pactbroker.TestResult verifyResponseFromProvider(IProviderInfo provider,
                                                                       au.com.dius.pact.core.model.RequestResponseInteraction interaction,
                                                                       java.lang.String interactionMessage,
                                                                       java.util.Map<java.lang.String,java.lang.Object> failures,
                                                                       ProviderClient client,
                                                                       java.util.Map<java.lang.String,? extends java.lang.Object> context)

Verifies the response from the provider against the interaction

verifyResponseByInvokingProviderMethods

au.com.dius.pact.core.pactbroker.TestResult verifyResponseByInvokingProviderMethods(IProviderInfo providerInfo,
                                                                                    IConsumerInfo consumer,
                                                                                    au.com.dius.pact.core.model.Interaction interaction,
                                                                                    java.lang.String interactionMessage,
                                                                                    java.util.Map<java.lang.String,java.lang.Object> failures)

Verifies the interaction by invoking a method on a provider test class

verifyRequestResponsePact

au.com.dius.pact.core.pactbroker.TestResult verifyRequestResponsePact(au.com.dius.pact.core.model.Response expectedResponse,
                                                                      java.util.Map<java.lang.String,? extends java.lang.Object> actualResponse,
                                                                      java.lang.String interactionMessage,
                                                                      java.util.Map<java.lang.String,java.lang.Object> failures,
                                                                      java.lang.String interactionId)

Compares the expected and actual responses

publishingResultsDisabled

boolean publishingResultsDisabled()

If publishing of verification results has been disabled

reportInteractionDescription

void reportInteractionDescription(au.com.dius.pact.core.model.Interaction interaction)

Display info about the interaction about to be verified