- Created by Jeff Kern, last modified on Jun 05, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 16 Next »
A page to describe the how-to's for various processes in SRDP.
Table of Contents:
Import/Update Cameo Model with Updates from Jira
Currently we have three types of information that we track in Jira and also reflect in the Cameo model:
- L2 Implementation Tickets from various Jira projects that are tracked in the System Architecture Model
- L1 Verification Tickets from the Jira Architecture project that are tracked in the System Architecture Model
- L1 Validation Tickets from the Jira SRDP project that are tracked in the Requirements Model.
In order to update any of these the process is approximately the same:
- Use the Jira Export script (at right) to export the tickets into a CSV file.
./jiraExport -u <username> -t [verification, validation, L2] <outputfilename>.csv - Use the java program (at right) to translate the CSV file from above into reqIF format. Each of the three types of import requires it's own specification file, make sure you select the correct one.
java -jar <relative path to downloaded jar file> <import specification xml> <CSV file> <Output filename>.reqif - Use a text editor to modify the output ReqIf file changing the xmlns:ns2="http://... to xmlns="http://...
- Start the Cameo Program and open the appropriate project.
- Recursively lock the package containing the requirements to be updated.
- Import the .reqif file under File>> Import From >> Requirements Interchange Format
- Select the file in the dialog
- If prompted: select the correct package for the addition of new requirements. I suggest creating a subpackage to import the new requirements to and then moving them to the appropriate location. If you are not prompted for a location, then no new requirements are imported (although existing requirements have been updated).
- For all new requirements, you may need to correct the element numbering to be "Consecutive" and use the required prefix.
- Move new requirements to reproduce the hierarchy of the Jira tickets.
- Remove the lock on the requirements allocation package (committing the changes to the server).
Resources
Jira Export Type | Import Specification File | Target Project |
---|---|---|
Verification | Architecture | |
Validation | Requirements | |
L2 | Architecture |
Import Verification Tickets to the Cameo Architecture Project
The Verification tests are tracked within the Jira Architecture project for the DMS groups. In order to import these into the Cameo project execute the following steps:
- Log into open-jira.nrao.edu and search for issues using the Export Verification Tickets filter.
- Ensure that only the Key, Summary, and Description, Test Procedure, Status, and Test Report columns are displayed, and that they are in that order.
- In the open-jira interface under the Export tools select CSV (Current Fields).
- Choose a Comma as the delimiter in the dialog box that pops up.
- Using a text editor remove the first line (column headers) from the downloaded CSV file.
- Download the two resource files from the right. These are a Java program that will do the translation from CSV to ReqIf format and the specification file.
- Execute the java program usage is: java -jar <relative path to downloaded jar file> <import specification xml> <CSV file> <Output filename.reqif>
- Use a text editor to modify the output ReqIf file changing the xmlns:ns2="http://... to xmlns="http://...
- Start the Cameo Program and open the SRDP System Architecture project.
- Recursively lock the Requirements Allocation package
- Import the .reqif file under File>> Import From >> Requirements Interchange Format
- Select the file in the dialog
- If prompted select the Verification package. If you are not asked, then no new requirements are updated (although existing requirements have been updated).
- Create the correct hierarchy among any newly created requirements.
- Link the tests to the verified requirements through a verifies relation.
- Remove the lock on the requirements allocation package (committing the changes to the server).
Import Validation Tickets to the Cameo Requirements Project
The Validation tests are tracked within the Jira SRDP project . In order to import these into the Cameo project execute the following steps:
- Download the python export utility at right.
- Execute the python utility: ./exportTestsFromJira.py -u <username> -t validation <output filename>
- Download the two resource files from the right. These are a Java program that will do the translation from CSV to ReqIf format and the specification file.
- Execute the java program usage is: java -jar <relative path to downloaded jar file> <import specification xml> <CSV file> <Output filename.reqif>
- Use a text editor to modify the output ReqIf file changing the xmlns:ns2="http://... to xmlns="http://...
- Start the Cameo Program and open the SRDP System Requirements project.
- Recursively lock the Validation package
- Import the .reqif file under File>> Import From >> Requirements Interchange Format
- Select the file in the dialog
- If prompted select the Validation package. If you are not asked, then no new requirements are updated (although existing requirements have been updated).
- Create the correct hierarchy among any newly created requirements.
- Link the tests to the verified requirements through a verifies relation.
- Remove the lock on the requirements allocation package (committing the changes to the server).
Note: You must have the Python Jira module installed in your working environment (see https://jira.readthedocs.io/en/master/)
Import Tests from CSV to Jira
Importing from a CSV file to Jira was used in Wave 1 for the creation of the verification test tickets. The script to the right handles the import and does the linking between Tests and Sub-Tests. A few comments about the CSV file:
The CSV file MUST contain the following columns with the exact text in a header row at the top:
- description: The long description of the test.
- summary: A short description, this will become the ticket title
- issuetype: Should either be Test or Sub-Test. Sub-Tests are assumed to be linked to the most recent Test ticket in the file.
The python script usage can be determined by "./importTestToJira -h"
Note: You must have the Python Jira module installed in your working environment (see https://jira.readthedocs.io/en/master/)
Resources
- No labels