Local Recording and Execution

Set up local recording and execution on Windows, macOS, Linux, or iOS, including software installs, device connection, and launch steps for testers.

QApilot Executor Local Agent

QApilot allows you to run tests on your local machines. To run the tests locally, you need a small QApilot Local Agent (Java) utility running on the machine for test orchestration, i.e., queueing tests, running the tests, fetching the test results, etc.

Prerequisites

You should have a QApilot Local agent on your machine.
Enable Developer options on your mobile device.

Updating QAPilot Local Agent - New Version

Navigate to Local Agent and click Download Agent.

It will redirect to the below window. Check the new and old versions of the local agent executor files for Windows, Max, and Linux devices.

Also, you can refer to the document and video demo for installation instructions on the devices listed in the top right corner.

When using QApilot for test recording with local devices, the process typically involves setting up the devices on your local network → device/system, and configuring them to work with the QApilot platform.

Connect the device to your system. Ensure you have enabled developer options for local testing and the QApilot Local Executor (Local Agent) is installed and running.
The connected device will automatically be displayed on the Test Recording Screen.

Software Installation:

Install Required Software:

How To Connect to the Local Device?

Prerequisites

Ensure you create a Project. Logging into the QApilot UI is a prerequisite for accessing the Projects Menu. The Projects Home page is the first screen shown after the respective user's successful login. Click the Project card to make the changes or Create a New Project.

Click on the Project Card. Select the Recorder option from the Configurations list.
The first step is to set the Connection type—selecting the kind of Environment, Cloud or Local.
Select Local Devices → It will redirect to the below screen:

Depending on your choice, select a Desktop OS: Windows, Mac, or Linux. Connect your mobile device to your laptop or desktop.

Local Devices refer to physical devices on which the Test cases are run to check the respective app's functionality. Cloud devices refer to the devices present in the Cloud farm.

The Cloud Device setup will enable running the Test Cases on multiple mobile devices as they are integrated/configured to be part of the Automation testing environment. This arrangement will facilitate the Test Cases' check to understand the application's compatibility.

For Windows:

Pre-requisites:

Administrative Privileges: The script requires administrative privileges to modify system environment variables and install applications.
JDK and Android SDK Directories: Ensure the JDK and SDK folders are located in the same directory as the script.
install local agent QApilot Local executor.

Installation Steps to follow:

Uninstall any previous QApilot builds if any.
Run the install.bat file.
If all prerequisites are met, the Setup Wizard will automatically open.
Follow the basic instructions & wait for the installation to complete.
Restart the system.
Run the QApilot application from your installed directory.

For Mac Android:

Install android SDK

To download the latest version of Android SDK, navigate to the link Download Android SDK

Install node.js

To download the latest version of Node.js, navigate to the link Download Node.js

Download and install local agent QApilot Local executor

Install Java and Set the Path

Download the JDK from Oracle's website or use Homebrew to install it:
```
brew install openjdk@11
```
Set up the JDK environment file:
echo 'export PATH="/usr/local/opt/openjdk@11/bin:$PATH"' >> ~/.zshrc
echo 'export JAVA_HOME=$(/usr/libexec/java_home -v 11)' >> ~/.zshrc
source ~/.zshrc

Install Android Studio and Set the Path

Download Android Studio from the official website.
Run the installer and follow the setup wizard.
Open the downloaded file and drag Android Studio to the Applications folder.
Open Android Studio and follow the setup wizard.
Open a terminal and find the SDK path: open -e ~/.zshrc
Add the following lines (adjust the path as needed):
export ANDROID_HOME=$HOME/Library/Android/sdk
export PATH=$PATH:$ANDROID_HOME/emulator
export PATH=$PATH:$ANDROID_HOME/tools
export PATH=$PATH:$ANDROID_HOME/tools/bin
export PATH=$PATH:$ANDROID_HOME/platform-tools
Save the file and reload the terminal: source ~/.zshrc

For Linux:

Install android SDK

To download the latest version of Android SDK, navigate to the link Download Android SDK

Install node.js

To download the latest version of Node.js, navigate to the link Download Node.js

Download and install local agent QApilot Local executor

Install Java & Set Path

Download the JDK from Oracle's website
Set up the JDK environment file:
echo 'export PATH="/usr/local/opt/openjdk@11/bin:$PATH"' >> ~/.zshrc
echo 'export JAVA_HOME=$(/usr/libexec/java_home -v 11)' >> ~/.zshrc
source ~/.zshrc

Install Android Studio & Set the Path

Download Android Studio from the official website.
Run the installer and follow the setup wizard.
Open the downloaded file and drag Android Studio to the Applications folder.
Open Android Studio and follow the setup wizard.
Open a terminal and find the SDK path: open -e ~/.zshrc
Add the following lines (adjust the path as needed):
export ANDROID_HOME=$HOME/Library/Android/sdk
export PATH=$PATH:$ANDROID_HOME/emulator
export PATH=$PATH:$ANDROID_HOME/tools
export PATH=$PATH:$ANDROID_HOME/tools/bin
export PATH=$PATH:$ANDROID_HOME/platform-tools
Save the file and reload the terminal: source ~/.zshrc

Once the installations are done for your choice of OS. Extract the Local Agent launcher file.

For Mac IOS:

Install Java and Set Path:

Download the JDK from Oracle's website Click Here or use Homebrew to install it:
```
brew install openjdk@11
```
Check how to set the path Click Here

Install Android Studio & Set the Path

Download Android Studio from the official website. Click Here
Check how to set the path Click Here

XCode installation

Log in with the Developer Account on the Apple website.
Go to the downloads page (https://developer.apple.com/download/) and download the latest version of Xcode
After the download is completed, double-click on the dmg file of Xcode.
Drag the Xcode dmg file to the application folder.

Install node.js

To download the latest version of Node.js, navigate to the link Download Node.js

Download and install local agent QApilot Local executor

Update WebDriverAgent

Download the source code of the latest version of WebDriverAgent from the below link https://github.com/appium/WebDriverAgent/releases/latest

Extract Local Agent:

Extract the Executor zip file

Open CMD from the same file location

Enter npm i for the first time, once the installation is done.

Enter npm start, if the Android SDK path is set and corrected the respective screen is displayed.

The respective Physical Device will be displayed in the Device dropdown.
Enable Developer Tools/Options on the connected Device/Mobile.
Enable USB Debugging.

Applying the above two steps is mandatory to add the respective Device details to the QA pilot UI.

The Mobile settings of Developer Tools and USB Debugging for the QA pilot UI will fetch the device details. The user can use any search engine (Google/Bing) to understand how to enable the required mobile settings for the respective model (mobile company & model).

Unless the above two settings are enabled on the Device to be selected, the Device details are not shown under the Device dropdown to proceed to the next step.

Select the respective options from various fields(App, Module, Testcase, Page, and VPN Required) on Select App & Testcase as shown above.

The user can select the options from the dropdown or click the button to create a new element for every field.

New element creation: