Edge Qauto

Pre-requisites

Install Java following the React Native guide: https://reactnative.dev/docs/set-up-your-environment?platform=android

Install Maestro and Flashlight to be able to run the test scripts.

Usage

Install

Clone this repository and change into the directory:

git clone git@github.com:EdgeApp/edge-qauto.git
cd edge-qauto

Setup

Run the setup script:

source qauto

This will prompt you with questions about which test you wish to run. You can run this command anytime to change the choices you made.

Run

Run the test configured by the previous with the command:

qauto

This will run the test and ask you if you want to show the result report.

The default number of tests (iterations) is 8, but you can change this by passing a number to the qauto command:

qauto 3

iOS Simulator Metrics

On macOS, qauto-ios records an Instruments Time Profiler trace while running the selected Maestro flow on a booted iOS Simulator. It requires Xcode, Maestro, and a booted simulator.

Configure the test as usual, then run:

source qauto
./qauto-ios

By default, the first booted simulator is used. Set IOS_SIM_UDID to target a specific booted simulator. Traces and metadata are written to results-ios/.

Re-opening Results

The results are saved to the results/ directory as a JSON file. You can always open the results again using:

flashlight report results/<filename>.json

Python Script Requirements

If you use extract_flashlight_score.py to extract scores from Flashlight results, you need Python 3 and Playwright:

pip install playwright
python3 -m playwright install

This will install the Playwright Python package and the required browser binaries.

Pronunciation

Qauto is pronounced "Kado".

Utility Scripts

• extract_flashlight_score.py: Extracts the average score from a Flashlight results JSON file by generating the HTML report and scraping the score from it.
  • Usage: python3 extract_flashlight_score.py <path-to-json>