au.com.dius.pact.provider.junit5

Class MessageTestTarget

au.com.dius.pact.provider.junit5.MessageTestTarget

All Implemented Interfaces:

TestTarget

Direct Known Subclasses:

AmpqTestTarget

public class MessageTestTarget
implements TestTarget

Test target for use with asynchronous providers (like with message queues).

This target will look for methods with a @PactVerifyProvider annotation where the value is the description of the interaction.

Constructor Detail

MessageTestTarget

@JvmOverloads
public MessageTestTarget(@NotNull
                                       java.util.List<java.lang.String> packagesToScan,
                                       @Nullable
                                       java.lang.ClassLoader classLoader)

Test target for use with asynchronous providers (like with message queues).

This target will look for methods with a @PactVerifyProvider annotation where the value is the description of the interaction.

Parameters:

packagesToScan - List of packages to scan for methods with @PactVerifyProvider annotations. Defaults to thefull test classpath.

MessageTestTarget

@JvmOverloads
public MessageTestTarget(@NotNull
                                       java.util.List<java.lang.String> packagesToScan)

Test target for use with asynchronous providers (like with message queues).

This target will look for methods with a @PactVerifyProvider annotation where the value is the description of the interaction.

Parameters:

packagesToScan - List of packages to scan for methods with @PactVerifyProvider annotations. Defaults to thefull test classpath.

MessageTestTarget

@JvmOverloads
public MessageTestTarget()

Test target for use with asynchronous providers (like with message queues).

This target will look for methods with a @PactVerifyProvider annotation where the value is the description of the interaction.

Method Detail

isHttpTarget

public boolean isHttpTarget()

If this is a request response (HTTP or HTTPS) target

getProviderInfo

@NotNull
public au.com.dius.pact.provider.ProviderInfo getProviderInfo(@NotNull
                                                                       java.lang.String serviceName,
                                                                       @Nullable
                                                                       au.com.dius.pact.core.model.PactSource pactSource)

Returns information about the provider

prepareRequest

@Nullable
public kotlin.Pair<java.lang.Object,java.lang.Object> prepareRequest(@NotNull
                                                                               au.com.dius.pact.core.model.Interaction interaction,
                                                                               @NotNull
                                                                               java.util.Map<java.lang.String,? extends java.lang.Object> context)

Prepares the request for the interaction.

Returns:

a pair of the client class and request to use for the test, or null if there is none

prepareVerifier

public void prepareVerifier(@NotNull
                            au.com.dius.pact.provider.IProviderVerifier verifier,
                            @NotNull
                            java.lang.Object testInstance)

Prepares the verifier for use during the test

executeInteraction

@NotNull
public au.com.dius.pact.provider.ProviderResponse executeInteraction(@Nullable
                                                                              java.lang.Object client,
                                                                              @Nullable
                                                                              java.lang.Object request)

Executes the test (using the client and request from prepareRequest, if any)

Returns:

Map of failures, or an empty map if there were not any