How to configure QMetry Agent?

Introduction

QMetry Agent for Test Automation help users to run and schedule automation project through registered agents. It runs the automated project at scheduled time on hosting machine and generates the test results which can be pushed into the QMetry using methodologies like QMetry Result Push API, Jenkins, Maven, other CI/CD tools.

User can define Agent Alias and add tasks for QMetry Agent. On activation the Agent requests for task through QMetry and accumulates automated project execution schedules in Agent Pool. It automatically executes project on hosting machine as per scheduled date and time, regardless of the automation and build framework. On completion of test execution, it updates status of schedule.

User can configure QMetry Agent in the Go to Automation > Automation Agent > Download & Run Agent & assign the test suite execution task to scheduler in the Test Suites module.

Steps to Create an Agent

1. Go to Go to Automation > Automation Agent > Download & Run Agent.

2. Expand the Download & Run Agent section, if not expanded already.



3. You will find Agent download and installation instructions on the screen.

4. Download QMetryAgent.zip by clicking on the QMetry Agent download link.

5. Extract the QMetryAgent.zip on the computer drive.

6. Open the QMetryAgent folder.

7. Run <QMetry Agent Directory>/ QmetryAutomationAgent.jar by clicking on it.

The QMetry Agent wizard opens with the following fields on it:

  • URL: The URL of your QMetry Test Management application instance.
  • API Key: Generate API Key from Automation App > Agent & Launcher.
  • Agent Name: Enter name of your preference as Agent Alias to identify the specific agent.
  • Sync. Duration (in seconds): The time indicates how often your agent will communicate with server to get jobs scheduled.

 Click on the Start Agent button.



Users can also view logs by clicking on the View Logs button.

The Agent is added on the list of Registered Agents with Status as “Active”.



The screen lists out all agents added in QMetry with the details of OS, Machine Address, Status (Not Registered, Active, Inactive),  Schedules etc.

The Actions column includes the ScheduleHistory and Delete buttons.


Note: Automation related rights are assigned from User Management > Roles. The logged-in user will have access rights over Agent feature accordingly.


The columns on the screen are described below:

  • Alias: This is Agent Alias mentioned by user while adding Agent. 
  • OS: Operating System on hosting machine on which the Test Suite will be executed.
  • MAC Address:    Machine address of hosting machine on which the Test Suite will be executed.
  • Status:  The Agent status could be ‘Active’ or ‘Inactive’.
  • Active: QMetry Agent is executed to request schedule from QMetry application. When you start the agent, it attains ‘Active’ status and remains ‘Active’ till it keeps requesting for schedule from QMetry application at the frequency defined.
  • Inactive: As stated above, QMetry Agent and its connection with QMetry application are checked at a defined interval. If QMetry Agent is not communicating with QMetry application for more than the defined time and it stops requesting for schedule, then the QMetry Agent status is updated as ‘Inactive’.
  • Schedules: The column shows number of pending schedules and in-progress schedules. For example, 4 Scheduled / 2 In-progress.
  • Actions: The column includes History and Delete buttons under it.
    • Schedule Agent: Click on the Schedule button to schedule QMetry Agent run. 
    • Delete: Click on the Delete button to delete the Agent in that grid. 
    • History: The column shows the History button for each Agent grid. Click on the button to view the schedule details of that particular Agent. A pop-up screen opens that displays schedule details of the Agent.

Filter Options 

You can filter the Registered Agents on the following criteria:

  • Alias
  • OS
  • Status

When you are done with Agent configuration in the Apps > Automation App > Agent & Launcher, go to the Test Suites module to carry out automation testing by scheduling tasks for Agent.


See also

Automation Testing