au.com.dius.pact.provider.reporters

Interface VerifierReporter

All Known Implementing Classes:

AnsiConsoleReporter, JsonReporter, MarkdownReporter

public VerifierReporter

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

Method Summary

Modifier and Type	Method and Description
void	bodyComparisonFailed(java.lang.Object comparison)
void	bodyComparisonOk()
void	displayFailures(java.util.Map<java.lang.String,? extends java.lang.Object> failures)
void	errorHasNoAnnotatedMethodsFoundForInteraction(au.com.dius.pact.core.model.Interaction interaction)
void	finaliseReport()
void	generatesAMessageWhich()
java.lang.String	getExt() The extension for the reporter
java.io.File	getReportDir()
java.io.File	getReportFile()
void	headerComparisonFailed(java.lang.String key, java.util.List<java.lang.String> value, java.lang.Object comparison)
void	headerComparisonOk(java.lang.String key, java.util.List<java.lang.String> value)
void	includesHeaders()
void	includesMetadata()
void	initialise(IProviderInfo provider)
void	interactionDescription(au.com.dius.pact.core.model.Interaction interaction)
void	metadataComparisonFailed(java.lang.String key, java.lang.Object value, java.lang.Object comparison)
void	metadataComparisonOk()
void	metadataComparisonOk(java.lang.String key, java.lang.Object value)
void	pactLoadFailureForConsumer(IConsumerInfo consumer, java.lang.String message)
void	reportVerificationForConsumer(IConsumerInfo consumer, IProviderInfo provider, java.lang.String tag)
void	requestFailed(IProviderInfo provider, au.com.dius.pact.core.model.Interaction interaction, java.lang.String interactionMessage, java.lang.Exception e, boolean printStackTrace)
void	returnsAResponseWhich()
void	setReportDir(java.io.File p)
void	setReportFile(java.io.File p)
void	stateChangeRequestFailed(java.lang.String state, IProviderInfo provider, boolean isSetup, java.lang.String httpStatus)
void	stateChangeRequestFailedWithException(java.lang.String state, IProviderInfo provider, IConsumerInfo consumer, boolean isSetup, java.lang.Exception e, boolean printStackTrace)
void	stateForInteraction(java.lang.String state, IProviderInfo provider, IConsumerInfo consumer, boolean isSetup)
void	statusComparisonFailed(int status, java.lang.Object comparison)
void	statusComparisonOk(int status)
void	verificationFailed(au.com.dius.pact.core.model.Interaction interaction, java.lang.Exception e, boolean printStackTrace)
void	verifyConsumerFromFile(au.com.dius.pact.core.model.PactSource pactFile, IConsumerInfo consumer)
void	verifyConsumerFromUrl(au.com.dius.pact.core.model.UrlPactSource pactUrl, IConsumerInfo consumer)
void	warnPactFileHasNoInteractions(au.com.dius.pact.core.model.Pact<au.com.dius.pact.core.model.Interaction> pact)
void	warnProviderHasNoConsumers(IProviderInfo provider)
void	warnStateChangeIgnored(java.lang.String state, IProviderInfo provider, IConsumerInfo consumer)
void	warnStateChangeIgnoredDueToInvalidUrl(java.lang.String state, IProviderInfo provider, boolean isSetup, java.lang.Object stateChangeHandler)

Method Detail

getExt

java.lang.String getExt()

The extension for the reporter

getReportDir

java.io.File getReportDir()

setReportDir

void setReportDir(java.io.File p)

getReportFile

java.io.File getReportFile()

setReportFile

void setReportFile(java.io.File p)

initialise

void initialise(IProviderInfo provider)

finaliseReport

void finaliseReport()

reportVerificationForConsumer

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

verifyConsumerFromUrl

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

verifyConsumerFromFile

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

pactLoadFailureForConsumer

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

warnProviderHasNoConsumers

void warnProviderHasNoConsumers(IProviderInfo provider)

warnPactFileHasNoInteractions

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

interactionDescription

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

stateForInteraction

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

warnStateChangeIgnored

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

stateChangeRequestFailedWithException

void stateChangeRequestFailedWithException(java.lang.String state,
                                           IProviderInfo provider,
                                           IConsumerInfo consumer,
                                           boolean isSetup,
                                           java.lang.Exception e,
                                           boolean printStackTrace)

stateChangeRequestFailed

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

warnStateChangeIgnoredDueToInvalidUrl

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

requestFailed

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

returnsAResponseWhich

void returnsAResponseWhich()

statusComparisonOk

void statusComparisonOk(int status)

statusComparisonFailed

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

includesHeaders

void includesHeaders()

headerComparisonOk

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

headerComparisonFailed

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

bodyComparisonOk

void bodyComparisonOk()

bodyComparisonFailed

void bodyComparisonFailed(java.lang.Object comparison)

errorHasNoAnnotatedMethodsFoundForInteraction

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

verificationFailed

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

generatesAMessageWhich

void generatesAMessageWhich()

displayFailures

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

includesMetadata

void includesMetadata()

metadataComparisonOk

void metadataComparisonOk()

metadataComparisonOk

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

metadataComparisonFailed

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