au.com.dius.pact.provider

Class ProviderVerifierBase

au.com.dius.pact.provider.ProviderVerifierBase

All Implemented Interfaces:

IProviderVerifier

public class ProviderVerifierBase
implements IProviderVerifier

Verifies the providers against the defined consumers in the context of a build plugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProviderVerifierBase.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static ProviderVerifierBase.Companion	Companion
static java.lang.String	PACT_FILTER_CONSUMERS
static java.lang.String	PACT_FILTER_DESCRIPTION
static java.lang.String	PACT_FILTER_PROVIDERSTATE
static java.lang.String	PACT_PROVIDER_VERSION
static java.lang.String	PACT_PROVIDER_VERSION_TRIM_SNAPSHOT
static java.lang.String	PACT_SHOW_FULLDIFF
static java.lang.String	PACT_SHOW_STACKTRACE
static java.lang.String	PACT_VERIFIER_PUBLISH_RESULTS

Constructor Summary

Constructors

Constructor and Description
ProviderVerifierBase(java.lang.Object pactLoadFailureMessage, java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask, java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask, java.util.function.Supplier<java.util.List> projectClasspath, java.util.List<? extends au.com.dius.pact.provider.reporters.VerifierReporter> reporters, java.util.function.Function<java.lang.reflect.Method,java.lang.Object> providerMethodInstance, java.util.function.Supplier<java.lang.String> providerVersion) Verifies the providers against the defined consumers in the context of a build plugin
ProviderVerifierBase(java.lang.Object pactLoadFailureMessage, java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask, java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask, java.util.function.Supplier<java.util.List> projectClasspath, java.util.List<? extends au.com.dius.pact.provider.reporters.VerifierReporter> reporters, java.util.function.Function<java.lang.reflect.Method,java.lang.Object> providerMethodInstance) Verifies the providers against the defined consumers in the context of a build plugin
ProviderVerifierBase(java.lang.Object pactLoadFailureMessage, java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask, java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask, java.util.function.Supplier<java.util.List> projectClasspath, java.util.List<? extends au.com.dius.pact.provider.reporters.VerifierReporter> reporters) Verifies the providers against the defined consumers in the context of a build plugin
ProviderVerifierBase(java.lang.Object pactLoadFailureMessage, java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask, java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask, java.util.function.Supplier<java.util.List> projectClasspath) Verifies the providers against the defined consumers in the context of a build plugin
ProviderVerifierBase(java.lang.Object pactLoadFailureMessage, java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask, java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask) Verifies the providers against the defined consumers in the context of a build plugin
ProviderVerifierBase(java.lang.Object pactLoadFailureMessage, java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask) Verifies the providers against the defined consumers in the context of a build plugin
ProviderVerifierBase(java.lang.Object pactLoadFailureMessage) Verifies the providers against the defined consumers in the context of a build plugin
ProviderVerifierBase() Verifies the providers against the defined consumers in the context of a build plugin

Method Summary

Modifier and Type	Method and Description
au.com.dius.pact.core.pactbroker.TestResult	displayBodyResult(java.util.Map<java.lang.String,java.lang.Object> failures, java.util.Map<java.lang.String,? extends java.lang.Object> comparison, java.lang.String comparisonDescription)
void	displayFailures(java.util.Map<java.lang.String,? extends java.lang.Object> failures) Displays all the failures from the verification run
au.com.dius.pact.core.pactbroker.TestResult	displayHeadersResult(java.util.Map<java.lang.String,java.lang.Object> failures, java.util.Map<java.lang.String,? extends java.util.List<java.lang.String>> expected, java.util.Map<java.lang.String,? extends java.lang.Object> comparison, java.lang.String comparisonDescription)
au.com.dius.pact.core.pactbroker.TestResult	displayStatusResult(java.util.Map<java.lang.String,java.lang.Object> failures, int status, java.lang.Object comparison, java.lang.String comparisonDescription)
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()
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()
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>	getProviderVersion()
java.util.List<au.com.dius.pact.provider.reporters.VerifierReporter>	getReporters() List of the all reporters to report the results of the verification to
StateChange	getStateChangeHandler()
VerificationReporter	getVerificationReporter()
boolean	publishingResultsDisabled() This will return true unless the pact.verifier.publishResults property has the value of "true"
void	reportInteractionDescription(au.com.dius.pact.core.model.Interaction interaction) Display info about the interaction about to be verified
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)
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)
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	setProviderVersion(java.util.function.Supplier<java.lang.String> p)
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
void	setStateChangeHandler(StateChange p)
void	setVerificationReporter(VerificationReporter p)
au.com.dius.pact.core.pactbroker.TestResult	verifyInteraction(IProviderInfo provider, IConsumerInfo consumer, java.util.Map<java.lang.String,java.lang.Object> failures, au.com.dius.pact.core.model.Interaction interaction)
au.com.dius.pact.core.pactbroker.TestResult	verifyMessagePact(java.util.Set<java.lang.reflect.Method> methods, au.com.dius.pact.core.model.messaging.Message message, java.lang.String interactionMessage, java.util.Map<java.lang.String,java.lang.Object> failures)
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) 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

