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.


melioraTestlab: Publish test results to Testlab

  • projectKey : String

    The key of the Testlab project you want to publish the results to.

  • ruleset : String (optional)

    A "source" is a set of settings and mapping rules defined in Testlab. Enter a name of the source you wish to use for processing the pushed results. If you wish to override a setting (or settings) in your job, choose the "Override source settings" option and set the preferred values.

    If not set, the default source in your Testlab will be used.

  • rulesetSettings (optional)
      Nested Object
    • testRunTitle : String (optional)
    • milestone : String (optional)
    • testTargetTitle : String (optional)
    • testEnvironmentTitle : String (optional)
    • addIssueStrategy (optional)
    • reopenExisting : boolean (optional)
    • assignToUser : String (optional)
    • importTestCases : boolean (optional)
    • importTestCasesRootCategory : String (optional)
    • robotCatenateParentKeywords : boolean (optional)
    • testCaseMappingField : String (optional)
    • tags : String (optional)
  • description : String (optional)

    The description to be set for the Testlab test run to create or update.

    In this field the build time environmental variables of Jenkins are handy. In addition to the by default set environment variables this plugin registers the following variables that can be used for configuration values:

    Variable Description
    ${BUILD_FULL_DISPLAY_NAME} Combined full display name of the build with job name and build number. For example 'my jenkins job #133'
    ${BUILD_RESULT} Result of the build. For example 'SUCCESS' or 'UNSTABLE'.
    ${BUILD_STATUS} Summary of the overall build. For example 'broken for a long time'.

    To use variables in your configuration values make sure to enter tags as ${VARIABLE}.

  • parameters : String (optional)

    Environment variables to sent to Testlab as test case parameters.

    Test cases in Testlab can include parameters in the content as ${PARAM1} formatted tags. Normally, these tags are set and replaced with values set during the test case execution or execution planning phase. By listing variables to this setting makes it possible to send values of environmental variables from Jenkins as test case parameters to Testlab.

    For example, test case(s) in your Testlab project might have a parameter titled ${BROWSER}. When running automated UI tests in your Jenkins, enter a value "BROWSER" to this setting and ensure that your job sets an environmental variable BROWSER to some sensible value. This way running the job sends and sets the ${BROWSER} test case parameter value to all run tests to a value matching to the environmental variable.

    Probably the easiest way to set environment variables is to use a fitting plugin.

  • publishRobot (optional)

    The plugin supports publishing the results directly from Robot Framework output files found in the build.

    Note: This option publishes results directly from Robot's output.xml file. This produces a more detailed result in Testlab compared to the junit-format based output of Robot Framework.

      Nested Object
    • robotCatenateParentKeywords : boolean
    • robotOutput : String (optional)
  • publishTap (optional)

    The plugin supports publishing the results from TAP (Test Anything Protocol) files found in the build. If not checked, the possible TAP results produced by the job are ignored.

    To publish TAP results the TAP-Plugin must be installed to your Jenkins. In addition to this, the job must be configured with "Publish TAP Results" Post-build Action to make the results available for publishing.

      Nested Object
    • tapFileNameInIdentifier : boolean (optional)
    • tapTestNumberInIdentifier : boolean (optional)
    • tapTestsAsSteps : boolean (optional)
    • tapMappingPrefix : String (optional)
  • advancedSettings (optional)
      Nested Object
    • testCaseMappingField : String
    • companyId : String (optional)
    • apiKey (optional)
      • Type: class hudson.util.Secret
    • usingonpremise (optional)
        Nested Object
      • onpremiseurl : String (optional)
  • automationSource : String (optional)

    Source is used to identify results, so that two test runs with the same source name should contain results for same, or similar tests. The default {JOB_NAME} - value uses the Jenkins job's name as automation source name.

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.