Jens Johansen
e2b6208871
This CL shards the CFE try bot tests better. * co19_2 runs was previously made faster, so using 10 shards on that is way too much. * sdk_test runs was previously made faster, so using 5 shard on that is way too much. * unit_tests was taking ~10 minutes and wasn't sharded. This CL shards it. Note that this sharding is semi-complicated because a few tests use git which is not usable on shard-runs. To overcome this a previous CL renamed the tests that use git and here the sharded runs only run the tests that doesn't require git. Then the "main bot" runs the tests that require git. * unit tests suites was taking ~12 minutes and wasn't sharded. This CL shards it. Note that this sharding is semi-complicated because a few of the suites use git which is not usable on shard-runs. Also a single suite uses many more files that it is reasonable to include in the fileset for the shards. In both cases these are run on the "main bot" instead. The suit runnier was already "threaded", but simply launched all threads (say around 20 or something like that) at the same time. That's not ideal if having, say, 8 cores to work with (which is what the bots seem to have) - or 12 (which is what my computer has). Now only 'cores - 1' "threads" are run at any one time, and most "sub-suites" are sharded, so that if one finishes early that core can start another "sub-suite" - hopefully utilizing more of the resources avaiable on the computer running it. In total - in my 'benchmarks' (i.e. try bot runs) - the front-end-linux-release-x64-try bot previously rook around 35 minutes to complete, and with these changes it takes around 15 minutes to complete. The biggest entry in the timeline is now building dart which takes almost half that time. It does so with fewer shards than before, but each might be utilized for longer. Change-Id: Ie034058d8f33aafd21bc49f2bc878484563ba01c Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/181383 Commit-Queue: Jens Johansen <jensj@google.com> Reviewed-by: Johnni Winther <johnniwinther@google.com>
tools/bots
This folder contains scripts and configuration files used by Dart's continuous integration and testing infrastructure.
Test matrix
The file test_matrix.json defines the test configurations run by Dart's CI
infrastructure. Changes to the test matrix affect all builds that include them.
Structure
The test matrix is a JSON document and consists of the "filesets" object, the
"configurations" list, and the "builder_configurations" list as well as a
"global" values object and a "branches" list.
Filesets
The file sets define files and/or directories that need to be present for a test
configuration at runtime. Any directory specified will be included along with
its subdirectories recursively. Directory names must have a / at the end. All
paths are relative to the SDK checkout's root directory.
"filesets": {
"a_fileset_name": [
"a/directory/",
"a/file"
],
"another_fileset_name": [
"another/directory/",
"another/file"
]
}
Configurations
The configurations describe all named configurations that the CI infrastructure supports. It consists of a list of configuration descriptions.
Each configuration description defines one or more configuration names using a
simple template syntax, where a group (a|b|c) means taking each of the
options for a different configuration name. The set of all configuration names
is the result of picking each combination of group options.
The configuration name implicitly defines the options of the configuration
(system, architecture, compiler, etc.), but additional options can be given in
an options field.
"configurations": {
"unittest-(linux|win|mac)": {
"options": {
"compiler": "dartk",
"mode": "release",
}},
Builder Configurations
The builder configurations describes all test configurations a specific builder must execute. Each builder configuration is an object that specifies which builders it applies to, defines the build steps for the builders, and some additional metadata. Only one builder configuration can apply to a builder.
"builder_configurations": [
{
"builders": [
"a-builder",
"another-builder"
],
"meta": {
"description": "Description of this configuration."
},
"steps": [
]
}
]
Each step is an object and must have a name. A step may also specify a script to
run instead of the default script: tools/test.py. Additional arguments may be
specified. These arguments will be passed to the script.
Inside arguments, the following variables will be expanded to values extracted from the builder name:
${mode}: the mode in which to run the tests; e.g.,release,debug${arch}: architecture to run the tests on; e.g.,ia32,x64$[system}: the system on which to run the tests; e.g.,win,linux,mac${runtime}: the runtime to use to run the tests; e.g.,vm,chrome,d8
"steps": [
{
"name": "build it",
"script": "tools/build.py",
"arguments": ["--a-flag", "target", "another_target"]
},
{
"name": "test it",
"arguments": ["-nconfiguration-${system}"]
}
]
A step that uses the script tools/test.py either explicitely or by default is
called a "test step". Test steps must include the -n command line argument to
select one of the named configurations defined in the configurations section.
A step using the default script may also be sharded across many machines using
the "shards" parameter. If a step is sharded, it must specify a "fileset".
Only the files and directories defined by the file set will be available to the
script when it's running on a shard.
{
"name": "shard the tests",
"shards": 10,
"fileset": "a_fileset_name"
}
Builders
Builder name parsing
The builder names are split by '-' and each part is then examined if it is an
option. Options can be runtimes (e.g. "chrome"), architectures (e.g. x64) and
operating system families (e.g. win). For each valid option, additional
arguments are passed to the tools/build.py script.
Adding a new builder
To add a builder:
- Decide on a name.
- Add the builder name to a new or existing configuration.
- File an issue labelled "area-infrastructure" to get your builder activated.
Testing a new or modified builder
Builders can be tested using a tool called led that is included in
depot_tools. Replace buildername and CL number with the correct values and run:
led get-builder luci.dart.ci:<builder name> | \
led edit-cr-cl 'https://dart-review.googlesource.com/c/<cl number>' | \
led launch
Adding a builder to the commit queue
For now, file an issue labeled "area-infrastructure" to get your builder added to the commit queue.
Glossary
Builder
A builder has a name and defines the steps the need to be run when it is executed by a bot. In general, a builder defines how to build and test software.
Bot
A physical or virtual machine (or even a docker container) that executes all commands it receives. Often, these commands are the steps defined by a builder.
Sharding
Sharded steps copy all files in a file set to as many bots as specified and runs the same command on all of the shards. Each shard has a shard number. The shard number and the total number of shards are passed as arguments to the command. The command is then responsible for running a subset of its work on each shard based on these arguments.