Menu

qTest Automation Host 2.x Installation Guide on Mac OS

Overview

In this article, we will walk through how to install qTest Automation Host version 2.x on a Mac machine.

Download qTest Automation Host 2.x

  1. From the Download Automation Host page, download the qTest Automation Host 2.x for Mac.
    Note: It is highly recommended that you download the latest 2.x version to benefit from bug fixes and enhancements.
  2. Open the Terminal.
  3. Copy the downloaded file agentctl-[version]-mac-x64-full.tgz to a desired installation directory, e.g. /usr/local/agentctl-[version]-mac-x64-full.tgz
    IMPORTANT:
    • If you plan to install multiple automation host instances, it is important that you create a parent folder for each instance to easily identity the instance as well to avoid issues when upgrading each instance. The best practice is to suffix parent folder with a number. For example:
      • Instance #1: /usr/local/qtest-automation-host-1/agentctl-[version]-mac-x64-full.tgz
      • Instance #2: /usr/local/qtest-automation-host-2/agentctl-[version]-mac-x64-full.tgz
      • ...
      • Instance #N: /usr/local/qtest-automation-host-N/agentctl-[version]-mac-x64-full.tgz
    • Replace [version] in the command to the actual version that you have chosen to download, e.g. 2.1.1
  4. Change the current directory to the installation directory. For EXAMPLE:
    $ cd /usr/local
    or if you are going to install multiple automation host instances
    $ cd /usr/local/qtest-automation-host-N
  5. Extract the bundle:
    $ tar -zxf agentctl-[version]-osx-x64-full.tgz
  6. Change the current directory to the extracted agentctl 2.0:
    $ cd agentctl-[version]

Acquire your qTest API Token

  1. Login to qTest Manager as an Administrator and access the Resources page.
  2. Expand the APIs and SDK section.
  3. Copy the API Token, as shown below:

blur_that.png

NOTES ABOUT QTEST API TOKEN CHANGES:

The token will be automatically changed by qTest Manager if below events occur:

  • Users change their password in qTest Manager OR
  • Users switch authentication type, e.g. from authenticating with qTest using Username and Password to SSO or LDAP, and vice versa

Install and Configure the Automation Host

There are two options to install and configure the Automation Host:

  • Via web interface 
  • Via command line

Install and Configure the Automation Host via Web Interface

  1. From the Terminal, execute the following command:
    /path/to/agentctl-[version]$ ./agentctl start
  2. Wait for a couple of minutes for the Automation Host to fully start. Open a web browser and navigate to http://localhost:6789. the registration UI will display.host-registration-ui.png
  3. Next, enter information to register the Automation Host:
    • Host Name: Enter a meaningful name for the host
    • qTest URL: Your qTest Site URL
    • qTest Token: Enter the token from the step Aquire your qTest API token
    • Full Name: Your full name
    • Configure Proxy: Optional. Select this option if you are connecting to the internet through your corporate proxy
      • Script: If your proxy server is configured with a script, enter the URL to access your PAC (Proxy Auto-Configuration) file.
      • Host: Enter the proxy host address. It can be either the IP address, computer name, or dns name of this proxy server. Note: If you specify both Script and Host, the Automation Host will connect to the script-based proxy server first and then connect to the proxy host if the connection to the script-based one failed.
      • Port: Specify the port that the proxy server is running on. This parameter is required.
      • Username: If your proxy server requires basic authentication, enter a username to authenticate with the proxy. Otherwise, leave this field empty.
      • Password: If your proxy server requires basic authentication, enter a password to authenticate with the proxy. Otherwise, leave this field empty.

EXAMPLE

host-registration-ui-sample.png

Select Register to start registering the Automation Host with qTest Manager. This process will take a while. Once it's finished, you'll be automatically navigated to the home page.

Install and Configure the Automation Host via Command Line

From Terminal, execute the following command to configure the Automation Host:

/path/to/agentctl-[version]$ ./agentctl config -Phostname="[automation_host_name]" -Phost=[ip_address or computer_name] -Pport=[agent_port] -Pautostart=[true|false] -Pqtest.url=[qtest_url] -Pqtest.token=[qtest_token] -Pproxy.enable=[true|false] -Pproxy.host=[proxy_host] -Pproxy.port=[proxy_port] -Pproxy.username=[proxy_username] -Pproxy.password=[proxy_password] -Pproxy.script=[proxy_script_url]

