Menu

Create TestNG Agent

In this article, we will walk you thru how to add a new TestNG Agent to a specific agent host from qTest Launch.

Note: follow this article to learn how to access to a specific host in qTest Launch in order to create a new Agent.

Step 1

Download the sample TestNG automation project at https://github.com/QASymphony/testng-sample and save it to your local machine.

  • On Windows: D:\testng-sample
  • On Linux or Mac: /usr/local/testng-sample

Structure of TestNG project:

  • Dependency libraries are under /resources/libs folder
  • The TestNG XML file: testNgSuite.xml
  • The automation project being packaged in .jar file, and located at /target/OpenURL-1.0.jar 

Step 2

Execute the command below to compile automation project and package it:

mvn clean compile package test

Step 3

Access to qTest Launch then locate a host that you want to create a new agent and open its detail dialog. On the host detail dialog, click on Agents tab then Click on + New Agent button. You will be presented with the New Agent dialog, as shown below:

new-agent.png

General Information

  • Agent Name: name of the new agent, e.g. New Agent
  • qTest Manager Project: select a project that the new agent will be associated with, e.g. qConnect - Sample Project
  • Agent Type: TestNG Agent

testng-general-info.png

Test Scripts

  • Directory (required): specify the path to your TestNG source code that you have downloaded in step 1
  • Scripting libs (optional): provide paths to the dependency libraries (files or folders) in your TestNG source code that you have downloaded in step 1. You can input one or multiple paths, separated by a comma. If all of your libraries are in a folder, simply put its path here
  • Include (required): define patterns to scan for tests in the automation project (methods/classes) using ANT Style Pattern Matcher. Use a comma as a separator between patterns.
  • Exclude: define patterns to ignore tests (method/classes) when scanning using ANT Style Pattern Matcher

HINT: ANT Style Pattern Matcher uses the following rules:

  • matches one character.
  • * matches zero or more characters.
  • ** matches zero or more 'directories' in a path.

Test Scripts example on Windows

testng-test-scripts-windows.png

Test Scripts example on Linux or Mac

testng-test-scripts-linux-mac.png

Execution

TestNG Agent supports 3 execution modes to build and run your test project: Command, Ant, Maven. You need to provide different information depending on the execution mode you choose.

Execution mode: Maven

  • Executable home: input the path to the directory where Maven is installed
  • Goal: input the goal defined in your POM file to deploy your project
  • POM file: provide the path to your POM file, which is located under the home directory of your test source code. Please note that this is the relative path under your scripting directory.
  • TestNG test file: input the name of TestNG XML file here. NOTE: This file should be located under the home directory of your source code and you can only input one file. You can simply input its relative path into this field
  • Command arguments: provide any additional arguments to execute the target

Screenshots below shows an example of Maven execution mode information.

Windows:

testng-exec-mode-maven-windows.png

Linux or Mac

testng-execution-maven-mac-launch.png

Execution mode: Ant

  • Executable home: path to the directory where Ant is installed
  • Target: specify which target to be executed. This is the name of the target which has been defined in your build file.
  • Build file: the path to your build file in which the above target is defined. This file is located under the home directory defined in Test Scripts section of your test source code
  • TestNG test file: input the file name TestNG XML file here. NOTE: this file should be located under the root directory of your source code and you can only input one file. You can simply input its relative path in this field.
  • Command arguments: provide additional arguments to execute the target

Screenshots below shows an example of Ant execution mode configuration

Windows:

testng-exec-mode-ant-windows.png

Linux or Mac

testng-exec-mode-ant-linux-mac.png

Execution mode: Command

  • Executable home: input the path where JAVA/JDK is installed
  • Command: the command to execute your scripts
  • TestNG test file: input the file name TestNG XML file
  • Command arguments: target directory where all built outputs are located plus any needed arguments

Below are examples of Command execution mode configuration.

Windows:

  • Executable mode: Command
  • Executable home: C:\Program Files\Java\jdk1.8.0_144
  • Command: java
  • TestNG test file: testNgSuite.xml
  • Command arguments: -cp “D:\testng-sample\target\*”

testng-exec-mode-command-windows.png

Linux or Mac

  • Executable mode: Command
  • Executable home: /usr/local/jdk1.8.0_144
  • Command: java
  • TestNG test file: testNgSuite.xml
  • Command arguments: -cp “/usr/local/testng-sample/target/*”

testng-exec-mode-command-linux-mac.png

IMPORTANT NOTES

While the agent is executing your tests, it is recommended that you do not modify TestNG XML file as the changes may lose after the execution is done.

 

 

Subscribe To Our Blog
Powered by Zendesk