au.com.dius.pact.provider.reporters

Interface VerifierReporter

All Known Implementing Classes:

AnsiConsoleReporter, JsonReporter, MarkdownReporter, SLF4JReporter

public VerifierReporter

Interface to verification reporters that can hook into the events of the PactVerifier

Constructor Detail

VerifierReporter

public VerifierReporter()

Method Detail

getExt

@Nullable
java.lang.String getExt()

The extension for the reporter

getReportDir

@Nullable
java.io.File getReportDir()

setReportDir

void setReportDir(@Nullable
                  java.io.File p)

getReportFile

@NotNull
java.io.File getReportFile()

setReportFile

void setReportFile(@NotNull
                   java.io.File p)

getVerifier

@NotNull
IProviderVerifier getVerifier()

setVerifier

void setVerifier(@NotNull
                 IProviderVerifier p)

initialise

void initialise(@NotNull
                IProviderInfo provider)

finaliseReport

void finaliseReport()

reportVerificationForConsumer

void reportVerificationForConsumer(@NotNull
                                   IConsumerInfo consumer,
                                   @NotNull
                                   IProviderInfo provider,
                                   @Nullable
                                   java.lang.String tag)

verifyConsumerFromUrl

void verifyConsumerFromUrl(@NotNull
                           au.com.dius.pact.core.model.UrlPactSource pactUrl,
                           @NotNull
                           IConsumerInfo consumer)

verifyConsumerFromFile

void verifyConsumerFromFile(@NotNull
                            au.com.dius.pact.core.model.PactSource pactFile,
                            @NotNull
                            IConsumerInfo consumer)

pactLoadFailureForConsumer

void pactLoadFailureForConsumer(@NotNull
                                IConsumerInfo consumer,
                                @NotNull
                                java.lang.String message)

warnProviderHasNoConsumers

void warnProviderHasNoConsumers(@NotNull
                                IProviderInfo provider)

warnPactFileHasNoInteractions

void warnPactFileHasNoInteractions(@NotNull
                                   au.com.dius.pact.core.model.Pact<au.com.dius.pact.core.model.Interaction> pact)

interactionDescription

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

stateForInteraction

void stateForInteraction(@NotNull
                         java.lang.String state,
                         @NotNull
                         IProviderInfo provider,
                         @NotNull
                         IConsumerInfo consumer,
                         boolean isSetup)

warnStateChangeIgnored

void warnStateChangeIgnored(@NotNull
                            java.lang.String state,
                            @NotNull
                            IProviderInfo provider,
                            @NotNull
                            IConsumerInfo consumer)

stateChangeRequestFailedWithException

void stateChangeRequestFailedWithException(@NotNull
                                           java.lang.String state,
                                           boolean isSetup,
                                           @NotNull
                                           java.lang.Exception e,
                                           boolean printStackTrace)

stateChangeRequestFailed

void stateChangeRequestFailed(@NotNull
                              java.lang.String state,
                              @NotNull
                              IProviderInfo provider,
                              boolean isSetup,
                              @NotNull
                              java.lang.String httpStatus)

warnStateChangeIgnoredDueToInvalidUrl

void warnStateChangeIgnoredDueToInvalidUrl(@NotNull
                                           java.lang.String state,
                                           @NotNull
                                           IProviderInfo provider,
                                           boolean isSetup,
                                           @NotNull
                                           java.lang.Object stateChangeHandler)

requestFailed

void requestFailed(@NotNull
                   IProviderInfo provider,
                   @NotNull
                   au.com.dius.pact.core.model.Interaction interaction,
                   @NotNull
                   java.lang.String interactionMessage,
                   @NotNull
                   java.lang.Exception e,
                   boolean printStackTrace)

returnsAResponseWhich

void returnsAResponseWhich()

statusComparisonOk

void statusComparisonOk(int status)

statusComparisonFailed

void statusComparisonFailed(int status,
                            @NotNull
                            java.lang.Object comparison)

includesHeaders

void includesHeaders()

headerComparisonOk

void headerComparisonOk(@NotNull
                        java.lang.String key,
                        @NotNull
                        java.util.List<java.lang.String> value)

headerComparisonFailed

void headerComparisonFailed(@NotNull
                            java.lang.String key,
                            @NotNull
                            java.util.List<java.lang.String> value,
                            @NotNull
                            java.lang.Object comparison)

bodyComparisonOk

void bodyComparisonOk()

bodyComparisonFailed

void bodyComparisonFailed(@NotNull
                          java.lang.Object comparison)

errorHasNoAnnotatedMethodsFoundForInteraction

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

verificationFailed

void verificationFailed(@NotNull
                        au.com.dius.pact.core.model.Interaction interaction,
                        @NotNull
                        java.lang.Exception e,
                        boolean printStackTrace)

generatesAMessageWhich

void generatesAMessageWhich()

displayFailures

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

Deprecated.

displayFailures

void displayFailures(@NotNull
                     java.util.List<au.com.dius.pact.provider.VerificationResult.Failed> failures)

includesMetadata

void includesMetadata()

metadataComparisonOk

void metadataComparisonOk()

metadataComparisonOk

void metadataComparisonOk(@NotNull
                          java.lang.String key,
                          @Nullable
                          java.lang.Object value)

metadataComparisonFailed

void metadataComparisonFailed(@NotNull
                              java.lang.String key,
                              @Nullable
                              java.lang.Object value,
                              @NotNull
                              java.lang.Object comparison)

reportVerificationNoticesForConsumer

void reportVerificationNoticesForConsumer(@NotNull
                                          IConsumerInfo consumer,
                                          @NotNull
                                          IProviderInfo provider,
                                          @NotNull
                                          java.util.List<au.com.dius.pact.core.pactbroker.VerificationNotice> notices)

warnPublishResultsSkippedBecauseFiltered

void warnPublishResultsSkippedBecauseFiltered()

warnPublishResultsSkippedBecauseDisabled

void warnPublishResultsSkippedBecauseDisabled(@NotNull
                                              java.lang.String envVar)