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.

TestingBot plugin

View this plugin on the Plugins site

testingbotChecks: Publish TestingBot results as a GitHub check

  • message : String (optional)
    Optional summary shown on the check. When left empty, a summary is generated from the TestingBot sessions in the build (for example, 3 of 4 TestingBot session(s) passed.). The check links to the embedded TestingBot build report when one is available, otherwise to the Jenkins run.
  • name : String (optional)
    The name of the GitHub check (its context) that appears on the commit and pull request, e.g. TestingBot. Use a distinct name if you publish more than one check from a job. Defaults to TestingBot.

testingbotPublisher: Run TestingBot Test Publisher

  • testDataPublishers (optional)
      Array / List of Nested Choice of Objects
    • attachments
      • showAttachmentsAtClassLevel : boolean (optional)
      • showAttachmentsInStdOut : boolean (optional)
    • $class: 'AutomateTestDataPublisher'
      • $class: 'ClaimTestDataPublisher'
        • displayClaimActionsInTestResultsTable : boolean
      • junitFlakyTestPublisher
        • jiraTestResultReporter
          • configs
              Array / List of Nested Choice of Objects
            • jiraSelectableArrayField
              • fieldKey : String
              • values
                  Array / List of Nested Object
                • value : String
            • jiraSelectableField
              • fieldKey : String
              • value : String
            • jiraStringArrayField
              • fieldKey : String
              • values
                  Array / List of Nested Object
                • value : String
            • jiraStringField
              • fieldKey : String
              • value : String

                Insert a string value.

                You can include Jenkins Environment variables (see link), or the following variables defined by this plugin:

                Variable usage: ${VAR_NAME}

                CRFL - new line

                DEFAULT_SUMMARY - configured in the global configuration page

                DEFAULT_DESCRIPTION - configured in the global configuration page

                TEST_RESULT

                TEST_NAME

                TEST_FULL_NAME

                TEST_STACK_TRACE

                TEST_ERROR_DETAILS

                TEST_DURATION

                TEST_PACKAGE_NAME

                TEST_PACKAGE_CLASS_METHOD_NAME

                TEST_STDERR

                TEST_STDOUT

                TEST_OVERVIEW

                TEST_AGE

                TEST_PASS_COUNT

                TEST_SKIPPED_COUNT

                TEST_FAIL_SINCE

                TEST_IS_REGRESSION - expands to true/false

                BUILD_RESULT

                WARNING: Your input will not be validated against the server's metadata. Check Jira to make sure you insert a valid value for this field and use the Validate Fields button below, otherwise the plugin will fail to create your issue.

            • jiraUserField
              • fieldKey : String
              • value : String

                Insert the username.

                For example if you have a user with:

                Display Name: John Doe, Username: johndoe, Email: johndoe@email.com,

                you need to write johndoe in this field. Any other value (like display name, or email) will not work.

          • projectKey : String
          • issueType : String
          • autoRaiseIssue : boolean
            Create issues automatically for failing tests that don't yet have one linked.
          • autoResolveIssue : boolean
            Automatically apply transition to resolve issues linked to tests, if the test passes.
            Experimental feature: For now it only looks for the first transition that contains in its name "resolve". If it is found, it will be applied, if not, the status of the issue will not change. In future releases this will be parametrized.
          • autoUnlinkIssue : boolean
            Automatically unlinked issue from tests, if the test passes.
          • overrideResolvedIssues : boolean
            Create issues automatically for failing tests that are linked to resolved issues (Stored by jenkins in JiraIssueKeyToTestMap.json).
          • manualAddIssue : boolean
            Allow issues to be manually linked via the jenkins webinterface for failing tests that aren't linked yet.
          • additionalAttachments : boolean (optional)
            This plugin will include to a Jira issue additional files from junit-attachments plugin as attachments. Only working together with option auto raise issues.
        • $class: 'JunitResultPublisher'
          If checked, each JUnit test result XML file will be examined to see if it represents a SOASTA CloudTest composition. For applicable tests, a hyperlink to the SOASTA CloudTest dashboard will be inserted into the test report.
          • urlOverride : String
            Specify the CloudTest URL to use when creating hyperlinks to CloudTest dashboards. Normally, this can be left blank, and the URL will be extracted from the test result file.
        • $class: 'PerfSigTestDataPublisher'
          • dynatraceProfile : String
        • $class: 'SahaginTestDataPublishser'
          • $class: 'SauceOnDemandReportPublisher'
            Show embedded Sauce OnDemand reports, including video and logs. Your test should use Selenium client factory (at least version 1.3 to match test cases to individual Sauce OnDemand jobs).
            • jobVisibility : String (optional)
              Set your test results visibility permissions. The Sauce Documentation has all the various levels described in detail.
          • $class: 'StabilityTestDataPublisher'
            • $class: 'TestCafePublisher'
              • $class: 'TestReporter'
                • $class: 'YoutrackTestDataPublisher'

                testingbotUpload: Upload an app to TestingBot Storage

                • file : String
                  Workspace-relative path to the app to upload, for example build/outputs/apk/debug/app-debug.apk or build/MyApp.ipa. A zipped iOS Simulator build (.zip of a .app) works too. Environment variables (such as $WORKSPACE) are expanded.
                • credentialsId : String (optional)
                  The TestingBot credential (key/secret) used to upload the app. Leave empty to use the first available TestingBot credential.
                • variableName : String (optional)
                  Name of the environment variable that the uploaded app URL (a tb:// reference) is exported under, for use by later build steps as the Appium app capability. Defaults to TESTINGBOT_APP_URL.

                testingbot: TestingBot

                • credentialsId : String
                  The ID of the TestingBot credentials (created on the global Manage Jenkins > Credentials page) whose key and secret should be exposed to the build as environment variables (TESTINGBOT_KEY/TB_KEY and TESTINGBOT_SECRET/TB_SECRET).

                testingbotTunnel: TestingBotTunnel

                • credentialsId : String
                  The ID of the TestingBot credentials used to authenticate the tunnel. The key and secret are also exposed to the block as environment variables (TESTINGBOT_KEY/TB_KEY and TESTINGBOT_SECRET/TB_SECRET).
                • options : String (optional)
                  Optional command-line options passed to the TestingBot Tunnel, e.g. --tunnel-identifier my-id or --proxy host:8080. Supported options are --debug, --tunnel-identifier, --proxy, --proxy-userpwd, --metrics-port and --auth; other options are ignored and reported in the build log. Values containing spaces may be quoted.

                testingbotUpload: Upload an app to TestingBot Storage

                • file : String
                • credentialsId : String (optional)

                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.