This article will go through the entire process of setting up and validating a Rally Integration. The main sections of the following article are as follows:
- Ensure Rally Integration is enabled
- Run Velocity Campaign. Review Velocity campaign report and open Rally defects for Test Case results that did not produced desired results
- Verify Rally defect is logged in to Rally correctly
- Run an individual Test Case and open Rally defects for Test Case results that did not produced desired results
- Overview of configuring Rally Integration
- Rally Integration Setup Walkthrough Video Tutorial
1. Ensure the Rally Integration is enabled
Before we being with creating Rally Issue Tickets, first navigate to “Integrations” under “Tools” from the toolbar:
Ensure that you have an active Integration with Rally and that is set to Enabled. Below the "Rally Integration" is set to “Yes” under Enabled: (For more information on how to first build the Rally Integration, consult the Cyara User Guide article on "Creating a Rally Integration")
2. Submit Rally 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 three very small test cases that will generate one of each test results:
- Success
- Failed
- Satisfactory
The 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
Now that we have found an unexpected behavior, we want to open a Rally defect so that development could look at it.
To open Rally Defect you will need to click on “Create” button in the upper hand corner section of the Test Case Result page.
Once clicked, a “Create New Ticket” dialog box will open.
You will notice how 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 Rally integration.
3. Verify Rally defect is logged in to Rally correctly
Once “tester” clicks the “Create” button, the Rally defect ticket is created, and the Test Case result is permanently linked to the Rally defect number.
At this time, you can click on the “Rally-XX” defect link or on the “View” button to view the defect in Rally.
If you are currently not logged into Rally, you will be presented with the Rally Portal Login dialog box. Please use the credentials listed in the Access Information section.
Note: Typically, after you logged in once, Rally creates a cookie which will enable browser to skip login part for all subsequent Rally sessions.
The Rally Defect with all the information from the Test Case will now be displayed:
Rally also lists all other project defects by default as you can see to the left of the newly created defect above.
4. Submit Rally defects from the results of the manual Test Case validation
Rally 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 Rally defect so that development could look at it.
Similarly to how the Rally 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.
You will notice how all the relevant data fields have been pre-populated with the data.
I have extended 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.
5. Overview of configuring Rally Integration
Further to the instructions on how to create a Rally Integration for the first time as covered in the Cyara User Guide article on "Creating a Rally Integration"
The following section contains additional information needed for establishing connectivity.
Note: When configuring the Rally integration from Cyara Cloud Portal to Rally deployed on customer premise and Rally portal is not accessible from the internet, the customers IT organization must enable firewall access from the Cyara Cloud to premise instance of Rally by whitelisting the Cyara integration FQDN to allow connections from the Cyara Cloud. We communicate to Rally using HTTPS.
- US FQDN: egress-ips.cyaraportal.us
- AU FQDN: egress-ips.cyaraportal.com
- UK FQDN: egress-ips.cyaraportal.co.uk
Api Url |
URL of the Rally Portal (customer specific). If integrating Cyara Cloud to Customer Prem, this url must be accessible from the internet (e.g. https://rally1.rallydev.com) |
Incident Portal Url |
URL for viewing Rally defects. Use Api Url with |
Username |
The Rally user/username on who behalf we will be creating tickets. This user must have access to Rally and have privileges to create tickets. |
Password |
Depending on the type of security enabled this can be a security token or a user password.
Some on-premise Rally installations may not be using OAuth 2.0 security, in those cases you will need to use the actual Rally user password instead of a token. If there is no API Token option under the profile, most likely OAuth is not required. When using OAuth API Token, you must make sure that the token is generated for the specific user on whose credentials will be used by Cyara to create Rally tickets.
API Token is obtained from the CA Agile Central Application Manager. See this “How-To” article: LINK
… or follow the below steps (API Token must be created while logged as the user being configured in the “Username” filed above: 1. Log into CA Agile Central Application Manager (https://rally1.rallydev.com/login ) using your CA Agile Central username and password. 2. Click the API KEYS tab at the top of the page. 3. Click the Create New API Key link. 4. Enter a name or description for the key in the Description field. For example, "Domo API Connection" 5. In the Grants section, select the Full Access option. 6. Click the Create button. |
The following section allows for configuring mapping of Cyara Test Case Results to Rally data fields.
Known Rally fields are selected from the “New Rally Field” list and new fields can be defined by selecting “New Custom Field”. Selecting the ? Icon will display list of Cyara variables that will contain Test Case results information.
As an example, the Rally “description” field contains the complete list of all variables so that once Rally 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 Rally defect (remember the pop-up that is displayed when Rally 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 must be completed by the tester. Each flag is a selection between “Yes” or “No”
Field Name |
Display Name |
Type |
Value |
Overridable |
Required |
Read Only |
project |
Project |
Lookup |
empty |
Yes |
Yes |
No |
name |
Name |
Single Line Text |
Rally Demo: Test case '$TestCaseName' completed with the result of: '$Result'. |
No |
Yes |
No |
description |
Description |
Multi Line Text |
Campaign Name: $CampaignName Detailed Result: $DetailedResult Test Result: $Result Test Result Category: $ResultCategory Failed Step Description: $StepDescription Failed Step No: $StepNo Test Case Description: $TestCaseDescription Test Case Name: $TestCaseName Test Case Notes: $TestCaseNotes The Url to the Portal Detailed Result page: $Url The Username creating the Incident: $Username |
No |
No |
No |
tags |
Tags |
Lookup |
Cyara |
No |
No |
No |
iteration |
Iteration |
Lookup |
empty |
No |
No |
No |
userStory |
User Story |
Lookup |
empty |
No |
No |
No |
notes |
Notes |
Multi Line Text |
empty |
No |
No |
No |
priority |
priority |
Choice |
None,Normal,Low,High Attention,Resolve Immediately |
No |
Yes |
No |
severity |
severity |
Choice |
None,Minor Problem ,Major Problem,Crash/Data Loss,Cosmetic |
No |
Yes |
No |
state |
State |
Choice |
Submitted,Fixed,Closed,Open |
No |
Yes |
No |
environment |
Environment |
Choice |
None,Development,Test,Staging,Production |
No |
Yes |
No |
scheduled state |
Schedule State |
Choice |
Defined,In-Progress,Accepted,Completed |
No |
Yes |
No |
resolution |
Resolution |
Choice |
None,Architecture,Code Change,Configuration Change,Database Change,Duplicate,Need More Information,Not a Defect,Software Limitation,User Interface |
No |
Yes |
No |
FoundInBuild |
Found in Build |
Single Line Text |
empty |
No |
No |
No |
Blocked |
Blocked |
Choice |
False,True |
No |
Yes |
No |
BlockedReason |
Blocked Reason |
Single Line Text |
empty |
No |
No |
No |
6. Rally Integration Setup Walkthrough Video Tutorial
For a detailed walkthrough of how to configure the Integration between Rally and your Cyara Platform, watch the tutorial video below.
Comments
0 comments
Please sign in to leave a comment.