Atest

Atest is a command line tool that allows users to build, install, and run Android tests locally, greatly speeding test re-runs without requiring knowledge of Trade Federation test harness command line options. This page explains how to use Atest to run Android tests.

For general information on writing tests for Android, see Android Platform Testing.

For information on the overall structure of Atest, see Atest Developer Guide.

And to add a feature to Atest, follow Atest Developer Workflow.

Setting up your environment

To run Atest, follow the steps in the sections below to set up your environment.

Set environment variable

Set test_suite for Soong or LOCAL_COMPATIBILITY_SUITE for Make per Packaging build script rules.

1. Run envsetup.sh

From the root of the Android source checkout, run:

source build/envsetup.sh

2. Run lunch

Run the $ lunch command to bring up a menu of supported devices. Find the device and run that command.

For example, if you have an ARM device connected, run the following command:

lunch aosp_arm64-eng

This sets various environment variables required for running Atest and adds the Atest command to your $PATH.

Basic usage

Atest commands take the following form:

atest [optional-arguments] test-to-run

Optional arguments

You can use the following optional arguments with Atest commands.

Option	Long option	Description
`-b`	`--build`	Builds test targets.
`-i`	`--install`	Installs test artifacts (APKs) on device.
`-t`	`--test`	Runs the tests.
`-s`	`--serial`	Runs the tests on the specified device. One device can be tested at a time.
`-d`	`--disable-teardown`	Disables test teardown and cleanup.
	`--info`	Shows the relevant info of the specified targets and exits.
	`--dry-run`	A synonym of --info.
`-m`	`--rebuild-module-info`	Forces a rebuild of the module-info.json file.
`-w`	`--wait-for-debugger`	Waits for debugger prior to execution. Only for instrumentation tests.
`-v`	`--verbose`	Displays DEBUG level logging.
	`--generate-baseline`	Generates baseline metrics, runs 5 iterations by default.
	`--generate-new-metrics`	Generates new metrics, run 5 iterations by default.
	`--detect-regression`	Runs regression detection algorithm.
	`--[CUSTOM_ARGS]`	Specifies custom args for the test runners.
`-a`	`--all-abi`	Runs the tests for all available device architectures.
`-h`	`--help`	Shows help message and exits.
	`--host`	Runs the test completely on the host without a device. (Note: Running a host test that requires a device with --host will fail.)

For more information on -b, -i and -t, see Specifying steps: build, install, or run.

Tests to run

You can run one or more tests using test-to-run. To run multiple tests, separate test references with spaces. For example:

atest test-to-run-1 test-to-run-2

Here are some examples:

atest FrameworksServicesTests
atest example/reboot
atest FrameworksServicesTests CtsJankDeviceTestCases
atest FrameworksServicesTests:ScreenDecorWindowTests

For more information on how to reference a test, see Identifying tests.

Identifying tests

You can specify the test-to-run argument with the test's module name, Module:Class, class name, TF integration test, file path or package name.

Module name

To run an entire test module, use its module name. Input the name as it appears in the LOCAL_MODULE or LOCAL_PACKAGE_NAME variables in that test's Android.mk or Android.bp file.

Examples:

atest FrameworksServicesTests
atest CtsJankDeviceTestCases

Module:Class

To run a single class within a module, use Module:Class. Module is the same as described in Module name. Class is the name of the test class in the .java file and can be the fully qualified class name or the basic name.

Examples:

atest FrameworksServicesTests:ScreenDecorWindowTests
atest FrameworksServicesTests:com.android.server.wm.ScreenDecorWindowTests
atest CtsJankDeviceTestCases:CtsDeviceJankUi

Class name

To run a single class without explicitly stating a module name, use the class name.

Examples:

atest ScreenDecorWindowTests
atest CtsDeviceJankUi

Using the Module:Class reference is recommended whenever possible since Atest requires more time to search the complete source tree for potential matches if no module is stated.

Examples (ordered from fastest to slowest):

atest FrameworksServicesTests:com.android.server.wm.ScreenDecorWindowTests
atest FrameworksServicesTests:ScreenDecorWindowTests
atest ScreenDecorWindowTests

TF integration test

To run tests that are integrated directly into TradeFed (non-modules), input the name as it appears in the output of the tradefed.sh list configs command. For example:

To run the reboot.xml test:

atest example/reboot

To run the native-benchmark.xml test:

atest native-benchmark

File path

You can run both module-based tests and integration-based tests by inputting the path to their test file or directory as appropriate. You can also run a single class by specifying the path to the class's Java file. Both relative and absolute paths are supported.

