How to Use qTest Scenario in Jira


Note: This article contains legacy information for Scenario versions earlier than 2.1.0. For updated information on Scenario 2.1.0 and beyond, please refer to this article.

With qTest Scenario, teams can easily collaborate on Jira issues to create their features and scenarios through a native Gherkin editor experience.  

Some of the benefits of using qTest Scenario editor include:

  • Better collaboration and standardization of all feature files connected to your BDD framework.
  • Facilitates autocompletion of tags which makes sure your features are organized correctly. 
  • Facilitates autocompletion at the step level for better reuse of previously implemented steps. 
  • Syntax checking and error handling directly in Jira keep teams from making mistakes. 

Once you install and configure Scenario, you are ready to begin.

How to Use qTest Scenario in Jira

  1. Navigate to your Jira backlog and select the appropriate project.
  2. Create an Issue.
  3. Enter your Issue criteria.
    Note: The Description field is unnecessary to complete because your acceptance criteria for your requirements are described as the test.
  4. Select Create.
  5. Select the newly opened ticket from your backlog.
  6. If you have not previously entered your Git information, or haven't done so recently, you will be prompted to re-enter your username and password. This is because the user that is using the Scenario plug-in will be directly changing the Git Repository.
    • Important: If you are using SSO, your Git Password with be your Git API Token instead of your personal Git Password.
  7. You will notice that the Scenario add-on will display near the bottom of the screen.
  8. In the Feature section of the Scenario plug-in, enter the file name that will create a feature file in your Git repository. The feature file name will autocomplete in the directory. If you are using nested folders, you will include the folder name in your file name.
    Example: /path/here/name.feature

    Note: If the feature name directory already exists, qTest Scenario will notify the user upon Save.  This helps limit the mistake of overwriting existing feature files in your VCS.
  9. Enter a description of the Feature.
  10. In the Scenario section, enter the name of the Scenario or the name of the test case, that will display in Manager.
  11. Initially, enter the syntax of the Scenario steps to complete the test case, i.e. Given, When, etc. (The second test case and beyond, the syntax portion will auto-complete. You will have the option to use an already saved Syntax, or you can write a new one.)
  12. Save.

qTest Scenario Highlights

qTest Scenario has the ability to speed up scenario creation inside of Jira while also maintaining a correct syntax structure. Below are these features:

Autocomplete Steps

The ability to autocomplete scenario steps is a huge time saver for new test scenario creation.  Simply begin by typing any word in your Gherkin Given-When-Then steps to see existing steps displayed as suggestions. (These steps are saved after you begin using Scenario. As you continue to use the product, your 'library' of steps will grow.)

Example: Enter "coffee should" after And to view all scenario step options.

Autocomplete Tags 

The ability to autocomplete feature tags helps organize your scenarios is an easier manner.  Simply begin typing an "@" and a letter to see any existing tags displayed as suggestions.

Example: Enter "@c" and view all tag options available.

Syntax Checking

To make sure you are following proper Gherkin syntax, as qTest Scenario will enforce syntax checking. This limits the ability to create invalid scenarios in our BDD framework. 

Example: Enter invalid syntax and notice the error message.

Save to Git Repository 

Once you save, your feature file will be sent directly to your repository location that was defined when you configured Scenario. 

  1. Now that you have saved and your Git repository commit has been updated with the file entered in qTest Scenario, any changes that are edited in your Git repository will also be synced back into Jira. 
    Hint: If you have the triggerJenkins Pulse Rules set up, you could have the rule pick up here to notify Jenkins of a new job.
  2. View update in VCS.
    Example: GitHub
  3. Edit the feature file in VCS.
  4. View update in Jira.



Powered by Zendesk