Page tree

You are on the Xray Cloud documentation. If you are looking for Xray Server documentation, you can find it in this page

Skip to end of metadata
Go to start of metadata

Cucumber .feature files can be exported from Xray and executed externally. They can be generated from the following Xray issues:

  • Test
  • Test Set
  • Test Execution
  • Test Plan

Or, from an Issue mapped as a Requirement issue type.

If the language defined to export the Cucumber .feature files is not the default (i.e., En), then a language tag will be added.

Rules

Xray generates Cucumber .feature files according to the context issue and the following rules:

Test:
  • A single Cucumber feature file is generated for each requirement associated with this Test.
  • The feature contains the feature header description of the associated requirement, if there is no requirement associated then the feature header will contain the summary of the test.
  • The feature contains the background of the Test, if present in the Precondition associated with it.
  • The feature contains the Scenario/Scenario Outline defined in this Test.
Test Set, Test Execution, Test Plan or Requirement issue:
  • A single Cucumber feature file is generated for each different tuple (Requirement, Precondition).
  • A Test Execution does not contain repeated tests.
  • If a Test is not associated with a requirement, then it will be exported as an independent feature file.
  • If a Test is associated with more than one requirement, then a feature file will be generated for each requirement. The generated .feature files will contain repeated test scenarios.
  • The feature contains the feature header description of the associated requirement, if present. If no requirement is associated then the feature header will contain the summary of the Test Set if the test was exported from a single test set or the summary of the Test. 
  • The feature contains the common background of the Tests, if present in the Precondition.
  • The feature contains the Scenario/Scenario Outline for all the tests.

Feature File Format


[ #language: { language } ]
[ @{ Test Execution issue Key } ]
[ @{ Requirement issue Key } ]
Feature: [{ Requirement Issue Summary } || { Test Set Issue Summary } || { Test Issue Summary }]
    [{ Requirement Issue Description }]
     
    [Background:
        { Pre-Conditions }]
     
    [# { Test Issue Description }]
    @{ Test Issue Key } 
    [@{ SubRequirement Issue Key 1 } ... @{ SubRequirement Issue Key N }] 
    [@{ Test Set Issue Key 1 } ... @{ Test Set Issue Key N }] 
    [@{ Test Issue Label 1 } ... @{ Test Issue Label N}]
    Scenario [Outline]: { Test Issue Summary }
        {Test Issue Steps}
    ...


Feature File Naming Convention

The max filename will always be 50 characters without the file extension and will follow the rules below:

When "Generate features file name using summary" is disabled

If the summary option, in the cucumber options, is disabled:

  • and the feature contains a requirement:

<sequential_id_one_based>[_<issue_requirement_key>][_<issue_precondition_key>]

  • and no requirement is present on the feature and there is a small amount of tests:
<sequential_id_one_based>[_<issue_test_key_1>,<issue_test_key_2>,...]
  • and no requirement is present on the feature and there is a large enough amount of tests to exceed the filename limit:

<sequential_id_one_based>[_<issue_test_key_1>,<issue_test_key_2>,...][(+[number_of_remaining_tests])]

When "Generate features file name using summary" is enabled

If the summary option, in the cucumber options, is enabled:

  • and the feature contains a requirement:

<sequential_id_one_based>[_<issue_requirement_summary>]

  • and no requirement is present on the feature:

<sequential_id_one_based>[_<issue_test_summary_1>][(+[number_of_remaining_tests])]

Note: Summaries will be truncated to prevent filename from exceeding the 50 character limit.

Example

Exporting a Test Execution with the following Tests:

Key
Requirement
Precondition
T1R1C1
T2R1-
T3-C2
T4R2C1
T5R2C3
T6--
T7R2, R3C1
T8R2, R3-
T9

-

C2
T10R1C1

generates the following 9 feature files:

File
Requirements
Precondition
Tests
Filename
1R1C1T1, T101_R1_C1.feature
2R1-T22_R1.feature
3R2C1T4, T73_R2_C1.feature
4R2C3T54_R2_C3.feature
5R2-T85_R2.feature
6R3-T86_R3.feature
7R3C1T77_R3_C1.feature
8-C2T3, T98_T3,T9_C2.feature
9--T69_T6.feature
  • No labels