Page History
| Warning | ||
|---|---|---|
| ||
This tool is deprecated and is going to be removed on future versions. From Xray 2.1 onwards, the preferred way for way of importing Manual Tests is by using Xray's Test Case Importer, as detailed in Importing Manual Tests using Test Case Importer. |
Some users consider For some users, it is easier to create Manual Test definitions in a spreadsheet and then import them to Xray using the import procedure described in Importing and Exporting Tests (CSV). Xray for JIRA provides a tool a xray-converter to tool to make it straightforward.
This tool It converts a CSV, that basically contains the steps definitions, to into the generic JIRA's Jira CSV-compatible import format, which requires all rows to be fulfilledfilled.
| Table of Contents |
|---|
Conversion overview
- Your step definitions must be defined in a spreadsheet that follows a specific format (see bellowtable below). So, you You can either use an example file as basis, or adapt your already existing spreadsheet;.
- Then, you may run xray-converter to convert the "steps " spreadsheet" to into the generic CSV format supported by JIRAJira/Xray.;
- Don't forget that in the end, you will have to import the tests , using the newly-created CSV file, as described in Importing and Exporting Tests (CSV).
Layout of spreadsheet with steps
Your spreadsheet must obey strictly follow this format (example file):
| TCID | Project | Region | Issue_Type | Environment | Summary | Component | Description | Reporter | Priority | Labels | Test_Type | Step | Data | Expected_Result |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | QA Test Repository | AMER | Test | Test | Test Case 1 | App1 | Test Description 1 | Ivaan, Iftekhar: IT (NYK) | Trivial | Java,Test | Manual | Browse to url | www.bn.com | BN home page shows |
| 1 |
| Click login | |||||||||||||
| 1 |
| Enter Userid | iivaan |
| 1 |
| Enter Password | xyz123 | OK button enable | ||||||||||||
| 1 |
| Click OK |
| Welcome Msg shows | ||||||||||||||
| 2 | QA Test Repository | AMER | Test | Test | Test Case 2 | App1 | Test Description 2 | Ivaan, Iftekhar: IT (NYK) | Trivial | Java,Test | Manual | Browse to url | www.bn.com | BN home page shows |
| 2 |
| Click OK |
| Welcome Msg shows | ||||||||||||||
| 3 | QA Test Repository | AMER | Test | Test | Test Case 3 | App1,App2 | Test Description 3 | Ivaan, Iftekhar: IT (NYK) | Trivial | Java,Test | Manual | Browse to url | www.bn.com | BN home page shows |
| Info |
|---|
The TCID must be the first column of your spreadsheet and the Step, Data and Expected_Result the last three columns. These columns are mandatory; otherwise, otherwise the conversion won't work properly. Is also advised to It is also recommended that you always have the Issue_Type and the Test_Type columns in order to force JIRA Jira to create your tests with the correct Issue Type and Test Type. |
...
Export your "steps spreadsheet" to CSV and set your separator type as ; preferably. You'll now have a file similar to the following output (example file).
...
| Info |
|---|
Make sure you have Java environment installed on you your machine and set JAVA_HOME. You can follow these instructions Detailed instructions are in https://confluence.atlassian.com/display/CROWD/Setting+JAVA_HOME |
...
Implementation
Copy the CSV with the steps to the data/ subdirectory within the xray-converter folder.
- Run the xray-converter (see syntax bellowbelow).
- Import the issues to JIRA Jira using JIRAJira's native CSV import feature
...
- .
| Info |
|---|
In Unix based systems or OS X, you must use the xray-convert.sh executable; in Windows, you should use the xray-converter.bat batch file. |
Syntax
| Argument | Description | Example (based on spreadsheet example) |
|---|---|---|
| -path | The path to the file to convert | -path ./data/SampleTestCase.csv |
| -data | The test step's Data column name | -data Data |
| -result | The test step's Expected Result column name | -result Expected_Result |
| -step | The test step's Step column name | -step Step |
| -attrDelimiter | The delimiter used in the file to separate the different attributes | -attrDelimiter ";" |
| -testDelimiter | The delimiter used in the file to separate the different tests to import |
| or please provide the column name. When this cell value changes, it means that the line represents a new Test. | -testDelimiter TCID |
Examples
Unix
| Code Block | ||
|---|---|---|
| ||
./xray-converter.sh -path ./data/SampleTestCase1.csv -step Step -data Data -result Expected_Result -attrDelimiter ";" -testDelimiter TCID |
...
| Note |
|---|
When executing the xray-converter.bat file, you do not specify the argument's names, but you must respect must follow the order shown in the example. |
| Note |
|---|
When exporting from XLS to CSV, choose the option: "CSV (comma separated)" ;. |
| Note |
|---|
The test steps to import in the XLS , can not cannot contain the caracter character " at the end of any line; otherwise, otherwise the exported document will be unformatted;. |
| Warning | ||
|---|---|---|
| ||
If you get an error like 'C:\Program' is not recognized as an internal or external command, it's because Windows is not interpreting the JAVA path as it shouldcorrectly. Ee.g:., ECHO %JAVA_HOME% You can fixed it with fix it by providing JAVA_HOME path with a "" e.g., "C:\Program Files\Java\jdk1.8.0_45" or more radically, copy this folder to C:\jdk1.8.0_45 and change JAVA_HOME to C:\jdk1.8.0_45 |
...
Installation
- Download xray-converter here
- Unzip it to a directory of your choice.
| Info | ||
|---|---|---|
| ||
New version. Compatible with newlines inside cells ("\n", "\r"). |