Versions Compared

Old Version 16

changes.mady.by.user Mrunalini Potnis

Saved on

compared with

New Version 17

changes.mady.by.user Mrunalini Potnis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 13

Table of Contents

Configuring a Standard Jenkins job

...

1. To create a new Jenkins job, click on the New Item option on the Jenkins menu.


Image RemovedImage Added

2. Provide a name for your job.

    Select Freestyle project on the screen and then click OK.


Image RemovedImage Added


3. Next, the configuration page appears where you can configure your job by various categories: General, Source Code Management (SCM), Build Triggers, Build, and Post build actions.

...

1. On the Add post-build Actions drop-down, select the "Publish test result to QMetry for Jira version 4.X above" option.



2. There are two options: Cloud or Server. Based on your Jira Hosting, select either Jira Cloud or Jira Server.


Image RemovedImage Added


3. Fill the required data in accordingly for Cloud/Server.

...

In case of Cloud instance for QMetry for JIRA, select the Cloud option and fill in the required data.


Image RemovedImage Added

You can get more information regarding fields by clicking on the Help icon for respective fields. It explains what to enter in that particular field.

...


Parameter

Type

Required

Description

API Key

string

Yes

Your API Key. 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.

Format

selection

Yes

Format of result file to be imported. Supported formats:

cucumber/json testng/xml junit/xml QAF hpuft/xml specflow/json

File

string

Yes

Path to your result file to be uploaded.

Example : The Jenkins plugin is expecting the file in Jenkins Workspace. 
If your workspace name is WithoutSouceCode, then you will find a folder name with "WithoutSouceCode" in your installation directory like Jenkins/Home/workspace/WithoutSouceCode. 
Your result file should be under Jenkins/Home/workspace/WithoutSouceCode/Testng-result.xml. 
The path that should be set in plugin configuration is "/Testng-result.xml"

If your automation generates multiple result files of the supported format in a folder then provide the absolute path till the folder name(It should not be the path till workspace). QMetry plugin will zip all supported format files and upload them to QMetry. 

Test Cycle To Reuse

stringNoKey of the test cycle to be reused.

Upload Screenshots

checkboxNoCheck to upload attachments in execution. Default value: false.

Environment

stringNoName of the environment on which test cycle has to be executed.
Build

string

NoName of the build for test cycle execution.


Test Case and Test Cycle Fields

Parameter

Type

Required

Description

Summary (only for Test Cycle)

string

No

Summary of test cycle.

Description

string

No

Description of test case/test cycle

Priority

string

No

Priority to be added to the test case/test cycle.

Status

string

No

Status to be added to the test case/test cycle.

Components

string

No

Comma separated names of Components to be added to the test case/test cycle.

Labels

string

No

Comma separated names of Labels to be added to the test case/test cycle.

Fix Version Id (How to find the Fix Version Id)

number

No

Id of Fix Version to be added to the test case/test cycle.

Sprint Id (How to find the Sprint Id)

number

No

Id of Sprint to be added to the test case/test cycle.

Assignee

string

No

Account Key of the current user for test case/test cycle.

Reporter

string

No

Account Key of the current user for test case/test cycle.

Precondition (only for Test Case)

string

No

Precondition for test case.

Estimated Time (only for Test Case)

string

No

Estimated time for test case in ‘HH:mm’ format

Planned Start Date (only for Test Cycle)

string

No

Planned Start Date of test cycle in 'dd/MMM/yyyy HH:mm' format

Planned End Date (only for Test Cycle)

string

No

Planned End Date of test cycle in 'dd/MMM/yyyy HH:mm' format

Custom Fields

string

No

Comma separated custom fields in JSON array.


Server

In case of Server instance for QMetry for Jira, select the Server option and fill in the required data.


Image RemovedImage Added


Parameters for Server instance:


Basic Authentication OR
Personal Access Token

Yes

Parameter

Type

Required

Description

Jira URLstringYesEnter Jira URL.

string

Basic Authentication

Basic authentication with Jira's credentials.

  • Jira Username
  • Jira Password: Password for Jira instance.

Personal Access Token

If the Allow basic authentication on API calls option is disabled in Jira, then Personal Access Token is required for authentication.

