A remote executor is a machine that is used to execute your automated tests. For connecting the machine with your TestCollab setup, you will need to install remote executor on your machine. Currently we support Windows and Debian based Linux systems.
- Test Automation setting is enabled. The setting can be enabled from "General Configuration" page by an admin
- Your Testcollab installation should be accessible from machine where remote executor is installed. If you are using self hosted instance on private network machine then TestCollab should be accessible on same network. For Cloud (SaaS) accounts, machine having remote executor installed should be able to access internet.
Configuring TestCollab Setup For Remote Machine:
To add a machine with remote executor to TestCollab. You can do it From Settings -> Remote Executors.
Adding remote executor will need following information:
- Machine name: This is the name which will represent machine in the application.
- Machine API Key: This can be any random series of alphabets that will be used for authentication of remote executor. This field should be unique for each remote executor. You can also opt to get an API key automatically generated by the system. Please note that the length of the API key you provide should not exceed 15 characters
Installing on Windows:
Remote executor for windows can be downloaded using button below -
- After you run the downloaded package, you will be prompted to enter two parameters. Your Test Collab Host and Remote executor API key.
2. Next you will be required to confirm the path where remote executor files would be copied
3. In Test Collab Host, add the URL of your TestCollab installation and in Remote executor API key, add the unique API key that you entered while adding remote executor on TestCollab.
4. Similarly follow the rest of the wizard - and you will see the success message if everything goes fine.
Note: All configuration changes will require a service restart. For Windows, Go to 'Run > services.msc > Right click Test Collab Remote Executor > Select Restart'.
Installing on Linux:.
Remote executor for linux can be downloaded using button below -
- Change to the directory you downloaded the package into.
- Give executable permissions to the file using the following command
chmod 755 testcollab_remote_executor_lin64.sh
3. Run installer file as root using either of these commands, depending on your platform
4. Follow the wizard as it installs. During installation you will be prompted to confirm the path where tcmre would be copied
5. Next would be the URL you use to access your Test Collab instance
And finally the unique API key that you entered while adding remote executor on TestCollab.
- If at the time of installation you see a daemon related error "Job for tcmre.service failed because the control process exited with error code" , then you may need to add#!/bin/shat the beginning of /etc/init.d/tcmre
- All configuration changes will require a service restart. Linux users can start remote executor using the command command 'sudo /etc/init.d/tcmre start' or 'sudo service tcmre start'. You may replace 'start' with 'stop' or 'restart'. For Windows, Go to 'Run > services.msc > Right click Test Collab Remote Executor > Select Restart'.
Installing on Mac:
Remote executor for Mac can be downloaded using button below -
- Extract the downloaded archive (tcmre_for_Mac.zip) into /opt/share/
- Edit /opt/share/tcmre/config.ini with your settings i.e. Machine API Key and Test Collab server URL
- Test the tool by running the following command in terminal: /opt/share/tcmre/bin/node /opt/share/tcmre/src/index
- If you want the remote executor to get launched automatically when your system starts, you can copy /opt/share/tcmre/tcmre.job.plist in /Library/LaunchDaemons to set it as daemon.
- Restart your system
Please note it is important to configure your firewall or router settings if they do not block applications to listen on specific ports.
For further clarification, please watch the screen-cast here- http://testcollab.com/blog/screencast-test-automation-with-test-collab/