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 for JIRA - Test Management Plugin

View this plugin on the Plugins site

step([$class: 'QTM4JResultPublisher']): Publish test result to QMetry for JIRA Old

  • name : String
  • apikey : String
  • file : String
  • attachFile : boolean
  • testrunname : String
  • labels : String
  • sprint : String
  • version : String
  • component : String
  • format : String
  • platform : String
  • comment : String
  • apikeyserver : String
  • jiraurlserver : String
  • proxyUrl : String
  • password
    • Type: class hudson.util.Secret
  • testrunnameserver : String
  • labelsserver : String
  • sprintserver : String
  • versionserver : String
  • componentserver : String
  • username : String
  • fileserver : String
  • attachFileServer : boolean
  • formatserver : String
  • platformserver : String
  • commentserver : String
  • testToRun : String
  • testrunkey : String
  • testassethierarchy : String
  • testCaseUpdateLevel : String
  • jirafields : String
  • testrunkeyserver : String
  • testassethierarchyserver : String
  • testCaseUpdateLevelServer : String
  • jirafieldsserver : String
  • disableaction : boolean
  • serverAuthenticationType : String
  • personalAccessToken : String

step([$class: 'TestReportDeployPublisher']): Publish results to QMetry for Jira version 3.X below

  • name : String
  • apikey : String
    API Key is unique for a specific user in a single project . The result will be imported for the project associated with the given API Key.
  • file : String
    Path of the result file/directory relative to build directory.
  • attachFile : boolean
    Check for upload attachments in execution. Default value: false.
  • testrunname : String
    Name of the test run to be created. For example: Test Run
  • labels : String
    Comma separated names of Labels to be added to the test run. For example: label1, label2
  • sprint : String
    Name of Sprint to be added to the test run. For example: Final sprint
  • version : String
    Comma separated names of versions to be added to the test run. For example: version1, version2
  • component : String
    Comma separated names of Components to be added to the test run. For example: component1, component2
  • format : String
  • platform : String
    Name of Platform on which test run to be executed. For example: IOS
  • comment : String
    Comment to be added to the test run.
  • apikeyserver : String
    API Key is unique for a specific user in a single project . The result will be imported for the project associated with the given API Key.
  • jiraurlserver : String
    Your JIRA url. Example:https://qmetryjiraeval.qmetry.com/rest/qtm/latest/automation/importresults
  • proxyUrl : String
  • password
    Password for your account.
    • Type: class hudson.util.Secret
  • testrunnameserver : String
    Name of the test run to be created. For example: Test Run
  • labelsserver : String
    Comma separated names of Labels to be added to the test run. For example: label1, label2
  • sprintserver : String
    Name of Sprint to be added to the test run. For example: Final sprint
  • versionserver : String
    Comma separated names of versions to be added to the test run. For example: version1, version2
  • componentserver : String
    Comma separated names of Components to be added to the test run. For example: component1, component2
  • username : String
    Username for your account.
  • fileserver : String
    Path of the result file/directory relative to build directory
  • attachFileServer : boolean
    Check for upload attachments in execution. Default value: false.
  • formatserver : String
  • platformserver : String
    Name of Platform on which test run to be executed. For example: IOS
  • commentserver : String
    Comment to be added to the test run.
  • testToRun : String
  • testrunkey : String
    Provide Test Run key to append new results to existing Test Run.
  • testassethierarchy : String
  • testCaseUpdateLevel : String
    Test Case update level while reusing test case, starts from 0 to 2. (This is only applicable when you use TestCase-TestStep Hierarchy option) Default :- No change in test steps while reusing Test Case.
  • jirafields : String
    Provide JSON array of custom jirafields.
  • testrunkeyserver : String
    Provide Test Run key to append new results to existing Test Run.
  • testassethierarchyserver : String
  • testCaseUpdateLevelServer : String
    Test Case update level while reusing test case, starts from 0 to 2. (This is only applicable when you use TestCase-TestStep Hierarchy option) Default :- No change in test steps while reusing Test Case.
  • jirafieldsserver : String
    Provide JSON array of custom jirafields.
  • disableaction : boolean
  • serverAuthenticationType : String
  • personalAccessToken : String
    Enter Personal Access Token of your account.

