The Sauce Labs Cookbook

Sauce Headless

Front End Performance Testing

Insights

External Resources

More Info


Page tree
Skip to end of metadata
Go to start of metadata

With Sauce Runner for Real Devices, you can run tests using the Espresso and XCUITest frameworks, run tests in parallel across multiple devices, and run subsets of tests against specific devices. This topic describes the options you can use with the runner. You can set the options as environment variables that can be referenced in your testing scripts, or pass them as command line parameters, which will take precedence over options set as environment variables. You can also create a runner configuration file with the options and commands for running your tests.

Only Available in TestObject

At the moment, the Sauce Runner is only available for our Legacy Real Device Cloud Platform, check the Real Device Testing in Sauce Labs Feature Preview for updates on when the Sauce Runner will be available.


What You'll Need

General Usage

JAVA_HOME=$(/usr/libexec/java_home --version 8) java -jar runner.jar  <command> <command options>

Commands

CommandDescription
xcuitestDefines xcuitest as the test framework to use for your native iOS tests
espressoDefines espresso as the test framework to use for your native Android tests
configDefines a configuration YAML file where the runner executes based on the parameters set in the file. Please note, if you decide to use the config command you can no longer use any of the command options below. For more information please read the following wiki page: Creating a Sauce Runner for Real Devices Configuration File.

Options

RequiredOptionDescription
X--apikeyThe API key for your Sauce Labs real device cloud account.
X--appThe path to the *.ipa or *.apk file of the application under test or the id number of an already uploaded app. In your command line, refer to the location where you have downloaded the runner.jar file or run the command from the folder from where you downloaded the runner.
X--testThe path to the *.ipa or *.apk file of the test.
X--datacenter

The Data Center endpoint to use in your tests. For Espresso and XCUITest, you'll need to choose from either the US or EU data centers. For more information, see Data Center Endpoints.

If you don't specify a device or devices for your test, one will be assigned to your tests based on the type of application you're testing against.


--deviceFor static allocation of a device, provide the ID for the type of device to use in your tests, such as 'iPhone_5_real'. You can find the IDs for devices on the Live Testing page in the Sauce Labs web interface. Under the Real Devices tab, search for the type of device you want to use, and then click the Details link in the device description to see the device ID. See Examples of Device Specifications for the Real Device Runner for more information.

--devicesThe list of devices, allocated dynamically or through static description of the device ID, to use in your tests. See Examples of Device Specifications for the Real Device Runner for more information.

--testname

Set a custom test name to appear on the UI, Default is Test.


--tunnelIdentifierIf you are using Sauce Connect Proxy, provide the identifier of the tunnel you want to use.

--checkFrequencyInterval in seconds to check test results. Default is 30.

--timeoutTest timeout in minutes. Test duration cannot exceed 60 minutes. Defaults to 60.

--xmlFolderThe folder for the JUnit XML output.

--urlProvide the URL of an alternative REST endpoint to use. See Data Center Endpoints.

--platformVersionFor dynamic allocation of a device, provide an operating system version to use. For example, use '9' to allocate a device running major version 9 and arbitrary versions of the OS, or '9.3.3' for a specific version. See Examples of Device Specifications for the Real Device Runner for more information.

--privateDevicesOnly

If set, only private devices will be queried.


--phoneOnly

If set, only phones will be queried.


--tabletOnly

If set, only tablets will be queried.


--deviceNameQuery

For dynamic allocation of a device, provide the device name you would like to dynamically allocate. For example, use 'iPhone.*Plus' to allocate any iPhone Plus device. See Examples of Device Specifications for the Real Device Runner for more information.


--testsToRun

XCUITest only

Provide a comma separated list of test cases or test classes.

If you want to run all tests of a class, provide only the classname. If you want to run a specific method of a class, provide the class name and method name separated with a '/' (i.e., '--testsToRun ClassA,ClassB/methodC' runs all tests in 'ClassA' and only 'methodC' of 'ClassB').


Example

--testsToRun ClassA,ClassB/methodC


--useTestOrchestrator

Espresso only

If set, the instrumentation will start with Test Orchestrator version 1.1.1 in use.

NOTE: with Test Orchestrator, it is in most cases recommended to also add the "--e clearPackageData true" parameter to remove all shared state from your device's CPU and memory after each test.


--e

Espresso only

Provide a list of test options to Espresso. The key-value pairs supported by espresso are documented here: https://developer.android.com/studio/test/command-line#AMOptionsSyntax. In the example, the test would execute all test methods defined in the class com.example.android.TestClassA and the test method methodName defined in com.example.android.TestClassB.


Example: Execute all tests in class TestClassA

--e class com.example.android.TestClassA


Example: Execute a specific test in class TestClassB

--e class com.example.android.TestClassB#methodName

Using Sauce Runner with a Proxy

If you need Sauce Runner to connect to the internet through a proxy server, use the -D command to specify a direct domain connection to your proxy server and port. The parameters http.proxyUser and http.proxyPassword are optional and can be used if the proxy needs authentication:

java -Dhttp.proxyHost=<your proxy server> -Dhttp.proxyPort=<the port to use> -Dhttp.proxyUser=<the username to use> -Dhttp.proxyPassword=<the password to use>

CLI Examples

XCUITest Example

XCUITest Example with All Required Parameters and Setting the Data Center Option to US
java -jar runner.jar xcuitest --test DummyTestingApp-Runner.ipa --app DummyTestingApp.ipa --apikey <apikey> --datacenter US

Espresso Example

Espresso Example with all Required Parameters and Setting the Data Center Option to US
java -jar runner.jar espresso --test DummyTestingApp-Runner.apk --app DummyTestingApp.apk --apikey <apikey> --datacenter US