Jira Integration with Cyara Platform

This article will go through the entire process of setting up and validating a Jira Integration. The main sections of the following article are as follows:  

1. Enable the Jira Integration
2. Run Velocity Campaign. Review Velocity campaign report and open Jira defects for Test Case results that did not produced desired results
3. Verify Jira defect is logged in to the Jira
4. Run an individual Test Case and open Jira defects for Test Case results that did not produced desired results
5. Overview of configuring Jira Integration
6. Jira Integration Setup Walkthrough Video Tutorial

1. Enable the Jira Integration

Navigate to “Integrations” under “Tools” from the toolbar:

Ensure that you have an active Integration with Jira and that is set to Enabled. Below the "Jira Integration" is set to “Yes” under Enabled: (For more information on how to first build the Jira Integration, consult the Cyara User Guide article "Configuring Jira Integration") 

2. Submit Jira defects from the results of the Velocity Campaign

Next, we will run a Velocity Campaign that we have designed to have a range of Test Case results, including failures. Navigate to the Campaigns Tab

Run a Velocity Campaign. For the purposes of this demonstration, we'll run a quick regression test.

• This campaign will validate three very small test cases that will generate one of each test results:
  • Success
  • Failed
  • Satisfactory

This demo campaign will take about 30 seconds to run. Once finished, navigate to the Reports Tab and Select Velocity

Click View next to the the latest report for the Velocity Campaign that was just run.

You will see a report depicting the results of your Velocity Campaign. In our demonstration test we placed a total of 3 calls, of which one was Success, one Failed and one Satisfactory

Scroll down to the list of the individual Test Case results and select the result for the “Test – Fail” Test Case

Looking at the detailed result, you will see that the test case had failed due to the Expect to Hear No Match in Step 1.

Click the Call number in the left hand column to expand this failed Test Case Result further.

Now that we have found an unexpected behavior, we want to open a Jira defect so that development could look at it.

To open Jira Defect, you must click on “Create” button in the upper hand corner section of the Test Case Result page.

After the Create button is clicked, a “Create New Ticket” dialog box will open.

You will notice that all the relevant data fields have been pre-populated with the data.

You can also extend the “Description” field (by dragging lower right-hand corner of the text box) to show all test case results data that was configured to be submitted with the defect.

At this time (depending on the configuration) the “tester” can review and update any information that is being submitted.

More on how this data gets mapped into the data fields is to be discussed when we review the configuration of the Jira integration in further chapters.

3. Verify Jira defect is logged in to the Jira

Once the “Create” button has been clicked on the "Create New Ticket" popup, the Jira defect ticket is created, and the Test Case result is permanently linked to the Jira defect number.

At this time, you can click on the “JIR-XX” defect link or on the “View” button to view the defect in Jira.

If you are currently not logged into Jira, you will be presented with the Jira Portal Login dialog box.

Note: Typically, after you logged in once, Jira creates a cookie which will enable browser to skip login part for all subsequent Jira sessions

The Jira Defect with all the information from the Test Case will now be displayed, below is a sample Jira from the Cyara Demonstration Jira environment.

Note: Newly created Jiras will appear in the linked Jira Project Kanban Board, in the defect list at the bottom of the "Backlog" column. 

4. Submit Jira defects from the results of the manual Test Case validation

Jira defects do not have to be only created from Velocity Campaign Test Result Failures, they can also be created from any manual Test Case Validation, see below for details.

First navigate to the Test Cases Tab and Select “Test Cases & Blocks”

In this example, we're going to validate a Test Case that we know will fail.

Looking at the detailed result you will see that the test case had failed due to the Expect to Hear No Match in Step 1

Now that we have found an unexpected behavior, we want to open a Jira defect so that development could look at it.

Similarly to how the Jira Defect was created earlier in the Velocity Campaign, on the Test Case Validation Results screen, click the “Create” button in the upper hand corner to start the "Create New Ticket" dialog box process.

Again, the relevant data fields have been pre-populated with the data.

The “Description” field can be extended by dragging lower right-hand corner of the text box to show all test case results data that was configured to be submitted with the defect.

5. Overview of configuring Jira Integration

Further to the instructions on how to create the Jira Integration for the first time as covered in the Cyara User Guide article on "Configuring Jira Integration"
The following section contains additional information needed for establishing connectivity.

Note: When configuring Jira integration from Cyara Cloud Portal to Jira deployed on-premise infrastructure and this Jira portal is not accessible from the internet, the customers IT organization must enable firewall access from the Cyara Cloud to premise instance of Jira by whitelisting the Cyara integration FQDN to allow connections from the Cyara Cloud. We communicate to Jira using HTTPS.

• US FQDN: egress-ips.cyaraportal.us
• AU FQDN: egress-ips.cyaraportal.com
• UK FQDN: egress-ips.cyaraportal.co.uk

The following section allows for configuring mapping of Cyara Test Case Results to Jira data fields.

Known Jira fields are selected from the “New Jira Field” list and new fields can be defined by selecting “New Custom Field”. Selecting  will display list of Cyara variables that will contain Test Case results information.

As an example, the Jira “description” field contains the complete list of all variables so that once Jira defect is created you can see what that data looks like (see below). Multiple variables can be used in the same text string to comprise complex information.

The following settings in the filed selection are used to control what fields are truly required and if they could be overwritten by the tester when they are submitting the Jira defect (remember the pop-up that is displayed when Jira defect is submitted form the test case result). Some fields can be pre-populated with Cyara $variables, while some can be just predefined fields with no data, that have to be completed by the tester. Each flag is a selection between “Yes” or “No”

6. Jira Integration Setup Walkthrough Video Tutorial

For a detailed walkthrough of how to configure a Jira Integration with Cyara, watch the tutorial video below.