robotframework:acceptance-test

Full name:

org.robotframework:robotframework-maven-plugin:1.5.0:acceptance-test

Description:

Runs the Robot tests. Behaves like invoking the "jybot" command. The goal will not fail the maven build, rather the results are evaluated by the verify goal. For details see the maven-failsafe-plugin, which uses the same strategy for integration testing. Robot Framework tests cases are created in files and directories, and they are executed by configuring the path to the file or directory in question to the testCasesDirectory configuration. The given file or directory creates the top-level tests suites, which gets its name, unless overridden with the "name" option, from the file or directory name.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: integration-test.

Optional Parameters

Name Type Since Description
<argumentFile> File - A text file to read more arguments from.
User property is: argumentFile.
<combinedTagStats> List - Creates combined statistics based on tags. Use the format "tags:title"
<criticalTags> List - Tests that have the given tags are considered critical.
<debugFile> File - A debug file that is written during execution.
<document> String - Sets the documentation of the top-level tests suites.
<dryrun> boolean - Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax.
Default value is: false.
<excludes> List - Selects the tests cases by tags.
<excludes_cli> String - Selects the tests cases by tags. Given as a comma separated list. This setting overrides the value for excludes configuration in pom.xml.

Example:

mvn -Dexcludes=foo,bar verify
(This setting is needed to support overriding the configuration value from command prompt on maven 2.)


User property is: excludes.
<exitOnFailure> boolean - Sets robot to stop execution immediately if a critical test fails.
Default value is: false.
<externalRunner> ExternalRunnerConfiguration -

Test are executed in a new process if this configuration is used.

The classpath for the new process will include by default all the test scope dependencies from the pom.

  • Environment variables can be added with environmentVariables map. CLASSPATH environment variable is added (prepended) to the default dependencies.
  • excludeDependencies can be used to exclude the test scope dependencies from the classpath of the new process.
  • jvmArgs can be used to specify JVM options
Example:
<externalRunner>
     <environmentVariables>
         <foo>bar</foo>
         <CLASSPATH>this-should-be-seen-by-external-process.jar</CLASSPATH>
     </environmentVariables>
     <jvmArgs>
         <jvmArg>-XX:PermSize=128m</jvmArg>
         <jvmArg>-XX:MaxPermSize=256m</jvmArg>
         <jvmArg>-Xmx512m</jvmArg>
     </jvmArgs>
     <excludeDependencies>true</excludeDependencies>
</externalRunner>

<extraPathDirectories> File[] - Additional locations (directories, ZIPs, JARs) where to search test libraries from when they are imported. Maps to Jybot's --pythonpath option. Otherwise if no locations are declared, the default location is ${project.basedir}/src/test/resources/robotframework/libraries.
<includes> List - Selects the tests cases by tags.
<includes_cli> String - Selects the tests cases by tags. Given as a comma separated list. This setting overrides the value for includes configuration in pom.xml.

Example:

mvn -Dincludes=foo,bar verify
(This setting is needed to support overriding the configuration value from command prompt on maven 2.)


User property is: includes.
<listener> String - Sets a single listener for monitoring tests execution, can also be set via commandline using -Dlistener=MyListener.
User property is: listener.
<listeners> List - Sets multiple listeners for monitoring tests execution. Use the format "ListenerWithArgs:arg1:arg2" or simply "ListenerWithoutArgs"
<log> File - Sets the path to the generated log file.
<logLevel> String - Sets the threshold level for logging.
<logTitle> String - Sets a title for the generated tests log.
<metadata> List - Sets free metadata for the top level tests suites.
<monitorColors> String - Using ANSI colors in console. Normally colors work in unixes but not in Windows. Default is 'on'.
  • 'on' - use colors in unixes but not in Windows
  • 'off' - never use colors
  • 'force' - always use colors (also in Windows)

