Menu

Quick Start Guide


qTest Scenario - BDD for Jira

qTest Scenario - BDD for Jira is a free add-on that provides end-to-end support for Behavior Driven Development (BDD), Test Driven Development (TDD), and Acceptance Test Driven Development (ATDD).  qTest Scenario increases tester productivity and is the first and only Jira plugin to manage the end-to-end workflow from test creation to test execution - all inside of Jira.  

qTest Scenario enables teams to optimize and scale a Test-First approach across your entire organization.  Your team can see the progress of testing within each sprint or release.  qTest Scenario’s built-in Gherkin editor lets you to build features and scenarios directly in the plugin.  These features and scenarios are stored and managed in the GitHub source repository.

IMPORTANT: If you use qTest Pulse, other qTest Scenario features are available for qTest Pulse users.  The features described in this document are all included in the free version of qTest Scenario.  

Installing qTest Scenario - BDD for Jira

To install qTest Scenario, perform the following steps in Jira.

  1. Select settings in the left panel.




  2. Select Add-ons in the left panel.



  3. Type ‘Scenario’ in the Search the Marketplace field.  The results of your search are displayed under the Search field.   


  4. Click the Install button for the qTest Scenario for Jira add-on.  The Confirm add-on installation pop-up window is displayed.  

  5. Click the Accept & Install button.  The following screen is displayed.  



    When the qTest Scenario add-on has been installed, the following screen is displayed.   



  6. Click the Close button.  The Atlassian Marketplace for Jira screen is displayed.  

Enabling qTest Scenario

Now that you have installed qTest Scenario, you must enable Scenario in order to use it.  To do so, follow the steps shown below from the Atlassian Marketplace for Jira.

  1. Click the Manage add-ons option located in the left panel of the screen and then select the qTest Scenario add-on in the User-installed add-ons area of the screen.



  2. Click the Free trial button to activate and then select Get started to watch a quick video

Setting Up Scenario in a Project

After installing the qTest Scenario plugin and enabling it, you must configure the qTest Scenario settings on a per project basis in order to use Scenario in that project.  The first time you use qTest Scenario, you will also be prompted to enter your GitHub username and password and select your preferences.  

IMPORTANT: To set up qTest Scenario in a project and use Scenario, the GitHub Administrator must have turned on GitHub for the project and assigned the user his or her credentials in GitHub.  The user must be a collaborator on that GitHub project and the administrator must grant the user push access.  

Select Project to Configure 

To set up Scenario in a project, perform the following steps.  

  • On the Projects page, select the project in which you want to set up qTest Scenario.  In this example, we will select the Coffee Shop project.    

    Select_Project.png

  • On the Open issues page for the selected project, click the Project settings option located at the bottom of the left panel.  

    Select_Setting_in_Project.png

On the Project Settings page, click the qTest Scenario option located at the bottom of the middle panel. 

Then select Congifure your Project button to enter the setup wizard.



Connect to GitHub

  • Enter your Git Repository Url and chose Github for Git Provider.  This displays the URL of the repository where the Scenario Gherkin editor will store your qTest Scenario feature files for this project. The repository must be public.  

    NOTE: The GitHub repository must have been previously created.  The GitHub URL used for one project can differ from the GitHub URL used for another project.  

  • The Feature File Folder field displays the folder name where your feature files will be stored in the repository then Click Next.  (If you wish, you may specify a subfolder in the filename’s path.)      

  • The Default Branch field is to designate which branch your feature files will be stored.  For most cases, your default branch will be titled "master" but you can change this field if your VCS has a different default branch title.   

  • In the Editor issue types area, select the applicable checkbox(es) to enable the Scenario Gherkin editor for that issue type.  In this example, the ‘Story’ checkbox has been selected; therefore, the Scenario Editor will be displayed in all Jira tickets with an issue type of ‘Story’ in this project.   
  • After you select your Jira issues that will be connected to qTest Scenario, you will need to sync any existing features files by logging into Git repository.  This allows your existing features files to be searched and scenario steps to be autocompleted when you start using the add-on. 
  • Once you have finished the setup wizard, the Webhook field is needed to insert into the Webhook area of your GitHub project.  This webhook must be configured in order to make sure any file changes in GitHub will correctly correspond with Jira issues. 


 

