Spira QA Coverage Jira app¶
Install the Spira QA Coverage App
This app is available for Jira Cloud on the Jira Marketplace
If you are syncing issues from Jira Cloud to Spira cloud, and are syncing requirements, you can install a Jira marketplace app. This lets users across all Jira projects see the QA coverage information in Jira from the Spira requirement.
This allows Jira users to always see the latest QA coverage information recorded in Spira directly from Jira.
Prerequisites¶
- Use Jira Cloud
- Use Spira cloud (hosted by Inflectra - this includes a trial instance)
- Fully configure the data sync between Jira and Spira
- Make sure you are syncing Jira issues to, in part, Spira requirements
- Install the Jira app from the Jira marketplace
Configure the Jira app¶
- Log into your Jira instance as an admin
- Find the "Spira QA Coverage" app and select the option to configure it.
- You will now need to fill in the 3 fields as below
- Spira URL: this needs to be the base URL for your Spira instance, which needs to be in the form of either
https://mysite.spiraservice.net
orhttps://demo.spiraservice.net/mysite
- Username: This is the login you use to connect to Spira (set this to a user who only has read-only permissions to all relevant products in Spira, so that they are not able to write to any product or part of your Spira instance)
- API Key: This is the RSS Token / API key for the user name you specified.
You can get the Spira API Key from within the User Details admin screen of Spira, or if logged in as that user from the My Profile page.
What to do if you cannot connect
The configuration page for the app will only allow you to save the settings if all fields are filled in. If users see a message while looking at a Jira issue that the app can't connect, please try the following:
- Check your URL is your BASE url - it should not include a "/" at the end. It should not have anything like "login.aspx" at the end
- Make sure your API key includes the "{" and "}" and matches what you see on your Profile page after you go away from and then go back to the Profile page
- Ask your Spira system admin to go to System Administration > System > Security Settings. There is a field called "Allowed Domains". Add "https://Jira.inflectra.com" and hit
Save
Using the app¶
- Go to a Jira issue that syncs to a requirement in Spira
- Click the "Spira QA Coverage" button
- This will reveal the "Spira QA Coverage" panel
- You will then see the test coverage mini bar chart and its details underneath. This shows the percentage and number of tests in each execution status.
Note that if the issue does not sync with any Spira requirement you will instead see an info message that says that "This issue is not linked to a Spira requirement."