org.xwiki.test.docker.junit5

Class TestConfiguration

java.lang.Object

org.xwiki.test.docker.junit5.TestConfiguration

public class TestConfiguration
extends Object

Configuration options for the test.

Since:

10.9

Version:

$Id: 143019a376f340df8234ccd942dcb272eacef251 $

Constructor Summary

Constructors

Constructor and Description
TestConfiguration(UITest uiTestAnnotation)

Method Summary

Modifier and Type	Method and Description
Browser	getBrowser()
Database	getDatabase()
Properties	getDatabaseCommands()
String	getDatabaseTag()
List<org.xwiki.tool.extension.ExtensionOverride>	getExtensionOverrides()
Set<org.xwiki.test.integration.maven.ArtifactCoordinate>	getExtraJARs()
List<ServletEngine>	getForbiddenServletEngines()
String	getJDBCDriverVersion()
String	getName()
String	getOutputDirectory()
List<String>	getProfiles()
Properties	getProperties()
ServletEngine	getServletEngine()
String	getServletEngineTag()
List<Integer>	getSSHPorts()
boolean	isDatabaseDataSaved()
boolean	isDebug()
boolean	isOffice()
boolean	isOffline()
boolean	isResolveExtraJARs()
boolean	isVerbose()
void	merge(TestConfiguration testConfiguration)
boolean	vnc()

Methods inherited from class java.lang.Object

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

Constructor Detail

TestConfiguration

public TestConfiguration(UITest uiTestAnnotation)

Parameters:

uiTestAnnotation - the annotation from which to extract the configuration

Method Detail

merge

public void merge(TestConfiguration testConfiguration)
           throws DockerTestException

Parameters:

testConfiguration - the configuration to merge with the current one

Throws:

DockerTestException

getBrowser

public Browser getBrowser()

Returns:

the browser to use

getDatabase

public Database getDatabase()

Returns:

the database to use

getServletEngine

public ServletEngine getServletEngine()

Returns:

the Servlet engine to use

isVerbose

public boolean isVerbose()

Returns:

true if the test should output verbose console logs or not

isDebug

public boolean isDebug()

Returns:

true if the test should output debug console logs or not

Since:

10.11RC1

isDatabaseDataSaved

public boolean isDatabaseDataSaved()

Returns:

true true if the database data should be mapped to a local directory on the host computer so that it can be saved and reused for another run

Since:

10.10RC1

isOffline

public boolean isOffline()

Returns:

true if the Maven resolving is done in offline mode (i.e. you need to have the required artifacts in your local repository). False by default to avoid developer problems but should be set to true in the CI to improve performance of functional tests

Since:

10.10RC1

getDatabaseTag

public String getDatabaseTag()

Returns:

the docker image tag to use (if not specified, uses the default from TestContainers)

Since:

10.10RC1

getServletEngineTag

public String getServletEngineTag()

Returns:

the docker image tag to use (if not specified, uses the "latest" tag)

Since:

10.10RC1

getJDBCDriverVersion

public String getJDBCDriverVersion()

Returns:

the version of the JDBC driver to use for the selected database (if not specified, uses a default version depending on the database)

Since:

10.10RC1

vnc

public boolean vnc()

Returns:

true if VNC container is started and recording is done and saved on test exit

Since:

10.10RC1

getProperties

public Properties getProperties()

Returns:

the list of configuration properties to use when generating the XWiki configuration files such as as xwiki.properties (check xwiki.properties.vm to find the list of supported properties)

Since:

10.10RC1

getDatabaseCommands

public Properties getDatabaseCommands()

Returns:

the list of database docker commands to use and that will override default commands (example of command character-set-server=utf8mb4

Since:

11.2RC1

getExtraJARs

public Set<org.xwiki.test.integration.maven.ArtifactCoordinate> getExtraJARs()

Returns:

the list of extra JARs to add to the WEB-INF/lib directory

Since:

10.11RC1

isResolveExtraJARs

public boolean isResolveExtraJARs()

Returns:

true if extra JARs version should be resolved when missing, see UITest.resolveExtraJARs()

Since:

12.5RC1

getExtensionOverrides

public List<org.xwiki.tool.extension.ExtensionOverride> getExtensionOverrides()

Returns:

the overrides of the extensions descriptors

Since:

11.6RC1

getSSHPorts

public List<Integer> getSSHPorts()

Returns:

the list of ports that should be SSH-forwarded when connecting from a Docker container to the host (i.e. when using the host.testcontainers.internal host name). This is in addition to port 8080 which is always added. For example if you need XWiki to send a mail to a SMTP server running on port 3025 on the host, you should add port 3025 to the list.

Since:

10.11RC1

getProfiles

public List<String> getProfiles()

Returns:

the list of Maven profiles to activate when resolving dependencies for the current POM.

Since:

10.11RC1

getName

public String getName()

Returns:

the String representation of the configuration (used for example as a directory name where to save the generated XWiki configuration - XWiki WAR file, etc)

Since:

10.10RC1

getOutputDirectory

public String getOutputDirectory()

Returns:

the output directory where to output files required for running the tests. If the maven.build.dir system property is not defined then construct an output directory name based on the defined configuration so that we can run different configurations one after another without them overriding each other. The maven.build.dir system property is there to allow controlling where the Maven output directory is located when running from Maven.

isOffice

public boolean isOffice()

Returns:

true if an office container must be provided to run the tests.

Since:

10.11RC1

getForbiddenServletEngines

public List<ServletEngine> getForbiddenServletEngines()

Returns:

the list of Servlet Engines on which this test must not be executed. If the Servlet Engine is selected then the test will be skipped

Since:

10.11RC1