In this tutorial, we will create some tests in Cucumber for Ruby (or JRuby).

The test (specification) is initially created in Jira as a Cucumber Test and afterwards, it is exported using the UI or the REST API.


  • Install Ruby or JRuby
  • Install the "cucumber" gem


After creating a Cucumber Test of Cucumber Type "Scenario Outline" in Jira, you can export the specification of the test to a Cucumber .feature file via the REST API or the Export to Cucumber UI action from within the Test Execution issue.

The created file will be similar to the following: 

Feature: As a user, I can calculate the sum of 2 numbers
	@TEST_CALC-908 @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
							    | input_1 | input_2 | button | output |
							    | 20      | 30      | add    | 50     |
							    | 2       | 5       | add    | 7      |
							    | 0       | 40      | add    | 40     | 
							    | 4       | 50      | add    | 54     | 

After running the tests and generating the Cucumber JSON  report (e.g., data.json), it can be imported to Xray via the REST API or the Import Execution Results action within the Test Execution.

cucumber -x -f json -o data.json

The execution screen details will not only provide information on the test run result, but also of each of the examples provided in the Scenario Outline.

The Cucumber Scenarios Example/Result details (i.e., Hooks, Backgrounds and Steps) are only available for executions done in Xray v2.2.0 and above.


The icon represents the evidences ("embeddings") for each Hook, Background and Steps.

Learn more

Please see Testing in BDD with Gherkin based frameworks (e.g. Cucumber) for an overview on how to use Cucumber Tests with Xray.