<monitorWidth> String - Width of the monitor output. Default is 78.
<name> String - Sets the name of the top-level tests suites.
<noStatusReturnCode> boolean - If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
Default value is: false.
<nonCriticalTags> List - Tests that have the given tags are not critical.
<output> File - Sets the path to the generated output file.
<outputDirectory> File - Configures where generated reports are to be placed.
Default value is: ${project.build.directory}/robotframework-reports.
<randomize> String - Sets the test execution order to be randomized. Valid values are all, suite, and test
<report> File - Sets the path to the generated report file.
<reportBackground> String - Sets background colors for the generated report and summary.
<reportTitle> String - Sets a title for the generated tests report.
<runEmptySuite> boolean - Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition.
Default value is: false.
<runFailed> File - Re-run failed tests, based on output.xml file. This can also be set via commandline using -DrunFailed=path/to/output.xml.
User property is: runFailed.
<runMode> String - Sets the execution mode for this tests run. Note that this setting has been deprecated in Robot Framework 2.8. Use separate dryryn, skipTeardownOnExit, exitOnFailure, and randomize settings instead.
<skip> boolean - Skip tests, bound to -Dmaven.test.skip, which suppresses test compilation as well.
Default value is: false.
User property is: maven.test.skip.
<skipATs> boolean - Skip acceptance tests executed by this plugin. Bound to -DskipATs. This allows to run tests and integration tests, but no acceptance tests.
User property is: skipATs.
<skipITs> boolean - Skip acceptance tests executed by this plugin together with other integration tests, e.g. tests run by the maven-failsafe-plugin. Bound to -DskipITs
User property is: skipITs.
<skipTeardownOnExit> boolean - Sets whether the teardowns are skipped if the test execution is prematurely stopped.
Default value is: false.
<skipTests> boolean - Skip tests. Bound to -DskipTests. This allows to skip acceptance tests together with all other tests.
User property is: skipTests.
<splitOutputs> String - Splits output and log files.
<suiteStatLevel> String - Defines how many levels to show in the Statistics by Suite table in outputs.
<suites> List - Selects the tests suites by name.
<suites_cli> String - Selects the tests suites by name. Given as a comma separated list. This setting overrides the value for suites configuration in pom.xml.

Example:

mvn -Dsuites=foo,bar verify
(This setting is needed to support overriding the configuration value from command prompt on maven 2.)


User property is: suites.
<summaryTitle> String - Sets a title for the generated summary report.
<tagDocs> List - Adds documentation to the specified tags.
<tagStatExcludes> List - Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs.
<tagStatIncludes> List - Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs.
<tagStatLinks> List - Adds external links to the Statistics by Tag table in outputs. Use the format "pattern:link:title"
<tags> List - Sets the tags(s) to all executed tests cases.
<testCasesDirectory> File - The directory where the test cases are located.
Default value is: ${project.basedir}/src/test/robotframework/acceptance.
User property is: testCasesDirectory.
<tests> List - Selects the tests cases by name.
<tests_cli> String - Selects the tests cases by name. Given as a comma separated list. This setting overrides the value for tests configuration in pom.xml.

Example:

mvn -Dtests=foo,bar verify
(This setting is needed to support overriding the configuration value from command prompt on maven 2.)


User property is: tests.
<timestampOutputs> boolean - Adds a timestamp to all output files.
<variableFiles> List - Sets variables using variables files. Use the format "path:args"
<variables> List - Sets individual variables. Use the format "name:value"
<variables_cli> String - Sets individual variables. Use the format "name:value" and separate entries with comma. These are added into variables defined in the pom (variables with same name are overridden). (This setting is needed to support overriding the configuration value from command prompt on maven 2.)
User property is: variables.
<warnOnSkippedFiles> boolean - Show a warning when an invalid file is skipped.
<xunitFile> File - Sets the path to the generated XUnit compatible result file, relative to outputDirectory. The file is in xml format. By default, the file name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores.

Parameter Details

<argumentFile>

A text file to read more arguments from.
  • Type: java.io.File
  • Required: No
  • User Property: argumentFile

<combinedTagStats>

Creates combined statistics based on tags. Use the format "tags:title"
  • Type: java.util.List
  • Required: No

<criticalTags>

Tests that have the given tags are considered critical.
  • Type: java.util.List
  • Required: No

<debugFile>

A debug file that is written during execution.
  • Type: java.io.File
  • Required: No

<document>

Sets the documentation of the top-level tests suites.
  • Type: java.lang.String
  • Required: No

<dryrun>

Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax.
  • Type: boolean
  • Required: No
  • Default: false

<excludes>

Selects the tests cases by tags.
  • Type: java.util.List
  • Required: No

<excludes_cli>

Selects the tests cases by tags. Given as a comma separated list. This setting overrides the value for excludes configuration in pom.xml.