Example: Two ways to run the CtsJankDeviceTestCases module via path

Run module from android repo-root:
```
atest cts/tests/jank
```
From android repo-root/cts/tests/jank:
```
atest .
```

Example: Run a specific class within CtsJankDeviceTestCases module via path. From android repo-root:

atest cts/tests/jank/src/android/jank/cts/ui/CtsDeviceJankUi.java

Example: Run an integration test via path. From android repo-root:

atest tools/tradefederation/contrib/res/config/example/reboot.xml

Package name

Atest supports searching tests by package name.

Examples:

atest com.android.server.wm
atest android.jank.cts

Specifying steps: Build, install, or run

You can specify which steps to run by using the -b, -i, and -t options. If you don't specify an option, then all steps run.

Build targets only: atest -b test-to-run
Run tests only: atest -t test-to-run
Install apk and run tests: atest -it test-to-run
Build and run, but don't install: atest -bt test-to-run

Atest can force a test to skip the cleanup/teardown step. Many tests, such as CTS, clean up the device after the test is run, so trying to rerun your test with -t will fail without the --disable-teardown parameter. Use -d before -t to skip the test clean up step and test iteratively.

atest -d test-to-run
atest -t test-to-run

Running specific methods

You can run specific methods within a test class. Although the whole module needs to be built, this reduces the time needed to run the tests. To run specific methods, identify the class using any of the ways supported for identifying a class (Module:Class, file path, etc) and append the name of the method.

atest reference-to-class#method1

You can specify multiple methods with commas.

atest reference-to-class#method1,method2,method3

Examples:

atest com.android.server.wm.ScreenDecorWindowTests#testMultipleDecors
atest FrameworksServicesTests:ScreenDecorWindowTests#testFlagChange,testRemoval

The following two examples show the preferred ways to run a single method, testFlagChange. These examples are preferred over only using the class name because specifying the module or the Java file location allows Atest to find the test much faster:

Using Module:Class

atest FrameworksServicesTests:ScreenDecorWindowTests#testFlagChange

From android repo-root

atest frameworks/base/services/tests/servicestests/src/com/android/server/wm/ScreenDecorWindowTests.java#testFlagChange

Multiple methods can be run from different classes and modules:

atest FrameworksServicesTests:ScreenDecorWindowTests#testFlagChange,testRemoval ScreenDecorWindowTests#testMultipleDecors

Running multiple classes

To run multiple classes, separate them with spaces in the same way as running multiple tests. Atest builds and runs classes efficiently, so specifying a subset of classes in a module improves performance over running the whole module.

Examples:

Two classes in the same module:

atest FrameworksServicesTests:ScreenDecorWindowTests FrameworksServicesTests:DimmerTests

Two classes in different modules:

atest FrameworksServicesTests:ScreenDecorWindowTests CtsJankDeviceTestCases:CtsDeviceJankUi

Running native tests

Atest can run native tests.

Examples:

Input tests:

atest -a libinput_tests inputflinger_tests

Use -a to run the tests for all available device architectures, which in this example is armeabi-v7a (ARM 32-bit) and arm64-v8a (ARM 64-bit).

To select a specific native test to run, use colon (:) to specify the test name and hashtag (#) to further specify an individual method. For example, for the following test definition:

TEST_F(InputDispatcherTest, InjectInputEvent_ValidatesKeyEvents)

You can run the entire test using

atest inputflinger_tests:InputDispatcherTest

or an individual test method using

atest inputflinger_tests:InputDispatcherTest#InjectInputEvent_ValidatesKeyEvents

Detecting metrics regression

You can generate pre-patch or post-patch metrics without running regression detection. You can specify the number of iterations, but the default is five.

Examples:

atest test-to-run --generate-baseline [optional-iteration]
atest test-to-run --generate-new-metrics [optional-iteration]

Local regression detection can be run in three options:

Generate baseline (pre-patch) metrics and place them in a folder. Atest runs the tests through the specified iterations, generates post-patch metrics, and compares those against existing metrics.

Example:
```
atest test-to-run --detect-regression /path/to/baseline --generate-new-metrics [optional-iteration]
```
Using a folder containing previously generated post-patch metrics, Atest runs the tests n iterations, generates a new set of pre-patch metrics, and compares those against those provided.

Note: The developer needs to revert the device/tests to pre-patch state to generate baseline metrics.

Example:
```
atest test-to-run --detect-regression /path/to/new --generate-baseline [optional-iteration]
```
Using two folders containing both pre-patch and post-patch metrics, Atest runs the regression detection algorithm without any tests.

Example:
```
atest --detect-regression /path/to/baseline /path/to/new
```