About the Plugin

QMetry Test Management for JIRA plugin for Jenkins has been designed to seamlessly integrate your CI/CD pipeline with QMetry.

Easily configure Jenkins to submit your test results to QMetry without needing to write any code or deal with REST API. Your Test Results could be from any automation framework like Cucumber, Test NG, JUnit, QAF and more.

For more info visit QMetry Test Management for JIRA.

Read the following topics on this page:

1. Requirements
2. Configuring a standard Jenkins Job.
3. Configuring QMetry for JIRA Plugin job as a post build action.
4. Triggering the job and publishing results in JIRA.

Pre-requisites

1. QMetry Test Management for JIRA installed in Server/Data Center or Cloud
2. Jenkins installation

Configuring a Standard Jenkins job

Freestyle

Let’s create a standard Freestyle job in Jenkins.

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

2. Provide a name for your job.

    Select Freestyle project on the screen and then click OK.

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.

4. On the Source Code Management tab, select the appropriate option in which you have your source code. For example, here it is “Git”. So, select “Git” and provide the necessary information. (Note: You need to configure GitHub plugin in global configuration).

5.  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: * * * * *).

6. Next, Select a build step. You can select from various options: Ant, Maven, Windows batch process, etc. For example, for a maven project, trigger a maven build and specify goals.

Next step is to add Post-build Actions. Here, add the plugin: “QMetry Test Management for JIRA Plugin”.

Configuring QMetry for JIRA Test Management Plugin as a Post-build Action

Jenkins works as a bridge between QMetry Test Management and JIRA plugin. To publish results in QMetry for JIRA, define another post-build action.

1. On the Add post-build Actions drop-down, select the "Publish test result to QMetry for JIRA" option.

2. There are two options: Cloud or Server. Based on the type of JIRA instance you have, select either JIRA Cloud or JIRA Server.

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

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.

Parameters for Cloud instance:

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

Parameters for Server instance:

4.   On successful completion of the process, you can see the console output. It displays statistics for Tests run, Failures, Errors, Skipped, etc.

5. Finally check your JIRA account.

    In case of Cloud instance, you can see the success result for your test cases.

Configure Specflow for Freestyle

Prerequisites

1) MSBuild Plugin

2) VSTest Runnner Plugin

3) Visual Studio IDE setup or Visual Studio Build Tools setup on server

Step 1: Checkout Source Code.

Step 2: Add Script to update packages for msbuild using NuGet.exe file from checkout repository.

Step 3: Configure msbuild executable in Manage Jenkins > Global Tool Configuration > MSTest.

Step 4: Select a build step for MSBuild in Build Section.

Step 5: 1)Select "MSBuild Version" which is configured in Global Tool Configuration

     2)Specify the relative path for solution file in "MSBuild Build File"

Step 6: Configure vstest executable in Manage Jenkins > Global Tool Configuration > VSTest.

Step 7: Select a build step for VSTest in Build Section.

Step 8:   1)Select "VSTest Version" which is configured in Global Tool Configuration

2)Specify the relative path to your VSTest compiled assemblies in "Test Files"

3)Uncheck "Enable Code Coverage" checkbox

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.

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 Pipeline script.

Enter Pipeline script to define your code repository, generate test result and upload test results into QMetry Test Management.

Code Snippet for Cloud

step([$class: 'QTM4JResultPublisher',testToRun: 'CLOUD', apikey: 'b8fc4842a27656646aa5a955b73e84c249b5f4a085845075eea8001',  format: 'junit/xml', file: '/target\\surefire-reports\\TEST-com.temp.junit.temptestcase.FirstTestTest.xml', testassethierarchy: 'TestCase-TestStep', labels: 'junit,master', version: 'version 1.11', testrunname: 'demo junit testrun for testcase level', testrunkey: 'TES-2', platform: 'platform 1', sprint: 'TES Sprint 1', comment: 'junit demo pipeline comment', component: 'pipeline', testCaseUpdateLevel:'2', jirafields: ' ', attachFile: false])       

Code Snippet for Server

step([$class: 'QTM4JResultPublisher',testToRun: 'SERVER',jiraurlserver: 'http://qtmforjira.qmetry.com',username: 'superadmin',password: 'testPipeline1@3',apikeyserver: '3527c27609317aae022071ac16f2dd7f908c93110cb6ed9', formatserver: 'junit/xml', fileserver: '/target\\surefire-reports\\TEST-com.temp.junit.temptestcase.FirstTestTest.xml', testassethierarchyserver: 'TestCase-TestStep', labelsserver: 'junit master', versionserver: 'version 1.11', testrunnameserver: 'demo junit testrun for testcase level', testrunkeyserver: 'TES-3', platformserver: 'platform 1', componentserver: 'pipeline project', sprintserver: 'JEN Sprint 1', commentserver: 'junit master comment', testCaseUpdateLevelServer: '2', jirafieldsserver: ' ', attachFileServer: false])       

Syntax of format:

• cucumber/json
• testng/xml
• junit/xml
• qas/json
• hpuft/xml
• specflow/json

Parameters for Cloud

Parameters for Server instance

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

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

Configure Specflow for Pipeline

Prerequisites

1) VSTest Runnner Plugin

2) Visual Studio IDE setup or Visual Studio Build Tools setup on server

Step 1: Checkout Source Code.

checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[url: 'https://github.com/lizamathew/Spec-Flow-Demo.git']]])

Step 2: Add Script to update packages for msbuild using NuGet.exe file from checkout repository.

bat 'C:/Users/liza.mathew/.jenkins/workspace/PipelineSpecflowProjectMaster/Specflow/.nuget/NuGet.exe update -self'

Step 3: Configuration for MSBuild

bat "\"${tool 'MSBuild'}\" Specflow/SpecResults.sln"
(MSBuild is a tool configured for path to MSBuild executable then specify relative path for solution file of project)

Step 4: Configuration of VSTest

VSTest is a tool configured for path to VSTest executable.

step([$class: 'VsTestBuilder', 'vsTestName':'${tool VSTest}', enablecodecoverage : false, 'testFiles':'Specflow/SpecResults.ApprovalTestSuite/bin/Release/SpecResults.ApprovalTestSuite.dll'])

• vsTestName: path to VSTest executable
• testFiles: specify relative path to your VSTest compiled assemblies

Define Parameters

To define parameters for your job, select the This project is parameterized check box.

The Add Parameter drop-down is enabled with the list of parameter types. Use the drop-down button to add as many parameters as you need.

There are different parameter types available. The way parameters take effect according their respective parameter type.

For example,

String Parameter are selected, and corresponding parameters are added as shown below.

The above parameters will be parsed dynamically at the run time.

The field values should be entered in the following syntax:

${ParameterName}

For example,

For the parameters created above, the field value would be ${API} and ${TestRunName} respectively. The parameter values will be parsed accordingly for the corresponding fields.

The values can also be changed before triggering the Jenkins build.

Go to Main Page