Methods inherited from interface au.com.dius.pact.provider.IProviderVerifier

displayFailures, finaliseReports, getCheckBuildSpecificTask, getExecuteBuildSpecificTask, getProjectClasspath, getProjectHasProperty, getProviderMethodInstance, getReporters, publishingResultsDisabled, reportInteractionDescription, reportStateForInteraction, setCheckBuildSpecificTask, setExecuteBuildSpecificTask, setProjectClasspath, setProjectHasProperty, setProviderMethodInstance, setReporters, verifyRequestResponsePact, verifyResponseByInvokingProviderMethods, verifyResponseFromProvider, verifyResponseFromProvider

Field Detail

PACT_VERIFIER_PUBLISH_RESULTS

public static java.lang.String PACT_VERIFIER_PUBLISH_RESULTS

PACT_FILTER_CONSUMERS

public static java.lang.String PACT_FILTER_CONSUMERS

PACT_FILTER_DESCRIPTION

public static java.lang.String PACT_FILTER_DESCRIPTION

PACT_FILTER_PROVIDERSTATE

public static java.lang.String PACT_FILTER_PROVIDERSTATE

PACT_SHOW_STACKTRACE

public static java.lang.String PACT_SHOW_STACKTRACE

PACT_SHOW_FULLDIFF

public static java.lang.String PACT_SHOW_FULLDIFF

PACT_PROVIDER_VERSION

public static java.lang.String PACT_PROVIDER_VERSION

PACT_PROVIDER_VERSION_TRIM_SNAPSHOT

public static java.lang.String PACT_PROVIDER_VERSION_TRIM_SNAPSHOT

Companion

public static ProviderVerifierBase.Companion Companion

Constructor Detail

ProviderVerifierBase

public ProviderVerifierBase(java.lang.Object pactLoadFailureMessage,
                            java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask,
                            java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask,
                            java.util.function.Supplier<java.util.List> projectClasspath,
                            java.util.List<? extends au.com.dius.pact.provider.reporters.VerifierReporter> reporters,
                            java.util.function.Function<java.lang.reflect.Method,java.lang.Object> providerMethodInstance,
                            java.util.function.Supplier<java.lang.String> providerVersion)

Verifies the providers against the defined consumers in the context of a build plugin

Parameters:

checkBuildSpecificTask - Callback to determine if something is a build specific task

executeBuildSpecificTask - Consumer SAM to execute the build specific task

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

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

providerMethodInstance - Callback to return the instance for the provider method to invoke

ProviderVerifierBase

public ProviderVerifierBase(java.lang.Object pactLoadFailureMessage,
                            java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask,
                            java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask,
                            java.util.function.Supplier<java.util.List> projectClasspath,
                            java.util.List<? extends au.com.dius.pact.provider.reporters.VerifierReporter> reporters,
                            java.util.function.Function<java.lang.reflect.Method,java.lang.Object> providerMethodInstance)

Verifies the providers against the defined consumers in the context of a build plugin

Parameters:

checkBuildSpecificTask - Callback to determine if something is a build specific task

executeBuildSpecificTask - Consumer SAM to execute the build specific task

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

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

providerMethodInstance - Callback to return the instance for the provider method to invoke

ProviderVerifierBase

public ProviderVerifierBase(java.lang.Object pactLoadFailureMessage,
                            java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask,
                            java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask,
                            java.util.function.Supplier<java.util.List> projectClasspath,
                            java.util.List<? extends au.com.dius.pact.provider.reporters.VerifierReporter> reporters)

Verifies the providers against the defined consumers in the context of a build plugin

Parameters:

checkBuildSpecificTask - Callback to determine if something is a build specific task

executeBuildSpecificTask - Consumer SAM to execute the build specific task

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

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

ProviderVerifierBase

public ProviderVerifierBase(java.lang.Object pactLoadFailureMessage,
                            java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask,
                            java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask,
                            java.util.function.Supplier<java.util.List> projectClasspath)

