UITest (XWiki Platform - Test - Docker UI Test Framework 13.7-rc-1 API)

@Documented
 @Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD,ANNOTATION_TYPE})
 @ExtendWith(value=org.xwiki.test.integration.junit5.ValidateConsoleExtension.class) @ExtendWith(value=org.xwiki.test.docker.internal.junit5.XWikiDockerExtension.class) @ExtendWith(value=org.xwiki.test.docker.internal.junit5.TestReferenceParameterResolver.class)
 @TestInstance(value=PER_CLASS)
 @TestMethodOrder(value=org.junit.jupiter.api.MethodOrderer.OrderAnnotation.class)
public @interface UITest

Marks a test as being a functional UI Test.

Since:: 10.6RC1
Version:: $Id: 3e57d3a745d5c4930cd67de12de071f90b8e8656 $

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`Browser`	`browser`
`Database`	`database`
`String[]`	`databaseCommands`
`String`	`databaseTag`
`boolean`	`debug`
`ExtensionOverride[]`	`extensionOverrides`
`String[]`	`extraJARs`
`ServletEngine[]`	`forbiddenEngines`
`String`	`jdbcDriverVersion`
`boolean`	`office` Note: The version of LibreOffice is read from the current `pom.xml`.
`boolean`	`offline`
`String[]`	`profiles`
`String[]`	`properties`
`boolean`	`resolveExtraJARs`
`boolean`	`saveDatabaseData`
`ServletEngine`	`servletEngine`
`String`	`servletEngineTag`
`int[]`	`sshPorts`
`boolean`	`verbose`
`boolean`	`vnc`

- Element Detail
  - browser
```
public abstract Browser browser
```
    Returns:
    
    the browser to use, see Browser
    
    Default:
    
    org.xwiki.test.docker.junit5.browser.Browser.FIREFOX
- - database
```
public abstract Database database
```
    Returns:
    
    the database to use, see Database
    
    Since:
    
    10.9
    
    Default:
    
    org.xwiki.test.docker.junit5.database.Database.HSQLDB_EMBEDDED
- - servletEngine
```
public abstract ServletEngine servletEngine
```
    Returns:
    
    the Servlet Engine to use, see ServletEngine
    
    Since:
    
    10.9
    
    Default:
    
    org.xwiki.test.docker.junit5.servletengine.ServletEngine.JETTY_STANDALONE
- - verbose
```
public abstract boolean verbose
```
    Returns:
    
    true if the test should output verbose console logs or not
    
    Since:
    
    10.10RC1
    
    Default:
    
    false
- - debug
```
public abstract boolean debug
```
    Returns:
    
    true if the test should output debug console logs or not
    
    Since:
    
    10.11RC1
    
    Default:
    
    false
- - saveDatabaseData
```
public abstract boolean saveDatabaseData
```
    Returns:
    
    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
    
    Default:
    
    false
- - offline
```
public abstract boolean offline
```
    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
    
    Default:
    
    false
- - servletEngineTag
```
public abstract String servletEngineTag
```
    Returns:
    
    the docker image tag to use (if not specified, uses the "latest" tag)
    
    Since:
    
    10.10RC1
    
    Default:
    
    ""
- - databaseTag
```
public abstract String databaseTag
```
    Returns:
    
    the docker image tag to use (if not specified, uses the default from TestContainers)
    
    Since:
    
    10.10RC1
    
    Default:
    
    ""
- - jdbcDriverVersion
```
public abstract String jdbcDriverVersion
```
    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
    
    Default:
    
    ""
- - vnc
```
public abstract boolean vnc
```
    Returns:
    
    true if VNC container is started and recording is done and saved on test exit
    
    Since:
    
    10.10RC1
    
    Default:
    
    true
- - properties
```
public abstract String[] properties
```
    Returns:
    
    the list of configuration properties to use when generating the XWiki configuration files such as xwiki.properties with Velocity (check xwiki.properties.vm to find the list of supported properties)
    
    Since:
    
    10.10RC1
    
    Default:
    
    {}
- - extensionOverrides
```
public abstract ExtensionOverride[] extensionOverrides
```
    Returns:
    
    the properties to overwrite in the generated extensions descriptors
    
    Since:
    
    11.6RC1
    
    Default:
    
    {}
- - extraJARs
```
public abstract String[] extraJARs
```
    Returns:
    
    the optional list of JARs (specified as artifact coordinates groupId:artifactId) that should be added to WEB-INF/lib. For example this is useful for artifacts containing Hibernate mapping files since those cannot currently be loaded as extensions.
    
    Since:
    
    10.11RC1
    
    Default:
    
    {}
- - resolveExtraJARs
```
public abstract boolean resolveExtraJARs
```
    Returns:
    
    true if the specified extra JAR versions must be resolved (when they're not specified), by checking the transitive list of dependencies in the current POM. Note that there are 2 limitations: resolving takes time and SNAPSHOT versions will be resolved to the latest published SNAPSHOT. This is why it's off by default. When false the current POM version will be used for the missing exyta JAR versions. The main use case for using true is in contrib extensions where the current POM version usually don't match extra JARs versions and you may not want to hardcode the version and thus you can let the docker test framework find it for you.
    
    Since:
    
    12.5RC1
    
    Default:
    
    false
- - sshPorts
```
public abstract int[] sshPorts
```
    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
    
    Default:
    
    {}
- - profiles
```
public abstract String[] profiles
```
    Returns:
    
    the list of Maven profiles to activate when resolving dependencies for the current POM.
    
    Since:
    
    10.11RC1
    
    Default:
    
    {}
- - office
```
public abstract boolean office
```
    Note: The version of LibreOffice is read from the current pom.xml.
    
    Returns:
    
    true if LibreOffice must be installed in the Servlet Container.
    
    Since:
    
    10.11RC1
    
    See Also:
    
    ServletContainerExecutor
    
    Default:
    
    false
- - forbiddenEngines
```
public abstract ServletEngine[] forbiddenEngines
```
    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
    
    Default:
    
    {}
- - databaseCommands
```
public abstract String[] databaseCommands
```
    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
    
    Default:
    
    {}

Annotation Type UITest

Optional Element Summary

Element Detail

browser

database

servletEngine

verbose

debug

saveDatabaseData

offline

servletEngineTag

databaseTag

jdbcDriverVersion

vnc

properties

extensionOverrides

extraJARs

resolveExtraJARs

sshPorts

profiles

office

forbiddenEngines

databaseCommands