Our documentation site has been updated to AIO Tests Knowledge Base
Import Cases/Feature files
AIO Tests allows easy import of existing manual Cases. On import, all data from file is copied over to AIO fields, including traceability (requirements) mapping. This helps the user to start work on AIO Tests readily.
AIO Tests supports import functionality via a Comma-Separated-Values (.csv), an Excel file or Cucumber feature files. The file size should not be more than 100 MB.
- 1 Steps to Import
- 2 Import CSV/XLS
- 2.1.1 Sample .csv
- 2.1.2 Sample .xlsx
- 2.1.3 Sample BDD Excel
- 2.2 Field Mapping
- 2.3 Mapping folder hierarchy
- 2.4 Mapping Data driven cases/Example based cases
- 2.5 Data Mapping
- 3 Import Cucumber, Gherkin based Feature files
- 4 How to Import Custom Fields
- 5 Missing Data Impact
- 6 Import Cases from External System
- 7 Import Cases from Other AIO Tests Projects
Steps to Import
“Import Cases” button can be seen on the Cases tab as shown below.
Click on the Import Cases button to open the import page with four tabs - File, External System, Other Projects and Jobs.
On the File page, there are two options
XLS/CSV - Single XLS or CSV file < 100MB or an Excel containing Cucumber cases
Feature File- Cucumber feature files, each not exceeding 100MB. Maximum 10 .feature files can be uploaded in one go
Import CSV/XLS
To import a .csv/Excel file, users can upload a .csv/Excel file by clicking the “Browse to attach file” link under the XLS/CSV browse box.
For ease of use, we have created a sample .csv/Excel file with headers mapping directly to fields in AIO Tests. The first two fields (Test Key and Title) are mandatory for creating cases.
Sample .csv
Blank sample .csv
Single line cases sample .csv
Multi-line cases sample .csv
Sample .xlsx
Sample BDD Excel
Please note that the first row in user’s .csv or Excel file is considered as header by the system
The Existing Case ID and Title are mandatory fields that need to be mapped
The sample .csv and Excel file provided is for ease of use and not a mandatory format. User can map their own fields to AIO Tests fields
Single line and multi-line .csv files are provided to show examples of how the import will work in these scenarios
Field Mapping
The below screenshot shows the Field Mapping section that appears once the file has been uploaded. It takes the headers from the uploaded file and maps it to the AIO Tests fields automatically. User can update the mappings if required. There is an option to reset all the fields if the user wants to map them manually. If user changed a few mappings and would like to see what AIO Tests auto-mapped, they can click on “Re-Initialize Mapping”. Click on Select Data Mapping to go to the next step.
Mapping folder hierarchy
AIO Tests requires a special delimiter to identify a folder hierarchy, which is ->
As an example, a folder mapping of Login->2FA
, will result in a parent folder named Login
and a child folder under Login, named 2FA
While importing cases, if a default folder is selected i.e. anything other than “Not Assigned”, then the above hierarchy would be created under the selected default folder.
Mapping Data driven cases/Example based cases
To import cases based on parameters, user needs to add a column in excel and map it with the Datasets field in the above field mapping. Users are expected to define the datasets with pipe separated values as below :
To use a parameter in a step, it needs to be enclosed within angular brackets as highlighted below:
Data Mapping
The next section Data Mapping maps data provided in the file to values available in AIO Tests and Jira. The Source Field values are unique values available in the source file and the AIO Tests Target Field values are the values for the respective fields available in AIO Tests. E.g. The source file can have priorities defined as Highest, High, Med and Low. AIO Tests however offers Critical, High, Medium, Low and Lowest. So user is asked to map their source field values with AIO Tests field values. Screenshot below shows Highest from source file mapped to Critical in AIO Tests. If a value (for status, types, priorities and custom fields) isn’t mapped, but the same name value is found in the project being imported to, in AIO Tests, it will automatically be assigned once the import process finishes.
Folder: This acts as the destination folder where the user wants to import their cases. By default Not Assigned folder is selected but user can select from the already created folders via the drop-down.
After mapping is finalized, click on Start Import button. This action will lead to the tab of Jobs (CSV/XLSX) along with a success message stating “Batch <batch #> created successfully”.
Jobs - This tab shows all the import requests that have either been submitted or completed. Once the batch is created, its in status “Queued”. The import function is a batch process which runs every 2 minutes and checks if any files have been submitted/queued for import. If new files exist, they are processed. Clicking the highlighted icon below, updates the status of the batch to either “Running” or “Completed”.
On clicking the down carat icon on the right gives the results of the batch processing; whether the import actually succeeded or not.
Import Cucumber, Gherkin based Feature files
Users can import Feature files in AIO Tests.
Each scenario/scenario outline gets mapped to one AIO Test case. If the test case already exists in AIO, the case will be updated based on the feature file
Scenario outline gets converted into a single case and example values become datasets/examples
For adding story as a requirement in the newly created case, the scenario or the feature needs to be annotated with @JREQ-<Storykey>
Docstrings and Data tables get copied in the data column
Below lists how data from a feature file maps to a newly created case in AIO Tests
Scenario to AIO Tests mapping
Scenario | AIO Test Case | Note |
---|---|---|
Scenario Name | Title |
|
Feature name | Description |
|
Case Key | AIO Test case key | If the specified key exists in AIO, the case will be updated with changes in feature file |
Steps | Steps |
|
Data Table in Steps | Data in steps |
|
Docstrings in Steps | Data in steps |
|
Tags | All tags get added to case |
|
Requirement id | Jira Requirements [if at feature level then, all tests created from scenarios will have mapping] | All requirements need to be prefixed with JREQ- |
Background Steps | Steps in case - before the scenario steps |
|
Rule | Description |
|
Examples | Example |
|
Sample Feature Files
To import feature files, users can click on Browse To Upload file under the BDD section.
On attaching the file, the below option would show up:
Folder : Default folder where scenarios will be imported as tests.
Default Status: Status in which to import scenarios
Clicking on Start Import will create one batch job for each file selected. The jobs are available on the Jobs → Feature File tab as below.
BDD Jobs
Clicking on down carat icon for a job shows a detailed view along with errors if any as below.
How to Import Custom Fields
If there are fields that need to be imported but are not present in AIO Tests by default then users can
Create custom fields in AIO Tests
While importing, the custom fields creating in AIO will be available to map to the fields from Excel/CSV
Few things to note
For Single select list and Multi select list type of custom fields, users can import a maximum of 50 list options
For importing date fields, users will need to ensure they follow the supported date formats (see below for the list)
User type fields (single user and multi-user) will not be imported. Users will need use Bulk edit of case details feature to update such fields
Supported Date Formats for Custom Fields
8-Jun-20 | 8-Jun-2020 | Jun 8, 2020 | Jun 8, 20 | Jun-8, 20 | Jun-8, 2020 | 8-Jun, 20 | 8-Jun, 2020 | 8 Jun 2020 |
8 Jun 20 | 8/Jun/2020 | 8/Jun/20 | 2020-Jun-8 | 2020 Jun 8 | 2020/Jun/8 | Jun 8 2020 | Jun 8 20 | June 8, 2020 |
June 8, 20 | 8-June-2020 | 8-June-20 | 8 June 2020 | 8 June 20 | June-8, 2020 | June-8, 20 | 8-June, 20 | 8-June, 2020 |
2020/June/8 | 2020-June-8 | 8/June/2020 | 8/June/20 | 2020 June 8 | Jun-8-2020 | Jun-8-20 | June-8-20 | June-8-2020 |
Missing Data Impact
If some data is found missing or is empty while importing/mapping the file, the file will fail to import with an error. Below is a list of few common errors.
Message | Description |
---|---|
Story not found [Jira issue key] | This usually happens when the Jira story that you are trying to link doesn't exist or if it belongs to another project. |
Cannot create Test Step. Mandatory data is missing for Test Step. Please provide the value for Step and Expected Result | While creating a Case with steps, step description and expected result are mandatory fields. If source file doesn’t provide these values then this error will be shown |
Import Cases from External System
Click here to learn more about importing cases from external systems into AIO Tests. AIO Tests supports import of cases from XRAY. Please reach out to the support team via help@aiotests.com to get more details.
Import Cases from Other AIO Tests Projects
Click here to learn more about importing cases from other projects that have AIO Tests enabled.