Example:

mvn -Dexcludes=foo,bar verify
(This setting is needed to support overriding the configuration value from command prompt on maven 2.)

  • Type: java.lang.String
  • Required: No
  • User Property: excludes

<exitOnFailure>

Sets robot to stop execution immediately if a critical test fails.
  • Type: boolean
  • Required: No
  • Default: false

<externalRunner>

Test are executed in a new process if this configuration is used.

The classpath for the new process will include by default all the test scope dependencies from the pom.

  • Environment variables can be added with environmentVariables map. CLASSPATH environment variable is added (prepended) to the default dependencies.
  • excludeDependencies can be used to exclude the test scope dependencies from the classpath of the new process.
  • jvmArgs can be used to specify JVM options
Example:
<externalRunner>
     <environmentVariables>
         <foo>bar</foo>
         <CLASSPATH>this-should-be-seen-by-external-process.jar</CLASSPATH>
     </environmentVariables>
     <jvmArgs>
         <jvmArg>-XX:PermSize=128m</jvmArg>
         <jvmArg>-XX:MaxPermSize=256m</jvmArg>
         <jvmArg>-Xmx512m</jvmArg>
     </jvmArgs>
     <excludeDependencies>true</excludeDependencies>
</externalRunner>
  • Type: org.robotframework.mavenplugin.ExternalRunnerConfiguration
  • Required: No

<extraPathDirectories>

Additional locations (directories, ZIPs, JARs) where to search test libraries from when they are imported. Maps to Jybot's --pythonpath option. Otherwise if no locations are declared, the default location is ${project.basedir}/src/test/resources/robotframework/libraries.
  • Type: java.io.File[]
  • Required: No

<includes>

Selects the tests cases by tags.
  • Type: java.util.List
  • Required: No

<includes_cli>

Selects the tests cases by tags. Given as a comma separated list. This setting overrides the value for includes configuration in pom.xml.

Example:

mvn -Dincludes=foo,bar verify
(This setting is needed to support overriding the configuration value from command prompt on maven 2.)

  • Type: java.lang.String
  • Required: No
  • User Property: includes

<listener>

Sets a single listener for monitoring tests execution, can also be set via commandline using -Dlistener=MyListener.
  • Type: java.lang.String
  • Required: No
  • User Property: listener

<listeners>

Sets multiple listeners for monitoring tests execution. Use the format "ListenerWithArgs:arg1:arg2" or simply "ListenerWithoutArgs"
  • Type: java.util.List
  • Required: No

<log>

Sets the path to the generated log file.
  • Type: java.io.File
  • Required: No

<logLevel>

Sets the threshold level for logging.
  • Type: java.lang.String
  • Required: No

<logTitle>

Sets a title for the generated tests log.
  • Type: java.lang.String
  • Required: No

<metadata>

Sets free metadata for the top level tests suites.
  • Type: java.util.List
  • Required: No

<monitorColors>

Using ANSI colors in console. Normally colors work in unixes but not in Windows. Default is 'on'.
  • 'on' - use colors in unixes but not in Windows
  • 'off' - never use colors
  • 'force' - always use colors (also in Windows)
  • Type: java.lang.String
  • Required: No

<monitorWidth>

Width of the monitor output. Default is 78.
  • Type: java.lang.String
  • Required: No

<name>

Sets the name of the top-level tests suites.
  • Type: java.lang.String
  • Required: No

<noStatusReturnCode>

If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
  • Type: boolean
  • Required: No
  • Default: false

<nonCriticalTags>

Tests that have the given tags are not critical.
  • Type: java.util.List
  • Required: No

<output>

Sets the path to the generated output file.
  • Type: java.io.File
  • Required: No

<outputDirectory>

Configures where generated reports are to be placed.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/robotframework-reports

<randomize>

Sets the test execution order to be randomized. Valid values are all, suite, and test
  • Type: java.lang.String
  • Required: No

<report>

Sets the path to the generated report file.
  • Type: java.io.File
  • Required: No

<reportBackground>

Sets background colors for the generated report and summary.
  • Type: java.lang.String
  • Required: No

<reportTitle>

Sets a title for the generated tests report.
  • Type: java.lang.String
  • Required: No

<runEmptySuite>

Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition.
  • Type: boolean
  • Required: No
  • Default: false

