au.com.dius.pact.provider.reporters

Class MarkdownReporter

au.com.dius.pact.provider.reporters.MarkdownReporter

All Implemented Interfaces:

VerifierReporter

public class MarkdownReporter
implements VerifierReporter

Pact verifier reporter that displays the results of the verification in a markdown document

Field Detail

reportFile

@NotNull
public java.io.File reportFile

verifier

@NotNull
public IProviderVerifier verifier

Constructor Detail

MarkdownReporter

public MarkdownReporter(@NotNull
                        java.lang.String name,
                        @Nullable
                        java.io.File reportDir,
                        @NotNull
                        java.lang.String ext)

Pact verifier reporter that displays the results of the verification in a markdown document

Parameters:

ext - The extension for the reporter

MarkdownReporter

public MarkdownReporter(@NotNull
                        java.lang.String name,
                        @Nullable
                        java.io.File reportDir)

Method Detail

getReportFile

@NotNull
public java.io.File getReportFile()

setReportFile

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

getVerifier

@NotNull
public IProviderVerifier getVerifier()

setVerifier

public void setVerifier(@NotNull
                        IProviderVerifier p)

initialise

public void initialise(@NotNull
                       IProviderInfo provider)

finaliseReport

public void finaliseReport()

reportVerificationForConsumer

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

verifyConsumerFromUrl

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

verifyConsumerFromFile

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

pactLoadFailureForConsumer

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

warnProviderHasNoConsumers

public void warnProviderHasNoConsumers(@NotNull
                                       IProviderInfo provider)

warnPactFileHasNoInteractions

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

interactionDescription

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

stateForInteraction

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

warnStateChangeIgnored

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

stateChangeRequestFailedWithException

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

stateChangeRequestFailed

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

warnStateChangeIgnoredDueToInvalidUrl

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

requestFailed

public 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

public void returnsAResponseWhich()

statusComparisonOk

public void statusComparisonOk(int status)

statusComparisonFailed

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

includesHeaders

public void includesHeaders()

headerComparisonOk

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

headerComparisonFailed

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

bodyComparisonOk

public void bodyComparisonOk()

bodyComparisonFailed

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

errorHasNoAnnotatedMethodsFoundForInteraction

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

verificationFailed

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

generatesAMessageWhich

public void generatesAMessageWhich()

displayFailures

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

displayFailures

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

metadataComparisonFailed

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

includesMetadata

public void includesMetadata()

metadataComparisonOk

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

metadataComparisonOk

public void metadataComparisonOk()

reportVerificationNoticesForConsumer

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

warnPublishResultsSkippedBecauseFiltered

public void warnPublishResultsSkippedBecauseFiltered()

warnPublishResultsSkippedBecauseDisabled

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

getName

@NotNull
public java.lang.String getName()

setName

public void setName(@NotNull
                    java.lang.String p)

getReportDir

@Nullable
public java.io.File getReportDir()

setReportDir

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

getExt

@NotNull
public java.lang.String getExt()

The extension for the reporter

setExt

public void setExt(@NotNull
                   java.lang.String p)

The extension for the reporter

Parameters:

p - The extension for the reporter