A Test is a scenario made up of with the following components: a sequence of steps and , conditions or variables, where test inputs and an expected result. are provided and the test target is run using those inputs, to see how it performs. Certain working conditions are also present, to verify how they are handled by the test target. Every requirement or objective the test target is expected to achieve, needs at least one test. An expected result is outlined and the actual result is compared to it in order to assess the test success.

...

Automated Tests are executed through an external tool which controls the execution of tests and the comparison of actual outcomes to predicted outcomes. They can automate some repetitive tasks in a formalized testing process already in place, or add additional testing that would be difficult do perform manually. The following automated Test types are available:

• Cucumber
• Generic

In JIRAJira's administration, you may add other values (see list bellow) for the "Test Type" custom field , for example if you (see list below). For example, you may want to differentiate automated tests that may exist simultaneously in a project.

...

Note: other values for the "Test Type" custom field values not shown above are not supported.

Cucumber

Cucumber is a tool that executes plain-text functional descriptions as automated tests. The language that Cucumber understands is called Gherkin, which is a Business Readable, Domain Specific Language that describes a business-readable, domain-specific language that describes the software’s behavior without detailing how that behavior is implemented. It is a line-oriented language that and uses indentation to define structure. Line endings terminate statements (e.g., steps). Either spaces or tabs may be used for indentation (but spaces are more portable). Most lines start with a keyword.

Reference cucumber site

For more information on the Cucumber Basics, please consult the Wiki and Tutorials at: http://cucumber.io

...

•  Scenario,  a set of instructions exclusively composed by constant values, which, when executed by a tool, will only give a static result . (e.g.: , 2 + 3 = 5)
•  Scenario Outline,  a generic set of instructions containing variables, which, when executed by a tool, will prompt varied results according to the specified input.

- On the  Steps  Field, is inputted the behavior to The behavior to be reproduced by the Cucumber tool in entered in the Steps field.

Generic

A Generic Test is an automated agnostic Test that is executed by an external tool. Execution results will then be imported back to JIRAJira. An example might be a JUnit test that is used for quality assurance.

...

The only Field that is related to a Generic Test is it's its Definition. Here, the automated external test may be defined or referenced through an open text field. 

...

The Generic Test Definition field supports the JIRA Jira markup wiki language.

Manual

Manual Tests are user-assisted tests, listing an assortment of guidelines the user must follow, and the results such behavior is expected to accomplish. After performing the test as instructed, If the actual test result is compared with matches the expected test result, and if the they positively match, the test is considered as passed, and if they don’t, the test is considered ; otherwise, it is marked as failed.

Fields

Manual Tests are segmented in Manual Steps. Each Manual Step is composed with of 4 fields - (Step, Data, Expected Result and Attachments - being the Step field ) with Step being the only mandatory one that’s mandatory;.

• In the Step Field, is inputted the Step - The action to be reproduced by the tester;
• In the Data field is inputted any Data - Any data the related step requests (pe.eg., login credentials) to be used by the tester;tester 
• In the Expected Result is inputted the behaviour the - The behavior the step should accomplish;accomplish 
• The Attachments are external - External files that provide additional information related with the corresponding Manual Step. Attachments can only be added or removed in the Test Issue view page.

...

The Step, Data and Expected Result fields support the JIRA Jira markup wiki language.

Actions

...

In order to create a new Test Issue the user must:, 

Step 1: Click the Create Issue at the top of the screen to open the Create Issue dialog box / page.

...

Step 2: Select the  Project  and on  Issue Type select Test,  select Test.

Step 3: Under the General tab, type a Summary for the test and fill any all appropriate fields — mandatory fields are at least, the mandatory ones marked with an asterisk.

Step 4: On the Test Details tab, select the Test Type and complete any all appropriate fields;