Command Parameters and Descriptions:

Parameter Name Description
 config Execute the configuration command
-Phostname

Name of this automation host instance.

Notes:

  • This parameter is only available from Automation Host 2.1.1 and later
  • If your automation host has been installed and started successfully at least once. You will not be able to change your automation host name afterward with `./agentctl config -Phostname="Your new host name"` command. However, you can change you automation host name in the Automation Host UI or in qTest Launch (for Elite users)
-Phost

The host address. You can specify either actual IP address or computer name of this machine. If this parameter is omitted, localhost will be used.

Notes: 

  • This parameter is removed from Automation Host 2.2.2. This means you do not need to specify this parameter when registering the host through command line
  • If you use localhost for -Phost parameter, you will not be able to access to this automation host UI from other computer in your network
  • If you use IP address for -Phost parameter and the IP address changes when the computer restarted, this will cause the automation host failed to start. In this case, re-execute command `./agentctl config -Phost="<New IP address>"` to update the host IP address, and start the host again with command `./agentctl start`
  • If the IP address changes after the machine restarts, e.g. your machine is in a corporate network that employs a DHCP server, you should use computer name instead. Notes: you need to make sure that you can reach to your host machine via computer name by running ping command in your Terminal and receiving response from the command. For EXAMPLE: if one of the below command receives some responses other than Unknown host, then you can use the whole name that you specify in the ping command, in bold, as the host address
    • ping <your computer name> OR
    • ping <your computer name>.local OR
    • ping <your computer name>.<your company domain>
-Pport Specify a port that your automation host will be running on. If this parameter is omitted, port 6789 will be used.
-Pqtest.url Url of your qTest Manager instance.
-Pqtest.token The qTest API token generated for your qTest Manager account. You can copy it from the API & SDK section in qTest Manager's Resource page.
-Pautostart Available from Automation Host 2.2.2. Possible value is true or false. If the value is true, the automation host will automatically start when system starts up. Default value is false.
-Pproxy.enable Possible value is true or false. If the value is true, you will need to provide proxy settings, otherwise, set it to false
-Pproxy.host The proxy host address. You can specify either actual IP address, computer name or dns name of this proxy server
-Pproxy.port The port that the proxy server is running on. This parameter is required if -Pproxy.enable is set to true.
-Pproxy.username If your proxy server requires basic authentication, enter a username to authenticate with the proxy.
-Pproxy.password If your proxy server requires basic authentication, enter a password to authenticate with the proxy.
-Pproxy.script If your proxy server is configured with a script, enter the URL to access your PAC (Proxy Auto-Configuration) file

Configure qTest Automation Host without Proxy

The example command below shows how to configure the qTest Automation Host 2.x in a non-proxy environment. The values for each parameter are highlighted in bold.

Notes: remove -Phostname parameter if you are using Automation Host version 2.1.0 or older.

Automation Host 2.2.1 EXAMPLE

/path/to/agentctl-[version]$ ./agentctl config -Phostname="My Automation Host" -Phost=192.168.76.29 -Pport=6789 -Pproxy.enable=false -Pqtest.url=https://demo.qtestnet.com -Pqtest.token=[qtest_token]

Automation Host 2.2.2+ EXAMPLE. Notes:

  • -Phost parameter is omitted and
  • -Pautostart parameter is added

/path/to/agentctl-[version]$ ./agentctl config -Phostname="My Automation Host" -Pport=6789 -Pautostart=true -Pproxy.enable=false -Pqtest.url=https://demo.qtestnet.com -Pqtest.token=[qtest_token]

Configure qTest Automation Host with Proxy Settings

The example command below shows how to configure the qTest Automation Host 2.x in a proxy environment. The values for each parameter are highlighted in bold.

Notes: remove -Phostname parameter if you are using Automation Host version 2.1.0 or older.

 

If your proxy does not require authentication:

  • Automation Host 2.2.1 EXAMPLE

