Configure and Use Scenario in JIRA


After installing the qTest Scenario plugin, you must configure the Scenario settings on a per project basis to use Scenario in that project. The configuration will allow you to link your Jira project, Scenario, and your Git repository. The first time you use qTest Scenario, you will be prompted to enter your Git username and password and select your preferences.  

IMPORTANT: To configure qTest Scenario in a Jira project and use Scenario inside of Jira, the Git Repository Administrator will need to turn on your Git repository for the Jira project and assign the user(s) his or her credentials in the Git repository.

The user(s) must be a collaborator on that Git project, and the administrator must grant them push access.  Currently, Scenario integrates with:

  • Bitbucket
  • GitHub
  • GitLab
    Note: When integrating with GitLab, you must use a Personal Access Token instead of a Password. To learn how to retrieve your Personal Access Token, refer to this article.

How to Configure Scenario

  1. Open your Jira application.
  2. Select the Jira Project for which you would like use Scenario.
  3. Navigate to the Settings tab for the Jira project.
  4. Scroll down within the Jira Project settings column, and select qTest Scenario
  5. The "Project Settings" page displays.
    Note: The webhook displayed here is your Scenario webhook. You will use this to connect to your Git Repository.
    Note: The picture here shows an Enterprise Settings tab. Please note that this will not show up unless you have enabled Enterprise Features. More on this in the Enable Enterprise Features section.

Project Settings

  1. Select Configure your Project.
  2. The "Configure Your Project Settings" dialog displays. Input the following:
    • Git Repository URL
    • Git Provider: choose the appropriate server environment
    • Feature File Folder: provide the directory path for the highest level feature file directory.
    • Feature File Extension: Choose either the .feature or .story extension. 
      Note: Even though Scenario offers a .story extension, JBehave syntax is still not supported.
      • IMPORTANT: For versions 2.3.0 and beyond, qTest Scenario now supports JBehave syntax. Refer to the 2.3.0 Release Notes for more information.
    • Git Username
    • Git Password
      : If you are using SSO, your Git Password will be your Git API Token instead of your personal Git Password.
  3. Select Next, and choose your Default Branch to commit your code. This is the repository code branch where your features files will be entered.

  4. Select Next, and choose your Editor Issue Type(s). The issue type(s) selected here will be the default for the Scenario gherkin editor.

  5. Select Next, and you will receive a message validating your setup is complete. Save.
  6. Now your Scenario application is configured with your Jira application.

Enable Enterprise Features

Select the Enable Enterprise Features button if you are using a private repository and the paid version of Scenario.

  1. Enter the following:
  • qTest Domain
  • qTest Username
  • qTest Password

  1. Select Ready.
  2. Your Enterprise Features are now enabled for qTest Scenario, and you will have an  Enterprise Settings tab within your Scenario plugin.

Enterprise Settings

To access these settings, select the Enterprise Settings tab right next to the Project Settings tab.

  1. Input the following information: 
    • qTest Domain: enter your qTest Pulse URL
    • Scenario Project Id: this is unique for each Jira project configured with Scenario. You will input this as a Pulse Constant.
    • Actions: used to configure Scenario with the Trigger Jenkins Pulse Rule. To add a new Action, do the following:
      1. Select the New Action button.
      2. Ensure the Active checkbox is selected.
      3. Name the Action.
      4. Input the Webhook Endpoint which is the Pulse Event webhook associated with the Pulse Rule you are configuring with Scenario.
      5. Save

Use Scenario in JIRA

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. 

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. 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.
  8. Select your branch.
    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.
    IMPORTANT: Users cannot change an already existing feature file's name from within Jira.
  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. Select 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.)Autocomplete.png

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: BitBucket
  3. Edit the feature file in VCS.
  4. View update in Jira.




Powered by Zendesk