dev.jeka.core.api.tooling.docker

Class JkDockerAppTester

java.lang.Object

dev.jeka.core.api.testing.JkApplicationTester

dev.jeka.core.api.tooling.docker.JkDockerAppTester

All Implemented Interfaces:

java.lang.Runnable

public class JkDockerAppTester
extends JkApplicationTester

Field Summary

Fields inherited from class dev.jeka.core.api.testing.JkApplicationTester

reAttemptDelay, startTimeout

Method Summary

Modifier and Type	Method and Description
protected void	executeTests() Executes the tests for the application under test.
<T extends JkDockerBuild> T	getDockerBuild()
protected void	init() Prepares the variables required to start and stop the application, including the base URL and port configuration.
protected boolean	isApplicationReady() Check and returns if the application is ready to be tested.
static JkDockerAppTester	of(JkDockerBuild dockerBuild, java.util.function.Consumer<java.lang.String> tester)
JkDockerAppTester	setBaseUrl(java.lang.String baseUrl) Sets the base URL for the application.
JkDockerAppTester	setContextPath(java.nio.file.Path contextPath)
JkDockerAppTester	setImageName(java.lang.String imageName)
JkDockerAppTester	setPort(int port) Sets the port for the application to use.
JkDockerAppTester	setShowAppLogs(boolean showAppLogs) Configures whether application logs should be displayed during the testing process.
protected 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 dev.jeka.core.api.testing.JkApplicationTester

findFreePort, run

Methods inherited from class java.lang.Object

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

Method Detail

of

public static JkDockerAppTester of(JkDockerBuild dockerBuild,
                                   java.util.function.Consumer<java.lang.String> tester)

init

protected void init()

Description copied from class: JkApplicationTester

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

Overrides:

init in class JkApplicationTester

startApp

protected void startApp()

Description copied from class: JkApplicationTester

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.

Specified by:

startApp in class JkApplicationTester

isApplicationReady

protected boolean isApplicationReady()

Description copied from class: JkApplicationTester

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

Specified by:

isApplicationReady in class JkApplicationTester

executeTests

protected void executeTests()

Description copied from class: JkApplicationTester

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

Specified by:

executeTests in class JkApplicationTester

stopGracefully

protected void stopGracefully()

Description copied from class: JkApplicationTester

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

Overrides:

stopGracefully in class JkApplicationTester

stopForcefully

protected void stopForcefully()

Description copied from class: JkApplicationTester

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

Overrides:

stopForcefully in class JkApplicationTester

setPort

public JkDockerAppTester setPort(int port)

Sets the port for the application to use. If left empty, a random port will be choosen.

setBaseUrl

public JkDockerAppTester setBaseUrl(java.lang.String baseUrl)

Sets the base URL for the application. Default is http://localhost.

setShowAppLogs

public JkDockerAppTester setShowAppLogs(boolean showAppLogs)

Configures whether application logs should be displayed during the testing process.

setContextPath

public JkDockerAppTester setContextPath(java.nio.file.Path contextPath)

setImageName

public JkDockerAppTester setImageName(java.lang.String imageName)

getDockerBuild

public <T extends JkDockerBuild> T getDockerBuild()