<runFailed>

Re-run failed tests, based on output.xml file. This can also be set via commandline using -DrunFailed=path/to/output.xml.
  • Type: java.io.File
  • Required: No
  • User Property: runFailed

<runMode>

Sets the execution mode for this tests run. Note that this setting has been deprecated in Robot Framework 2.8. Use separate dryryn, skipTeardownOnExit, exitOnFailure, and randomize settings instead.
  • Type: java.lang.String
  • Required: No

<skip>

Skip tests, bound to -Dmaven.test.skip, which suppresses test compilation as well.
  • Type: boolean
  • Required: No
  • User Property: maven.test.skip
  • Default: false

<skipATs>

Skip acceptance tests executed by this plugin. Bound to -DskipATs. This allows to run tests and integration tests, but no acceptance tests.
  • Type: boolean
  • Required: No
  • User Property: skipATs

<skipITs>

Skip acceptance tests executed by this plugin together with other integration tests, e.g. tests run by the maven-failsafe-plugin. Bound to -DskipITs
  • Type: boolean
  • Required: No
  • User Property: skipITs

<skipTeardownOnExit>

Sets whether the teardowns are skipped if the test execution is prematurely stopped.
  • Type: boolean
  • Required: No
  • Default: false

<skipTests>

Skip tests. Bound to -DskipTests. This allows to skip acceptance tests together with all other tests.
  • Type: boolean
  • Required: No
  • User Property: skipTests

<splitOutputs>

Splits output and log files.
  • Type: java.lang.String
  • Required: No

<suiteStatLevel>

Defines how many levels to show in the Statistics by Suite table in outputs.
  • Type: java.lang.String
  • Required: No

<suites>

Selects the tests suites by name.
  • Type: java.util.List
  • Required: No

<suites_cli>

Selects the tests suites by name. Given as a comma separated list. This setting overrides the value for suites configuration in pom.xml.

Example:

mvn -Dsuites=foo,bar verify
(This setting is needed to support overriding the configuration value from command prompt on maven 2.)

  • Type: java.lang.String
  • Required: No
  • User Property: suites

<summaryTitle>

Sets a title for the generated summary report.
  • Type: java.lang.String
  • Required: No

<tagDocs>

Adds documentation to the specified tags.
  • Type: java.util.List
  • Required: No

<tagStatExcludes>

Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs.
  • Type: java.util.List
  • Required: No

<tagStatIncludes>

Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs.
  • Type: java.util.List
  • Required: No

<tagStatLinks>

Adds external links to the Statistics by Tag table in outputs. Use the format "pattern:link:title"
  • Type: java.util.List
  • Required: No

<tags>

Sets the tags(s) to all executed tests cases.
  • Type: java.util.List
  • Required: No

<testCasesDirectory>

The directory where the test cases are located.
  • Type: java.io.File
  • Required: No
  • User Property: testCasesDirectory
  • Default: ${project.basedir}/src/test/robotframework/acceptance

<tests>

Selects the tests cases by name.
  • Type: java.util.List
  • Required: No

<tests_cli>

Selects the tests cases by name. Given as a comma separated list. This setting overrides the value for tests configuration in pom.xml.

Example:

mvn -Dtests=foo,bar verify
(This setting is needed to support overriding the configuration value from command prompt on maven 2.)

  • Type: java.lang.String
  • Required: No
  • User Property: tests

<timestampOutputs>

Adds a timestamp to all output files.
  • Type: boolean
  • Required: No

<variableFiles>

Sets variables using variables files. Use the format "path:args"
  • Type: java.util.List
  • Required: No

<variables>

Sets individual variables. Use the format "name:value"
  • Type: java.util.List
  • Required: No

<variables_cli>

Sets individual variables. Use the format "name:value" and separate entries with comma. These are added into variables defined in the pom (variables with same name are overridden). (This setting is needed to support overriding the configuration value from command prompt on maven 2.)
  • Type: java.lang.String
  • Required: No
  • User Property: variables

<warnOnSkippedFiles>

Show a warning when an invalid file is skipped.
  • Type: boolean
  • Required: No

<xunitFile>

Sets the path to the generated XUnit compatible result file, relative to outputDirectory. The file is in xml format. By default, the file name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores.
  • Type: java.io.File
  • Required: No