skia2/infra/bots/recipe_modules
Robert Iannucci dec4c0b298 Rename example.py -> examples/full.py for all modules
`example.py` is going away; examples folder can now hold multiple
example recipes.

R=borenet@google.com

Bug: skia:
Change-Id: Ib28910987342217bc52040d4d966444174ce27a3
Reviewed-on: https://skia-review.googlesource.com/18432
Commit-Queue: Eric Boren <borenet@google.com>
Reviewed-by: Eric Boren <borenet@google.com>
2017-06-02 11:40:36 +00:00
..
builder_name_schema Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
core Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
ct Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
env Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
file Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
flavor Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
infra Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
isolate Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
run Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
skia_swarming Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
swarming Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
swarming_client Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
vars Rename example.py -> examples/full.py for all modules 2017-06-02 11:40:36 +00:00
README.md Use new recipes.py test command 2017-04-18 13:57:56 +00:00

Skia Recipe Modules

This directory contains recipe modules designed to be used by recipes (see infra/bots/recipes). They are all Skia-specific and some are interrelated:

  • 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.
  • swarming - Utilities for running Swarming tasks.
  • vars - Common global variables used by Skia recipes/modules.

When you change a recipe module, you generally need to re-train the simulation test:

$ python infra/bots/recipes.py test run --train

Or:

$ cd infra/bots; make train

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 for the module. The tests are run using the recipes test command above.