Espresso Testing On HyperExecute
This page outlines how to execute your Espresso tests on HyperExecute with YAML 0.2
Prerequisites
To run the Tests on HyperExecute from your Local System, you are required:
- Your LambdaTest Username and Access key
- HyperExecute CLI in order to initiate a test execution Job .
- Setup the Environmental Variable
- HyperExecute YAML file which contains all the necessary instructions.
- An Android app (.apk or .aab file).
Step 1: Setup Your Test Suite
You can use your own project to configure and test it. For demo purposes, we are using the sample repository.
Download or Clone the code sample for the Espresso framework from the LambdaTest GitHub repository to run the tests on the HyperExecute.
View on GitHubStep 2: Setup the CLI in your Test Suite
After cloning / downloading the sample repo, you need to setup the CLI and the environment variables.
Download the HyperExecute CLI
The CLI is used for triggering the tests on HyperExecute. It is recommend to download the CLI binary on the host system and keep it in the root directory of the suite to perform the tests on HyperExecute.
You can download the CLI for your desired platform from the below mentioned links:
Setup Environment Variable
Now, you need to export your environment variables LT_USERNAME and LT_ACCESS_KEY that are available in the LambdaTest Profile page.
Run the below mentioned commands in your terminal to setup the CLI and the environment variables.
- Linux / MacOS
- Windows
export LT_USERNAME="undefined"
export LT_ACCESS_KEY="undefined"
set LT_USERNAME="undefined"
set LT_ACCESS_KEY="undefined"
Step 3: Upload your Application
Upload your android application (.apk file) to the LambdaTest servers using our REST API. You need to provide your Username and AccessKey in the format Username:AccessKey
in the cURL command for authentication.
Enter your local path of your android app instead of <YOUR_LOCAL_APP_PATH>
in the below cURL command.
curl -u "undefined:undefined" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"<YOUR_LOCAL_APP_PATH>"" -F "name="sampleApp""
Response of above cURL will be a JSON object containing the
App ID
of the format -<APP123456789012345678901234567>
and will be used in the next step.
Step 4: Upload your Test Suite
Upload your test suite (.apk file) to the LambdaTest servers using our REST API by providing your Username and AccessKey in the format Username:AccessKey
in the cURL command for authentication.
Here is an example cURL request to upload your app using our REST API:
Enter your local path of your test suite app instead of <YOUR_LOCAL_APP_PATH>
in the below cURL command.
Step 5: Configure YAML in your Test Suite
Enter your <APP_ID>
and <TEST_SUITE_ID>
in the YAML file that you have fetched in the above step.
- Auto Sharding
- Manual Sharding
---
version: "0.2"
globalTimeout: 150
testSuiteTimeout: 150
testSuiteStep: 150
concurrency: 2
runson: android
autosplit: true
report: true #to generate reports
framework:
name: "android/espresso"
args:
buildName: "Espresso"
video: true
deviceLog: true
artifacts: true #to generate artifacts
# You can use either the appId (lt://APP1234567) or provide the path of the application using appPath. Both examples are given below.
appPath: proverbial_android.apk
testSuitePath: proverbial_android_expressotest.apk
# We have used the appPath and testSuitePath here.
appId: lt://<APP_ID>
testSuiteAppId: lt://<TEST_SUITE_ID>
# We have used the appId and testSuiteAppID here.
deviceSelectionStrategy: all
devices: ["Galaxy.*", "Pixel.*"]
jobLabel: ['HYP', 'Espresso', 'Auto Sharding']
You can use either the appId
and testSuiteAppId
or provide the path of the application using appPath
and testSuitePath
. Both examples are given below.
---
version: "0.2"
globalTimeout: 150
testSuiteTimeout: 150
testSuiteStep: 150
concurrency: 2
runson: android
autosplit: false
report: true #to generate reports
framework:
name: android/espresso
args:
buildName: Espresso
video: true
deviceLog: true
artifacts: true #to generate artifacts
appPath: proverbial_android.apk
testSuitePath: proverbial_android_expressotest.apk # We have used the appPath and testSuitePath here.
appId: lt://APP123456789
testSuiteAppId: lt://APP123456789 # We have used the appId and testSuiteAppID here.
deviceSelectionStrategy: all
devices:
- Galaxy.*
- Pixel.*
shards:
mappings:
- name: shard1
strategy: class
values:
- com.lambdatest.proverbial.BrowserTest
# The strategy for this shard is based on "class".
# This shard will run all tests from the class com.lambdatest.proverbial.BrowserTest.
- name: shard2
strategy: package
values:
- com.lambdatest.proverbial
# The strategy for this shard is based on "package".
# This shard will run all tests that belong to the package com.lambdatest.proverbial.l.
- name: shard3
strategy: skipClass
values:
- com.lambdatest.proverbial.BrowserTest
# The strategy for this shard is to skip a specific class.
# This shard will avoid running tests from the class com.lambdatest.proverbial.BrowserTest.
jobLabel: ['HYP', 'Espresso', 'Manual Sharding']
- The uploadArtefact flag is currently not available for Espresso framework tests.
- To run adb commands in the pre and post-steps, include the following two flags in your YAML file: To execute it, you must have purchased an equivalent number of parallels for both HyperExecute and Real Device.
privateCloud: true
preservedDevice: true
Step 6: Generate Reports and Artifacts
To generate artifacts for your Espresso tests, add the artifacts: true
, and report: true
flag in your YAML file:
report: true
framework:
name: "android/espresso"
args:
artifacts: true
...//
To download these artifacts in your local machine, you can pass the --download-artifacts
and --download-report
flag with the CLI command to execute the tests as shown in the next step.
Step 7: Execute your Test Suite
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.
Run the below command in your terminal at the root folder of the project:
./hyperexecute --config RELATIVE_PATH_OF_YOUR_YAML_FILE --download-artifacts --download-report
OR use this command if you have not exported your username and access key in the step 2.
./hyperexecute --user undefined --key undefined --config RELATIVE_PATH_OF_YOUR_YAML_FILE --download-artifacts --download-report
Visit the HyperExecute Dashboard and check your Job status.
If you are stumbling upon errors during Espresso test execution, then refer to the Espresso Troubleshoot guide for detailed explanations to your common errors.
Additional Details
Sharding
Sharding is a mobile test automation technique that distributes test cases across multiple real and virtual devices via parallel testing. It entails breaking down test suites into smaller subsets known as shards and running each shard concurrently on separate test execution environments.
There are two types of Sharding:
Manual Sharding
This feature enables users to manually specify shards along with their definitions, offering multiple strategies such as class, package, and more. By doing so, users can have greater flexibility and control over the sharding process.
Auto Sharding
The system intelligently determines the distribution of tests across devices, employing specific criteria to optimize the testing process.
-
When Shards are added :
-
If you are using the
deviceSelectionStrategy: all
,then in that case all the specified shards will be executed on every device available. -
If you are using the
deviceSelectionStrategy: any
, then in that case all the specified shards will be executed on just one device from the provided list.
-
-
When Shards are not added :
-
If you are using the
deviceSelectionStrategy: all
, then in that case the tests will be executed on all mentioned devices in.yaml
based on the concurrency. -
If you are using the
deviceSelectionStrategy: any
, then in that case all the specified tests will be executed on each device from the provided list, considering the concurrency setting.
-
Conclusion
By following the instructions in this documentation, you can seamlessly execute the Espresso tests on HyperExecute, leveraging its secure cloud infrastructure, advanced features, and optimized test execution workflow.