blob: c065974b092480d8da1ef1c9ca3f49d6dd486564 [file] [log] [blame] [view]
# Android Test Instructions
[TOC]
## Device Setup
### Physical Device Setup
#### ADB Debugging
The adb executable exists within the Android SDK:
```shell
third_party/android_tools/sdk/platform-tools/adb
```
In order to allow the ADB to connect to the device, you must enable USB
debugging:
* Before Android 4.1 (Jelly Bean):
* Go to "System Settings"
* Go to "Developer options"
* Check "USB debugging".
* Un-check "Verify apps over USB".
* On Jelly Bean and above, developer options are hidden by default. To unhide
them:
* Go to "About phone"
* Tap 10 times on "Build number"
* The "Developer options" menu will now be available.
* Check "USB debugging".
* Un-check "Verify apps over USB".
#### Screen
You **must** ensure that the screen stays on while testing: `adb shell svc power
stayon usb` Or do this manually on the device: Settings -> Developer options ->
Stay Awake.
If this option is greyed out, stay awake is probably disabled by policy. In that
case, get another device or log in with a normal, unmanaged account (because the
tests will break in exciting ways if stay awake is off).
#### Disable Verify Apps
You may see a dialog like [this
one](http://www.samsungmobileusa.com/simulators/ATT_GalaxyMega/mobile/screens/06-02_12.jpg),
which states, _Google may regularly check installed apps for potentially harmful
behavior._ This can interfere with the test runner. To disable this dialog, run:
```
adb shell settings put global package_verifier_enable 0
```
### Using Emulators
#### Building for emulation
The fast Android emulators use the X86 instruction set, so anything run on such
an emulator has to be built for X86. Add
```
target_cpu = "x86"
```
to your args.gn file. You may want use different out directories for your X86
and ARM builds.
#### Setting up your workstation
The Android emulators support VM acceleration. This, however, needs to be
enabled on your workstation, as described in
https://developer.android.com/studio/run/emulator-acceleration.html#accel-vm.
#### Creating and running emulators from Android Studio
The easiest way to create and run an emulator is to use Android Studio's
Virtual Device Manager. See
https://developer.android.com/studio/run/managing-avds.html.
Creating emulators in Android Studio will modify the current SDK. If you are
using the project's SDK then this can cause problems the next time you sync
the project, so it is normally better to use a different SDK root when
creating emulators. You can set this up either by creating the Android Studio
project using generate_gradle.py's --sdk or --sdk-path options or by
changing the SDK location within AndroidStudio's settings.
#### Starting an emulator from the command line
Once you have created an emulator (using Android Studio or otherwise) you can
start it from the command line using the
[emulator](https://developer.android.com/studio/run/emulator-commandline.html)
command:
```
{$ANDROID_SDK_ROOT}/tools/emulator @emulatorName
```
where emulatorName is the name of the emulator you want to start (e.g.
Nexus_5X_API_27). The command
```
{$ANDROID_SDK_ROOT}/tools/emulator -list-avds
```
will list the available emulators.
#### Creating an emulator from the command line
New emulators can be created from the command line using the
[avdmanager](https://developer.android.com/studio/command-line/avdmanager.html)
command. This, however, does not provide any way of creating new device types,
and provides far fewer options than the Android Studio UI for creating new
emulators.
The device types are configured through a devices.xml file. The devices.xml
file for standard device types are within Android Studio's install, and that
for any additional devices you define are in $ANDROID_EMULATOR_HOME (defaulting
to ~/.android/). The contents of devices.xml is, however, undocumented (and
presumably subject to change), so this is best modified using Android Studio.
## Building Tests
If you're adding a new test file, you'll need to explicitly add it to a gn
target. If you're adding a test to an existing file, you won't need to make gn
changes, but you may be interested in where your test winds up. In either case,
here are some guidelines for where a test belongs:
### C++
C++ test files typically belong in `<top-level directory>_unittests` (e.g.
`base_unittests` for `//base`). There are a few exceptions -- browser tests are
typically their own target (e.g. `content_browsertests` for `//content`, or
`browser_tests` for `//chrome`), and some unit test suites are broken at the
second directory rather than the top-level one.
### Java
Java test files vary a bit more widely than their C++ counterparts:
- Instrumentation test files -- i.e., tests that will run on a device --
typically belong in either `<top-level directory>_javatests` or `<top-level
directory>_test_java`. Regardless, they'll wind up getting packaged into one
of a few test APKs:
- `webview_instrumentation_test_apk` for anything in `//android_webview`
- `content_shell_test_apk` for anything in `//content` or below
- `chrome_public_test_apk` for most things in `//chrome`
- `chrome_sync_shell_test_apk` in a few exceptional cases
- JUnit or Robolectric test files -- i.e., tests that will run on the host --
typically belong in `<top-level directory>_junit_tests` (e.g.
`base_junit_tests` for `//base`), though here again there are cases
(particularly in `//components`) where suites are split at the second
directory rather than the top-level one.
Once you know what to build, just do it like you normally would build anything
else, e.g.: `ninja -C out/Release chrome_public_test_apk`
## Running Tests
All functional tests should be runnable via the wrapper scripts generated at
build time:
```sh
<output directory>/bin/run_<target_name> [options]
```
Note that tests are sharded across all attached devices unless explicitly told
to do otherwise by `-d/--device`.
The commands used by the buildbots are printed in the logs. Look at
https://build.chromium.org/ to duplicate the same test command as a particular
builder.
### INSTALL\_FAILED\_CONTAINER\_ERROR or INSTALL\_FAILED\_INSUFFICIENT\_STORAGE
If you see this error when the test runner is attempting to deploy the test
binaries to the AVD emulator, you may need to resize your userdata partition
with the following commands:
```shell
# Resize userdata partition to be 1G
resize2fs android_emulator_sdk/sdk/system-images/android-25/x86/userdata.img 1G
# Set filesystem parameter to continue on errors; Android doesn't like some
# things e2fsprogs does.
tune2fs -e continue android_emulator_sdk/sdk/system-images/android-25/x86/userdata.img
```
## Symbolizing Crashes
Crash stacks are logged and can be viewed using `adb logcat`. To symbolize the
traces, define `CHROMIUM_OUTPUT_DIR=$OUTDIR` where `$OUTDIR` is the argument you
pass to `ninja -C`, and pipe the output through
`third_party/android_platform/development/scripts/stack`. If
`$CHROMIUM_OUTPUT_DIR` is unset, the script will search `out/Debug` and
`out/Release`. For example:
```shell
# If you build with
ninja -C out/Debug chrome_public_test_apk
# You can run:
adb logcat -d | third_party/android_platform/development/scripts/stack
# If you build with
ninja -C out/android chrome_public_test_apk
# You can run:
adb logcat -d | CHROMIUM_OUTPUT_DIR=out/android third_party/android_platform/development/scripts/stack
# or
export CHROMIUM_OUTPUT_DIR=out/android
adb logcat -d | third_party/android_platform/development/scripts/stack
```
## JUnit tests
JUnit tests are Java unittests running on the host instead of the target device.
They are faster to run and therefore are recommended over instrumentation tests
when possible.
The JUnits tests are usually following the pattern of *target*\_junit\_tests,
for example, `content_junit_tests` and `chrome_junit_tests`.
When adding a new JUnit test, the associated `BUILD.gn` file must be updated.
For example, adding a test to `chrome_junit_tests` requires to update
`chrome/android/BUILD.gn`. If you are a GYP user, you will not need to do that
step in order to run the test locally but it is still required for GN users to
run the test.
```shell
# Build the test suite.
ninja -C out/Default chrome_junit_tests
# Run the test suite.
out/Default/run_chrome_junit_tests
# Run a subset of tests. You might need to pass the package name for some tests.
out/Default/run_chrome_junit_tests -f "org.chromium.chrome.browser.media.*"
```
### Debugging
Similar to [debugging apk targets](android_debugging_instructions.md#debugging-java):
```shell
out/Default/bin/run_chrome_junit_tests --wait-for-java-debugger
out/Default/bin/run_chrome_junit_tests --wait-for-java-debugger # Specify custom port via --debug-socket=9999
```
## Gtests
```shell
# Build a test suite
ninja -C out/Release content_unittests
# Run a test suite
out/Release/bin/run_content_unittests [-vv]
# Run a subset of tests
out/Release/bin/run_content_unittests [-vv] --gtest-filter ByteStreamTest.*
```
## Instrumentation Tests
In order to run instrumentation tests, you must leave your device screen ON and
UNLOCKED. Otherwise, the test will timeout trying to launch an intent.
Optionally you can disable screen lock under Settings -> Security -> Screen Lock
-> None.
Next, you need to build the app, build your tests, and then run your tests
(which will install the APK under test and the test APK automatically).
Examples:
ContentShell tests:
```shell
# Build the code under test
ninja -C out/Release content_shell_apk
# Build the tests themselves
ninja -C out/Release content_shell_test_apk
# Run the test (will automagically install the APK under test and the test APK)
out/Release/bin/run_content_shell_test_apk [-vv]
```
ChromePublic tests:
```shell
# Build the code under test
ninja -C out/Release chrome_public_apk
# Build the tests themselves
ninja -C out/Release chrome_public_test_apk
# Run the test (will automagically install the APK under test and the test APK)
out/Release/bin/run_chrome_public_test_apk [-vv]
```
AndroidWebView tests:
```shell
ninja -C out/Release webview_instrumentation_apk
ninja -C out/Release webview_instrumentation_test_apk
out/Release/bin/run_webview_instrumentation_test_apk [-vv]
```
In order to run a subset of tests, use -f to filter based on test class/method
or -A/-E to filter using annotations.
Filtering examples:
```shell
# Run a test suite
out/Debug/bin/run_content_shell_test_apk
# Run a specific test class
out/Debug/bin/run_content_shell_test_apk -f AddressDetectionTest.*
# Run a specific test method
out/Debug/bin/run_content_shell_test_apk -f \
AddressDetectionTest#testAddressLimits
# Run a subset of tests by size (Smoke, SmallTest, MediumTest, LargeTest,
# EnormousTest)
out/Debug/bin/run_content_shell_test_apk -A Smoke
# Run a subset of tests by annotation, such as filtering by Feature
out/Debug/bin/run_content_shell_test_apk -A Feature=Navigation
```
You might want to add stars `*` to each as a regular expression, e.g.
`*`AddressDetectionTest`*`
### Debugging
Similar to [debugging apk targets](android_debugging_instructions.md#debugging-java):
```shell
out/Debug/bin/run_content_shell_test_apk --wait-for-java-debugger
```
### Deobfuscating Java Stacktraces
If running with `is_debug=false`, Java stacks from logcat need to be fixed up:
```shell
out/Release/bin/java_deobfuscate out/Release/apks/ChromePublicTest.apk.mapping < stacktrace.txt
```
Any stacks produced by test runner output will already be deobfuscated.
## Running Blink Layout Tests
See [Layout Tests](testing/layout_tests.md).
## Running GPU tests
(e.g. the "Android Debug (Nexus 7)" bot on the chromium.gpu waterfall)
See https://www.chromium.org/developers/testing/gpu-testing for details. Use
`--browser=android-content-shell`. Examine the stdio from the test invocation on
the bots to see arguments to pass to `src/content/test/gpu/run_gpu_test.py`.