robotframework:testdoc

Full name:

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

Description:

Create documentation of test suites using the Robot Framework testdoc tool.
Uses the testdoc bundled in Robot Framework jar distribution. For more help see testdoc documentation.

Attributes:

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

Required Parameters

Name Type Since Description
<testdoc> TestDocConfiguration - Test case documentation configuration. Required settings:
  • outputFile The name for the output file. We also support patterns like *.html, which indicates to derive the output name from the original name.
  • dataSourceFile Name or path of the documented test case(s). Supports ant-like pattern format to match multiple inputs, such as src/robot/**/*.robot
Paths are considered relative to the location of pom.xml and must point to a valid test case file. For example src/main/test/ExampleTest.txt Optional settings:
  • outputDirectory Specifies the directory where documentation files are written. Considered to be relative to the ${basedir} of the project. Default ${project.build.directory}/robotframework/testdoc
  • title Set the title of the generated documentation. Underscores in the title are converted to spaces. The default title is the name of the top level suite.
  • name Override the name of the top level test suite.
  • doc Override the documentation of the top level test suite.
Example 1: 
<testdoc>
     <outputFile>MyTests.html</outputFile>
     <dataSourceFile>src/test/resources/MyTests.txt</dataSourceFile>
</testdoc>
Example 2: 
<testdoc>
     <outputFile>*.html</outputFile>
     <dataSourceFile>src/robot/**/*.robot</dataSourceFile>
</testdoc>

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>

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

<testdoc>

Test case documentation configuration. Required settings:
  • outputFile The name for the output file. We also support patterns like *.html, which indicates to derive the output name from the original name.
  • dataSourceFile Name or path of the documented test case(s). Supports ant-like pattern format to match multiple inputs, such as src/robot/**/*.robot
Paths are considered relative to the location of pom.xml and must point to a valid test case file. For example src/main/test/ExampleTest.txt Optional settings:
  • outputDirectory Specifies the directory where documentation files are written. Considered to be relative to the ${basedir} of the project. Default ${project.build.directory}/robotframework/testdoc
  • title Set the title of the generated documentation. Underscores in the title are converted to spaces. The default title is the name of the top level suite.
  • name Override the name of the top level test suite.
  • doc Override the documentation of the top level test suite.
Example 1: 
<testdoc>
     <outputFile>MyTests.html</outputFile>
     <dataSourceFile>src/test/resources/MyTests.txt</dataSourceFile>
</testdoc>
Example 2: 
<testdoc>
     <outputFile>*.html</outputFile>
     <dataSourceFile>src/robot/**/*.robot</dataSourceFile>
</testdoc>
  • Type: org.robotframework.mavenplugin.TestDocConfiguration
  • Required: Yes