Step 4a: If you are writing a Manual Test:
- Select the Test Type as Manual;. 
- After filling out the Manual Steps Fields fields, press the Add button to jump to the next Manual Step;. 
- Use the Pencil button to edit a previous inputted previously entered Manual Step, and in the end press the Update button ;when done. 
- Use the Bin button to delete a previous inputted entered Manual Step;.
- To change a Manual Step position in the Test, grab drag the left area on of the left of it's row and move drop it to the desired place;.

Step 4b: If you are writing a Cucumber Test:
- Select the Test Type as Cucumber;. 
- On Cucumber Type, select test type between either Scenario or Scenario Outline ;as test type. 
- On Cucumber Scenario, enter the Cucumber Scenario clauses in Gherkin;.

Step 4c: If you are writing a Generic Test:
- Select the Test Type as Generic;.
- On Generic Test Definition enter , enter the definition for the automated generic Test;.

Optional:
- Click on the Test Sets tab to associate the current issue with Test Sets;.
- Click on the Pre-Conditions tab to associate the current issue with Pre-Conditions;.
- Click on the Test Plans tab to associate the current issue with Test Plans;. 
- Click on the Link Issues tab to Link link with other issues and specify the nature of the association;.
- To create a series of similar tests – in within the same  Project  – select check the  Create another  check box at the bottom of the dialog;. 

Step 5: When you are satisfied with the content of your test, click the the Create  buttonbutton.

Step 5a: If you selected the checked the Create another check box (above), a new new Create Issue  dialog dialog appears. This issue is automatically pre-populated with your previous test details, while leaving the the Summary  field field blank.

Edit

Editing an existing Test can be done using either in one of the following procedurestwo ways:

• Using the Edit Issue dialog box
• Using the Inline Edit for JIRA Plugin

...

Step 3a: If you are editing a Manual Test:
- To input a new Manual Steps field, use the empty areas at the bottom and press click the Add button;.
- Use the Pencil button to edit a previous inputted Manual previously entered Manual Step, and in the end press click the Update button ;when done.
- Use the Bin button to delete a previous inputted previously entered Manual Step;.
- To change a Manual Step position in the Test, grab drag the left area on the left of it's that row and move drop it to the desired place;.

Step 3b: If you are editing a Cucumber Test: 
- To change test type on Cucumber Type select between , select either Scenario or Scenario Outline;.
- In the Steps field, you can edit previous inputed, a previously entered or create a new , Cucumber Cucumber Scenario clauses in Gherkin;.

Step 3c: If you are editing a Generic Test:
-In the Steps field, you can edit previous inputed, a previously entered or create a new , Definitions Definition for the automated generic Test;.

Optional:
- Click on the Test Sets tab to edit Test Set associations;.
- Click on the Pre-Conditions tab to edit Pre-Condition associations;.
- Click on theLink Issues the Link Issues tab to edit Links with other issues;.

Step 4: Click the Update button to save your changes.

...

Xray Test issue sections support inline editing similar to JIRA Jira native and custom fields inline edit. This prevents full page reloads when modifying fields.

Inline Edit Fields

To inline edit a field, just hover over the field view area and click it.

The following Test fields support inline edit:

• Type: the The Test issue type
• Definition: The automated generic test definition (only visible for Generic tests)
• Cucumber Type: The Cucumber Scenario type (only visible for Cucumber tests)

To inline edit automated Test issues:

Step 1b: If you are Inline inline editing a Cucumber Test: 
- You can hover on over the actual Test Type, click it, and change it for to another type that is available on the select box;.
- You can hover on over the actual Cucumber Type, click it, and change it for to another type that is available on the select box;.
- You can hover on over the Steps field, click it, and edit the its contents;.

Step 1c: If you are Inline inline editing a Generic Test:
- You can hover on over the actual Test Type, click it, and change ir for it to another type available on the select box;.
- You can hover on over the Definition field, click it, and edit the its contents;.

Notes: On JIRA On Jira versions greater or equal to 7.3.0, the definition Definition field supports Jira's Rich Text Editor. To enable the Rich Text Editor, you have to set the renderer of the definition custom field to  Wiki Style Renderer.  Its It is also possible to use Rich Text Editor on JIRA on Jira versions greater than 7.2.0 by enabling the experimental Rich Text Editor in JIRA in Jira configurations, but this feature its is not totally supported by Xray.

