Importing Cucumber Tests

The following endpoint is provided to import a Cucumber .feature file or a zip file containing multiple .feature files. The files in the zip file may be in folders/subfolders.

Each .feature file will be processed and will try to find or create a Test/Pre-Condition inside the project given in the projectKey parameter. We use the following rules:

Tests:

1. try to find the Test by key, if found then update it; else...
2. try to find the Test having:
   1. a label with the original relative path of .feature (e.g. "core/sample_addition.feature)
   2. a label named "id:xxx", where xxx is some number (e.g. "id:1", "id:32"); this label comes from a scenario/scenario outline's tag
   3. no other label ending in ".feature"
3. try to find the Test having:
   
   1. a label with the original relative path of .feature (e.g. "core/sample_addition.feature)
   2. the same summary
   3. no other label ending in ".feature"
4. try to find the Test having:
   1. the same Summary
   2. no label ending in ".feature", except the one corresponding to the relative path of the Cucumber file being imported
5. When a Test is found, if Xray Enterprise is enabled, the import will update
   • the default version if it is Cucumber/Gherkin,
   • the latest active Cucumber/Gherkin test case version.
   • create a new version if none of the previous ones are matched
6. create Test in that project and add a label with the relative path of the feature. The tags used in the scenario/scenario outline are also added as labels.

Pre-Conditions:

1. try to find the Pre-Condition by key, if found then update it; else...
2. try to find the Pre-Condition having both:
   1. a label with the original relative path of .feature (e.g. "core/sample_addition.feature)
   2. no other label ending in ".feature"
3. try to find the Pre-Condition having both:
   1. the same Summary
   2. no label ending in ".feature", except the one corresponding to the relative path of the Cucumber file being imported
4. create Pre-Condition in that project and add a label with the relative path of the feature

Organization:

1. updateRepository Query Parameter:
   A new query parameter named updateRepository is added to the REST API endpoint for importing cucumber features.

2. Default Behavior:

   1. When the updateRepository parameter is not provided, it defaults to updateRepository=false.

   2. In this default state, the Test Repository will not be updated to maintain compatibility with previous versions.

3. Enabling Repository Update:

   1. If updateRepository=true is specified, the imported Tests will be organised into the Test Repository.

   2. The organisation of Tests follows the folder structure defined in the import zip file.

4. Automatic Folder Creation:

   1. Folders will be automatically created in the Test Repository if they do not exist as per the structure in the import file.

5. Handling Test Movement:

   1. If an existing feature is updated and its location is changed to a different folder, Xray will move the Tests to the new folder accordingly.

6. Error Handling for Folder Creation:

   1. If a folder cannot be created due to naming issues or other conflicts, an HTTP 400 error will be returned.

   2. The system will attempt to update the folder locations for other valid features in the import, allowing for partial updates where possible.

Considering the above zip folder structure:

 System will import into the following Test Repository path:

1. 1. Folder "Math"
      Tests Cucumber test C and D
   2. Folder "Math/Sub"
      Test Cucumber test B
   3. Folder "Math/Sum"
      Test Cucumber test A

The mapping from the Scenario/Scenario Outline present in the .feature files to the Test issues in Jira would be as follows:

@REQ_CALC-889
Feature: As a user, I can calculate the sum of 2 numbers     
       
	Background:
		#@PRECOND_TX-114
		Given that the calculator is turned on
		And the mode is to advanced
		#@PRECOND-TX-155
		Given that the calculator has been reset

	@UI @core
	Scenario Outline: Cucumber Test As a user, I can calculate the sum of 2 numbers
		Given I have entered <input_1> into the calculator
		And I have entered <input_2> into the calculator
		When I press <button>
		Then the result should be <output> on the screen
	
		  Examples:
		    | input_1 | input_2 | button | output |
		    | 20      | 30      | add    | 50     |
		    | 2       | 5       | add    | 7      |
		    | 0       | 40      | add    | 40     | 
		    | 4       | 50      | add    | 54     |

@REQ_CALC-1910
Feature: As a user, I can calculate the sum of two numbers

Background:
  Given I have a calculator
  And I have some fingers


@id:1 @fast
Scenario Outline: Cucumber Test As a user, I can calculate the sum of two positive numbers
  Given I have entered <input_1> into the calculator
  And I have entered <input_2> into the calculator
  When I press <button>
  Then the result should be <output> on the screen

Examples:
| input_1 	| input_2 	| button| output|
| 20  		| 30 		| add	| 50 	|
| 2  		| 5  		| add 	| 7  	|
| 0  		| 40 		| add 	| 40 	| 
| 4  		| 50 		| add 	| 54 	| 
| 5  		| 50 		| add 	| 55 	| 


@id:2
Scenario: Cucumber Test As a user, I can calculate the sum of two negative numbers
  Given I have entered -1 into the calculator
  And I have entered -3 into the calculator
  When I press add
  Then the result should be -4 on the screen

Note that some field values in the JSON files will follow some rules:

• Issue Type: Overridden by the Test or Pre-Condition issue type;
• Summary: Overridden by the internally generated summary;
• Parent: This field is ignored;
• Scenario Type, Cucumber Scenario and Background: Not allowed to provide a value for these fields.

[
	{
		"id":"14400",
		"key":"DEV-915",
		"self":"http://localhost:8727/rest/api/2/issue/14400",
		"issueType": {
            "id": "10100",
            "name": "Test"
        }
	},
	{
		"id":"14401",
		"key":"DEV-916",
		"self":"http://localhost:8727/rest/api/2/issue/14401",
		"issueType": {
            "id": "10103",
            "name": "Pre-Condition"
        }
	}
]