README.md 9.5 KB
Newer Older
1
# Flutter DeviceLab
2

3
DeviceLab is a physical lab that tests Flutter on real devices.
Yegor's avatar
Yegor committed
4

5
This package contains the code for the test framework and tests. More generally
Yegor's avatar
Yegor committed
6 7 8
the tests are referred to as "tasks" in the API, but since we primarily use it
for testing, this document refers to them as "tests".

9
Current statuses for the devicelab are available at
10
https://flutter-dashboard.appspot.com/#/build. See [dashboard user guide](https://github.com/flutter/cocoon/blob/master/app_flutter/USER_GUIDE.md)
11 12
for information on using the dashboards.

13 14 15 16 17 18
## Table of Contents
* [How the DeviceLab runs tests](#how-the-devicelab-runs-tests)
* [Running tests locally](#running-tests-locally)
* [Writing tests](#writing-tests)
* [Adding tests to continuous integration](#adding-tests-to-continuous-integration)
* [Adding tests to presubmit](#adding-tests-to-presubmit)
19 20


21 22 23 24 25 26 27 28 29 30
## How the DeviceLab runs tests

DeviceLab tests are run against physical devices in Flutter's lab (the "DeviceLab").

Tasks specify the type of device they are to run on (`linux_android`, `mac_ios`, `mac_android`, `windows_android`, etc).
When a device in the lab is free, it will pickup tasks that need to be completed.

1. If the task succeeds, the test runner reports the success and uploads its performance metrics to Flutter's infrastructure. Not
all tasks record performance metrics.
2. If the task fails, the test runner reports the failure to Flutter's infrastructure and no performance metrics are collected
Yegor's avatar
Yegor committed
31

32
## Running tests locally
Yegor's avatar
Yegor committed
33 34 35 36 37 38

Do make sure your tests pass locally before deploying to the CI environment.
Below is a handful of commands that run tests in a similar way to how the
CI environment runs them. These commands are also useful when you need to
reproduce a CI test failure locally.

39
### Prerequisites
40

41
You must set the `ANDROID_SDK_ROOT` environment variable to run
42 43
tests on Android. If you have a local build of the Flutter engine, then you have
a copy of the Android SDK at `.../engine/src/third_party/android_tools/sdk`.
44

45 46
You can find where your Android SDK is using `flutter doctor`.

47
### Warnings
48

49
Running the devicelab will do things to your environment.
50

51
Notably, it will start and stop Gradle, for instance.
52

53
### Running specific tests
54

Yegor's avatar
Yegor committed
55 56 57
To run a test, use option `-t` (`--task`):

```sh
Ian Hickson's avatar
Ian Hickson committed
58
# from the .../flutter/dev/devicelab directory
59
../../bin/cache/dart-sdk/bin/dart bin/test_runner.dart test -t {NAME_OR_PATH_OF_TEST}
Yegor's avatar
Yegor committed
60 61
```

62 63
Where `NAME_OR_PATH_OF_TEST` can be either of:

64
- the _name_ of a task, which is a file's basename in `bin/tasks`. Example: `complex_layout__start_up`.
65 66 67
- the path to a Dart _file_ corresponding to a task, which resides in `bin/tasks`.
  Tip: most shells support path auto-completion using the Tab key. Example:
  `bin/tasks/complex_layout__start_up.dart`.
Ian Hickson's avatar
Ian Hickson committed
68

Yegor's avatar
Yegor committed
69 70 71
To run multiple tests, repeat option `-t` (`--task`) multiple times:

```sh
72
../../bin/cache/dart-sdk/bin/dart bin/run.dart -t test1 -t test2 -t test3
Yegor's avatar
Yegor committed
73 74
```

75
### Running tests against a local engine build
76 77 78 79 80 81 82 83 84 85

To run device lab tests against a local engine build, pass the appropriate
flags to `bin/run.dart`:

```sh
../../bin/cache/dart-sdk/bin/dart bin/run.dart --task=[some_task] \
  --local-engine-src-path=[path_to_local]/engine/src \
  --local-engine=[local_engine_architecture]
```

86
An example of a local engine architecture is `android_debug_unopt_x86`.
87

88
### Running an A/B test for engine changes
89 90 91 92

You can run an A/B test that compares the performance of the default engine
against a local engine build. The test runs the same benchmark a specified
number of times against both engines, then outputs a tab-separated spreadsheet
93 94
with the results and stores them in a JSON file for future reference. The
results can be copied to a Google Spreadsheet for further inspection and the
95
JSON file can be reprocessed with the `summarize.dart` command for more detailed
96
output.
97 98 99 100 101 102 103 104 105 106 107 108 109 110

Example:

```sh
../../bin/cache/dart-sdk/bin/dart bin/run.dart --ab=10 \
  --local-engine=host_debug_unopt \
  -t bin/tasks/web_benchmarks_canvaskit.dart
```

The `--ab=10` tells the runner to run an A/B test 10 times.

`--local-engine=host_debug_unopt` tells the A/B test to use the `host_debug_unopt`
engine build. `--local-engine` is required for A/B test.

111 112 113
`--ab-result-file=filename` can be used to provide an alternate location to output
the JSON results file (defaults to `ABresults#.json`). A single `#` character can be
used to indicate where to insert a serial number if a file with that name already
114
exists, otherwise, the file will be overwritten.
115

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
A/B can run exactly one task. Multiple tasks are not supported.

Example output:

```
Score	Average A (noise)	Average B (noise)	Speed-up
bench_card_infinite_scroll.canvaskit.drawFrameDuration.average	2900.20 (8.44%)	2426.70 (8.94%)	1.20x
bench_card_infinite_scroll.canvaskit.totalUiFrame.average	4964.00 (6.29%)	4098.00 (8.03%)	1.21x
draw_rect.canvaskit.windowRenderDuration.average	1959.45 (16.56%)	2286.65 (0.61%)	0.86x
draw_rect.canvaskit.sceneBuildDuration.average	1969.45 (16.37%)	2294.90 (0.58%)	0.86x
draw_rect.canvaskit.drawFrameDuration.average	5335.20 (17.59%)	6437.60 (0.59%)	0.83x
draw_rect.canvaskit.totalUiFrame.average	6832.00 (13.16%)	7932.00 (0.34%)	0.86x
```

The output contains averages and noises for each score. More importantly, it
contains the speed-up value, i.e. how much _faster_ is the local engine than
the default engine. Values less than 1.0 indicate a slow-down. For example,
0.5x means the local engine is twice as slow as the default engine, and 2.0x
means it's twice as fast. Higher is better.

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
Summarize tool example:

```sh
../../bin/cache/dart-sdk/bin/dart bin/summarize.dart  --[no-]tsv-table --[no-]raw-summary \
    ABresults.json ABresults1.json ABresults2.json ...
```

`--[no-]tsv-table` tells the tool to print the summary in a table with tabs for easy spreadsheet
entry. (defaults to on)

`--[no-]raw-summary` tells the tool to print all per-run data collected by the A/B test formatted
with tabs for easy spreadsheet entry. (defaults to on)

Multiple trailing filenames can be specified and each such results file will be processed in turn.

151
## Reproducing broken builds locally
Yegor's avatar
Yegor committed
152 153 154 155 156 157 158

To reproduce the breakage locally `git checkout` the corresponding Flutter
revision. Note the name of the test that failed. In the example above the
failing test is `flutter_gallery__transition_perf`. This name can be passed to
the `run.dart` command. For example:

```sh
159
../../bin/cache/dart-sdk/bin/dart bin/run.dart -t flutter_gallery__transition_perf
Yegor's avatar
Yegor committed
160
```
161

162
## Writing tests
163

keyonghan's avatar
keyonghan committed
164
A test is a simple Dart program that lives under `bin/tasks` and uses
165 166 167 168 169 170 171 172 173
`package:flutter_devicelab/framework/framework.dart` to define and run a _task_.

Example:

```dart
import 'dart:async';

import 'package:flutter_devicelab/framework/framework.dart';

174
Future<void> main() async {
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
  await task(() async {
    ... do something interesting ...

    // Aggregate results into a JSONable Map structure.
    Map<String, dynamic> testResults = ...;

    // Report success.
    return new TaskResult.success(testResults);

    // Or you can also report a failure.
    return new TaskResult.failure('Something went wrong!');
  });
}
```

Only one `task` is permitted per program. However, that task can run any number
of tests internally. A task has a name. It succeeds and fails independently of
other tasks, and is reported to the dashboard independently of other tasks.

A task runs in its own standalone Dart VM and reports results via Dart VM
service protocol. This ensures that tasks do not interfere with each other and
lets the CI system time out and clean up tasks that get stuck.

198
## Adding tests to continuous integration
199

200
Host only tests should be added to `flutter_tools`.
201

202
There are several PRs needed to add a DeviceLab task to CI.
203

204
_TASK_- the name of your test that also matches the name of the
205
  file in `bin/tasks` without the `.dart` extension.
206 207 208

1. Add prod builder to [flutter/infra devicelab_config.star](https://github.com/flutter/infra/blob/master/config/devicelab_config.star)
  - Example PR: https://github.com/flutter/infra/pull/401/files
209
  - This will need to soak for 15 minutes after merged to propagate (should show up in [LUCI console](https://ci.chromium.org/p/flutter/g/devicelab/console))
210 211 212 213 214
  - There are various lists for the different testbeds a test can run on
2. Add task to [flutter/flutter prod_builders.json](https://github.com/flutter/flutter/blob/master/dev/prod_builders.json)
  - Example PR: https://github.com/flutter/flutter/pull/79913/files
  - Set `flaky: true` for validation before blocking tree
3. After 10 green runs, update [flutter/flutter prod_builders.json](https://github.com/flutter/flutter/blob/master/dev/prod_builders.json) to `flaky:false`
215 216 217

If your test needs to run on multiple operating systems, create a separate test
for each operating system.
218 219 220 221 222 223 224 225 226 227 228 229 230

## Adding tests to presubmit

Flutter's DeviceLab does not currently have capacity to run tests against physical devices in presubmit.

Note that DeviceLab tests should generally require a tethered device. If you are adding host-only tests, considering adding your test to `packages/flutter_tools/test/integration.shard`.  Example: https://github.com/flutter/flutter/pull/73577/files"

1. Add try builder to [flutter/infra devicelab_config.star](https://github.com/flutter/infra/blob/master/config/devicelab_config.star)
  - Example PR: https://github.com/flutter/infra/pull/401/files
  - This will need to soak for 15 minutes after merged to propagate
  - There are various lists for the different testbeds a test can run on
2. Add task to [flutter/flutter try_builders.json](https://github.com/flutter/flutter/blob/master/dev/try_builders.json)
  - Example PR: https://github.com/flutter/flutter/pull/79913/files