Running Playwright with Real Devices on HyperExecute

This guide details how to execute your Playwright Real Device tests on HyperExecute:

Prerequisites

To run the Tests on HyperExecute from your Local System, you are required:

• Your LambdaTest Username and Access key
• HyperExecute YAML file which contains all the necessary instructions.
• HyperExecute CLI in order to initiate a test execution Job.
• Setup the Environmental Variable

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.

Sample repo

Download or Clone the code sample for the Playwright Real Device from the LambdaTest GitHub repository to run the tests on the HyperExecute.

View on GitHub

Configure the Capabilities

Configure the desired capabilities based on your test requirements. For example:

const capabilities = {
  'browserName': 'Chrome', #Browsers allowed: `Chrome`, `MicrosoftEdge`, `pw-chromium`, `pw-firefox` and `pw-webkit`
  'browserVersion': 'latest',
  'LT:Options': {
    'platform': 'android',
    'build': 'Playwright HyperExecute Build',
    'name': 'Playwright HyperExecute Test',
    'user': '<your_lambdatest_user_name>',
    'accessKey': '<your_lambdatest_access_key>',
    # 'network': true,
    'video': true,
    'console': true
  }
}

You can generate capabilities for your test requirements with the help of our inbuilt 🔗 Capabilities Generator Tool.

Configure the CDP URL

• You will have to update the CDP (Chrome DevTools Protocol) URL which is a protocol used for communication between the browser and the developer tools.

const browser = await chromium.connect({
  wsEndpoint: `wss://cdp.lambdatest.com/playwright?capabilities=${encodeURIComponent(JSON.stringify(capabilities))}`
})

Step 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:

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

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

export LT_USERNAME="undefined"
export LT_ACCESS_KEY="undefined"

Windows

set LT_USERNAME="undefined"
set LT_ACCESS_KEY="undefined"

Step 3: Configure YAML in your Test Suite

Configure your YAML file as per your use cases using key value pairs.

In this sample YAML file, we have mentioned:

• version of the YAML file
• runson flag to specify the operating system
• Mode of execution is Autosplit. You can also opt for Matrix or Hybrid mode.
• Pre and Post commands
• and other necessary YAML Parameters

---
version: "0.2"

runson: android

autosplit: true

concurrency: 1

retryOnFailure: true
maxRetries: 2

cacheKey: '{{ checksum "package-lock.json" }}'
cacheDirectories:
  - node_modules

env:
  INFRA_TIMEOUT: 2000

runtime:
  language: node
  version: "18"

pre:
  - npm install
  - npx playwright install

testDiscovery:
    command: cat pw_androidtests.txt
    mode: static
    type: raw

testRunnerCommand: npm run test-android --verbose

framework:
  name: appium
  args:
    playwrightRD : true
    region: eu

jobLabel: ['Playwright', 'Real-Device', 'HyperExecute']

info

To Run test on Mobile Containers in a Particular Region

dynamicAllocation: true

framework:
  name: appium
  args:
    playwrightRD : true
    region: ap       # supported regions -> ap, eu, us 
    reservation: false

• If reservation : false, it means that it will allocate the device from any region. If you want to allocate the device of any specific region, keep the reservation : true.

Step 4: 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 <path_of_yaml_file>

OR use this command if you have not exported your username and access key in the step 2.

./hyperexecute --user <your_username> --key <your_access_key> --config <your_yaml_file_name>

Step 5: Monitor the Test Execution

Visit the HyperExecute Dashboard and check your Job status.

Step 6: Download Artifacts and Reports

HyperExecute also facilitates the provision to download the Artifacts and Reports on your local machine. Click on the corresponding button to download your generated artifacts and reports.