QMetry BDD Installation Guide (Offline using Docker)

This guide walks you through the installation process of QMetry BDD.
Setting up QMetry BDD with your on-premise QMetry Test Management (QTM) installation enables seamless integration of behavior-driven development practices into your testing workflow. With QMetry BDD, you can manage feature files, automate test executions, and streamline collaboration between business and technical teams.

QMetry BDD Installation Options

You can install QMetry BDD on the same server where the QTM Application is installed.

Pre-requisites for the Installation

Before installing QMetry BDD, ensure the following:

QMetry Application should be pre-installed. Refer QMetry and Reports Installation on Linux - 2 Tier. Follow Steps 1 to 7 (up to Enter Base URL) mentioned in the Install QMetry Application section. Please note that Step 7 is mandatory.
Active MQ server is configured with QTM Application.
All the servers must support the commands: unzip, curl, vim.
Internet access is enabled on all servers to install using docker.
Ensure Proxy servers are not blocking downloads.
Docker installation requires root user access.
Get QMetryBDD.zip file from QMetry Support.
The following should be installed on the server:
- CentOS, RHEL-7 and RHEL-8
- Docker Version 20.10.13
- Docker Compose Version v2.5.0
- Yum-tools
Make sure that the docker service has been configured on the server to start automatically on reboot of the server.

Required Ports

Installation	Ports that need to be enabled and should be available for use

Installation	Ports that need to be enabled and should be available for use
Active MQ Server	8181 & 61616

Download Docker Images of BDD Server

On an Internet-enabled machine, download the BDD Server Docker image by following these steps:

Run the following command. Next, it will ask for docker's credentials. Enter the credentials. Please contact QMetry Support, if you do not have the credentials.

docker login

Run the following commands to pull QMetry BDD docker image from the docker repository.

docker pull qmetry/qmetry:bdd_latest

The download has started. Wait until it finishes.

Run the following command to confirm the Docker image was downloaded successfully.

docker images

Run the following command to save the BDD Server Docker image as a .tar file. You can change the file path if needed."

docker save -o /opt/qtm/qmetrybdd.tar qmetry/qmetry:bdd_latest

Transfer the qmetrybdd.tar file to QMetry BDD Server.

Installing QMetry BDD Server

Get the QMetryBDD.zip file from QMetry Support and copy it to the server for BDD installation.

Follow the steps mentioned below.

Copy the QMetryBDD.zip installation file to your server and unzip it. Navigate to the directory where these files are saved.

unzip QMetryBDD.zip 
cd QMetryBDD

Execute the following commands.

sudo su
chmod +x bdd.sh
./bdd.sh

The next question during the installation process will be as follows.

Options	Enter Value

Options	Enter Value
Do you want to make an online installation (Y/N)?	N

Users are required to enter the value of the following configuration parameters:

Prompt	Description	Example

Prompt	Description	Example
Enter QMetry Database Host IP/DNS Name	Host address where QMetry database is running. Note: In case of AWS installation enter the private IP of the AWS instance where the QTM Application's database is installed.	`localhost`
Enter QMetry Database Port	Database Port Number	`3306`
Enter QMetry Database Schema	Name of the database/schema QMetry will use.	`qmetry`
Enter QMetry Database UserName	DB user with read/write privileges on the schema.	`root`
Enter QMetry Database Password	Password for the above DB user.	`********`
Enter ActiveMQ Host URL	Host URL of ActiveMQ messaging service.	`localhost:61616`
Enter ActiveMQ UserName	Username for ActiveMQ authentication.	`admin`
Enter ActiveMQ Password	Password for ActiveMQ user.	`********`
Please enter full path of .tar file for docker image	For offline upgrade, mention the directory path of .tar file for docker image.	`/opt/qmetrybdd.tar`

The installation may take a while.

Once the installation is complete, execute the following command.

docker ps

The following message will be displayed.

If you are facing any issues during the installation process, kindly generate a support ticket on the Support Portal for assistance.