Package org.opentestfactory.test.harness

Class AbstractMicroServiceTestBase

java.lang.Object

org.opentestfactory.test.harness.AbstractMicroServiceTestBase

Direct Known Subclasses:

AbstractMicroserviceIntegrationTest

public abstract class AbstractMicroServiceTestBase
extends Object

This class offers base microservice test primitives. It also automatically starts the mock before each test, and stops it after each test.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	AbstractMicroServiceTestBase.ContentType	It so happens that YAML is not a supported content type for org.apache.http.entity.ContentType so we need to have our content type model here :/

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AUTH_TOKEN_KEY_SUFFIX
final AuthToken	BUS_AUTH_TOKEN
final URL	BUS_BASE_URL
static final Duration	DELAY_BEFORE_ASYNC_REQUEST_SEQUENCE_VERIFY
static final Duration	DELAY_BEFORE_ASYNC_REQUEST_VERIFY
static final Duration	DELAY_FOR_SSH
static final String	EVENTBUS_BASE_KEY
protected org.mockserver.integration.ClientAndServer	mockServer
final AuthToken	serviceAuthToken
static final String	SUBSCRIPTIONS_PATH
protected static final String	URL_KEY_SUFFIX

Constructor Summary

Constructors

Constructor	Description
AbstractMicroServiceTestBase(int receiverPort, URL sutBaseUrl, AuthToken serviceAuthToken)

Method Summary

