Documentation / Mobile phones

Run tests on mobile phones #

Test on Android #

You can run your tests on Chrome on Android phones.

Prerequisites #

We normally recommends using our Docker containers when you run sitespeed.io/Browsertime. However driving Android from Docker only works on a Linux host since there’s is no way at the moment to map USB on Mac. If you use a Mac Mini or another Mac computer you should use the npm version. try

Desktop #

If you don’t use Docker you need to:

  • Install the Android SDK on your desktop (just the command line tools!). If you are on a Mac and use Homebrew just run: brew tap caskroom/cask && brew cask install android-platform-tools

On your phone #

You probably want to setup a new phone from scratch to have a dedicated device. When you start your phone for the first time, follow these instructions:

  • Make sure to say no to all data collection (on a new Android its something like 4-5 times you need to say no)
  • Setup a specific Google account that you use for testing
  • Update to latest Chrome in the Play Store (log in with your new user)
  • Set volume to zero for Media/Alarm/Ring, and turn off the Power up/down sound. Turn off all sounds that you can!
  • Disable screen lock on your device (Set Screen Lock to None).
  • You probably also want to disable notifications from different update services. Do that under Settings and Apps, then choose the service and select Notifications and toggle Block All to On.

Next step is to prepare your phone to be used from a computer. To do that you need to enable Developer options:

  • Go to About device (or About phone) in your settings, tap it, scroll down to the Build number, tap it seven (7) times to enable developer options.

Then in Developer options:

  • Enable Stay awake
  • Turn off Automatic System Updates
  • Enable USB debugging

You are almost ready!

  • Plug in your phone using the USB port on your desktop computer.
  • When you plugin your phone, click OK on the “Allow USB debugging?” popup.

Run #

You are now ready to test using your phone:

sitespeed.io --android https://www.sitespeed.io

Remember: To test on Android using Docker you need to be on Linux (tested on Ubuntu). It will not work on OS X.

docker run --privileged -v /dev/bus/usb:/dev/bus/usb -e START_ADB_SERVER=true --rm -v "$(pwd):/sitespeed.io" sitespeedio/sitespeed.io:15.9.0  -n 1 --android --browsertime.xvfb false https://www.sitespeed.io

You will get result as you would with running this normally with summaries and waterfall graphs.

Connectivity #

If you run by default, the phone will use the current connection.

gnirehtet and Throttle #

You can use the connection of your desktop by reverse tethering. And then set the connectivity on your desktop computer.

  1. Download gnirehtet (Java or Rust version)
  2. Install Throttle (works on Mac OS X or Linux that has tc installed): npm install @sitespeed.io/throttle -g
  3. Make sure your phone is plugged into your desktop using USB.
  4. Start gnirehtet: ./gnirehtet run
  5. Start throttle: throttle 3g
  6. Run sitespeed.io.

If you use OS X you can use the Ryan Wirth wrapper for gnirehtet that makes it even simpler.

Note: the first time you run gnirehtet you need to accept the vpn connection on your phone.

TSProxy #

You can set connectivity by using TSProxy.

  1. Download TSProxy and make sure you have at least Python 2.7 installed.
  2. Check the local IP of your machine (in this example the IP is 10.0.1.7 and the default port for TSProxy is 1080).
  3. Start TSProxy and bind it to your IP: python tsproxy.py --bind 10.0.1.7 --rtt=200 --inkbps=1600 --outkbps=768
  4. Run \$ sitespeed.io --android --browsertime.chrome.args proxy-server="socks://10.0.1.7:1080" https://www.sitespeed.io

You could also use phuedxs Pi Network Conditioner, but using that requires some additional work but more reliable metrics.

Video and SpeedIndex #

You can also collect a video and get Visual Metrics. Running on Mac or without Docker you need to install the requirements for VisualMetrics yourself on your machine before you start. If you have everything setup you can run:

sitespeed.io --android --video --visualMetrics https://www.sitespeed.io

And using Docker (remember: only works in Linux hosts):

docker run --privileged -v /dev/bus/usb:/dev/bus/usb -e START_ADB_SERVER=true --rm -v "$(pwd):/sitespeed.io" sitespeedio/sitespeed.io:15.9.0  -n 1 --android --browsertime.xvfb false https://www.sitespeed.io

If you want to run Docker on Mac OS X, you can follow Appiums setup by creating a docker-machine, give out USB access and then run the container from that Docker machine.

Driving multiple phones from the same computer #

If you wanna drive multiple phones from one computer using Docker, you need to mount each USB port to the right Docker container.

You can do that with the --device Docker command: --device=/dev/bus/usb/001/007

The first part is the bus and that will not change, but the second part devnum changes if you unplug the device or restart,

You need to know which phone are connected to which USB port.

Here’s an example on how you can get that automatically before you start the container, feeding the unique id (that you get from lsusb).

#!/bin/bash

# Example ID, change this in your example
ID=22b8:2e76
LSUSB_OUTPUT=$(lsusb -d $ID)

if [ -z “$LSUSB_OUTPUT” ]; then
 echo “Could not find the phone”
 exit;
fi

BUS=`echo $LSUSB_OUTPUT | grep -Po 'Bus \K[0-9]+'`

