From version 126.6
edited by Vincent Massol
on 2018/11/09 13:20
To version 127.1
edited by Eduard Moraru
on 2018/11/13 17:41
Change comment: Simplified the configuration options table to improve readability and focus on the information

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.VincentMassol
1 +xwiki:XWiki.enygma
Content
... ... @@ -207,19 +207,44 @@
207 207  * Based on [[TestContainers>>https://www.testcontainers.org/]] and uses Docker to execute the tests under various Databases, Servlet Engines and Browsers.
208 208  * The only requirements for running these tests is to have Docker installed locally and to have the user under which you run your IDE and the Maven build be able to use the docker executable.
209 209  * Configurations options:(((
210 -|=System Property|[email protected] attribute|=Default value|=Valid values|=Description
211 -|##-Dxwiki.test.ui.browser=firefox##|##@UITest(browser = Browser.FIREFOX)##|##firefox##|##firefox##, ##chrome##|The browser used in the tests. Note that the version of the browser used is controlled by the version of Selenium that is defined in the ##pom.xml## of ##xwiki-platform-test-docker##.
212 -|##-Dxwiki.test.ui.database=hsqldb_embedded##|##@UITest(database = Database.HSQLDB_EMBEDDED)##|##hsqldb_embedded##|##mysql##, ##postgres##, ##hsqldb_embedded##|The database used in the tests
213 -|##-Dxwiki.test.ui.servletEngine=jetty_standalone##|##@UITest(servletEngine = ServletEngine.JETTY_STANDALONE)##|##jetty_standalone##|##tomcat##, ##jetty##, ##jetty_standalone##, ##external##|The Servlet Engine used in the tests. Use ##external## to use your own started and alreayd provisioned XWiki instance.
214 -|##-Dxwiki.test.ui.verbose=false##|##@UITest(verbose = false)##|##false##|##true##, ##false##|When active, displays more logs in the console (especially container startup logs)
215 -|##-Dxwiki.test.ui.saveDatabaseData=false|##@UITest(saveDatabaseData = false)##|##false##|##true##, ##false##|By default, database data is not saved between test executions. {{warning}}Note that if you decide to save database data, they'll be saved under a ##docker## user by Docker and you need your local user to be able to remove them if you want to clean your Maven ##target## directory.{{/warning}}
216 -|##-Dxwiki.test.ui.offline=false##|##@UITest(offline = false)##|##false##|##true##, ##false##|When offline, the custom XWiki WAR generation and the XWiki provisioning are done solely from your local Maven repository. Otherwise, when artifacts are not present locally or newer SNAPSHOT versions are available, they'll be fetched from Maven remote repositories.
217 -|##-Dxwiki.test.ui.databaseTag=latest##|##@UITest(databaseTag = "latest")##|[[Latest supported version by XWiki>>https://dev.xwiki.org/xwiki/bin/view/Community/DatabaseSupportStrategy]]|Any Docker tag available from Dockerhub for the container image|Version of the database to use. Isn't supported for HSQLDB Embedded since it doesn't run in a Docker container.
218 -|##-Dxwiki.test.ui.servletEngineTag=latest##|##@UITest(servletEngineTag = "latest")##|[[Latest supported version by XWiki>>https://dev.xwiki.org/xwiki/bin/view/Community/ServletContainerSupportStrategy/]]|Any Docker tag available from Dockerhub for the container image|Version of the Servlet Engine to use. Isn't supported for Jetty Standalone since it doesn't run in a Docker container.
219 -|##-Dxwiki.test.ui.jdbcDriverVersion=2.4.1##|##@UITest(jdbcDriverVersion = "2.4.1")##|Latest version validated by the XWiki dev team|Any version for the specified database that is available on Maven Central, e.g. for MySQL the groupId/artifactId is ##mysql##/##mysql-connector-java##.
220 -|##-Dxwiki.test.ui.vnc=true##|##@UITest(vnc = true)##|##true##|##true##, ##false##|When active a VNC container is started to record a video of the tests and more generally to allow connecting to the UI running the tests. Useful when debugging.
221 -|##-Dxwiki.test.ui.properties.*=...##|##@UITest(properties = { ... })##|No default|Velocity properties that are applied when generating XWiki's configuration files: ##xwiki.cfg##, ##xwiki.properties## and ##hibernate.cfg.xml##. Check the ##*.vm## files for these configuration files to see the list of possible values. Example: Tell XWiki that minification is off: ##-Dxwiki.test.ui.properties.xwikiPropertiesAdditionalProperties=debug.minify=false## or ##@UITest(properties = { "xwikiPropertiesAdditionalProperties=debug.minify=false" })##.
210 +|=System Property |[email protected] attribute|=Default value|=Valid values|=Description
211 +|##xwiki.test.ui.browser##|##browser##|##firefox##|(((
212 +* ##firefox## (##Browser.FIREFOX##)
213 +* ##chrome## (##Browser.CHROME##)
214 +)))|The browser used in the tests. Note that the version of the browser used is controlled by the version of Selenium that is defined in the ##pom.xml## of ##xwiki-platform-test-docker##.
215 +|##xwiki.test.ui.database##|##database##|##hsqldb_embedded##|(((
216 +* ##mysql## (##Database.MYSQL##)
217 +* ##postgres## (##Database.POSTGRESQL##)
218 +* ##hsqldb_embedded## (##Database.HSQLDB_EMBEDDED##)
219 +)))|The database used in the tests
220 +|##xwiki.test.ui.servletEngine##|##servletEngine##|##jetty_standalone##|(((
221 +* ##tomcat## (##ServletEngine.TOMCAT##)
222 +* ##jetty## (##ServletEngine.JETTY##)
223 +* ##jetty_standalone## (##ServletEngine.JETTY_STANDALONE##)
224 +* ##external## (##ServletEngine.EXTERNAL##)
225 +)))|The Servlet Engine used in the tests. Use ##external## to use your own started and alreayd provisioned XWiki instance.
226 +|##xwiki.test.ui.verbose##|##verbose##|##false##|(((
227 +* ##true##
228 +* ##false##
229 +)))|When active, displays more logs in the console (especially container startup logs)
230 +|##xwiki.test.ui.saveDatabaseData##|##saveDatabaseData##|##false##|(((
231 +* ##true##
232 +* ##false##
233 +)))|By default, database data is not saved between test executions. {{warning}}Note that if you decide to save database data, they'll be saved under a ##docker## user by Docker and you need your local user to be able to remove them if you want to clean your Maven ##target## directory.{{/warning}}
234 +|##xwiki.test.ui.offline##|##offline##|##false##|(((
235 +* ##true##
236 +* ##false##
237 +)))|When offline, the custom XWiki WAR generation and the XWiki provisioning are done solely from your local Maven repository. Otherwise, when artifacts are not present locally or newer SNAPSHOT versions are available, they'll be fetched from Maven remote repositories.
238 +|##xwiki.test.ui.databaseTag##|##databaseTag##|[[Latest supported version by XWiki>>https://dev.xwiki.org/xwiki/bin/view/Community/DatabaseSupportStrategy]]|Any Docker tag available from Dockerhub for the container image|Version of the database to use. Isn't supported for HSQLDB Embedded since it doesn't run in a Docker container.
239 +|##xwiki.test.ui.servletEngineTag##|##servletEngineTag##|[[Latest supported version by XWiki>>https://dev.xwiki.org/xwiki/bin/view/Community/ServletContainerSupportStrategy/]]|Any Docker tag available from Dockerhub for the container image|Version of the Servlet Engine to use. Isn't supported for Jetty Standalone since it doesn't run in a Docker container.
240 +|##xwiki.test.ui.jdbcDriverVersion##|##jdbcDriverVersion##|Latest version validated by the XWiki dev team|Any version for the specified database that is available on Maven Central, e.g. for MySQL the groupId/artifactId is ##mysql##/##mysql-connector-java##.
241 +|##xwiki.test.ui.vnc##|##vnc##|##true##|(((
242 +* ##true##
243 +* ##false##
244 +)))|When active a VNC container is started to record a video of the tests and more generally to allow connecting to the UI running the tests. Useful when debugging.
245 +|##xwiki.test.ui.properties.propName=p=v##|##properties = {"propName1=p1=v1", "propName2=p2=v2"}##|No default (empty)|Check the ##*.vm## files for the configuration files to see the list of possible values.|Velocity properties that are applied when generating XWiki's configuration files: ##xwiki.cfg##, ##xwiki.properties## and ##hibernate.cfg.xml##. Example: Tell XWiki that minification is off: ##-Dxwiki.test.ui.properties.xwikiPropertiesAdditionalProperties=debug.minify=false## or ##@UITest(properties = { "xwikiPropertiesAdditionalProperties=debug.minify=false" })##.
222 222  )))
247 +** {{info}}Reminder: System properties are in the form ##-DpropertyName=value## and Java annotation attributes are passed in the form ##@UITest(attributeName = value)##{{/info}}
223 223  * Tests get injected ##XWikiWebDriver## and ##TestUtils## instances as test method parameters.
224 224  * Test results is recording in a FLV file in the ##target## directory.
225 225  * A screenshot of the UI when the test is failing is also taken in the ##target## directory.

Get Connected