Document toolboxDocument toolbox

Test Case Import

Currently the add-on supports to import/migrate Test Cases from below:

[Screenshot - UG870_Admin_Test_Case_Import01]

Points to remember while importing Test Cases:

  1. Summary is mandatory to start the import.
  2. Appropriate date format is required when processing with date fields.
    • Use the syntax that complies with the Java SimpleDateFormat
    • Example: set date format to yyyy-MM-dd h:mm a if you are going to import date time value as 2030-01-01 12:00 AM
  3. Step ID is mandatory when a step is provided.
  4. Providing ISSUE KEY will update the corresponding issue, if found.
  5. Specify Requirement ID in Requirement column if you want to import Test Cases with Requirement associations.
    Note: if Requirement ID specified in import file cannot be found in your project, the Test Case will still be imported without Requirement associations.
  6. Specify Test Suite path in Test Suite column if you want to import Test Cases with Test Suite associations.
    Note: If Test Suite path specified in import file cannot be found from your project, it will be created from import file.
  7. At the end of the CSV file import wizard, you will be given the option of creating a CSV configuration file, which contains the settings you configured while running through the CSV file import wizard. This is useful if you need to test your CSV file import on a test JIRA server first before performing the import on a production system.

Import Test Cases from a .csv file: 

To import test cases from .csv file, follow these steps:

  1. Click "Administration->Add-ons" from the main menu.
  2. Click the "Test Case Import" link from the left panel under the "synapseRT" section.
  3. Click "CSV" icon from the page.
  4. Choose a project from "Project" dropdown and click "Next" button.
  5. Click "Choose File" button, browse to your test case file (.csv format).
  6. Specify a "Delimiter" if necessary. 
  7. Select "Use an existing configuration file" if you have, it will ask you to select the configuration file and mappings in the file will be loaded automatically in next page.
  8. Click "Next" button.
  9. Select the CSV fields to import, then set how you would like these converted to fields in JIRA.
    • Note: the field mapping can be done automatically if you have a configuration file created in your previous import and follow step 6.
  10. Click "Import" button.

    Note:

    If you need to import another CSV file with the same (or similar) settings to what you used through this procedure, click the save the configuration link to download a CSV configuration file, which you can use at the fifth step of the CSV file import wizard.

[Screenshot - UG870_Admin_Test_Case_Import02]

Tips for importing CSV data into JIRA fields

Below are some helpful tips when importing data from your CSV file into specific JIRA system fields and user created custom fields:

Jira Field

Import Notes

 -

synapseRT import only supports Jira system field (e.g. Summary, Priority ...) and custom fields from Jira standard field types (e.g. Checkboxes, Date Picker ...)

Jira advanced field types (e.g. Development Summary, Global Rank ...) and any field types from third party apps are not supported.

SummaryThis is the only required field.
Issue KeyYou can set the issue key for an imported issue. If an issue with a given key already exists in JIRA, it will be updated instead.
Component(s)You can import issues with multiple components by entering each component in a separate column.
Affects Version(s)You can import issues with multiple 'Affects Versions' by entering each version in a separate column.
Fix Version(s)You can import issues with multiple 'Fix Versions' by entering each version in a separate column.
Due Date
  • Use the syntax that complies with the Java SimpleDateFormat
  • Example: set date format to yyyy-MM-dd h:mm a if you are going to import date time value as 2030-01-01 12:00 AM
LabelsYou can import issues with multiple labels by entering each component in a separate column.
Epic LinkProvide Epic issue key if you want to link issues to an existing Epic in Jira.

Custom field types:

  • Date Picker
  • Date Time Picker
  • Use the syntax that complies with the Java SimpleDateFormat
  • Example: set date format to yyyy-MM-dd h:mm a if you are going to import date time value as 2030-01-01 12:00 AM

Custom field types:

  • Checkboxes
  • Labels
  • Select List (multiple choices)
  • You can import issues with multiple values by entering each value in a separate column.
  • Values for 'Checkboxes' and 'Select List (multiple choices)' fields require to be pre-defined in your Jira server.
  • Values for 'Labels' field are not required to be pre-defined in your Jira server, values will be created by import process.

Example:

Summary, Checkbox, Checkbox, Checkbox, Label, Label
"First issue", value1, , , Label1,
"Second issue", value2, , , Label1, Label2
"Third issue", value1, value2, value3, Label1,

Custom field types:

  • Number Field
  • Text Field (multi-line)
  • Text Field (single line)
  • URL Field
  • Values for those fields are not required to be pre-defined in your Jira server.
  • Values will be created by import process.

Custom field type:

  • Select List (cascading)
  • The '->' separator allows you to import the hierarchy.
  • Values for this field require to be pre-defined in your Jira server.

Example:

Summary, Cascading Custom Field
Example Summary, Parent Value -> Child Value

Custom field type:

  • User Picker (single user)
  • It requires to specify Jira 'username' in csv file in order to make a successful import.
  • The user(username) specified in csv five must be defined in Jira server already.

Downloadable examples

Import Test Cases from Test Link exported .xml file: 

To import test cases from Test Link exported .xml file, follow these steps:

  1. Click "Administration->Add-ons" from the main menu.
  2. Click the "Test Case Import" link from the left panel under the "synapseRT" section.
  3. Click "Test Link" icon from the page.
  4. Choose a project from "Project" dropdown and click "Next" button.
  5. Click "Choose File" button, browse to your test case file (.xml format).
  6. Click "Next" button.
  7. Select the XML fields to import, then set how you would like these converted to fields in JIRA.
  8. Click "Import" button.

[Screenshot - UG870_Admin_Test_Case_Import03]

You can find test case import sample file (.xml) from the link: TestLink_Test_Case_Import_Sample_File.xml

Note:

In Test Link export file (.xml), only value IDs are present for some fields. If you want to import such fields to synapseRT, you need replace these IDs with actual values first from xml file, and then start your import process. Otherwise those fields' values will not be imported as synapseRT doesn't know what exactly they are.

Below are some samples to replace IDs with actual values in Test Link xml file: 

Test Link FieldField's Data in XML FileUpdate Sample
Version<version><![CDATA[1]]></version><version><![CDATA[Version 1.0]]></version>
Importance<importance><![CDATA[2]]></importance><importance><![CDATA[High]]></importance>
Execution Type<execution_type><![CDATA[1]]></execution_type><execution_type><![CDATA[Manual]]></execution_type>

Migrate Test Cases from Zephyr add-on: 

synapseRT supports to migrate Zephyr Test Cases (issue type = Test) to synapseRT Test Cases (issue type = Test Case).

To migrate test cases from Zephyr add-on, follow these steps:

[Precondition]:

  1. Install synapeRT add-on to JIRA server from which Zephyr Test Cases are created.
  2. Disable Zephyr add-on, please refer to Atlassian Documentation about how to "Disabling and enabling add-ons". 
  3. Bulk move Zephyr Test Cases from "Test" issue type to "Test Case" issue type, please refer to Atlassian Documentation about how to "Move multiple issues".
    Note: you may need configure your JIRA project to make sure "Test Case" issue type is available for your project.

Once above preparation is done, follow below steps to complete data migration:

  1. Click "Administration->Add-ons" from the main menu.
  2. Click the "Test Case Import" link from the left panel under the "synapseRT" section.
  3. Click "Zephyr" icon from the page.
  4. Click "Import" button.
[Screenshot - UG870_Admin_Test_Case_Import04]
[Screenshot - UG870_Admin_Test_Case_Import05]