BDD Implementation

Enterprise teams practicing Behavior-Driven Development (BDD) can author, store, and sync feature files directly to or from Version Control Systems (VCS) like SVN, Git, GitLab, Bitbucket, and Azure DevOps, using the built-in Gherkin editor.

The two-way syncing between and VCS keeps developers, testers, and product owners up-to-date with the latest source code change commits with automated step definitions. Using automation agents, testers can trigger test executions directly from .

Test cases are smartly authored based on the feature step definitions and linked to requirements. Test Suite stores the automation execution results, ensuring complete feature traceability.

Workflow

QTM_BDD_Workflow.png

  • Business analysts or scenario writers create test scenarios for upcoming features in Gherkin.

  • Once finalized, they push the code to the repository linked with the project.

  • Automation engineers get notified when the BDD code is updated.

  • At the time of test execution, automation engineers pull the latest code from the repository and run automation tests.

  • After the automation test run -

    • The system creates automated test cases, test suites, and test executions.

    • The system updates automation test results on the Test Execution screen

Pre-requisites

You should have the following rights in :

  • Project module "Modify" rights.

  • Requirement module "Modify" rights.

You can write BDD Code in -

  • Jira Add-on

Configure BDD in

To configure BDD in , perform the following steps:

  1. Go to Project Management and select Projects.

  2. Go to the Project details page and select BDD Configuration.

  3. Click the + sign to add BDD Configuration.

    QPro_RQ_Adding_BDD_Configuration.png.png

  4. Enter the following details on the Add Configuration screen:

    • Version Control System:Select the version control system your organization uses as the code repository.

    • Type Select the Version Control System type as Cloud or Server.

    • Repository URL: Enter the repository URL.

    • Access Token: For Gitlab, Github, and Azure DevOps, enter the personal access token for authentication.

    • Username and Password: For Bitbucket or SVN integration, provide your username and password for authentication.

  5. Click Test to verify the Repository credentials.

  6. Once the Test is verified, click Save.

Note

For Bitbucket and Azure Integration, enter the cloned repository URL.

The configured version control system for BDD is displayed on the BDD Configuration tab.

QPro_RQ_BDD_Implementation_Tab__1_.png

Additional Resources

BDD in

Note

The BDD section in the Requirements module becomes visible only when a version control system is configured for the project.

Writing BDD Code in the Requirements Module

The Requirements module includes a Gherkin editor to write Test Scenarios in BDD code. Once finalized, you can push the code to GitHub, GitLab, Bitbucket, or SVN for automation testing.

QPro_BDD_Writing_BDD_Code_in_RQModule__1_.png

To write BDD code in the Requirement module, perform the following steps:

  1. Go to the Requirement Details page.

  2. Go to the BDD tab.

  3. Write the BDD code in the editor.

  4. Enter the following details:

    • Version Control: Select the Version Control System.

    • Repository: Repository populates based on the Version Control System.

    • Branch: Select the branch based on the repository selection. Branch access depends on the user who connects the BDD integration..

    • Folder Path: Select the folder to store the BDD file. If the folder path is not given, it pushes it into the root directory of the repository.

    • File Name: Enter the name of the file along with the extension. The file name should contain only characters, digits, and "_" with a file extension. No other special characters or spaces are allowed in the file name.

    • Notify Automation Engineer: Select users to notify about BDD updates. By default, all current Watchers of the requirement are selected. Add other users from the project.

    • Comment: Add notes to push the code to the repository.

  5. Perform either of the following:

    • Save: Saves the BDD content and requirement details in the database. The BDD content is saved by requirement version, not by individual entity.

    • Push: Creates a feature file with the given name and pushes it into the specified repository on the given folder path.

If you are writing BDD code while creating a requirement, then you can only save the code.

Pull Code from Repository

To pull the updated code from the repository to , perform the following steps:

  1. Open the Requirement Detail page.

  2. Go to the BDD tab.

  3. Click Pull.

After displaying the warning message, the system automatically pulls the latest code from the repository and save it in .

BDD in Jira Add-on

BDD is also implemented in the Jira add-on to facilitate test scenario creation and syncing of code directly to code repository even when requirements are imported from Jira.

The BDD panel is available in the Jira add-on for the issue types synced with "Requirement" in .

Pre-requisites

  • Install and Configure Jira Integration Add-On.

  • Configure the version control system with the Jira integrated project.

Writing BDD Code in Jira Add-on

The system displays Requirements or Stories imported from Jira with an External Key. Clicking the External Key opens the requirement detail page in the Jira add-on.

The BDD panel is also added to the requirement detail page, which allows you to enter BDD code and push the code to the repository.

QPro_BDD_Reusing_Existing_TC.png

To write BDD Code in Jira Add-on, perform the following steps:

  1. Open the Requirement Details Page in the Jira add-on.

  2. Select the Project.

  3. Locate the BDD section.

  4. Write or edit the BDD code in the editor.

  5. Click Push.

  6. Enter the requested details.

  7. Click Save to save the content or Push to create a feature file and push it into the repository.

BDD Code Execution

To execute BDD code and record results, follow this process:

  1. Write the BDD Code and push it to the repository.

  2. The system creates the file in the repository using the extension you specified in its file name.

  3. Add the repository reference in Jenkins and trigger the build from Jenkins.

  4. Jenkins publishes the build results according to the parameters you configured. Refer to Jenkins Plugin for QMetry for more details.

  5. Once the test process completes, it automatically creates the corresponding automated test cases, test suites, and test executions.

  6. updates the automation test results on the Test Execution screen.

Reusing Existing Test Cases

Reuse existing test cases for automation testing by writing BDD code in the Requirements module.

Include the Test Case ID of the existing test case in the BDD code using annotations. Specify individual test case IDs for each scenario.

  • If the test case is of "Automation" type and the test steps differ, then its version will be updated after execution of the BDD code.

  • If the test case is of "Manual" type, then its new version will be created with "Automation" type test case.

The test scenarios written in the Requirement BDD section become test steps added to the test case referenced by the annotation.

Example 4. Reusing Existing Test Cases

For example, in the BDD code, you mention Test Case ID "BDD-TC-18" with the annotation @testEntityKey=BDD-TC-18.

QPro_BDD_Reusing_Existing_Test_Cases.png

In repository

QPro_RQ_Reuse_TC_Example.png

When the BDD code executes:

QPro_RQ_Reuse_TC_Example.png

  • If Test Case ID "BDD-TC-18" is a manual test case, then its new version will be created as an automated test case.

  • If Test Case ID "BDD-TC-18" is an automated test case, a new version will be created if there are differences in test steps.

Finally, the system adds the test scenarios from the BDD code as test steps to the specified test case.



Linking Test Cases to Requirements

After executing the BDD code, the system either creates a new automation test case or updates an existing one. To track test coverage, link these test cases to their corresponding requirements.

To link a test case to a requirement, include the Requirement ID in the same test scenario of the BDD code where you mention the Test Case ID. Use annotations to specify both IDs.

When you include both the Test Case ID and Requirement ID annotations in the same BDD code, the system automatically links the created or updated test case to the specified requirement.

Example 5. Linking Test Cases to Requirements

In the BDD Code

  • Annotate the Test Case ID as @testEntityKey=BDD-TC-18.

  • Annotate the Requirement ID as @requirementKey=BDD-RQ-480

    QPro_Linking_TC_to_RQ.png

Go to the Requirement Details page and select the Test Case tab and verify that the test case is linked to the requirement.



In this section:
© 2025
Publication date: