Detox Testing on HyperExecute

Detox is a popular end-to-end testing framework for React Native applications. This documentation will help you run your Detox tests on TestMu AI HyperExecute using your local system setup.

note

Detox testing on TestMu AI is supported via HyperExecute on Android real devices and iOS simulators.

Prerequisites

Before you begin, ensure you have the following:

• A TestMu AI account. You can get your Username and Access Key from your Account Settings.
• Node.js and npm installed on your local system.
• A React Native application with Detox tests configured, or use the sample repository referenced in this guide.

Run a Sample Project

Step 1: Clone Sample Repository

Detox repo

Download or Clone the Detox sample from TestMu AI’s GitHub Repository

View on GitHub

Step 2: Download the CLI in your Project

Download the HyperExecute CLI and copy it into the root folder of the downloaded sample repository.

Platform	HyperExecute CLI
Linux	https://downloads.lambdatest.com/hyperexecute/linux/hyperexecute
Windows	https://downloads.lambdatest.com/hyperexecute/windows/hyperexecute.exe
macOS	https://downloads.lambdatest.com/hyperexecute/darwin/hyperexecute

Step 3: Execute your Test Suite

From the project root directory, execute the below CLI command in your terminal:

Verified

./hyperexecute --user undefined --key undefined --config RELATIVE_PATH_OF_YOUR_YAML_FILE 

NOTE : In case of macOS, if you get a permission denied warning while executing CLI, simply run chmod u+x ./hyperexecute to allow permission. In case you get a security popup, allow it from your System Preferences → Security & Privacy → General tab.

You've successfully triggered the Detox tests on HyperExecute. Visit the HyperExecute Dashboard and check your Job status.

Configure your own Project

Step 1: Download the CLI in your Project

Download the HyperExecute CLI and copy it into the root folder.

Platform	HyperExecute CLI
Linux	https://downloads.lambdatest.com/hyperexecute/linux/hyperexecute
Windows	https://downloads.lambdatest.com/hyperexecute/windows/hyperexecute.exe
macOS	https://downloads.lambdatest.com/hyperexecute/darwin/hyperexecute

Step 2: Configure YAML in your Test Suite

Use the sample YAML below to configure your execution:

Verified

hyperexecute.yaml

loading...

View on GitHub

📘 To explore more configuration options and tailor settings to your project needs, check out the YAML documentation.

Step 3: Monitor the Test Execution

Visit the HyperExecute Dashboard and check your Job status.

You can click on View Test from the HyperExecute logs, which will take you to the App Automation dashboard. There, you can access detailed device logs, crash logs, and Metadata for your test. You’ll also be able to watch a video recording of the Test sessions for better debugging and analysis.

Advanced Configuration

HyperExecute supports the following capabilities for your Detox test runs. Add the relevant keys to your hyperexecute.yaml file.

Tunnel