au.com.dius.pact.provider

Interface IProviderVerifier

All Known Implementing Classes:

ProviderVerifier

public IProviderVerifier

Interface to the provider verifier

Constructor Detail

IProviderVerifier

public IProviderVerifier()

Method Detail

getReporters

@NotNull
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(@NotNull
                  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

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

Callback to determine if something is a build specific task

setCheckBuildSpecificTask

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

Callback to determine if something is a build specific task

getExecuteBuildSpecificTask

@NotNull
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(@NotNull
                                 java.util.function.BiConsumer<java.lang.Object,au.com.dius.pact.core.model.ProviderState> p)

Consumer SAM to execute the build specific task

getProjectHasProperty

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

Callback to determine is the project has a particular property

setProjectHasProperty

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

Callback to determine is the project has a particular property

getProjectGetProperty

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

Callback to fetch a project property

setProjectGetProperty

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

Callback to fetch a project property

getProviderMethodInstance

@NotNull
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(@NotNull
                               java.util.function.Function<java.lang.reflect.Method,java.lang.Object> p)

Callback to return the instance for the provider method to invoke

getProjectClassLoader

@Nullable
java.util.function.Supplier<java.lang.ClassLoader> getProjectClassLoader()

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

setProjectClassLoader

void setProjectClassLoader(@Nullable
                           java.util.function.Supplier<java.lang.ClassLoader> p)

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

getProjectClasspath

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

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

setProjectClasspath

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

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

getPactLoadFailureMessage

@Nullable
java.lang.Object getPactLoadFailureMessage()

Callback to display a pact load error

setPactLoadFailureMessage

void setPactLoadFailureMessage(@Nullable
                               java.lang.Object p)

Callback to display a pact load error

getProviderVersion

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

Callback to get the provider version

setProviderVersion

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

Callback to get the provider version

getProviderTag

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

Deprecated.

Callback to get the provider tag

setProviderTag

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

Deprecated.

Callback to get the provider tag

getProviderBranch

@Nullable
java.util.function.Supplier<java.lang.String> getProviderBranch()

Callback to get the provider branch

setProviderBranch

void setProviderBranch(@Nullable
                       java.util.function.Supplier<java.lang.String> p)

Callback to get the provider branch

getProviderTags

@Nullable
java.util.function.Supplier<java.util.List> getProviderTags()

Callback to get the provider tags

setProviderTags

void setProviderTags(@Nullable
                     java.util.function.Supplier<java.util.List> p)

Callback to get the provider tags

getResponseFactory

@Nullable
java.util.function.Function<java.lang.String,java.lang.Object> getResponseFactory()

Callback which is given an interaction description and returns a response

setResponseFactory

void setResponseFactory(@Nullable
                        java.util.function.Function<java.lang.String,java.lang.Object> p)

Callback which is given an interaction description and returns a response

verifyProvider

@NotNull
java.util.List<au.com.dius.pact.provider.VerificationResult> verifyProvider(@NotNull
                                                                                     IProviderInfo provider)

Run the verification for the given provider and return any failures

reportStateForInteraction

void reportStateForInteraction(@NotNull
                               java.lang.String state,
                               @NotNull
                               IProviderInfo provider,
                               @NotNull
                               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(@NotNull
                     java.util.List<au.com.dius.pact.provider.VerificationResult.Failed> failures)

Displays all the failures from the verification run

verifyResponseFromProvider

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

Verifies the response from the provider against the interaction

verifyResponseFromProvider

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

Verifies the response from the provider against the interaction

verifyResponseByInvokingProviderMethods

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

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

verifyResponseByFactory

@NotNull
VerificationResult verifyResponseByFactory(@NotNull
                                                    IProviderInfo providerInfo,
                                                    @NotNull
                                                    IConsumerInfo consumer,
                                                    @NotNull
                                                    au.com.dius.pact.core.model.Interaction interaction,
                                                    @NotNull
                                                    java.lang.String interactionMessage,
                                                    @NotNull
                                                    java.util.Map<java.lang.String,java.lang.Object> failures,
                                                    boolean pending)

verifyRequestResponsePact

@NotNull
VerificationResult verifyRequestResponsePact(@NotNull
                                                      au.com.dius.pact.core.model.Response expectedResponse,
                                                      @NotNull
                                                      ProviderResponse actualResponse,
                                                      @NotNull
                                                      java.lang.String interactionMessage,
                                                      @NotNull
                                                      java.util.Map<java.lang.String,java.lang.Object> failures,
                                                      @NotNull
                                                      java.lang.String interactionId,
                                                      boolean pending)

Compares the expected and actual responses

publishingResultsDisabled

boolean publishingResultsDisabled()

If publishing of verification results has been disabled

reportInteractionDescription

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

Display info about the interaction about to be verified

generateErrorStringFromVerificationResult

@NotNull
java.lang.String generateErrorStringFromVerificationResult(@NotNull
                                                                    java.util.List<au.com.dius.pact.provider.VerificationResult.Failed> result)

reportStateChangeFailed

void reportStateChangeFailed(@NotNull
                             au.com.dius.pact.core.model.ProviderState providerState,
                             @NotNull
                             java.lang.Exception error,
                             boolean isSetup)

initialiseReporters

void initialiseReporters(@NotNull
                         IProviderInfo provider)

reportVerificationForConsumer

void reportVerificationForConsumer(@NotNull
                                   IConsumerInfo consumer,
                                   @NotNull
                                   IProviderInfo provider,
                                   @Nullable
                                   au.com.dius.pact.core.model.PactSource pactSource)

getVerificationSource

@Nullable
java.lang.String getVerificationSource()

Source of the verification (Gradle/Maven/Junit)

setVerificationSource

void setVerificationSource(@Nullable
                           java.lang.String p)

Source of the verification (Gradle/Maven/Junit)