...

Add Steps: After entering the Test step details (Step, Data and Expected Result fields) using the bottom table row text boxes, click on the Plus icon for creating a new step. The new step will be added in the last position in the steps table. 

Remove Steps: The last column for each step contains a Bin button for removing steps. After clicking the button, you will be prompted with a confirmation message to delete the step. This operation cannot be undone.

Edit Steps: When hovering over Step, Data and Expected Result fields, they highlight get highlighted and if you click them, the step row visualisation visualization will change to edit mode. From here, you can edit the fields and click on the Update button that appears in the last column to save changes or you can cancel the changes by clicking on the cancel Cancel button. Either way, the row will be back in View mode.

Move Steps: You can move a Test step Up or Down in the Test steps table from in one of two different ways:

• • Clicking Click on the drag area in the first column of each step and drag the step to the desired position.
  • Clicking Click on the actions menu and choosing the "Move To.." option. This method allows you to directly move a step to a specific position.

Add Attachments: While in View or Edit modes, you can add attachments to a step using the Plus sign appearing in the Attachments column. After clicking the button, you will be prompted with a dialog to choose the attachments to add.

Remove Attachments: While in View or Edit modes, you can remove attachments of Test steps using the Bin button that appears when hovering over existing attachments. After clicking the button, you will be prompted with a confirmation message to remove the attachment or not the attachment.

Copy Step Fields: You can copy the Step, Data and Expected Result fields to the clipboard by hovering over these fields and choosing the Copy icon next to each highlighted field. If the copy is successful, a green border will appear momentarily around the Copy icon.

Expand Fields: If the text boxes are too small to show all the information, you can expand the Step, Data and Expected Result fields by clicking the Expand icon next to each highlighted field. An inline dialog, with a bigger area, will be opened with the contents of the field and a wiki notation toolbar to assist you in writing your information. This operation is available in both View and Edit modes for manual Test steps. 

Clone Steps:  You can To clone an existing test steps. To clone a Test step, click on the actions menu and choose the "Clone" option. A confirmation message will be promptedappear. You Once you confirm, a new step will be created in the last position, containing all information of the cloned step (stepStep, dataData, expected result Expected Result and attachmentsAttachments).

Changing the Type of a Test

Xray provides the ability in the Global Preferences to configure if the In the Global Preferences, Xray allows you to configure if a test definition is deleted or not.

If this option is enabled, the previous Info details will be deleted.

Otherwise, the Info details will not be deleted, and it'll be possible to undo the Test Type change operation keeping and keep the previous information.

Additionally, in both cases, because each pre-condition must be of the same Type of the Test, any associated Pre-Conditions will be lost.

...

Cloning a Test issue creates a new Test with all the information of the cloned Test, except it's its executions. Therefore, the cloned issue will not be associated with any Test Execution issue.

...

...

...

...

Step 3: Type a Summary for the Pre-Condition and complete any all appropriate fields — at least, the required ones which are marked by an asterisk.This issue is automatically pre-populated with your previous Test issue Fix VersionsVersion/s.

Step 4: On the Pre-Condition Details tab, complete any all appropriate fields. This issue is automatically pre-populated with your previous Test type.

...

Select Pre-Condition Issues -  In order to select the Pre-Conditions to be associated, you can:

- Input the desired Pre-Condition Issue Key on the Pre-Conditions field;.
- Click on the Down Arrow on the Pre-Conditions field and select the Test Set from its History Search list;.
- Click on the + button wich which will prompt an Issue Selector Pop-Up;. 
- Click on the Search tab to use the Find JIRA Jira issues browser;.

Search  Pre-Condition  Issues -  In order to search for Pre-Conditions to be associated you can, under the Search tab:

