au.com.dius.pact.consumer

Class MessagePactBuilder

au.com.dius.pact.consumer.MessagePactBuilder

public class MessagePactBuilder

PACT DSL builder for v3 specification

Field Detail

Companion

public static au.com.dius.pact.consumer.MessagePactBuilder.Companion Companion

Constructor Detail

MessagePactBuilder

public MessagePactBuilder(@NotNull
                          au.com.dius.pact.core.model.Consumer consumer,
                          @NotNull
                          au.com.dius.pact.core.model.Provider provider,
                          @NotNull
                          java.util.List<au.com.dius.pact.core.model.ProviderState> providerStates,
                          @NotNull
                          java.util.List<au.com.dius.pact.core.model.messaging.Message> messages)

PACT DSL builder for v3 specification

Parameters:

consumer - The consumer for the pact.

provider - The provider for the pact.

providerStates - Provider states

messages - Messages for the pact

Method Detail

hasPactWith

@NotNull
public MessagePactBuilder hasPactWith(@NotNull
                                               java.lang.String provider)

Name the provider that the consumer has a pact with.

Parameters:

provider - provider name

Returns:

this builder.

given

@NotNull
public MessagePactBuilder given(@NotNull
                                         java.lang.String providerState)

Sets the provider state.

Parameters:

providerState - description of the provider state

Returns:

this builder.

given

@NotNull
public MessagePactBuilder given(@NotNull
                                         java.lang.String providerState,
                                         @NotNull
                                         java.util.Map<java.lang.String,? extends java.lang.Object> params)

Sets the provider state.

Parameters:

providerState - description of the provider state

params - key/value pairs to describe state

Returns:

this builder.

given

@NotNull
public MessagePactBuilder given(@NotNull
                                         au.com.dius.pact.core.model.ProviderState providerState)

Sets the provider state.

Parameters:

providerState - state of the provider

Returns:

this builder.

expectsToReceive

@NotNull
public MessagePactBuilder expectsToReceive(@NotNull
                                                    java.lang.String description)

Adds a message expectation in the pact.

Parameters:

description - message description.

withMetadata

@NotNull
public MessagePactBuilder withMetadata(@NotNull
                                                java.util.Map<java.lang.String,? extends java.lang.Object> metadata)

Adds the expected metadata to the message

withContent

@NotNull
public MessagePactBuilder withContent(@NotNull
                                               DslPart body)

Adds the JSON body as the message content

toPact

@NotNull
public au.com.dius.pact.core.model.messaging.MessagePact toPact()

Convert this builder into a Pact

consumer

@JvmStatic
 @NotNull
public static MessagePactBuilder consumer(@NotNull
                                                               java.lang.String consumer)

Name the consumer of the pact

Parameters:

consumer - Consumer name