dev.jeka.core.api.testing

Class JkApplicationTester

java.lang.Object

dev.jeka.core.api.testing.JkApplicationTester

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

JkDockerAppTester

public abstract class JkApplicationTester
extends java.lang.Object
implements java.lang.Runnable

Template class for performing actions on application to be deployed and undeployed.

The typical use-case is for testing applications end-to-end. Users need to implement :

• Methods for starting/stopping the application environment
• Method for checking the application is ready
• Method to running test

The run() method, then can be invoked to orchestrate the whole execution of tests, managing de deployment and cleanup of application environment.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	reAttemptDelay
protected int	startTimeout

Constructor Summary

Constructors

Constructor and Description
JkApplicationTester()

Method Summary

Modifier and Type	Method and Description
protected abstract void	executeTests() Executes the tests for the application under test.
protected int	findFreePort() Retiurn the first free port detected in the dynamic port range.
protected void	init() Prepares the variables required to start and stop the application, including the base URL and port configuration.
protected abstract boolean	isApplicationReady() Check and returns if the application is ready to be tested.
void	run() Deploy application environment, run tests and un-deploy the application gracefully.
protected abstract void	startApp() Starts the application and its environment.
protected void	stopForcefully() This method is invoked when, the application did not start until defined timeout.
protected void	stopGracefully() This method is invoked when tests are terminated, to undeploy the application and its environment.

Methods inherited from class java.lang.Object

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

Field Detail

startTimeout

protected int startTimeout

reAttemptDelay

protected int reAttemptDelay

Constructor Detail

JkApplicationTester

public JkApplicationTester()

Method Detail

run

public final void run()

Deploy application environment, run tests and un-deploy the application gracefully.

Specified by:

run in interface java.lang.Runnable

init

protected void init()

Prepares the variables required to start and stop the application, including the base URL and port configuration.

startApp

protected abstract void startApp()

Starts the application and its environment. This method should be invoked in a separate thread and is expected to block execution. The application should be terminated using the stopXXX methods.

isApplicationReady

protected abstract boolean isApplicationReady()

Check and returns if the application is ready to be tested.

executeTests

protected abstract void executeTests()

Executes the tests for the application under test. The method is supposed to throw an Exception (for instance if tests failed.

stopGracefully

protected void stopGracefully()

This method is invoked when tests are terminated, to undeploy the application and its environment.

stopForcefully

protected void stopForcefully()

This method is invoked when, the application did not start until defined timeout.

findFreePort

protected final int findFreePort()

Retiurn the first free port detected in the dynamic port range.