2017-02-02 14:02:37 +00:00
|
|
|
Skia Recipe Modules
|
|
|
|
===================
|
|
|
|
|
2017-04-12 14:17:36 +00:00
|
|
|
This directory contains recipe modules designed to be used by recipes (see
|
|
|
|
infra/bots/recipes). They are all Skia-specific and some are interrelated:
|
2017-02-02 14:02:37 +00:00
|
|
|
|
2017-04-12 14:17:36 +00:00
|
|
|
* builder_name_schema - Helps to derive expected behavior from task (formerly
|
|
|
|
builder) names.
|
|
|
|
* core - Use as a starting point for most recipes: runs setup and sync steps.
|
|
|
|
* ct - Shared Cluster Telemetry utilities.
|
|
|
|
* flavor - Allows the caller to specify a high-level command to run, leaving
|
|
|
|
the platform-specific details to be handled by the specific flavor
|
|
|
|
module.
|
|
|
|
* infra - Shared infrastructure-related utilities.
|
|
|
|
* run - Utilities for running commands.
|
2017-02-02 14:02:37 +00:00
|
|
|
* swarming - Utilities for running Swarming tasks.
|
2017-04-12 14:17:36 +00:00
|
|
|
* vars - Common global variables used by Skia recipes/modules.
|
|
|
|
|
|
|
|
When you change a recipe module, you generally need to re-train the simulation
|
|
|
|
test:
|
|
|
|
|
2017-04-18 13:15:53 +00:00
|
|
|
$ python infra/bots/recipes.py test run --train
|
2017-04-12 14:17:36 +00:00
|
|
|
|
2017-04-13 14:22:11 +00:00
|
|
|
Or:
|
|
|
|
|
|
|
|
$ cd infra/bots; make train
|
|
|
|
|
2017-04-12 14:17:36 +00:00
|
|
|
Each recipe module contains a few files:
|
|
|
|
|
|
|
|
* api.py - This is the meat of the module.
|
|
|
|
* \_\_init\_\_.py - Contains a single DEPS variable, indicating the other
|
|
|
|
recipe modules on which this module depends.
|
|
|
|
* example.py - Optional, this file contains examples which demonstrate how to
|
|
|
|
use the module and should contain enough tests to achieve 100% coverage
|
2017-04-18 13:15:53 +00:00
|
|
|
for the module. The tests are run using the recipes test command above.
|