> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Robot Framework plugin

View this plugin on the Plugins site

robot: Configure robot framework report collection

Publishes Robot Framework test reports into Hudson user interface.

Note that you must configure your build to produce these reports before you can publish them with this plugin.

All text fields support the use of environment variables available during build (e.g. ${BUILD_NUMBER}).

  • outputPath
    • Type: String
  • archiveDirName (optional)
    • Type: String
  • disableArchiveOutput (optional)

    output xml files are not needed by Jenkins once the publishing step of the build is finished.

    They are archived for traceability or reuse in some other context.

    You might want to disable archiving of those output xml files to save disk space on the Jenkins server.

    • Type: boolean
  • enableCache (optional)

    Enable cache for test results (produces memory pressure)

    • Type: boolean
  • logFileName (optional)

    File name relative to output path. Supports Ant GLOB style wildcards (e.g. **/log*.html).

    Splitted files will be copied automatically. If file name is specified log.html then all log-xxx.html will be saved.

    • Type: String
  • onlyCritical (optional)
    • Type: boolean
  • otherFiles (optional)

    Comma separated list of file names relative to output path. Supports Ant GLOB style wildcards (e.g. **/screenshot*.jpg).

    You can save any artifacts related to tests (e.g. Selenium screenshots) in the robot directory by configuring the filenames here. Items that are linked to the robot log files - like screenshots - have to be explicitly saved here in order to view them in the stored logs.

    • Type: String
  • outputFileName (optional)

    File name relative to output path. Supports Ant GLOB style wildcards (e.g. **/output*.xml).

    Splitted files will be copied automatically. If file name is specified output.xml then all output-xxx.xml will be saved.

    • Type: String
  • overwriteXAxisLabel (optional)

    Pattern to format x axis label in trend graphs. You can use $build for build number beside all letters from java class DateTimeFormatter (e.g. MM-dd HH:mm). Already created and cached images are not affected

    • Type: String
  • passThreshold (optional)
    • Type: double
  • reportFileName (optional)

    File name relative to output path. Supports Ant GLOB style wildcards (e.g. **/report*.html).

    Splitted files will be copied automatically. If file name is specified report.html then all report-xxx.html will be saved.

    • Type: String
  • unstableThreshold (optional)
    • Type: double

step([$class: 'RobotPublisher']): Publish Robot Framework test results

Publishes Robot Framework test reports into Hudson user interface.

Note that you must configure your build to produce these reports before you can publish them with this plugin.

All text fields support the use of environment variables available during build (e.g. ${BUILD_NUMBER}).

  • archiveDirName
    • Type: String
  • outputPath
    • Type: String
  • outputFileName

    File name relative to output path. Supports Ant GLOB style wildcards (e.g. **/output*.xml).

    Splitted files will be copied automatically. If file name is specified output.xml then all output-xxx.xml will be saved.

    • Type: String
  • disableArchiveOutput

    output xml files are not needed by Jenkins once the publishing step of the build is finished.

    They are archived for traceability or reuse in some other context.

    You might want to disable archiving of those output xml files to save disk space on the Jenkins server.

    • Type: boolean
  • reportFileName

    File name relative to output path. Supports Ant GLOB style wildcards (e.g. **/report*.html).

    Splitted files will be copied automatically. If file name is specified report.html then all report-xxx.html will be saved.

    • Type: String
  • logFileName

    File name relative to output path. Supports Ant GLOB style wildcards (e.g. **/log*.html).

    Splitted files will be copied automatically. If file name is specified log.html then all log-xxx.html will be saved.

    • Type: String
  • passThreshold
    • Type: double
  • unstableThreshold
    • Type: double
  • onlyCritical
    • Type: boolean
  • otherFiles

    Comma separated list of file names relative to output path. Supports Ant GLOB style wildcards (e.g. **/screenshot*.jpg).

    You can save any artifacts related to tests (e.g. Selenium screenshots) in the robot directory by configuring the filenames here. Items that are linked to the robot log files - like screenshots - have to be explicitly saved here in order to view them in the stored logs.

    • Type: String
  • enableCache

    Enable cache for test results (produces memory pressure)

    • Type: boolean
  • overwriteXAxisLabel

    Pattern to format x axis label in trend graphs. You can use $build for build number beside all letters from java class DateTimeFormatter (e.g. MM-dd HH:mm). Already created and cached images are not affected

    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.