README.md
1Skia Infrastructure 2=================== 3 4This directory contains infrastructure elements. 5 6 7Tasks and Jobs 8-------------- 9 10Files in this directory define a DAG of tasks which run at every Skia commit. A 11task is a small, self-contained unit which runs via Swarming on a machine in the 12pool. Tasks may be chained together, eg. one task to compile test binaries and 13another to actually run them. 14 15Jobs are collections of related tasks which help define sub-sections of the DAG, 16for example, to be used as try jobs. Each job is defined as an entry point into 17the DAG. 18 19The tasks.json file in this directory is the master list of tasks and jobs for 20the repo. Note that tasks.json is NEVER edited by hand but generated via 21gen_task.go and the input files enumerated below. The 22[Task Scheduler](https://skia.googlesource.com/buildbot/+/master/task_scheduler/README.md) 23reads the tasks.json file at each commit to determine which jobs to run. For 24convenience, gen_tasks.go is provided to generate tasks.json and also to test it 25for correct syntax and detecting cycles and orphaned tasks. Always edit 26gen_tasks.go or one of the following input JSON files, rather than tasks.json 27itself: 28 29 * android_map.json - Maps human-friendly names of Android devices to their 30 device codename and desired OS version. Edit this file when adding a new 31 type of Android device or updating the desired OS version. 32 * cfg.json - Basic configuration information for gen_tasks.go. 33 * gpu_map.json - Maps human-friendly names of GPUs to an appropriate Swarming 34 dimension, typically the PCI ID of the GPU. Edit this file when adding a 35 new GPU. 36 * jobs.json - The master list of all jobs to run. Edit this to add or remove 37 bots. 38 39Whenever gen_tasks.go, any of the above JSON files, or assets are changed, you 40need to run gen_tasks.go to regenerate tasks.json: 41 42 $ go run infra/bots/gen_tasks.go 43 44Or: 45 46 $ cd infra/bots; make train 47 48There is also a test mode which performs sanity-checks and verifies that 49tasks.json is unchanged: 50 51 $ go run infra/bots/gen_tasks.go --test 52 53Or: 54 55 $ cd infra/bots; make test 56 57 58Recipes 59------- 60 61Recipes are the framework used by Skia's infrastructure to perform work inside 62of Swarming tasks. The main elements are: 63 64 * recipes.py - Used for running and testing recipes. 65 * recipes - These are the entry points for each type of task, eg. compiling 66 or running tests. 67 * recipe_modules - Shared modules which are used by recipes. 68 * .recipe_deps - Recipes and modules may depend on modules from other repos. 69 The recipes.py script automatically syncs those dependencies in this 70 directory. 71 72 73Isolate Files 74------------- 75 76These files determine which parts of the repository are transferred to the bot 77when a Swarming task is triggered. The 78[Isolate tool](https://github.com/luci/luci-py/tree/master/appengine/isolate/doc) 79hashes each file and will upload any new/changed files. Bots maintain a cache so 80that they can efficiently download only the files they don't have. 81 82 83Assets 84------ 85 86Artifacts used by the infrastructure are versioned here, along with scripts for 87recreating/uploading/downloading them. See the README in that directory for more 88information. Any time an asset used by the bots changes, you need to re-run 89gen_tasks.go. 90 91 92Tools 93----- 94 95Assorted other infrastructure-related tools, eg. isolate and CIPD binaries. 96 97 98CT 99-- 100 101Helpers for running Skia tasks in Cluster Telemetry. 102 103