6.2.1 Installing & Configuring Automation Host on Windows

»Install and Configure your Automation Host

»Start your Automation Host

»Stop your Automation Host

»Uninstall the service

Install and Configure your Automation Host

Important_icon.pngImportant:

  • Java version 1.7 has been installed on your machine and JAVA_HOME environment variable has been configured before you run the tool.

After the zip file (qtest-automation-x.x.x.zip) has been downloaded, extract it. 

 

Important_icon.pngImportant:

  • By default, the tool will use domain localhost and port 6789 when it is running. However, you can change the default values:
    1. Create an environment variable named AGENT_SERVER_HOST and specify your desired domain name or this machine's IP address. If you are using a domain name, you will need to map the machine's IP Address with the domain name. Eg: AGENT_SERVER_HOST: 192.168.76.1
    2. Create an environment variable named AGENT_SERVER_PORT and specify your desired port number. Eg: AGENT_SERVER_PORT: 6789
  • If you want to use other Java version than the one specified in JAVA_HOME, you can create variable named QA_AGENT_JAVA_HOME and specify your desired Java home directory. Eg: C:Program FilesJavajdk1.7.0_25

Open a command console and change the current path to the extracted Automation Host tool directory.

Extracted_Automation_Host.png

Execute the following command to install the tool.

service install

 

After the service has been installed, run the below command to start it.

service start

 

Check the services which were installed on your local server and search for qTest Automation Agent. Right click on the service, select Properties and change its Startup Type to Automatically.

Open your browser and access to the URL with the domain and port as you specified  above (eg: localhost:6789). For the very first time, you will need to input the following information:

  • Host Name: the displayed name of this host in your qTest application. For now, you will not be able to modify this field after registering.
  • qTest URL: the URL to access to your qTest application.
  • Full Name: the displayed name of your qTest account.
  • qTest username and Password: the credentials to login to your qTest application.
  • If a proxy server is being used, click on Configure Proxy and then enter its info so the agent is able to submit test results to your qTest instance
    • Enable: select it in case a proxy is used
    • Host (required): host name or IP address of the proxy server
    • Port (required): port number of the proxy server
    • Username and Password: you can specify the domain before your username

After you have done filling in the information, click on Register button to register the host in your qTest.

automation-agent

Important_icon.pngImportant:

  • It is strongly recommended that the account is granted with Create Test Cases and Execute Test Runs permissions.

On the next screen, you can see the status indicates that the Automation Host has been registered successfully. You can also modify the followings:

  1. Polling frequency: select how often your automation agents will poll qTest for new automation schedules.
  2. Automation frameworks: there is a plugin for each supported framework. You can freely download the framework your project is working on from the list by clicking on the Download icon.
  3. Automation Agents: you can create new agents or edit existing ones' configurations.

Click on Save button to save the host's configurations.

To verify if the host has been registered successfully in qTest:

  • Login to your qTest application and access to any projects in which Automation Integration feature is activated.
  • Click on Automation Settings and choose tab Schedules.
  • You will see the list of registered Automation Host in the left panel.
  • IP Address may be dynamically changed. qTest shows the machine's IP at the time it is first connected to qTest.
  • IMAC and UUID uniquely identify a Automation Host registered with qTest.

button-round-warning-icon.pngHINT:

  • It is required that your qTest account is granted with Manage Project Settings permission to view registered host and agents' schedules in qTest.

Start your Automation Host

After the service has been installed, run the below command to start it.

service start

button-round-warning-icon.pngNOTE: When you download our qTest automation agent .zip file and extract it, there is two files: 1)  service.bat and 2) server.cmd. 

  • If you run automation as service.bat, the execution will happen in background. 
  • If you run automation as server.cmd, it will pop-up the browser window showing the execution in progress.

The above command will start the Automation Agent as a Windows service. The automation tests will be executed in the background as service.bat. If you want to monitor the execution progress, please follow steps below to run server.cmd.

  1. Stop the service:
    service stop
    
  2. Manually start the Automation Agent:
    server.cmd
    

Stop your Automation Host

After the service has been installed, run the below command to start it.

service stop

Uninstall the service

After the service has been installed, run the below command to start it.

service remove