au.com.dius.pact.provider.junit5

Class HttpTestTarget

au.com.dius.pact.provider.junit5.HttpTestTarget

All Implemented Interfaces:

TestTarget

Direct Known Subclasses:

HttpsTestTarget

public class HttpTestTarget
implements TestTarget

Test target for HTTP tests. This is the default target.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpTestTarget.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static HttpTestTarget.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
HttpTestTarget(java.lang.String host, int port, java.lang.String path) Test target for HTTP tests. This is the default target.
HttpTestTarget(java.lang.String host, int port) Test target for HTTP tests. This is the default target.
HttpTestTarget(java.lang.String host) Test target for HTTP tests. This is the default target.
HttpTestTarget() Test target for HTTP tests. This is the default target.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	executeInteraction(java.lang.Object client, java.lang.Object request) Executes the test (using the client and request from prepareRequest, if any)
static HttpTestTarget	fromUrl(java.net.URL url) Creates a HttpTestTarget from a URL. If the URL does not contain a port, 8080 will be used.
java.lang.String	getHost() Host to bind to.
java.lang.String	getPath() The path that the provider is mounted on.
int	getPort() Port that the provider is running on.
au.com.dius.pact.provider.ProviderInfo	getProviderInfo(java.lang.String serviceName, au.com.dius.pact.model.PactSource pactSource) Returns information about the provider
boolean	isHttpTarget() If this is a request response (HTTP or HTTPS) target
kotlin.Pair<java.lang.Object,java.lang.Object>	prepareRequest(au.com.dius.pact.model.Interaction interaction, java.util.Map<java.lang.String,? extends java.lang.Object> context) Prepares the request for the interaction.
void	prepareVerifier(au.com.dius.pact.provider.IProviderVerifier verifier, java.lang.Object testInstance) Prepares the verifier for use during the test

Methods inherited from interface au.com.dius.pact.provider.junit5.TestTarget

executeInteraction, getProviderInfo, isHttpTarget, prepareRequest, prepareVerifier

Field Detail

Companion

public static HttpTestTarget.Companion Companion

Constructor Detail

HttpTestTarget

public HttpTestTarget(java.lang.String host,
                      int port,
                      java.lang.String path)

Test target for HTTP tests. This is the default target.

Parameters:

host - Host to bind to. Defaults to localhost.

port - Port that the provider is running on. Defaults to 8080.

path - The path that the provider is mounted on. Defaults to the root path.

HttpTestTarget

public HttpTestTarget(java.lang.String host,
                      int port)

Test target for HTTP tests. This is the default target.

Parameters:

host - Host to bind to. Defaults to localhost.

port - Port that the provider is running on. Defaults to 8080.

HttpTestTarget

public HttpTestTarget(java.lang.String host)

Test target for HTTP tests. This is the default target.

Parameters:

host - Host to bind to. Defaults to localhost.

HttpTestTarget

public HttpTestTarget()

Test target for HTTP tests. This is the default target.

Method Detail

isHttpTarget

public boolean isHttpTarget()

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

getProviderInfo

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

Returns information about the provider

prepareRequest

public kotlin.Pair<java.lang.Object,java.lang.Object> prepareRequest(au.com.dius.pact.model.Interaction interaction,
                                                                     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(au.com.dius.pact.provider.IProviderVerifier verifier,
                            java.lang.Object testInstance)

Prepares the verifier for use during the test

executeInteraction

public java.util.Map<java.lang.String,java.lang.Object> executeInteraction(java.lang.Object client,
                                                                           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

getHost

public java.lang.String getHost()

Host to bind to.

Defaults to localhost.

getPort

public int getPort()

Port that the provider is running on.

Defaults to 8080.

getPath

public java.lang.String getPath()

The path that the provider is mounted on.

Defaults to the root path.

fromUrl

public static HttpTestTarget fromUrl(java.net.URL url)

Creates a HttpTestTarget from a URL. If the URL does not contain a port, 8080 will be used.