robotframework:rebot

Full name:

org.robotframework:robotframework-maven-plugin:2.1.0:rebot

Description:

Creates report files from output.xml using the Robot Framework rebot tool. Uses the rebot bundled in Robot Framework jar distribution. For more help see rebot documentation.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Optional Parameters

Name Type Since Description
<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
  • runnerClass can be used to specify runner class
  • runWithPython can be used to specify running with Python Robot Framework
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>
     <runnerClass>org.robotframework.RobotFramework</runnerClass>
     <runWithPython>false</runWithPython>
</externalRunner>

<flattenKeywords> List - Flatten keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#flattening-keywords.
  • 'FOR' - Flatten for loops fully.
  • 'FORITEM' - Flatten individual for loop iterations.
  • 'NAME:<pattern>' - Flatten keywords matching the given pattern.
  • 'TAG:<pattern>' - Flatten keywords with tags matching the given pattern.
The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.
<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.
<merge> boolean - When combining results, merge outputs together instead of putting them under a new top level suite.
Default value is: false.
<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.
<removeKeywords> List - Remove keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#removing-keywords.
  • 'ALL' - Remove data from all keywords unconditionally.
  • 'PASSED' -Remove keyword data from passed test cases. In most cases, log files created using this option contain enough information to investigate possible failures.
  • 'FOR' - Remove all passed iterations from for loops except the last one.
  • 'WUKS' - Remove all failing keywords inside BuiltIn keyword 'Wait Until Keyword Succeeds' except the last one.
  • 'NAME:<pattern>' - Remove data from all keywords matching the given pattern regardless the keyword status.
  • 'TAG:<pattern>' - Remove data from keywords with tags that match the given pattern.
The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.
<report> File - Sets the path to the generated report file.
<reportTitle> String - Sets a title for the generated tests report.
<rpa> boolean - Turn on generic automation mode.
Default value is: false.
<splitOutputs> String - Splits output and log files.
<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.
Default value is: ${project.build.directory}/robotframework-reports/rebot-xunit-results.xml.

Parameter Details

<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
  • runnerClass can be used to specify runner class
  • runWithPython can be used to specify running with Python Robot Framework
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>
     <runnerClass>org.robotframework.RobotFramework</runnerClass>
     <runWithPython>false</runWithPython>
</externalRunner>
  • Type: org.robotframework.mavenplugin.ExternalRunnerConfiguration
  • Required: No

<flattenKeywords>

Flatten keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#flattening-keywords.
  • 'FOR' - Flatten for loops fully.
  • 'FORITEM' - Flatten individual for loop iterations.
  • 'NAME:<pattern>' - Flatten keywords matching the given pattern.
  • 'TAG:<pattern>' - Flatten keywords with tags matching the given pattern.
The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.
  • 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

<merge>

When combining results, merge outputs together instead of putting them under a new top level suite.
  • Type: boolean
  • Required: No
  • Default: false

<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

<removeKeywords>

Remove keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#removing-keywords.
  • 'ALL' - Remove data from all keywords unconditionally.
  • 'PASSED' -Remove keyword data from passed test cases. In most cases, log files created using this option contain enough information to investigate possible failures.
  • 'FOR' - Remove all passed iterations from for loops except the last one.
  • 'WUKS' - Remove all failing keywords inside BuiltIn keyword 'Wait Until Keyword Succeeds' except the last one.
  • 'NAME:<pattern>' - Remove data from all keywords matching the given pattern regardless the keyword status.
  • 'TAG:<pattern>' - Remove data from keywords with tags that match the given pattern.
The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.
  • Type: java.util.List
  • Required: No

<report>

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

<reportTitle>

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

<rpa>

Turn on generic automation mode.
  • Type: boolean
  • Required: No
  • Default: false

<splitOutputs>

Splits output and log files.
  • Type: java.lang.String
  • 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
  • Default: ${project.build.directory}/robotframework-reports/rebot-xunit-results.xml