au.com.dius.pact.provider.reporters

Class JsonReporter

au.com.dius.pact.provider.reporters.JsonReporter

All Implemented Interfaces:

VerifierReporter

public class JsonReporter
implements VerifierReporter

Pact verifier reporter that generates the results of the verification in JSON format

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonReporter.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static JsonReporter.Companion	Companion
static java.lang.String	FAILED
static java.lang.String	REPORT_FORMAT
java.io.File	reportFile

Constructor Summary

Constructors

Constructor and Description
JsonReporter(java.lang.String name, java.io.File reportDir, com.google.gson.JsonObject jsonData, java.lang.String ext, java.lang.String providerName) Pact verifier reporter that generates the results of the verification in JSON format
JsonReporter(java.lang.String name, java.io.File reportDir)

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
com.google.gson.JsonObject	getJsonData()
java.lang.String	getName()
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(java.lang.String key, java.lang.Object value)
void	metadataComparisonOk()
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	setExt(java.lang.String p) The extension for the reporter
void	setJsonData(com.google.gson.JsonObject p)
void	setName(java.lang.String p)
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)

Methods inherited from interface au.com.dius.pact.provider.reporters.VerifierReporter

bodyComparisonFailed, bodyComparisonOk, displayFailures, errorHasNoAnnotatedMethodsFoundForInteraction, finaliseReport, generatesAMessageWhich, getExt, getReportDir, getReportFile, headerComparisonFailed, headerComparisonOk, includesHeaders, includesMetadata, initialise, interactionDescription, metadataComparisonFailed, metadataComparisonOk, metadataComparisonOk, pactLoadFailureForConsumer, reportVerificationForConsumer, requestFailed, returnsAResponseWhich, setReportDir, setReportFile, stateChangeRequestFailed, stateChangeRequestFailedWithException, stateForInteraction, statusComparisonFailed, statusComparisonOk, verificationFailed, verifyConsumerFromFile, verifyConsumerFromUrl, warnPactFileHasNoInteractions, warnProviderHasNoConsumers, warnStateChangeIgnored, warnStateChangeIgnoredDueToInvalidUrl

Field Detail

reportFile

public java.io.File reportFile

REPORT_FORMAT

public static java.lang.String REPORT_FORMAT

FAILED

public static java.lang.String FAILED

Companion

public static JsonReporter.Companion Companion

Constructor Detail

JsonReporter

public JsonReporter(java.lang.String name,
                    java.io.File reportDir,
                    com.google.gson.JsonObject jsonData,
                    java.lang.String ext,
                    java.lang.String providerName)

Pact verifier reporter that generates the results of the verification in JSON format

Parameters:

ext - The extension for the reporter

JsonReporter

public JsonReporter(java.lang.String name,
                    java.io.File reportDir)

Method Detail

getReportFile

public java.io.File getReportFile()

setReportFile

public void setReportFile(java.io.File p)

initialise

public void initialise(IProviderInfo provider)

finaliseReport

public void finaliseReport()

reportVerificationForConsumer

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

verifyConsumerFromUrl

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

verifyConsumerFromFile

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

pactLoadFailureForConsumer

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

warnProviderHasNoConsumers

public void warnProviderHasNoConsumers(IProviderInfo provider)

warnPactFileHasNoInteractions

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

interactionDescription

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

stateForInteraction

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

warnStateChangeIgnored

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

stateChangeRequestFailedWithException

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

stateChangeRequestFailed

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

warnStateChangeIgnoredDueToInvalidUrl

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

requestFailed

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

returnsAResponseWhich

public void returnsAResponseWhich()

statusComparisonOk

public void statusComparisonOk(int status)

statusComparisonFailed

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

includesHeaders

public void includesHeaders()

headerComparisonOk

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

headerComparisonFailed

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

bodyComparisonOk

public void bodyComparisonOk()

bodyComparisonFailed

public void bodyComparisonFailed(java.lang.Object comparison)

errorHasNoAnnotatedMethodsFoundForInteraction

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

verificationFailed

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

generatesAMessageWhich

public void generatesAMessageWhich()

displayFailures

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

metadataComparisonFailed

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

includesMetadata

public void includesMetadata()

metadataComparisonOk

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

metadataComparisonOk

public void metadataComparisonOk()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String p)

getReportDir

public java.io.File getReportDir()

setReportDir

public void setReportDir(java.io.File p)

getJsonData

public com.google.gson.JsonObject getJsonData()

setJsonData

public void setJsonData(com.google.gson.JsonObject p)

getExt

public java.lang.String getExt()

The extension for the reporter

setExt

public void setExt(java.lang.String p)

The extension for the reporter

Parameters:

p - The extension for the reporter