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.

QMetry Test Management Plugin

step([$class: 'QTMReportPublisher']): Publish Build Result(s) to QMetry Test Management

  • qtmUrl : String
    URL to your QTM application
  • qtmAutomationApiKey : String
    Get your Automation API Key from QTM interface.
    1. Login to QTM
    2. Go to Integration > Automation API
    3. Copy 'Key'
  • proxyUrl : String
    Enter Proxy URL
  • automationFramework : String
    Test Automation framework used in your project to produce Test Result File(s) to be uploaded to QTM. supported formats are :-
    • Json file(s) from Cucumber Tests
    • Xml file(s) from Junit Tests
    • Xml file(s) from TestNG Tests
    • Json file(s) from QAS Tests
    • XML file(s) from HP-UFT Tests
    • XML file(s) from Robot Tests
  • automationHierarchy : String
    Hierarchy which will be used to parse test result files on QTM. supported formats are :-
    • JUnit
      • 1 - Use current Hierarchy in which JUnit is treated as TestStep and is treated as Testcase
      • 2 - Use Junit as Testcase and link all those (from all testsuites and all files of Junit) to one Testsuite
      • 3 - Create Multiple Testsuites and then link their respective testcases in corresponding Testsuites
    • TestNG
      • 1 - Use as Testcase and as TestStep
      • 2 - Use as Testcase
      • 3 - Use as TestCase and as TestStep
  • testResultFilePath : String
    Path to result files to be uploaded to QTM relative to your Build directory.
    Provide a path to directory to upload multiple files at once.
  • buildName : String
    Cycle name attached to your test suite in QTM.
  • testSuiteName : String
    Test suite Key or Id (This will upload results to existing test suite with given Id or Key)
  • testSName : String
    Test Suite Name (This will create a new test suite with given name. It will be ignored if automation framework is JUnit and automation hierarchy is 3)
  • tsFolderPath : String
    Test Suite Folder Path (This will upload results to the mentioned Test Suite Folder. It will be ignored if the QMetry instance type is Server.)
  • platformName : String
    Name of platform linked with Test Suite
  • project : String
    Target Project ID or project Key or project name
  • release : String
    Target Release ID or Release name
  • cycle : String
    Target Cycle Id or Cycle Name
  • disableaction : boolean
  • testcaseFields : String
    Enter Test Case Fields in Json Format (add "Field Name" as json key in JSON object.) System defined fields supported by test-case module are description, testCaseType, testCaseState, component, priority, testcaseOwner, estimatedTime. User can also add User defined fields. Ex. testcaseFields: {"description":"Automated Test case", "testCaseType":"Security", "testCaseState":"Rejected", "component":["x"], "priority":"Blocker", "testcaseOwner":"john.deo", "estimatedTime":"143", "userDefinedFields" : {"Integrate" : "Custom Field Test case"}}
  • testsuiteFields : String
    Enter Test Suite Fields in Json Format (add "Field Name" as json key in JSON object.) System defined fields supported by test-suite module are description, testsuiteOwner, testSuiteState. User can also add Userdefined fields. Ex. testsuiteFields: {"description":"Automated Test suite", "testsuiteOwner": "John.deo", "testSuiteState": "New", "userDefinedFields": {"Integrate" : "Custom Field Test suite"}}
  • skipWarning : String
    Skip Warning while uploading Test Result File(s) to QTM. supported values are :-
    • 0 - Test Case Import will be failed if the Test Case summary is more than 255 characters
    • 1 - Test Case will be imported by truncating the Test Case summary to 255 characters
  • isMatchingRequired : String
    Create a new Test Case version or reuse the already created version while uploading Test Result File(s) to QTM. supported values are :-
    • 1 - Create a new Test Case or Test Case Version if no version matches with the one being uploaded
    • 0 - Reuse already linked Test Case version on Test Suite OR auto link the existing latest version of Test Case, if the Test Case entity key OR Test Case summary is found matching

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.