# Read the device number:
DEV=`echo $LSUSB_OUTPUT | grep -Po 'Device \K[0-9]+'`

echo $BUS/$DEV

Running different versions of Chrome #

You can choose which Chrome version you want to run on your phone using --chrome.android.package to specify each versions package name. By default (just using --android Chrome stable version is used):

  • Chrome Stable - com.android.chrome
  • Chrome Beta - com.chrome.beta
  • Chrome Dev - com.chrome.dev
  • Chrome Canary - com.chrome.canary
  • Chromium - org.chromium.chrome

If you installed Chrome Canary on your phone and want to use it, then add --chrome.android.package com.chrome.canary to your run. Driving different versions needs different versions of the ChromeDriver. The Chrome version number needs to match the ChromeDriver version number. Browsertime/sitespeed.io ships with the latest stable version of the ChromeDriver. If you want to run other versions, you need to download from the official ChromeDriver page. And then you specify the version by using --chrome.chromedriverPath.

Collect trace log #

One important thing when testing on mobile is to analyse the Chrome trace log. You can get that with --cpu:

sitespeed.io --android --cpu https://www.sitespeed.io

Running Firefox #

To run Firefox stable you just run:

sitespeed.io --android -b firefox https://www.sitespeed.io

Note that collecting the HAR is turned off since we cannot use the HAR Export trigger on Android.

Only run tests when battery temperature is below X #

You can configure your tests to run when the battery temperature of your phone is below a certain threshold. Over heated mobile phones throttles the CPU so its good to keep track of the temperature (if you send metrics to Graphite/InfluxDB the battery temperature is automatically sent).

Use --androidBatteryTemperatureLimit to set a minimum battery temperature limit before you start your test on your Android phone. Temperature is in Celsius.

In this example the tests will start when the battery is below 32 degrees. By default sitespeed.io will wait two minutes and then check again. You can configure the wait time with --androidBatteryTemperatureWaitTimeInSeconds.

sitespeed.io --android --androidBatteryTemperatureLimit 32 https://www.sitespeed.io

Run on a rooted device #

You can run on fresh Android device or on a rooted device. If you use rooted device and you use a Moto G5 or a Pixel 2 it will be configured for as stable performance as possible if you add --androidRooted to your run. We follow Mozillas setup best practise to do that. Make sure you only do that for a phone that you have dedicated to performance tests, since it will be kept in that performance state after the tests.

Power usage testing #

You can run power usage tests on your webpage with android. To do so, you would need to provide the --androidPower true option:

sitespeed.io --android -b firefox --androidPower true https://www.sitespeed.io

To get data from this, you need to make sure your phone has its charging disabled. One method of doing this could be to run adb over wifi instead of through a USB connection. Alternatively, if your phone is rooted, you can use commands that are similar to these (they are model-specific):

Pixel 2
-------
Disable: adb shell "su -c 'echo 1 > /sys/class/power_supply/battery/input_suspend'"
Enable: adb shell "su -c 'echo 0 > /sys/class/power_supply/battery/input_suspend'"

Moto G5
-------
Disable: adb shell "su -c 'echo 0 > /sys/class/power_supply/battery/charging_enabled'"
Enable: adb shell "su -c 'echo 1 > /sys/class/power_supply/battery/charging_enabled'"

Results from this are gathered into the android.power entry in the browsertime results JSON. The measurements are all in mAh (milliampere-hours). The metrics that are obtained depend on the major android version being used (Android 7 doesn’t have smearing which gives the screen and proportional metrics), but you will usually find these:

  • total: The total power used by the application.
  • cpu: The total cpu power used by the application.
  • sensor: The total sensor power used by the application.
  • screen: The total screen power (smeared) used by the application.
  • full-screen: The total screen power used during the test (not specific to the application).
  • wifi: The total wifi power used by the application.
  • full-wifi: The total wifi power used during the test (not specific to the application).
  • proportional: The proportionally smeared power usage portion of the application (power usage of background applications that are propotionally attributed to all open applications).

Test on iOS #

You can run your tests on Safari on iOS.

Prerequisites #

To be able to test you need latest OS X Catalina on your Mac computer and iOS 13 on your phone (or iPad).

Desktop #

Run your test using npm (instead of Docker).

SafariDriver the driver that drives Safari is bundled in OS X. But to be able to use it you need to enable it with:

safaridriver --enable

On your phone #

On Safari you need to enable Remote Automation to be able to drive it with WebDriver. To do this, toggle the setting in Settings → Safari → Advanced → Remote Automation.

Plug in the phone into your machine and trust the host and make sure that your phone is unlocked when you run your tests.

Your phone needs to be unlocked (turn off Auto-Lock) and make sure to turn down the brightness, so that you save energy.

If you have any problems, make sure to read the WebKit blog post about setting up your phone for Selenium.

Run #

You are now ready to test using your phone:

sitespeed.io -b safari --safari.ios https://www.sitespeed.io

Limitations #

At the moment there are a couple of limitations running Safari:

  • No HAR file
  • No videos
  • No way to set request headers
  • No built in setting connectivity

You can help us adding support in Browsertime!