Import Tests

You can import Test definitions from external sources using CSV files, either by using Xray's Test Case importer (recommended) or JIRA's native CSV importer plugin for importing issues (more info on JIRA's article on Importing Data from CSV).

This page explaing the later procedure, which is more generic and supports importing of all Test types. However, for manual Tests you should use Xray's Test Case importer.

You just have to:

1. Log in to JIRA as a user with the JIRA Administrators global permission.
2. Select Administration > System > Import & Export > External System Import > Import button, and then specify the input CSV file.

In the CSV file that you'll use for importing, besides native issue columns, like Summary, Description, amongst others, you need to specificy some additional columns related with Xray Test issues:

• the "Issue Type" column must be present in your CSV and must contain the name of Xray Test issue type which is, by default, "Test". Alternately, this column can contain the Test issue type ID.
• the "Test Type" custom field is required for each Xray Test Issue. This field can have the following values:
  • Manual
  • Automated[Cucumber] 
  • Automated[Generic]

There are some columns that you also need to specify, depending on the type of Test as described in the next sections.

Importing Manual Tests

In order to import Manual Tests to JIRA from a CSV you need define the following columns:

• "Test Type" custom field to "Manual"
• "Manual Test Steps" custom field with JSON list format representing all your manual steps. Here is an example for the "Manual Test Steps" custom field: 
  
  

[
    {
        "index": 0,
        "step": "Step 1",
        "data": "input Data 1",
        "result": "Excepted result 1"
    },
    {
        "index": 1,
        "step": "Step 2",
        "data": "input Data 2",
        "result": "Excepted result 2"                      
    },
    {
        "index": 2,
        "step": "Step 3",
        "data": "input Data 3",
        "result": "Excepted result 3"                      
    },
    {
        "index": 3,
        "step": "Step 4",
        "data": "input Data 4",
        "result": "Excepted result 4"                      
    }
]

Summary; Assignee; Reporter; Issue Type; Description; Test Type; Manual Test Steps
"Test issue 1"; admin; admin; 10000; "This is a Test issue"; "Manual"; "[ { ""index"": 0, ""step"": ""Step 1"", ""data"": ""input Data 1"", ""result"": ""Excepted result 1"" }, { ""index"": 1, ""step"": ""Step 2"", ""data"": ""input Data 2"", ""result"": ""Excepted result 2"" } ]"
"Test issue 2"; admin; admin; 10000; "This is a Test issue"; "Manual"; "[ { ""index"": 0, ""step"": ""Step 1"", ""data"": ""input Data 1"", ""result"": ""Excepted result 1"" } ]"

Importing Cucumber Tests

For Cucumber Test issues, you need to define the following columns in your CSV:

• "Test Type" to "Automated[Cucumber]"
• "Cucumber Test Type" to:
  • "Scenario" or
  • "Scenario Outline"
• "Cucumber Scenario" to the contents of a Cucumber Scenario.

Importing Automated Generic Tests

For automated generic Test issues, you need to define the following columns in your CSV:

• "Test Type" to "Automated[Generic]"
• "Generic Test Definition" to the test definition.

Export Tests

JIRA lets you export your data in CSV or Excel (file is saved as xls but you can open it with your spreadsheet tool and export it to CSV). Xray customfields are compatible with this function. Even Manual Test Steps field can be exported in a JSON format so that it can be imported back to JIRA directly.

Once the data is in XLS format, you must remove header and footers as those are HTML fields, and export data as CSV. 

Import Pre-Conditions, Test Sets, Test Executions and Test Plans

Besides Tests, and since Xray uses JIRA issue types for its core entities, it's also possible to import other entities such as Pre-Condtions, Test Sets, Test Executions and Test Plans.

Pre-Conditions

It's possible to specifiy the Tests by using the "Tests association with a Pre Condition" mapping upon importing. Multiple Tests may be specified by using the comma (",") delimiter.

Summary; Assignee; Reporter; Issue Type; Type; Condition; Description; Tests associated with Pre Condition
"Standalone PreCondition"; admin; admin; 10; Manual; "calculator must be turned on"; "This is a PreConditon issue";
"PreCondition linked to 2 Tests"; admin; admin; 10; Manual; "calculator must be scientific"; "This is a PreConditon issue"; CALC-779,CALC-756
"PreCondition linked to 1 Test"; admin; admin; 10; Manual; "calculator must be normal"; "This is a PreConditon issue"; CALC-779

Test Sets

It's possible to specifiy the Tests by using the "Tests associated with Test Set" mapping upon importing. Multiple Tests may be specified by using the comma (",") delimiter.

Summary; Assignee; Reporter; Issue Type; Description; Tests associated with Test Set
"Test Set without Tests"; admin; admin; 8; "This is a Test Set issue"; 
"Test Set with 2 Tests"; admin; admin; 8; "This is a Test Set issue"; CALC-908,CALC-887

Test Executions

It's possible to specifiy the Tests by using the "Tests association with Test Execution" mapping upon importing. Multiple Tests may be specified by using the comma (",") delimiter.

Fix Version; Summary; Assignee; Reporter; Issue Type; Description; Test Environments; Tests associated with Test Execution
"3.0"; "Test Execution without Tests"; admin; admin; 9; "This is a Test Execution issue";; 
"3.0"; "Test Execution with 2 Tests"; admin; admin; 9; "This is a Test Execution issue"; Android; CALC-908,CALC-887

Test Plans

It's possible to specifiy the Tests by using the "Tests associated with Test Plan" mapping upon importing. Multiple Tests may be specified by using the comma (",") delimiter.

Fix Version; Summary; Assignee; Reporter; Issue Type; Description; Tests associated with Test Plan
"3.0"; "Test Plan without Tests"; admin; admin; 10; "This is a Test Plan issue"; 
"3.0"; "Test Plan with 2 Tests"; admin; admin; 10; "This is a Test Plan issue"; CALC-908,CALC-887

Copying Tests from one JIRA server to another one

Sometimes you may want to copy Tests specified in some other JIRA server such as a staging/testing JIRA environment.

If you need to "migrate" (i.e. copy) the Tests to another JIRA server, you may follow the instructions above for exporting Tests to CSV and to import them from CSV.

The general procedure would be:

1. In the origin JIRA server
   1. filter out the the relevant Test issues in the Issues search screen
   2. make visible the columns you want to migrate (don't forget to include the Summary, Issue Type, Test Type, Manual Test Steps and other mandatory fields)
   3. export visible fields to CSV
2. In the destination JIRA server
   1. import Tests from CSV using JIRA's built-in CSV importer (don't forget to map all the mandatory fields)

What you will be able to copy:

• Test related fields (e.g. summary, labels, etc)
• Test Type (mandatory)
• Manual Test Steps (mandatory for Manual tests)

What you won't be able to copy:

• attachments (global or step level attachments)
• related entities and links (because they won't exist in the destination JIRA server)

Importing executions related information from a legacy (non-JIRA) test management tool to Xray on JIRA

Although Xray allows you to import execution related information, currently Xray does not provide an out-of-the-box solution for migration execution related information along with respective tests from other systems.

1. Migrate Tests specification
   1. From CSV using Test Case Importer; supports attachment   => you will miss the mapping information between original_idócreated_issue_key; you wil have to somehow manage it
   2. Programmatically create the Test issues using JIRA’s REST API (some examples in http://confluence.xpand-addons.com/display/XRAY/Tests+-+REST#Tests-REST-CreatingandEditingTests-JIRARESTAPI ); this will allow you to easily identify the mapping original_idócreated_issue_key , which can be used afterwards

2. Migrate organization (optional; not really necessary)

=> This depends greatly on the legacy system organization. If it groups somehow tests, then the JIRA REST API can be used to create the Test Set issues. After that, Xray’s REST API can be used in order to add the Tests. It is required to know the Tests issue keys in advance.

3. Import results

a) Create Test Executions with the respective Tests

=> For this, JIRA REST API can be used to create the Test Execution issue. After that, Xray’s REST API (i.e. POST /rest/raven/1.0/api/testexec/{testExecKey}/test) can be used in order to add the Tests. It is required to know in advance the Tests issue keys.

b) Import results for each Test Execution

• • Import just overall test result, for each test run that is part of the test execution
  • Import detailed test run results, including per step information

                => Each approach can be achieved using the REST API, and the POST /rest/raven/1.0/import/execution endpoint. You just need to know in advance the Test Execution key  and also the issues keys for each Test that is part of the Test Execution.