Zephyr Squad Test Management Plugin for Jenkins

About the plugin

Zephyr Squad plugin for Jenkins integrates Jenkins and Zephyr Squad version. This plugin creates test cases and publishes test results in Jira for JUnit test cases in Jenkins. It supports publishing maven surefire format test results (JUnit and TestNG).

This guide will cover how to create and execute test cases automatically in Zephyr Squad using this plugin; this includes:

Downloading and installing the plugin.
Adding Jira servers in the Jenkins global settings.
Configuring a standard Jenkins job.
Configuring Zephyr Squad plugin job as a post build action.
Triggering the job and publishing results in Jira.

Requirements

Zephyr Squad version 2.6.0 (Build 26002096), 2.5.4 (Build 25401885), version 2.5.3 (Build 25301883) or version 2.5.2 (Build 25201808) installed and enabled on Jira server.
ZAPI version 1.5 installed and enabled on Jira server.
Jenkins installation.

Download and install the plugin

You can download the plugin from Jenkins repository or from Zephyr utilities repository. To install the plugin follow the instructions on Jenkins portal – How to install plugins

Add Jira servers in Jenkins global settings

After installation configure Jenkins global settings to establish a connection with Jira server(s). Follow the below steps:

Launch Jenkins and access via a web browser.
Click Manage Jenkins from the Menu as illustrated in the below screenshot.
Click Configure System.
Locate the section "Zephyr Squad Configuration" and click Add. You can add more than one Jira server by clicking on Add button.
Enter Jira server URL and user credentials. Note that the user name and password must be that of a user with appropriate permissions to project(s). Click Test Configuration to validate the connection to Jira server.
Click the Save button to save the configuration changes.

Configure a standard Jenkins job

A job in Jenkins defines a sequence of tasks for Jenkins to perform. When a job is triggered, Jenkins looks for an Ant script or Maven build file and runs it. It also provides options to define post-build tasks. Follow the example below to configure a standard job and add a post build action:

Create a new Jenkins job by clicking the New Item link found on the menu.
Give a name for your job, check the box Freestyle project and click OK.
To configure the job you just created, click the <job name> on the Jenkins home page.
Click the Configure.
Choose Subversion option in the "Source Code Management" section.
Enter the subversion URL where the target project resides and press Tab.
Note
User credentials needs to be setup to access SVN server. Click enter credential link to set it up if you see below error
To add a build step, locate the "Build" section and select Invoke top-level maven targets from the Add build step dropdown.
Select clean package as your Goals.
The plugin requires JUnit test results. Locate the "Post-build Actions" section and select Publish JUnit test result report from Add post-build Actions dropdown.
Enter the path to the test report. In the example below the location is "Proj1\target\surefire-reports/*.xml" where Proj1 is the target project.

Configure Zephyr Squad Test Management plugin as a post build action

In order to publish results in Zephyr Squad, define another post-build action.

Select Publish test result to Zephyr Squad from Add post-build Actions dropdown.
Configure Zephyr plugin job.
Select the Jira URL from the dropdown. (Servers configured in the Jenkins global configuration are available here to select). This automatically pulls in projects, versions and cycles.
Select the Project Name from the dropdown. This re-populates the versions.
Select the Version from the dropdown. Selecting a version fetches all its cycles.
Select either an existing cycle from the dropdown or create a new cycle.
For existing cycle the default Cycle Duration will be that of existing cycle in Zephyr and Cycle Name Prefix will be of the format "Automation_<Date><Time>" stamp.
For new cycle you have option to select Cycle Duration from the dropdown and to edit default cycle prefix name "Automation". In the absence of a cycle prefix name "Automation" is used for new cycles.
Click Save.

Trigger the job and publish results in Zephyr

To trigger a job manually, click Build Now link on the menu. This builds the project and publishes the Junit result.

Jenkins creates the test cases in the selected Jira Project.

Finally, Jenkins assigns these test cases to the selected cycle and executes all the tests.

License

This plugin is open source. It follows the Apache License version 2.0.

It allows:

Freely download and use this software, in whole or in part, for personal, company internal, or commercial purposes;
Use this software in packages or distributions that you create.

It forbids you to:

Redistribute any piece of our originated software without proper attribution;
Use any marks owned by us in any way that might state or imply that we www.getzephyr.com endorse your distribution;
Use any marks owned by us in any way that might state or imply that you created this software in question.

It requires you to:

Include a copy of the license in any redistribution you may make that includes this software;
Provide clear attribution to us, www.getzephyr.com for any distributions that include this software.

It does not require you to:

Include the source of this software itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it;
Submit changes that you make to the software back to this software (though such feedback is encouraged).

See License FAQ for more details.

Feedback

Please provide your feedback at Jenkins Jira or Zephyr Squad Community.