mobile_app.yml

The mobile_app.yml file defines the configuration of the native app and the device that is used for your test run if you have selected it as a test type in config.yml.

source

nodejs

2021.1.0

ruby

2021.1.0

source: local_device

Specify where you want the mobile app to be tested.

language	source	description
	local_device	test a mobile app on a locally connected device
	browserstack	test a mobile app on a device in BrowserStack

app_path

nodejs

2021.1.0

ruby

2021.1.0

app_path: ./test-evolve-demo-app.apk

The relative or absolute path to the mobile app under test. This will be uploaded and installed to the configured device at the start of the test run.

default_timeout

nodejs

2021.1.0

ruby

2021.1.0

default_timeout: 20

Enter the number of seconds that the test automation should wait to find an element in the mobile app before failing the test.

browserstack

nodejs

2021.1.0

ruby

2021.1.0

If you have configured source to be browserstack, then the browserstack section defines the configuration for the device to be used to test the mobile app in Browserstack.

info

In order to use the Test Evolve BrowserStack integration you will need an account with BrowserStack. In order to use a device in BrowserStack for mobile app testing using the following configuration you will also need to add a valid username and api key to the accounts.yml configuration file.

local_testing

nodejs

2021.1.0

ruby

2021.1.0

local_testing: true

Use the BrowserStack binary to allow for testing of locally accessible environments.

For more information on how to setup the BrowserStack binary, visit https://www.browserstack.com/local-testing

option	description
true	enables local testing using the BrowserStack binary. if the binary is not running on the machine running the tests, or it is misconfigured the test will fail
false	the mobile app on the device in BrowserStack will only have access publicly accessible APIs

download_video_upon_failure

deprecated

Please remove this option from your configuration file.

browserstack_debug

nodejs

2021.1.0

ruby

2021.1.0

browserstack_debug: true

Enable the debug logs for the test in BrowserStack. These can be accessed via the BrowserStack dashboard.

option	description
true	enables debug logging
false	disables debug logging

test_name

nodejs

2021.1.0

ruby

2021.1.0

test_name: Regression Tests

This identifier is referred to as Project name in BrowserStack and it can be used to easily identify the results in BrowserStack.

mobile

browserstack only has a mobile section for testing mobile apps in Test Evolve.

Available mobile devices can be found here: https://www.browserstack.com/list-of-browsers-and-platforms/automate

Configurations can be found using the BrowserStack Capabilities Generator: https://www.browserstack.com/app-automate/capabilities. Select a mobile device in the tool and add the values from the generated capabilities to the Test Evolve configuration.

device

nodejs

2021.1.0

ruby

2021.1.0

device: iPhone 11 Pro

The name of the BrowserStack device.

platform

nodejs

2021.1.0

ruby

2021.1.0

platform: android

The OS of the BrowserStack device.

local_device

nodejs

2022.2.1

ruby

2021.1.0

If you have configured source to be local_device, then the local_device section defines the configuration for the locally connected device to be used to test the mobile app.

command_timeout

nodejs

2022.2.1

ruby

2021.1.0

command_timeout: 60

Specify the timeout of the connection to the device in Appium.

appium_options

nodejs

2022.2.1

ruby

2022.1.0

appium_options: []

Using this input array, you can now add any valid appium capability to configure your test run as required.

mobile

local_device only has a mobile section in Test Evolve.

device_name

nodejs

2022.2.1

ruby

2021.1.0

device_name: iPhone X

Specify the name of the connected device to be used in the test run.

platform_name

nodejs

2022.2.1

ruby

2021.1.0

platform_name: Android

Specify the operating system on the connected device being used in the test run. This helps Appium select the correct driver to use to connect and manage the device.

platform_version

nodejs

2022.2.1

ruby

2021.1.0

platform_version: 10.0

Specify the operating system version on the connected device being used in the test run. This helps Appium select the correct driver to use to connect and manage the device.

udid

nodejs

2022.2.1

ruby

2021.1.0

udid: emulator-5554

Specify the udid of the connected device being used in the test run. There are different methods to finding this id in Android and iOS.

Example mobile_app.yml

Ruby

default_config/mobile_app.yml

&defaults_mobile_app

source: local_device
app_path: ./testevolvemobileapp.apk
default_timeout: 20

browserstack:
  local_testing: false
  browserstack_debug: true
  test_name: Regression Tests

  mobile:
    device: Test Device
    platform: android

local_device:
  command_timeout: 60
  appium_options: []

  mobile:
    device_name: Pixel 2
    platform_name: Android
    platform_version: 10
    udid: emulator-5554

JavaScript

default_config/mobile_app.yml

source: local_device
app_path: ./testevolvemobileapp.apk
default_timeout: 20

browserstack:
  local_testing: false
  browserstack_debug: true
  test_name: Regression Tests

  mobile:
    device: Test Device
    platform: android

local_device:
  command_timeout: 60
  appium_options: []

  mobile:
    driver: UIAutomator2
    device_name: Samsung Galaxy S20
    platform_name: Android
    platform_version: "10"
    udid: emulator-5554