- Browse for the desired Pre-Condition Project or terms it Contains;.
- Click on the More button to add more browse fields such as Label, Fix Version, Saved Filter and Workflow Status;.
- Click on the Magnifier button after filling the browse fields , to get a list of matching entries;. 
- Click on the Advanced button to perform a JQL search;.

Step 4: Click Add.

Remove Pre-Conditions

...

Step 1: Open the Test you wish to remove the association with a Pre-Condition association.

Step 2: On the Pre-Conditions table, hover over the desired Pre-Condition row and click on the Trash button that appears in the end of the row. You will be prompted with a confirmation dialog.

...

Export to Cucumber

Cucumber Tests in JIRA Jira can be exported to feature files ready to be executed in Cucumber. The generated feature files follow the rules defined in Export Cucumber Features and take into account the context of the JIRA Jira Test issue.

A single Cucumber feature file should be generated and prompt to be downloadedprompted for download, unless the target Test is associated with multiple Requirements, which, in that case, will prompt a FeatureBundle zip file containing a single Cucumber feature file for every Requirement associated with the target Test.

To export a Cucumber Test issue to feature files, the following steps must be taken: 

Step 1: Open the Cucumber Test issue view page. 

...

Xray Test issues can be exported to XML. This export differs from the JIRA Jira default action for exporting to XML. Rather that than exporting all fields, the Xray export action will only export to XML the most relevant fields for Tests, such as the Test definition fields, Pre-Conditions and some issue-tracking information.

To export a Test issue to XML, the following steps must be taken: 

Step 1: Open the Test issue view page. 

...

To export a Test Run to CSV, the following steps must be taken: 

Step 1: Open the Test issue view page. 

...

Automated Generic Test issues can be exported to a plain text file. Only the Test Definition field will be included in the plain text file. This action can be useful to execute when executing a Generic Test externally from JIRAoutside of Jira.

To export an Automated Generic Test definition to plain text, the following steps must be taken: 

Step 1: Open the Automated Generic Test issue view page. 

...

Test Steps can be imported from external sources such as:

• • Test
  • CSV
  • JSON
  • Clipboard

The user You can configure which columns he wants you want to import along with if he wants , including if you want to override the steps already present in the Test.

...

The import from tests dialog allows the user you to choose which steps he you wants to clone from a given test and a checkbox to allow to user to choose if he wants you want to override the steps already present on in the testTest.

From CSV

The import steps from the CSV dialog allows the user you to choose the file that he you wants to import the steps from, the delimiter that is used in the csvCSV, a dropdown to specify which columns column layout the steps present in the file have, a checkbox to specify if the file has header or not, and a checkbox to allow to user you to choose if he you wants to override the steps already present on in the testTest.

From JSON

The import from json JSON dialog allows the user you to specify which file he you wants to import the steps from and provides the user with a checkbox that allows him to choose if he wants if you want to override the steps already present on in the testTest.

The json JSON file should be an array of step objects this . The objects should have the field step and can optionally have the fields data and result. Bellow you can see Below is an example of a valid json file:

[
   {
      "step":"Step 1",
      "data":"Data for Step 1",
      "result":"Result for Steps 1"
   },
   {
      "step":"Step 3",
      "data":"Data for Step 3"
   },
   {
      "step":"Step 4",
      "result":"Result for Step 4"
   },
   {
      "step":"Step 2"
   }
]

...

The import from clipboard allows the user you to copy the steps from Excel or CSV and paste them in the dialog. The dialog allows the user to You can choose if he wants you want to use the default excel Excel delimiter or use a custom one, if the user wants you want to copy steps from csv, to CSV. You can choose which column layout the steps in the file have and also provides the user with a checkbox that allows him to choose if he wants provides a checkbox if you want to override the steps already present on in the testTest.

After the steps are pasted in the dialog, it will displayed a display the previous version of the steps in the same dialog.

...

Manual Test Steps can be exported to CSV by clicking the “Export Steps” button , in the Test Details section of the Test.

...

The result will be a CSV file containing the Step, Data and , Expected Result columns and, if this options has been the option is selected, the Attachments column that contains the attachments links.

...