Connect to Bitbucket Cloud

  • Enter your Git Repository Url and chose Bitbucket Cloud for Git Provider.  This displays the URL of the repository where the Scenario Gherkin editor will store your qTest Scenario feature files for this project.

    NOTE: The BitBucket repository must have been previously created.  The repository must be public.  

  • The Feature File Folder field displays the folder name where your feature files will be stored in the repository.  (If you wish, you may specify a subfolder in the filename’s path.)   
  • The Default Branch field is to designate which branch your feature files will be stored.  For most cases, your default branch will be titled "master" but you can change this field if your VCS has a different default branch title. 

  • In the Editor issue types area, select the applicable checkbox(es) to enable the Scenario Gherkin editor for that issue type.  In this example, the ‘Story’ checkbox has been selected; therefore, the Scenario Editor will be displayed in all Jira tickets with an issue type of ‘Story’ in this project.   

  • After you select your Jira issues that will be connected to qTest Scenario, you will need to sync any existing features files by logging into Git repository.  This allows your existing features files to be searched and scenario steps to be autocompleted when you start using the add-on. 
  • Once you have finished the setup wizard, the Webhook field is needed to insert into the Webhook area of your Bitbucket project.  This webhook must be configured in order to make sure any file changes in Bitbucket will correctly correspond with Jira issues. 



Connect to qTest Pulse (Advanced Features)

qTest Scenario works as a free standalone for public repositories.  However, for enterprises looking to scale the BDD processes with private repositories, enterprise reporting, and BDD workflow automation, qTest Pulse is the best solution to pair wit qTest Scenario. 

For more information on qTest Scenario + qTest Pulse, request demo here.

  • Select Enable Advanced Features button and then enter in your qTest domain, username, and password. 

Login to Git on Jira Issue

The first time you use qTest Scenario, you are prompted in the Scenario Editor to enter your personal preferences for qTest Scenario across all projects.  Enter your Git username and password and specify the Font Size and Theme you wish to use.  Each user is prompted to enter this information one time and the preferences selected in this project will apply for the user across all Jira projects in which you will use qTest Scenario.  These are your personal preferences for qTest Scenario across all projects.   

HINT: If your account has two-factor authentication enabled, you should use a personal access token with public_repo in place of your account password.  For more details, please see: https://github.com/settings/tokens

Click the Save button.  The following message is displayed.

NOTE: You can change your preferences at any time.  To do so, click the Settings icon, located in the upper right of the Scenario Editor, and update your preferences.  

Using qTest Scenario

This section shows how to use q Test Scenario.  We begin by selecting the applicable issue on your configured Jira project. In this example, we used the 'User Story' issue type in the 'Coffee Shop' Jira project.

  1. From the System Dashboard, click create new User Story Issue Type.



  2. After the issue is created, select the Jira ID.



  3. Click the issue identifier located on the top of the right panel to fully open the issue.  (In this example, the issue identifier is CS-4.).  

    IMPORTANT: You must fully open the issue to display the Scenario Editor panel at the bottom of the Jira ticket.

    The following screen shows the Scenario Editor before you enter any text in it.  qTest Scenario automatically displays Feature: on the first line.  The Scenario Editor is used to type descriptions of behaviors you want to implement and test.  



  4. To start using qTest Scenario, type the feature name on line 2, to the right of the colon.

    For a new issue, notice the text box above line 1 is auto-populated with the name of the feature file to be stored in GitHub based on what you type on line 2.  A feature file is used to describe a single software feature.  If you prefer to enter your own text in the text box, above line 1, qTest Scenario will no longer auto-populate the field.  In either case, Scenario will automatically append .feature to the filename displayed in the text box above line 2.  


    HINT: The Scenario editor highlights Gherkin keywords in blue, such as Feature, Scenario, Given, When, And, Then, and But.  

    The following example shows a feature called "Coffee Shops should be closed on Tuesdays in December."  The scenario name for the feature is "Based on low coffee sales, coffee shops should be closed."  The scenario is valid because valid Gherkin syntax is used.  



  5. When you are satisfied with your work, click the Save button located at the bottom of the Scenario Editor.  The message ‘Successfully saved feature file’ is displayed.  The feature file is saved in your Git repository in the location you specified during setup.   