/path/to/agentctl-[version]$ ./agentctl config -Phostname="My Automation Host" -Phost=[ip_address] -Pport=6789 -Pqtest.url=https://demo.qtestnet.com -Pqtest.token=[qtest_token] -Pproxy.enable=true -Pproxy.host=[ip_address] -Pproxy.port=3128

  • Automation Host 2.2.2+ EXAMPLE. Notes:
    • -Phost parameter is omitted and
    • -Pautostart parameter is added

/path/to/agentctl-[version]$ ./agentctl config -Phostname="My Automation Host" -Pport=6789 -Pautostart=true -Pqtest.url=https://demo.qtestnet.com -Pqtest.token=[qtest_token] -Pproxy.enable=true -Pproxy.host=[ip_address] -Pproxy.port=3128

If your proxy does require basic authentication with a username and password:

  • Automation Host 2.2.1 EXAMPLE

/path/to/agentctl-[version]$ ./agentctl config -Phostname="My Automation Host" -Phost=[ip_address] -Pport=6789 -Pqtest.url=https://demo.qtestnet.com -Pqtest.token=[qtest_token] -Pproxy.enable=true -Pproxy.host=[ip_address] -Pproxy.port=3128 -Pproxy.username=proxyuser@qasymphony.com -Pproxy.password=s0mething#0923

  • Automation Host 2.2.2+ EXAMPLE. Notes:
    • -Phost parameter is omitted and
    • -Pautostart parameter is added

/path/to/agentctl-[version]$ ./agentctl config -Phostname="My Automation Host" -Pport=6789 -Pautostart=true -Pqtest.url=https://demo.qtestnet.com -Pqtest.token=(Your API token) -Pproxy.enable=true -Pproxy.host=192.168.76.138 -Pproxy.port=3128 -Pproxy.username=proxyuser@qasymphony.com -Pproxy.password=s0mething#0923

Your proxy is configured with a script:

  • Automation Host 2.2.1 EXAMPLE:

/path/to/agentctl-[version]$ ./agentctl config -Phostname="My Automation Host" -Phost=[ip_address] -Pport=6789 -Pqtest.url=https://demo.qtestnet.com -Pqtest.token=[qtest_token] -Pproxy.enable=true -Pproxy.script=https://proxytestlab.sampleproxy.com/proxy.pac

  • Automation Host 2.2.2+ EXAMPLE. Notes:
    • -Phost parameter is omitted and
    • -Pautostart parameter is added

/path/to/agentctl-[version]$ ./agentctl config -Phostname="My Automation Host" -Pautostart=true -Pport=6789 -Pqtest.url=https://demo.qtestnet.com -Pqtest.token=(Your API Token) -Pproxy.enable=true -Pproxy.script=https://proxytestlab.sampleproxy.com/proxy.pac

Note: If you specify both a script-based proxy server and a proxy server host, the Automation Host will connect to THE script based one first, then connect to the proxy host when the connection to script based one was failed.

SSL Proxy Configuration

[Updated] if you are using Automation Host 2.2+, you do not need to perform this step.

If you are using Automation Host 2.1 or older AND your organization uses an SSL proxy that alters all certificates on the internet, including the SSL certificate from your qTest site, to your own certificate that is not trusted by the Automation Host embedded Java, you will need to add your own certificate to the default Automation Host's embedded Java certificate keystore following these instructions.

IMPORTANT: Add System Environment Variable

Open the Terminal and execute this command to identify the Java version:

$ java -version

If the execution result shows your machine is running a Java whose version between 1.8.0_77 and 1.8.0_151, you must add an environment variable to make a proxy with basic authentication work properly. Follow these steps:

  1. Run the following command to edit the bash_profile file:
    $ vi ./bash_profile
  2. Add this line to the bash_profile file:
    export JAVA_TOOL_OPTIONS=-Djdk.http.auth.tunneling.disabledSchemes=""
    The image below shows how your updated bash_profile file will look like.
    bash_profile.png
  3. Save the file when you're done.
  4. Next, execute the command below to load the updated bash_profile:
    $ source ~/.bash_profile
  5. Verify the variable is loaded:
    $ echo JAVA_TOOL_OPTIONS
  6. If you see the output -Djdk.http.auth.tunneling.disabledSchemes= printed in the Terminal, then you have successfully added a new environment variable.