step([$class: 'TestReportDeployPublisherCloudV4']): Publish results to QMetry for Jira version 4.X above

  • testToRun : String
  • apikey : String
    API Key is unique for a specific user in a single project . The result will be imported for the project associated with the given API Key.
  • file : String
    Path of the result file/directory relative to build directory.
  • attachFile : boolean
    Pass true to upload attachments in execution. Default value: false. For more details, Refer automation help documents.
  • matchTestSteps : boolean
    Match Test Steps - True/False, True is the default.
    True - Create/Reuse a test case with a summary and test steps that exactly match the automated test case uploaded through the result file. The execution results and other execution details of the test case and steps will be imported from the automation result file.
    False - Create/Reuse a test case with a summary or test case key that exactly matches the automated test case uploaded through the result file, and exclude matching of test steps. The execution results of the test case will be imported or calculated based on the test case/step results from the automation result file. The execution result of the test case will be propagated to the test steps in the case of test case reuse/creation. Individual test case steps will not be matched and their execution results/details will not be picked from the result file.
  • format : String
  • disableaction : boolean
  • testCycleToReuse : String
    Issue Key of the test cycle to be reused. If issue key of test cycle is not provided it will create new Cycle.
  • environment : String
    Name of the environment on which test cycle has to be executed. Default Value is "No Environment".
  • build : String
    Name of the build for test cycle execution
  • testCycleLabels : String
    Comma separated names of Labels to be added to the test cycle. For example: label1, label2 To get values check under: Qmetry > Configuration > Labels
  • testCycleComponents : String
    Comma separated names of Components to be added to the test cycle. For example: component1, component2 To get values check under: Qmetry > Configuration > Component
  • testCyclePriority : String
    Default value for Priority [High,Blocker,Low,Medium]. To get other values check under Qmetry > Configuration > Priority
  • testCycleStatus : String
    Default value for Priority [Done,In Progress,To Do]. To get other values check under Qmetry > Configuration > Statuses > Test Cycle
  • testCycleSprintId : String
  • testCycleFixVersionId : String
  • testCycleSummary : String
  • testCycleCustomFields : String
    Enter Test Cycle Custom Fields in Json Array Format.
    For example: [{"name": "custom field 1", "value": "high,medium,low"}, {"name": "custom field 2", "value": "29/May/2020"}]
    To get more information check under: Qmetry > Configuration > Custom Fields > Test Cycle
  • testCycleStartDate : String
    Pass date in 'dd/MMM/yyyy HH:mm' format
  • testCycleEndDate : String
    Pass date in 'dd/MMM/yyyy HH:mm' format
  • testCycleReporter : String
    Enter Valid User Account Id
  • testCycleAssignee : String
    Enter Valid User Account Id
  • testCycleDescription : String
  • testCycleFolderId : String
    Enter folder id for Test Cycle.
    To get it, Go to QTM4J Test Cycle panel > Right click on any folder > select 'Copy Folder Id' option > Paste it here.
  • testCaseLabels : String
    Comma separated names of Labels to be added to the test case. For example: label1, label2 To get values check under: Qmetry > Configuration > Labels
  • testCaseEstimatedTime : String
    Pass time in 'HH:mm' format
  • testCaseReporter : String
    Enter Valid User Account Id
  • testCaseAssignee : String
    Enter Valid User Account Id
  • testCaseDescription : String
  • testCasePrecondition : String
  • testCaseComponents : String
    Comma separated names of Components to be added to the test case. For example: component1, component2 To get values check under: Qmetry > Configuration > Component
  • testCasePriority : String
    Default value for Priority [High,Blocker,Low,Medium]. To get other values check under Qmetry > Configuration > Priority
  • testCaseStatus : String
    Default value for Status [Done,In Progress,To Do]. To get other values check under Qmetry > Configuration > Statuses > Test Case
  • testCaseSprintId : String
  • testCaseFixVersionId : String
  • testCaseCustomFields : String
    Enter Test Case Custom Fields in Json Array Format.
    For example: [{"name": "custom field 1", "value": "high,medium,low"}, {"name": "custom field 2", "value": "29/May/2020"}]
    To get more information check under: Qmetry > Configuration > Custom Fields > Test Case
  • testCaseFolderId : String
    Enter folder id for Test Case.
    To get it, Go to QTM4J Test Case panel > Right click on any folder > select 'Copy Folder Id' option > Paste it here.
  • jiraUrlServer : String
    Your JIRA url. Example:http://qtm4j.qmetry.com:8080/rest/qtm4j/automation/latest/importresult
  • proxyUrl : String
  • username : String
    Username for your account.
  • password
    Password for your account.
    • Type: class hudson.util.Secret
  • apikeyServer : String
    API Key is unique for a specific user in a single project . The result will be imported for the project associated with the given API Key.
  • formatServer : String
  • fileServer : String
    Path of the result file/directory relative to build directory.
  • testCycleToReuseServer : String
    Issue Key of the test cycle to be reused. If issue key of test cycle is not provided it will create new Cycle.
  • environmentServer : String
    Name of the environment on which test cycle has to be executed. Default Value is "No Environment".
  • buildServer : String
    Name of the build for test cycle execution
  • attachFileServer : boolean
    Pass true to upload attachments in execution. Default value: false. For more details, Refer automation help documents.
  • matchTestStepsServer : boolean
    Match Test Steps - True/False, True is the default.
    True - Create/Reuse a test case with a summary and test steps that exactly match the automated test case uploaded through the result file. The execution results and other execution details of the test case and steps will be imported from the automation result file.
    False - Create/Reuse a test case with a summary or test case key that exactly matches the automated test case uploaded through the result file, and exclude matching of test steps. The execution results of the test case will be imported or calculated based on the test case/step results from the automation result file. The execution result of the test case will be propagated to the test steps in the case of test case reuse/creation. Individual test case steps will not be matched and their execution results/details will not be picked from the result file.
  • testCycleLabelsServer : String
    Comma separated names of Labels to be added to the test cycle. For example: label1, label2 To get values check under: Qmetry > Configuration > Labels
  • testCycleComponentsServer : String
    Comma separated names of Components to be added to the test cycle. For example: component1, component2 To get values check under: Qmetry > Configuration > Component
  • testCyclePriorityServer : String
    Default value for Priority [High,Blocker,Low,Medium]. To get other values check under Qmetry > Configuration > Priority
  • testCycleStatusServer : String
    Default value for Priority [Done,In Progress,To Do]. To get other values check under Qmetry > Configuration > Statuses > Test Cycle
  • testCycleSprintIdServer : String
  • testCycleFixVersionIdServer : String
  • testCycleSummaryServer : String
  • testCycleStartDateServer : String
    Pass date in 'dd/MMM/yyyy HH:mm' format
  • testCycleEndDateServer : String
    Pass date in 'dd/MMM/yyyy HH:mm' format
  • testCycleAssigneeServer : String
    Enter Valid User Account Id
  • testCycleReporterServer : String
    Enter Valid User Account Id
  • testCycleDescriptionServer : String
  • testCycleCustomFieldsServer : String
    Enter Test Cycle Custom Fields in Json Array Format.
    For example: [{"name": "custom field 1", "value": "high,medium,low"}, {"name": "custom field 2", "value": "29/May/2020"}]
    To get more information check under: Qmetry > Configuration > Custom Fields > Test Cycle
  • testCaseEstimatedTimeServer : String
    Pass time in 'HH:mm' format
  • testCaseAssigneeServer : String
    Enter Valid User Account Id
  • testCaseReporterServer : String
    Enter Valid User Account Id
  • testCaseDescriptionServer : String
  • testCaseCustomFieldsServer : String
    Enter Test Case Custom Fields in Json Array Format.
    For example: [{"name": "custom field 1", "value": "high,medium,low"}, {"name": "custom field 2", "value": "29/May/2020"}]
    To get more information check under: Qmetry > Configuration > Custom Fields > Test Case
  • testCaseLabelsServer : String
    Comma separated names of Labels to be added to the test case. For example: label1, label2 To get values check under: Qmetry > Configuration > Labels
  • testCaseComponentsServer : String
    Comma separated names of Components to be added to the test case. For example: component1, component2 To get values check under: Qmetry > Configuration > Component
  • testCasePriorityServer : String
    Default value for Priority [High,Blocker,Low,Medium]. To get other values check under Qmetry > Configuration > Priority
  • testCaseStatusServer : String
    Default value for Status [Done,In Progress,To Do]. To get other values check under Qmetry > Configuration > Statuses > Test Case
  • testCaseSprintIdServer : String
  • testCaseFixVersionIdServer : String
  • serverAuthenticationType : String
  • personalAccessToken : String
    Enter Personal Access Token of your account.
  • testCycleFolderPathServer : String
    Enter folder path for Test Cycle. For example: F1/F2/F3
  • testCaseFolderPathServer : String
    Enter folder path for Test Case. For example: F1/F2/F3
  • testCasePreconditionServer : String
  • testCaseExecutionCommentServer : String
    Enter comment to be added to the Test Case Executions.
  • testCaseExecutionActualTimeServer : String
    Pass time in 'HH:mm' format.
  • testCaseExecutionAssigneeServer : String
    Enter Valid User Account Id.
  • testCaseExecutionCustomFieldsServer : String
    Enter Test Case Execution Custom Fields in Json Array Format.
    For example: [{"name": "custom field 1", "value": "high,medium,low"}, {"name": "custom field 2", "value": "29/May/2020"}]
    To get more information check under: Qmetry > Configuration > Custom Fields > Test Execution
  • testCaseExecutionPlannedDateServer : String
    Pass date in 'dd/MMM/yyyy' format
  • automationHierarchyServer : String
    Set Hierarchy for Automation Uploads “Test Cycle - Test Case - Test Step Hierarchy” as Default, 1, 2 or 3 :-
    • JUnit
      • Default Settings - Will refer to QMetry > Automation > Automation API > Settings.
      • 1 - Test Suite Name Tag is created as Test Case & Test Case Name Tag is created as Test Step.
      • 2 - Test Suite Name Tag is created as Test Cycle & Test Case Name Tag is created as Test Case.
      • 3 - Test Cycle Summary will be auto-generated & Test Case Name Tag is created as Test Case.
    • TestNG
      • Default Settings - Will refer to QMetry > Automation > Automation API > Settings.
      • 1 - Test Name Tag is created as Test Case & Test Method Name Tag is created as Test Step.
      • 2 - Test Name Tag is created as Test Cycle & Test Method Name Tag is created as Test Case.
      • 3 - Suite Name Tag is created as Test Cycle & Test Method Name Tag is created as Test Case.
  • appendTestNameServer : String
    Applicable only for JUnit or TestNG frameworks automation result uploads with Automation Hierarchy 2 or 3 :-
    • JUnit
      • Default Settings - Will refer to QMetry > Automation > Automation API > Settings.
      • Yes - Append Test Suite Name to Test Case Name while creating the Test Case Summary.
      • No - Create the Test Case Summary as per the Test Case Name present in the result file.
    • TestNG
      • Default Settings - Will refer to QMetry > Automation > Automation API > Settings.
      • Yes - Append Test Name to Test Method Name while creating the Test Case Summary.
      • No - Create the Test Case Summary as per the Test Method Name in the result file.
  • automationHierarchy : String
    Set Hierarchy for Automation Uploads “Test Cycle - Test Case - Test Step Hierarchy” as Default, 1, 2 or 3 :-
    • JUnit
      • Default Settings - Will refer to QMetry > Automation > Automation API > Settings.
      • 1 - Test Suite Name Tag is created as Test Case & Test Case Name Tag is created as Test Step.
      • 2 - Test Suite Name Tag is created as Test Cycle & Test Case Name Tag is created as Test Case.
      • 3 - Test Cycle Summary will be auto-generated & Test Case Name Tag is created as Test Case.
    • TestNG
      • Default Settings - Will refer to QMetry > Automation > Automation API > Settings.
      • 1 - Test Name Tag is created as Test Case & Test Method Name Tag is created as Test Step.
      • 2 - Test Name Tag is created as Test Cycle & Test Method Name Tag is created as Test Case.
      • 3 - Suite Name Tag is created as Test Cycle & Test Method Name Tag is created as Test Case.
  • appendTestName : String
    Applicable only for JUnit or TestNG frameworks automation result uploads with Automation Hierarchy 2 or 3 :-
    • JUnit
      • Default Settings - Will refer to QMetry > Automation > Automation API > Settings.
      • Yes - Append Test Suite Name to Test Case Name while creating the Test Case Summary.
      • No - Create the Test Case Summary as per the Test Case Name present in the result file.
    • TestNG
      • Default Settings - Will refer to QMetry > Automation > Automation API > Settings.
      • Yes - Append Test Name to Test Method Name while creating the Test Case Summary.
      • No - Create the Test Case Summary as per the Test Method Name in the result file.
  • testCaseExecutionComment : String
    Enter comment to be added to the Test Case Executions.
  • testCaseExecutionActualTime : String
    Pass time in 'HH:mm' format.
  • testCaseExecutionAssignee : String
    Enter Valid User Account Id.
  • testCaseExecutionCustomFields : String
    Enter Test Case Execution Custom Fields in Json Array Format.
    For example: [{"name": "custom field 1", "value": "high,medium,low"}, {"name": "custom field 2", "value": "29/May/2020"}]
    To get more information check under: Qmetry > Configuration > Custom Fields > Test Execution
  • testCaseExecutionPlannedDate : String
    Pass date in 'dd/MMM/yyyy' format
  • region : String
    QTM4J supports two regions - USA and Australia. Check your region from Jira, navigate to 'QMetry > About > Hosted Region'

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.