From version 127.1
edited by Eduard Moraru
on 2018/11/13 17:41
To version 128.1
edited by Eduard Moraru
on 2018/11/14 12:35
Change comment: Even more simplification of the configuration options table and removed duplication.

Summary

Details

Page properties
Content
... ... @@ -207,44 +207,52 @@
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 -|##xwiki.test.ui.browser##|##browser##|##firefox##|(((
210 +{{info}}
211 +Reminder:
212 +* When passing the options as system properties, the format is ##-Dxwiki.test.ui.optionName=value##
213 +* When passing as Java annotation attributes, in functional tests, the format is ##@UITest(optionName = value)##
214 +{{/info}}
215 +
216 +(% style="overflow-x: auto;" %)
217 +(((
218 +|=Option Name|=Default Value|=Valid Values|=Description
219 +|##browser##|##firefox##|(((
212 212  * ##firefox## (##Browser.FIREFOX##)
213 213  * ##chrome## (##Browser.CHROME##)
214 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##|(((
223 +|##database##|##hsqldb_embedded##|(((
216 216  * ##mysql## (##Database.MYSQL##)
217 217  * ##postgres## (##Database.POSTGRESQL##)
218 218  * ##hsqldb_embedded## (##Database.HSQLDB_EMBEDDED##)
219 219  )))|The database used in the tests
220 -|##xwiki.test.ui.servletEngine##|##servletEngine##|##jetty_standalone##|(((
228 +|##servletEngine##|##jetty_standalone##|(((
221 221  * ##tomcat## (##ServletEngine.TOMCAT##)
222 222  * ##jetty## (##ServletEngine.JETTY##)
223 223  * ##jetty_standalone## (##ServletEngine.JETTY_STANDALONE##)
224 224  * ##external## (##ServletEngine.EXTERNAL##)
225 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##|(((
234 +|##verbose##|##false##|(((
227 227  * ##true##
228 228  * ##false##
229 229  )))|When active, displays more logs in the console (especially container startup logs)
230 -|##xwiki.test.ui.saveDatabaseData##|##saveDatabaseData##|##false##|(((
238 +|##saveDatabaseData##|##false##|(((
231 231  * ##true##
232 232  * ##false##
233 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##|(((
242 +|##offline##|##false##|(((
235 235  * ##true##
236 236  * ##false##
237 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##|(((
246 +|##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.
247 +|##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.
248 +|##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##.|
249 +|##vnc##|##true##|(((
242 242  * ##true##
243 243  * ##false##
244 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" })##.
253 +|##properties##|No default (empty)|Check the ##*.vm## files for the configuration files to see the list of possible values.|(% style="word-break: break-all;" %) 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" })##.
246 246  )))
247 -** {{info}}Reminder: System properties are in the form ##-DpropertyName=value## and Java annotation attributes are passed in the form ##@UITest(attributeName = value)##{{/info}}
255 +)))
248 248  * Tests get injected ##XWikiWebDriver## and ##TestUtils## instances as test method parameters.
249 249  * Test results is recording in a FLV file in the ##target## directory.
250 250  * A screenshot of the UI when the test is failing is also taken in the ##target## directory.

Get Connected