Start the Automation Host

If You are Using Automation Host 2.1.1 or Later

If you specified an Automation Host host name while executing the above config command, execute this command:

/path/to/agentctl-[version]$ ./agentctl start

Otherwise, execute the command below to start the host AND give your Automation Host a descriptive and meaningful name.

/path/to/agentctl-[version]$ ./agentctl start -Phostname="[automation host name]"

Example:

/usr/local/agentctl-[version]$ ./agentctl start -Phostname="My Automation Host"

If You are Using Automation Host 2.1.0 or Older

Automation Host versions 2.1.0 and older do not allow you to specify Automation Host host names in the config command. Instead, you are recommended to do so in this start command below:

/path/to/agentctl-[version]$ ./agentctl start -Phostname="[automation host name]"

Example:

/path/to/agentctl-[version]$ ./agentctl start -Phostname="My Automation Host"

IMPORTANT NOTES:

  • It might take some minutes for the Automation Host to fully start the first time.
  • If you run "./agentctl start" by itself, without a -Phostname parameter AND you did not specify the host name in previous config command (only available in Automation Host 2.1.1 and later), "Sample Agent" will be used as the default automation host name
  • Once the Automation Host host name is set, this name CANNOT be changed from the Terminal. However, you can change it from either the Automation Host UI or qTest Launch.

Access qTest Automation Host

Open your browser and enter the URL: http://<host>:<port>

Install the Automation Host as Service on Mac

If you want the Automation Host to automatically start when system starts, there are two options:

  1. Install Automation Host as a service OR
  2. Configure it to run at system start up (highly recommended Automation Host 2.2.2 and later). Refer to the previous instructions to learn how to configure Automation Host to automatically start when system starts

Install qTest Automation Host as a single Service on Mac

Notes: if you are using Automation Host version 2.1.1 or later AND you want to install multiple instances of Automation Host as services on Mac, skip to next section. Otherwise, follow these steps:

  1. Access the agentctl directory and execute following commands:
    1. If the automation host is running in the Terminal, stop it with this command:
      /path/to/agentctl-[version]$ ./agentctl stop
    2. Execute this command to install the Automation Host as a service:
      /path/to/agentctl-[version]$ sudo ./install
    3. Check if the service is installed successfully with the below command:
      /path/to/agentctl-[version]$ sudo launchctl list | grep com.qasymphony.qtest-automation-agent

Note: It might take some minutes for the service to fully start. After that, you can access the host UI using your browser.

Install Multiple qTest Automation Host Instances as Services on Mac

Note: this feature is only available for Automation Host version 2.1.1 and later.

Follow the steps below if you want to install multiple Automation Host instances as services on Mac:

  1. Extract the downloaded Automation Host package to multiple directories. Make sure to create a parent directory for each Automation Host instance to easily identify it as well to avoid issues when upgrading that instance. The example below shows how we extract each package inside a parent directory whose name is suffixed with a number:
    • Instance #1: /usr/local/qtest-automation-host-1/agentctl-[version]
    • Instance #2: /usr/local/qtest-automation-host-2/agentctl-[version]
    • ...
    • Instance #N: /usr/local/qTest-automation-host-N/agentctl-[version]
  2. Access each directory, then perform the following steps 3-5 for each directory.
  3. Install and Register the Automation Host.
    IMPORTANT: make sure you give each instance a unique Port number via the -Pport parameter. It is also highly recommended to give each instance a unique Automation Host name via -Phostname parameter in config or start command
  4. Stop the Automation Host instance if it is running in the Terminal:
    ./agentctl stop
  5. Execute the command below to install the host as a service:
    IMPORTANT: you must give the service a unique name via <service name> parameter:
    /path/to/agenctl-[version]$ sudo ./install "<service name>"

Uninstall Service

If you want to uninstall the Automation Host service, open the Terminal and execute the following commands:

/path/to/agentctl-[version]$ sudo ./uninstall
/path/to/agentctl-[version]$ sudo launchctl list | grep com.qasymphony.qtest-automation-agent

If you installed multiple instances of automation host as services on Mac, access to each automation host directory and execute the above ./uninstall command.

Powered by Zendesk