On-premise setup

To start using QConnect, you need to download the QConnect agent software, install it on the machine or machines that will execute the tests, and connect each agent to your organization in Copado Robotic Testing. After that, users in your organization can create robots in Copado Robotic Testing that automatically use the agents to run the tests.

QConnect agent is available for four environments: Docker, Windows, Mac and Mobile. On Mac & Windows systems, you can choose whether to run the agent in a Docker container, which isolates the test environment from the operating system, or as a native application, which makes it more straightforward for the tests to interact with the desktop and GUI applications.

QConnect for Mobile enables you to use your own mobile device(s) on your own pc and still run test cases from Copado Robotic Testing.

Downloading

QConnect client can be downloaded from your organizations agent view. Navigate to your organization’s Agents view by clicking your profile icon > Organizations > QConnect/Agents button.

(or follow direct link https://pace.qentinel.com/qconnect)

To download Docker QConnect, select option Docker image from Download QConnect dropdown. This starts downloading the image file (roughly 1.4 GB).

To download Windows installer, select option Windows installer from Download QConnect dropdown.

To download Mac installer, select option MacOS installer from Download QConnect dropdown.

To download Mobile installer, select either Windows installer with Android support or MacOS installer with iOS & Android support from Download QConnect dropdown.

qconnect download












After downloading, please follow the instructions for downloaded version:

Docker QConnect instructions

Prerequisites

QConnect agent runs locally in a Docker container, so installing Docker is a prerequisite. Docker is a widely used container platform available for Windows, Linux, and Mac. Install Docker from https://docs.docker.com/get-docker/, and make sure you can run the docker command line tool in a terminal window.

Add image to Docker

In a terminal window, run

docker load -i image

where image is the path to the downloaded file (by default, qconnect_latest.gz). This adds QConnect to the images managed by your Docker installation.

Verify the installation by running:

docker run --rm qconnect --version

which should print the QConnect agent version.

To view all your local versions of QConnect, run:

docker image ls qconnect

Start the QConnect agent locally

Start the QConnect agent locally by running in a terminal window

docker run -ti --rm --name containername --mount type=volume,src=volumename,dst=/agent --shm-size=256m qconnect

The containername and volumename will be the name of the Docker container that runs the agent software and the name of a new Docker volume, respectively. The agent identity and authorization data will be stored in that volume, i.e. in a file managed by your Docker installation. Pick recognizable containername and volumename, e.g. set both to qconnect-my-first-agent if the agent name is My First Agent.

if your terminal uses Git Bash on Windows, you may need to replace /agent with //agent on the command line.

Because this is the first run with an empty Docker volume, QConnect will ask for the authorization string in the terminal window. Copy the authorization string you got when creating agent in Copado Robotic Testing, paste it into the terminal, and press enter. The agent connects to Copado Robotic Testing and is ready to use.

Windows QConnect instructions

Prerequisites

A 64-bit Windows 10 operating system is required. To run web tests, a compatible browser (Chrome or Firefox) is needed.

It is strongly recommended to run the QConnect agent as a dedicated non-admin user. The test cases that QConnect runs have the same access rights to the machine that the user has, including reading and writing the user’s files and settings, launching applications, and sending data to the internet. Running the QConnect agent under a human user’s personal account could interfere with normal usage and risk the security of the user and of any systems that the user can access.

Installation

Run the downloaded file (by default, qconnect_latest.exe) to install the Copado QConnect agent application. If you get a dialog titled "Windows protected your PC", click "More info" and then "Run anyway" to proceed with the installation. The installer needs a working internet connection to download its software dependencies.

Start the Windows QConnect agent locally

To start QConnect for Windows, click on the Copado QConnect/Copado QConnect shortcut under Start Menu.

qconnect windows shortcut





The agent will open in a new terminal window. On the first run QConnect will ask for the authorization string in the terminal window. Copy the authorization string you got when creating agent in Copado Robotic Testing, paste it into the terminal, and press enter. The agent connects to Copado Robotic Testing and is ready to use.

qconnect windows first run

Closing the terminal window exits the agent. It will not keep running in the background. Connections to Copado Robotic Testing agents are only allowed when QConnect is running (i.e. terminal is open).

The authorization string is saved under the Windows user’s application data folder, so running QConnect again on the same machine as the same user will automatically connect to Copado Robotic Testing as the same agent.

If you make a mistake and need to revoke the token, you can do so by removing the file login from \AppData\Local\Copado\QConnect\agent.
When running a web browser test for the first time, you may see a dialog titled "Windows Defender Firewall has blocked some features of this app". This is an artifact of the Webdriver software used for communicating with browsers. Unless your test cases specifically need to accept incoming network connections, you can disallow access by clicking Cancel.

Mac QConnect instructions

Prerequisites

A 64-bit Mac operating system is required. To run web tests, a compatible browser (Safari, Chrome or Firefox) is needed.

At the moment Macs with latest Apple’s M1 processor are not supported.

If using Safari as a web browser, please enable "Remote Automation". Go to Safari’s preferences and enable "Show Develop menu in menu bar" under Advanced tab. Then open Developer menu and enable Remote Automation.

Installation

  1. Install tesseract dependency to your Mac

brew install tesseract
  1. Run the downloaded file (by default, qconnect_latest.pkg) to install the Copado QConnect agent application.

  2. Double-click the PKG installer and follow through the installation process.

qconnect mac installer
  1. Launch QConnect using LaunchPad, Finder or terminal using command qconnect-agent. A dialog should tell that QConnect is started in a new Terminal window. The dialog closes itself after 10 seconds unless user clicks OK.

qconnect mac launcher dialog
  1. In the first run QConnect for Mac asks for token. Input it. If you don’t yet have a token, please create agent on Copado Robotic Testing cloud as described here.

  2. QConnect should state that it is connected to Copado Robotic Testing and you can verify this by checking the agent’s status from Pace. A green icon should be visible and details presented about your "Mac".

QConnect for Mobile instructions

Prerequisites

A 64-bit Windows 10 or Mac OS operating system is required. A local mobile device needs to be properly setup and connected with USB cable.

It is strongly recommended to run the QConnect agent as a dedicated non-admin user. The test cases that QConnect runs have the same access rights to the machine that the user has, including reading and writing the user’s files and settings, launching applications, and sending data to the internet. Running the QConnect agent under a human user’s personal account could interfere with normal usage and risk the security of the user and of any systems that the user can access.

Installation

Run the downloaded file (by default, qconnect_mobile_latest.exe) to install the Copado QConnect agent application. If you get a dialog titled "Windows protected your PC", click "More info" and then "Run anyway" to proceed with the installation. The installer needs a working internet connection to download its software dependencies.

If you want to automate iOS devices, download and install "MacOS installer with iOS & Android support" (qconnect_mobile_latest.pkg). Install also tesseract before starting QConnect agent.

brew install tesseract

Start the Mobile QConnect agent locally

To start QConnect for Windows, click on the Copado QConnect/Copado QConnect shortcut under Start Menu.

qconnect windows shortcut





The agent will open in a new terminal window. On the first run QConnect will ask for the authorization string in the terminal window. Copy the authorization string you got when creating agent in Copado Robotic Testing, paste it into the terminal, and press enter. The agent connects to Copado Robotic Testing and is ready to use.

qconnect windows first run

Closing the terminal window exits the agent. It will not keep running in the background. Connections to Copado Robotic Testing agents are only allowed when QConnect is running (i.e. terminal is open).

The authorization string is saved under the Windows user’s application data folder, so running QConnect again on the same machine as the same user will automatically connect to Copado Robotic Testing as the same agent.

If you make a mistake and need to revoke the token, you can do so by removing the file login from \AppData\Local\Copado\QConnect\agent.
Remember to setup your mobile device as instructed here

You can attach multiple devices via usb to your QConnect machine. Each of these devices will be automatically identified and can be seen in your organizations QConnect status page (https://pace.qentinel.com/qconnect).

In the screenshot below, mobile device icon (1) under Type column is displayed for mobile agents.

qconnect mobile devices connected