To generate personal access token, perform the following steps:

  • Go to User Profile of your Jira.

    • Click on Personal Access Tokens and click on Create tokenJira URL.

    Username

    string

    Yes

    Jira Username.

    Password

    string

    Yes

    Password for Jira instance.

    Automation API Key

    string

    Yes

    Your API Key. 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.

    Format

    selection

    Yes

    Format of result file to be imported. Supported formats:

    cucumber/json testng/xml junit/xml QAF hpuft/xml specflow/json

    File

    string

    Yes

    Path to your result file to be uploaded.

    Example : The Jenkins plugin is expecting the file in Jenkins Workspace. 
    If your workspace name is WithoutSouceCode, then you will find a folder name with "WithoutSouceCode" in your installation directory like Jenkins/Home/workspace/WithoutSouceCode. 
    Your result file should be under Jenkins/Home/workspace/WithoutSouceCode/Testng-result.xml. 
    The path that should be set in plugin configuration is "/Testng-result.xml"

    If your automation generates multiple result files of the supported format in a folder then provide the absolute path till the folder name(It should not be the path till workspace). QMetry plugin will zip all supported format files and upload them to QMetry.

    Test Cycle To Reuse

    		stringNoKey of the test cycle to be reused.

    Upload Screenshots

    		checkboxNoCheck to upload attachments in execution. Default value: false.

    Environment

    		stringNoName of the environment on which test cycle has to be executed.
    Build

    string

    		NoName of the build for test cycle execution.



    Test Case and Test Cycle Fields

    Parameter

    Type

    Required

    Description

    Summary (only for Test Cycle)

    string

    No

    Summary of test cycle.

    Description

    string

    No

    Description of test case/test cycle

    Priority

    string

    No

    Priority to be added to the test case/test cycle.

    Status

    string

    No

    Status to be added to the test case/test cycle.

    Components

    string

    No

    Comma separated names of Components to be added to the test case/test cycle.

    Labels

    string

    No

    Comma separated names of Labels to be added to the test case/test cycle.

    Fix Version Id (How to find the Fix Version Id)

    number

    No

    Id of Fix Version to be added to the test case/test cycle.

    Sprint Id (How to find the Sprint Id)

    number

    No

    Id of Sprint to be added to the test case/test cycle.

    Assignee

    string

    No

    Account Key of the current user for test case/test cycle.

    Reporter

    string

    No

    Account Key of the current user for test case/test cycle.

    Estimated Time (only for Test Case)

    string

    No

    Estimated time for test case in ‘HH:mm’ format

    Planned Start Date (only for Test Cycle)

    string

    No

    Planned Start Date of test cycle in 'dd/MMM/yyyy HH:mm' format

    Planned End Date (only for Test Cycle)

    string

    No

    Planned End Date of test cycle in 'dd/MMM/yyyy HH:mm' format

    Custom Fields

    array

    No

    Comma separated custom fields in JSON array.


    Pipeline

    QMetry Test Management supports Jenkins Pipeline for implementing and integrating continuous delivery pipelines into Jenkins.

    Let’s create a standard Pipeline job in Jenkins.

    ...

    1. To create a new Jenkins job, click on the New Item option on the Jenkins menu.

    Image RemovedImage Added


    2. Provide a name for your job.

        Select Pipeline on the screen and then click OK.




    3. Next, the configuration page appears where you can configure your job by various categories: General, Build Triggers, Advanced Project Options, and Pipeline.




    4.  Optionally, you can set Build Triggers.

    Select the Build Triggers tab. Let’s just add a periodic trigger which triggers build every minute – every hour – every day (Schedule: * * * * *).



    5. Advanced Project Options: This is optional. You can give Display Name which will replace the name you gave earlier to the Pipeline project.




    6. Jenkins works as a bridge between QMetry Test Management and automation frameworks. To publish results in QMetry, provide a Pipeline script.

    ...


    Parameter

    Type

    Required

    Description

    API Key

    string

    Yes

    Your API Key. 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.

    Format

    selection

    Yes

    Format of result file to be imported. Supported formats:

    cucumber/json testng/xml junit/xml QAF hpuft/xml specflow/json

    File

    string

    Yes

    Path to your result file to be uploaded.

    Example : The Jenkins plugin is expecting the file in Jenkins Workspace. 
    If your workspace name is WithoutSouceCode, then you will find a folder name with "WithoutSouceCode" in your installation directory like Jenkins/Home/workspace/WithoutSouceCode. 
    Your result file should be under Jenkins/Home/workspace/WithoutSouceCode/Testng-result.xml. 
    The path that should be set in plugin configuration is "/Testng-result.xml"

    Test Cycle To Reuse

    		stringNoKey of the test cycle to be reused.

    Upload Screenshots

    		checkboxNoCheck to upload attachments in execution. Default value: false.

    Environment

    		stringNoName of the environment on which the test cycle has to be executed.
    BuildstringNoName of the build for test cycle execution.



    Test Case and Test Cycle Fields

    Parameter

    Type

    Required

    Description

    Summary (only for Test Cycle)

    string

    No

    Summary of test cycle.

    Description

    string

    No

    Description of test case/test cycle.

    Priority

    string

    No

    Priority to be added to the test case/test cycle.

    Status

    string

    No

    Status to be added to the test case/test cycle.

    Components

    string

    No

    Comma separated names of Components to be added to the test case/test cycle.

    Labels

    string

    No

    Comma separated names of Labels to be added to the test case/test cycle.

    Fix Version Id (How to find the Fix Version Id)

    number

    No

    Id of Fix Version to be added to the test case/test cycle.

    Sprint Id (How to find the Sprint Id)

    number

    No

    Id of Sprint to be added to the test case/test cycle.

    Assignee

    string

    No

    Account Key of the current user for test case/test cycle.

    Reporter

    string

    No

    Account Key of the current user for test case/test cycle.

    Precondition (only for Test Case)

    string

    No

    Precondition for test case.

    Estimated Time (only for Test Case)

    string

    No

    Estimated time for test case in ‘HH:mm’ format

    Planned Start Date (only for Test Cycle)

    string

    No

    Planned Start Date of test cycle in 'dd/MMM/yyyy HH:mm' format.

    Planned End Date (only for Test Cycle)

    string

    No

    Planned End Date of test cycle in 'dd/MMM/yyyy HH:mm' format.

    Custom Fields

    string

    No

    Comma separated custom fields in JSON array.



    Parameters for Server Instance


    Parameter

    Type

    Required

    Description

    Jira URL

    string

    Yes

    Enter Jira URL

    Username

    string

    Yes

    Jira Username.

    Password

    string

    Yes

    Password for Jira instance.

    API Key

    string

    Yes

    Your API Key. 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.

    Format

    selection

    Yes

    Format of result file to be imported. Supported formats:

    cucumber/json testng/xml junit/xml QAF hpuft/xml specflow/json

    File

    string

    Yes

    Path to your result file to be uploaded.

    Example : The Jenkins plugin is expecting the file in Jenkins Workspace. 
    If your workspace name is WithoutSouceCode, then you will find a folder name with "WithoutSouceCode" in your installation directory like Jenkins/Home/workspace/WithoutSouceCode. 
    Your result file should be under Jenkins/Home/workspace/WithoutSouceCode/Testng-result.xml. 
    The path that should be set in plugin configuration is "/Testng-result.xml"

    Test Cycle To Reuse

    		stringNoKey of the test cycle to be reused.

    Upload Screenshots

    		checkboxNoCheck to upload attachments in execution. Default value: false.

    Environment

    		stringNoName of the environment on which test cycle has to be executed.
    BuildstringNoName of the build for test cycle execution.


    Test Case and Test Cycle Fields

    Parameter

    Type

    Required

    Description

    Summary (only for Test Cycle)

    string

    No

    Summary of test cycle.

    Description

    string

    No

    Description of test case/test cycle.

    Priority

    string

    No

    Priority to be added to the test case/test cycle.

    Status

    string

    No

    Status to be added to the test case/test cycle.

    Components

    string

    No

    Comma separated names of Components to be added to the test case/test cycle.

    Labels

    string

    No

    Comma separated names of Labels to be added to the test case/test cycle.

    Fix Version Id (How to find the Fix Version Id)

    number

    No

    Id of Fix Version to be added to the test case/test cycle.

    Sprint Id (How to find the Sprint Id)

    number

    No

    Id of Sprint to be added to the test case/test cycle.

    Assignee

    string

    No

    Account Key of the current user for test case/test cycle.

    Reporter

    string

    No

    Account Key of the current user for test case/test cycle.

    Estimated Time (only for Test Case)

    string

    No

    Estimated time for test case in ‘HH:mm’ format

    Planned Start Date (only for Test Cycle)

    string

    No

    Planned Start Date of test cycle in 'dd/MMM/yyyy HH:mm' format

    Planned End Date (only for Test Cycle)

    string

    No

    Planned End Date of test cycle in 'dd/MMM/yyyy HH:mm' format

    Custom Fields

    string

    No

    Comma separated custom fields in JSON array.



    7. On successful completion of the process, you can see the console output. It displays a success message for uploading the result file.



    8. Finally check the test execution page in QMetry and review your test run results.