Field Detail

• public static final java.lang.String HEADER

Property Detail

• au.com.dius.pact.model.Consumer consumer

• java.util.List interactions

• java.lang.Integer port

• au.com.dius.pact.model.Provider provider

• java.util.List<au.com.dius.pact.model.ProviderState> providerStates

• java.util.List requestData

• java.lang.String requestDescription

• boolean requestState

• java.util.List responseData

• au.com.dius.pact.consumer.StatefulMockProvider server

Method Detail

• java.lang.Object buildInteractions()

• @java.lang.Deprecated au.com.dius.pact.model.PactFragment fragment()

• PactBuilder given(java.lang.String providerState)

  Defines the provider state the provider needs to be in for the interaction

  Parameters:

  providerState - provider state description

• PactBuilder given(java.lang.String providerState, java.util.Map params)

  Defines the provider state the provider needs to be in for the interaction

  Parameters:

  providerState - provider state description

  params - Data parameters for the provider state

• PactBuilder hasPactWith(java.lang.String provider)

  Defines the provider the consumer has a pact with

  Parameters:

  provider - provider name

• @java.lang.SuppressWarnings('ConfusingMethodName') PactBuilder port(int port)

  Defines the port the provider will listen on

  Parameters:

  port - port number

• @java.lang.Deprecated au.com.dius.pact.consumer.VerificationResult run(java.util.Map options = [:], groovy.lang.Closure closure)

  Executes the providers closure in the context of the interactions defined on this builder.

  deprecated:

  use runTest instead

  Parameters:

  options - Optional map of options for the run

  closure - Test to execute

  Returns:

  The result of the test run

• au.com.dius.pact.consumer.PactVerificationResult runTest(java.util.Map options = [:], groovy.lang.Closure closure)

  Executes the providers closure in the context of the interactions defined on this builder.

  Parameters:

  options - Optional map of options for the run

  closure - Test to execute

  Returns:

  The result of the test run

• void runTestAndVerify(java.util.Map options = [:], groovy.lang.Closure closure)

  Runs the test (via the runTest method), and throws an exception if it was not successful.

  Parameters:

  options - Optional map of options for the run

  closure

• PactBuilder serviceConsumer(java.lang.String consumer)

  Defines the service consumer

  Parameters:

  consumer - consumer name

• PactBuilder uponReceiving(java.lang.String requestDescription)

  Defines the start of an interaction

  Parameters:

  requestDescription - Description of the interaction. Must be unique.

• @java.lang.SuppressWarnings('DuplicateMapLiteral') PactBuilder willRespondWith(java.util.Map responseData)

  Defines the response attributes (body, headers, etc.) that are returned for the request

  Parameters:

  responseData - Map of attributes

  Returns:

• PactBuilder withAttributes(java.util.Map requestData)

  Defines the request attributes (body, headers, etc.)

  Parameters:

  requestData - Map of attributes

• @java.lang.Deprecated PactBuilder withBody(java.lang.String mimeType, groovy.lang.Closure closure)

  Allows the body to be defined using a Groovy builder pattern

  deprecated:

  Use the withBody method that takes a Map for options

  Parameters:

  mimeType - Optional mimetype for the body

  closure - Body closure

• @java.lang.Deprecated PactBuilder withBody(java.lang.String mimeType, java.util.List array)

  Allows the body to be defined using a Groovy builder pattern with an array as the root

  deprecated:

  Use the withBody method that takes a Map for options

  Parameters:

  mimeType - Optional mimetype for the body

  array - body

• @java.lang.Deprecated PactBuilder withBody(java.lang.String mimeType, LikeMatcher matcher)

  Allows the body to be defined using a Groovy builder pattern with an array as the root using a each like matcher for all elements of the array

  deprecated:

  Use the withBody method that takes a Map for options

  Parameters:

  mimeType - Optional mimetype for the body

  matcher - body

• PactBuilder withBody(java.util.Map options = [:], groovy.lang.Closure closure)

  Allows the body to be defined using a Groovy builder pattern

  Parameters:

  options - The following options are available: - mimeType Optional mimetype for the body - prettyPrint If the body should be pretty printed

  closure - Body closure

• PactBuilder withBody(java.util.Map options = [:], java.util.List array)

  Allows the body to be defined using a Groovy builder pattern with an array as the root

  Parameters:

  options - The following options are available: - mimeType Optional mimetype for the body - prettyPrint If the body should be pretty printed

  array - body

• PactBuilder withBody(java.util.Map options = [:], LikeMatcher matcher)

  Allows the body to be defined using a Groovy builder pattern with an array as the root

  Parameters:

  options - The following options are available: - mimeType Optional mimetype for the body - prettyPrint If the body should be pretty printed

  matcher - body

• void withFileUpload(java.lang.String partName, java.lang.String fileName, java.lang.String fileContentType, byte[] data)

  Sets up a file upload request. This will add the correct content type header to the request

  Parameters:

  partName - This is the name of the part in the multipart body.

  fileName - This is the name of the file that was uploaded

  fileContentType - This is the content type of the uploaded file

  data - This is the actual file contents