Verifies the providers against the defined consumers in the context of a build plugin

Parameters:

checkBuildSpecificTask - Callback to determine if something is a build specific task

executeBuildSpecificTask - Consumer SAM to execute the build specific task

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

ProviderVerifierBase

public ProviderVerifierBase(java.lang.Object pactLoadFailureMessage,
                            java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask,
                            java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> executeBuildSpecificTask)

Verifies the providers against the defined consumers in the context of a build plugin

Parameters:

checkBuildSpecificTask - Callback to determine if something is a build specific task

executeBuildSpecificTask - Consumer SAM to execute the build specific task

ProviderVerifierBase

public ProviderVerifierBase(java.lang.Object pactLoadFailureMessage,
                            java.util.function.Function<java.lang.Object,java.lang.Boolean> checkBuildSpecificTask)

Verifies the providers against the defined consumers in the context of a build plugin

Parameters:

checkBuildSpecificTask - Callback to determine if something is a build specific task

ProviderVerifierBase

public ProviderVerifierBase(java.lang.Object pactLoadFailureMessage)

Verifies the providers against the defined consumers in the context of a build plugin

ProviderVerifierBase

public ProviderVerifierBase()

Verifies the providers against the defined consumers in the context of a build plugin

Method Detail

getProjectHasProperty

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

Callback to determine is the project has a particular property

setProjectHasProperty

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

Callback to determine is the project has a particular property

getProjectGetProperty

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

setProjectGetProperty

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

getVerificationReporter

public VerificationReporter getVerificationReporter()

setVerificationReporter

public void setVerificationReporter(VerificationReporter p)

getStateChangeHandler

public StateChange getStateChangeHandler()

setStateChangeHandler

public void setStateChangeHandler(StateChange p)

publishingResultsDisabled

public boolean publishingResultsDisabled()

This will return true unless the pact.verifier.publishResults property has the value of "true"

verifyResponseByInvokingProviderMethods

public 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

displayBodyResult

public au.com.dius.pact.core.pactbroker.TestResult displayBodyResult(java.util.Map<java.lang.String,java.lang.Object> failures,
                                                                     java.util.Map<java.lang.String,? extends java.lang.Object> comparison,
                                                                     java.lang.String comparisonDescription)

verifyMessagePact

public au.com.dius.pact.core.pactbroker.TestResult verifyMessagePact(java.util.Set<java.lang.reflect.Method> methods,
                                                                     au.com.dius.pact.core.model.messaging.Message message,
                                                                     java.lang.String interactionMessage,
                                                                     java.util.Map<java.lang.String,java.lang.Object> failures)

displayFailures

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

Displays all the failures from the verification run

finaliseReports

public void finaliseReports()

Finalise all the reports after verification is complete

verifyInteraction

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

reportInteractionDescription

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

Display info about the interaction about to be verified

verifyRequestResponsePact

public 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)

Compares the expected and actual responses

displayStatusResult

public au.com.dius.pact.core.pactbroker.TestResult displayStatusResult(java.util.Map<java.lang.String,java.lang.Object> failures,
                                                                       int status,
                                                                       java.lang.Object comparison,
                                                                       java.lang.String comparisonDescription)

displayHeadersResult

public au.com.dius.pact.core.pactbroker.TestResult displayHeadersResult(java.util.Map<java.lang.String,java.lang.Object> failures,
                                                                        java.util.Map<java.lang.String,? extends java.util.List<java.lang.String>> expected,
                                                                        java.util.Map<java.lang.String,? extends java.lang.Object> comparison,
                                                                        java.lang.String comparisonDescription)

verifyResponseFromProvider

public 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

public 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

getPactLoadFailureMessage

public java.lang.Object getPactLoadFailureMessage()

setPactLoadFailureMessage

public void setPactLoadFailureMessage(java.lang.Object p)

getCheckBuildSpecificTask

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

Callback to determine if something is a build specific task

setCheckBuildSpecificTask

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

Callback to determine if something is a build specific task

Parameters:

p - Callback to determine if something is a build specific task

getExecuteBuildSpecificTask

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

Consumer SAM to execute the build specific task

setExecuteBuildSpecificTask

public 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

Parameters:

p - Consumer SAM to execute the build specific task

getProjectClasspath

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

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

setProjectClasspath

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

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

Parameters:

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

getReporters

public 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

public 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

Parameters:

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

getProviderMethodInstance

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

Callback to return the instance for the provider method to invoke

setProviderMethodInstance

public 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

Parameters:

p - Callback to return the instance for the provider method to invoke

getProviderVersion

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

setProviderVersion

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