Error Recognition

If you type invalid Gherkin syntax, Scenario will prompt you by displaying a red x on the left side of the line to indicate you must correct your work before saving.  

Step Completion

As you type a step, if Scenario finds previously-saved text that matches the text you are typing, an in-place drop-down list is automatically displayed that shows you the previous work.  You can select an item in the list to enter that text on the line you are typing.  

This feature, known as 
step completion, is used to help maintain consistency across Jira issues.  
HINT: You can also “nudge” Scenario to display a drop-down list.  To do so, type a keyword, followed by a space, followed by the key combination CTRL space.  You must type a space after typing the keyword for Scenario to consider it a valid step.  

In the following example, we will enter a scenario called "Based on low coffee, sales, coffee shops should be closed."  On the next line, we will type the keyword (Given) followed by a space, followed by CTRL space.  A drop-down list of all cases of steps where this keyword was previously used is displayed.   

HINT: The feature file must have valid syntax for Scenario to display these suggestions in a drop-down list. 

Tag Completion

A tag uses the syntax @[tag name] and is used to group scenarios.  qTest Scenario provides tag completion.  For example, if you type @c, any tags you previously used that begin with @c are displayed in an in-place drop-down list.

The Scenario editor highlights tags in green.  It also highlights placeholders, angle bracket syntax, and data tables in green.

Name Conflict Error

If a feature filename for the new issue already exists in GitHub, Scenario will prompt you by displaying the following error message.  

You can click the ‘Rename Your File’ option to rename the current feature file, and click the Save button.  Alternatively, you can click the ‘Link to Existing File’ option to link the new issue to the existing feature file.      

Search Feature Files

The Search feature is used to look for existing feature files stored in GitHub.  You can then reuse the feature file by linking to it or copy the contents of the feature file into the current issue.  To use the search function, perform the following steps.

  1. Click the Search icon (the magnifying glass) located in the top right of the Scenario Editor. 


    A search window opens.  The left panel lists previously saved feature files stored in GitHub for this project.

  2. Select a feature file in the left panel to display the contents of the feature file in the right panel.  



    You can also search for a feature file by clicking the Search icon in the top right of the Scenario Editor, typing some text in the Search field, and pressing the Search button.  In the example shown below, ‘coffee’ has been entered in the Search field.  Scenario searches the contents of the feature files stored in GitHub for this project.   

    You can select the desired feature file from the list to display the content of the feature file in the right panel.  Then, you can either link to the feature file or copy it.




Linking to an Existing Feature File

After using the search feature to select a previously used feature file that is stored in GitHub, you can link to the feature file as follows.  Perform the following steps from the Search window.

  1. Click the Link to Issue button.  The Search window closes and the Scenario Editor is redisplayed for the current Jira issue.


  2. Click the Save button to save the feature file in the current Jira issue.

    HINT: The current Jira issue will share the same feature file with a previously-created Jira issue.  If the feature file is edited, the changes will apply to any Jira issue that shares the feature file.

Copying an Existing Feature File

After using the search feature to select a previously used feature file that is stored in GitHub, you can copy the contents of the feature file to the current issue.  Perform the following steps from the Search window.

  1. Click the Copy Contents to Issue button.   The Search window closes, the Scenario Editor is redisplayed for the current Jira issue, and the feature file you selected is displayed in the editor.  



  2. Click the Save button to copy the contents of the feature file to the current issue.  qTest Scenario creates a new feature file with a unique filename in the GitHub repository.  Any subsequent editing changes you make to the new file apply to the current issue only.    
Subscribe To Our Blog
Powered by Zendesk