Modifier and Type	Method	Description
protected ExpectedOutputReceiver	getExpectedOutputReceiver()	Create an ExpectedOutputReceiver instance with the base setup from this test class.
protected SUTSender	jsonRESTPost(String testMessageResourceName, URI sutURI, JsonVariableMappings variableMappings, AuthToken sutAuthToken)	Send a JSON test input message to the SUT.
static void	mockServerWarmUp()
protected SUTSender	postJSONToSUTendPoint(String messageName, String sutEndpointPath, JsonVariableMappings variables)	Post a JSON test input to the specified endpoint.
protected SUTSender	postYAMLToSUTendPoint(String messageName, String sutEndpointPath)	Post a YAML test input to the specified endpoint.
protected org.mockserver.model.HttpRequest	requestMatcher(String pathOfMock, String expectedPayloadName)	Build a request matcher for the ExpectedOutputReceiver instance.
protected SUTSender	sendTemplatedTestMessage(String testMessageResourceName, JsonVariableMappings variableMappings)	Send a test input message built from template to the SUT bus.
protected SUTSender	sendTestMessage(String testMessageResourceName)	Send a test input message to the SUT bus.
void	startClientAndServer()
void	stopClientAndServer()
protected JsonVariableMappings	subscriptionMappings(String subscriptionName)
protected String	subscriptionPath(String subscriptionName)
protected InputStream	useTestResource(String resourceName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DELAY_BEFORE_ASYNC_REQUEST_VERIFY

public static final Duration DELAY_BEFORE_ASYNC_REQUEST_VERIFY

DELAY_BEFORE_ASYNC_REQUEST_SEQUENCE_VERIFY

public static final Duration DELAY_BEFORE_ASYNC_REQUEST_SEQUENCE_VERIFY

DELAY_FOR_SSH

public static final Duration DELAY_FOR_SSH

AUTH_TOKEN_KEY_SUFFIX

protected static final String AUTH_TOKEN_KEY_SUFFIX

See Also:

• Constant Field Values

URL_KEY_SUFFIX

protected static final String URL_KEY_SUFFIX

See Also:

• Constant Field Values

EVENTBUS_BASE_KEY

public static final String EVENTBUS_BASE_KEY

See Also:

• Constant Field Values

SUBSCRIPTIONS_PATH

public static final String SUBSCRIPTIONS_PATH

See Also:

• Constant Field Values

BUS_BASE_URL

public final URL BUS_BASE_URL

BUS_AUTH_TOKEN

public final AuthToken BUS_AUTH_TOKEN

serviceAuthToken

public final AuthToken serviceAuthToken

mockServer

protected org.mockserver.integration.ClientAndServer mockServer

Constructor Details

AbstractMicroServiceTestBase

public AbstractMicroServiceTestBase(int receiverPort,
 URL sutBaseUrl,
 AuthToken serviceAuthToken)

Parameters:

receiverPort - TCP port on which the test receiver will listen to expected (or unwanted) messages. Try to use different ones across tests, to isolate tests and make results easier to read.

sutBaseUrl - base URL from which the system under test will receive test inputs.

Method Details

mockServerWarmUp

@BeforeAll
public static void mockServerWarmUp()
                             throws InterruptedException

Throws:

InterruptedException

startClientAndServer

@BeforeEach
public void startClientAndServer()
                          throws InterruptedException

Throws:

InterruptedException

stopClientAndServer

@AfterEach
public void stopClientAndServer()
                         throws InterruptedException

Throws:

InterruptedException

sendTemplatedTestMessage

protected SUTSender sendTemplatedTestMessage(String testMessageResourceName,
 JsonVariableMappings variableMappings)
                                      throws URISyntaxException,
IOException

Send a test input message built from template to the SUT bus.

Parameters:

testMessageResourceName - the template with value placeholders as defined by JsonVariableMappings.

variableMappings - the mappings to apply.

Returns:

SUTSender object to test response code.

Throws:

URISyntaxException

IOException

sendTestMessage

protected SUTSender sendTestMessage(String testMessageResourceName)
                             throws IOException,
URISyntaxException

Send a test input message to the SUT bus.

Parameters:

testMessageResourceName - message content to send.

Returns:

reference to the SUTSender object for further actions like checking HTTP return codes.

Throws:

IOException

URISyntaxException

jsonRESTPost

protected SUTSender jsonRESTPost(String testMessageResourceName,
 URI sutURI,
 JsonVariableMappings variableMappings,
 AuthToken sutAuthToken)
                          throws IOException

Send a JSON test input message to the SUT.

Parameters:

testMessageResourceName - message content to send

sutURI - URI of the destination endpoint

variableMappings -

Returns:

reference to the SUTSender object for further actions like checking HTTP return codes.

Throws:

IOException

requestMatcher

protected org.mockserver.model.HttpRequest requestMatcher(String pathOfMock,
 String expectedPayloadName)
                                                   throws IOException

Build a request matcher for the ExpectedOutputReceiver instance.

Parameters:

pathOfMock -

expectedPayloadName -

Returns:

Throws:

IOException

useTestResource

protected InputStream useTestResource(String resourceName)

getExpectedOutputReceiver

protected ExpectedOutputReceiver getExpectedOutputReceiver()

Create an ExpectedOutputReceiver instance with the base setup from this test class.

Returns:

postJSONToSUTendPoint

protected SUTSender postJSONToSUTendPoint(String messageName,
 String sutEndpointPath,
 JsonVariableMappings variables)
                                   throws URISyntaxException,
IOException

Post a JSON test input to the specified endpoint.

Parameters:

messageName - name of the test resource to send, as for useTestResource(String)

sutEndpointPath - end point to post the json to.

Returns:

reference to the SUTSender object for further actions like checking HTTP return codes.

Throws:

URISyntaxException

IOException

postYAMLToSUTendPoint

protected SUTSender postYAMLToSUTendPoint(String messageName,
 String sutEndpointPath)
                                   throws URISyntaxException,
IOException

Post a YAML test input to the specified endpoint.

Parameters:

messageName - name of the test resource to send, as for useTestResource(String)

sutEndpointPath - end point to post the json to.

Returns:

reference to the SUTSender object for further actions like checking HTTP return codes.

Throws:

URISyntaxException

IOException

subscriptionMappings

protected JsonVariableMappings subscriptionMappings(String subscriptionName)
                                             throws IOException

Throws:

IOException

subscriptionPath

protected String subscriptionPath(String subscriptionName)
                           throws IOException

Throws:

IOException