Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A page to describe the how-to's for various processes in SRDP.

Table of Contents:

Table of Contents
maxLevel2

Expand
titleImport L2 Requirements from Jira.
Section

Import

L2 Requirements

/Update Cameo Model with Updates from Jira

to Cameo Architecture Project

Column
width75%

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:

  1. Use the Jira Export script (at right) to export the tickets into a CSV file.
    ./jiraExport -u <username> -t [verification, validation, L2] <outputfilename>.csv
  2. 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

The L2 requirements are tracked within the respective Jira projects for the DMS groups. In order to import these into the Cameo project execute the following steps:

  1. Log into open-jira.nrao.edu and search for issues using the Export L2 Requirements filter.
    1. Ensure that only the Key, Summary, and Description columns are displayed, and that they are in that order.
  2. In the open-jira interface under the Export tools select CSV (Current Fields).
    1. Choose a Comma as the delimter in the dialog box that pops up.
  3. Using a text editor remove the first line (column headers) from the downloaded CSV file.
  4. 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.
  5. Execute the java program usage is: java -jar <relative path to downloaded jar file> <import specification xml> <CSV file> <Output filenamefilename>.reqif>reqif
  6. Use a text editor to modify the output ReqIf file changing the xmlns:ns2="http://... to xmlns="http://...
  7. Start the Cameo Program and open the SRDP System Architecture appropriate project.
    1. Recursively lock the Requirements Allocation packagepackage containing the requirements to be updated.
  8. Import the .reqif file under File>> Import From >> Requirements Interchange Format
    1. Select the file in the dialog
    2. If prompted: select the correct wave based requirements package within the Requirements Allocation packagepackage 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 askedprompted for a location, then no new requirements are updated imported (although existing requirements have been updated).
    Select
    1. For all
    imported tests, right click and select "Element Numbering"
    1. Set numbering scheme to consecutive, and reset the prefix to "ARCH-"
    1. new requirements, you may need to correct the element numbering to be "Consecutive" and use the required prefix.
    2. Move new requirements to reproduce the hierarchy of the Jira tickets
    Create the correct hierarchy among any newly created requirements
    1. .
  9. Remove the lock on the requirements allocation package (committing the changes to the server).
Column
width25%

Resources


Jira Export

Type

Import Specification

File

Target

Project

Verification


Architecture

Validation


Requirements
L2
Architecture


Expand
titleImport Verification Tickets to the Cameo Architecture Project
Section

Import Verification Tickets to the Cameo Architecture Project

Column
width75%

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:

  1. Log into open-jira.nrao.edu and search for issues using the Export Verification Tickets filter.
    1. Ensure that only the Key, Summary, and Description, Test Procedure, Status, and Test Report columns are displayed, and that they are in that order.
  2. In the open-jira interface under the Export tools select CSV (Current Fields).
    1. Choose a Comma as the delimiter in the dialog box that pops up.
  3. Using a text editor remove the first line (column headers) from the downloaded CSV file.
  4. 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.
  5. Execute the java program usage is: java -jar <relative path to downloaded jar file> <import specification xml> <CSV file> <Output filename.reqif>
  6. Use a text editor to modify the output ReqIf file changing the xmlns:ns2="http://... to xmlns="http://...
  7. Start the Cameo Program and open the SRDP System Architecture project.
    1. Recursively lock the Requirements Allocation package
  8. Import the .reqif file under File>> Import From >> Requirements Interchange Format
    1. Select the file in the dialog
    2. If prompted select the Verification package. If you are not asked, then no new requirements are updated (although existing requirements have been updated).
  9. Create the correct hierarchy among any newly created requirements.
  10. Link the tests to the verified requirements through a verifies relation.
  11. Remove the lock on the requirements allocation package (committing the changes to the server).
Column
width25%

Resources

Expand
titleImport Validation Tickets to the Cameo Requirements Project
Section

Import Validation Tickets to the Cameo Requirements Project

Column
width75%
Column
width75%

The Validation tests are tracked within the Jira SRDP project . In order to import these into the Cameo project execute the following steps:

  1. Download the python export utility at right.
  2. Execute the python utility: ./exportTestsFromJira.py -u <username> -t validation <output filename>
  3. 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.
  4. Execute the java program usage is: java -jar <relative path to downloaded jar file> <import specification xml> <CSV file> <Output filename.reqif>
  5. Use a text editor to modify the output ReqIf file changing the xmlns:ns2="http://... to xmlns="http://...
  6. Start the Cameo Program and open the SRDP System Requirements project.
    1. Recursively lock the Validation package
  7. Import the .reqif file under File>> Import From >> Requirements Interchange Format
    1. Select the file in the dialog
    2. If prompted select the Validation package. If you are not asked, then no new requirements are updated (although existing requirements have been updated).
  8. Create the correct hierarchy among any newly created requirements.
  9. Link the tests to the verified requirements through a verifies relation.
  10. 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/)

Column
width25%

Resources

Expand
titleImport Tests from CSV to JIRA
Section

Import Tests from CSV to Jira

Column
width75%

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/)

Column
width25%

Resources