1<!--- AUTOGENERATED BY `./recipes.py test train` --> 2# Repo documentation for [crosvm](https://chromium.googlesource.com/crosvm/crosvm.git) 3## Table of Contents 4 5**[Recipe Modules](#Recipe-Modules)** 6 * [crosvm](#recipe_modules-crosvm) 7 8**[Recipes](#Recipes)** 9 * [build_chromeos_hatch](#recipes-build_chromeos_hatch) 10 * [build_docs](#recipes-build_docs) 11 * [build_linux](#recipes-build_linux) 12 * [build_windows](#recipes-build_windows) 13 * [crosvm:examples/container_build_context](#recipes-crosvm_examples_container_build_context) 14 * [crosvm:examples/cros_container_build_context](#recipes-crosvm_examples_cros_container_build_context) 15 * [crosvm:examples/host_build_context](#recipes-crosvm_examples_host_build_context) 16 * [crosvm:examples/source_context](#recipes-crosvm_examples_source_context) 17 * [health_check](#recipes-health_check) 18 * [push_to_github](#recipes-push_to_github) 19 * [update_chromeos_merges](#recipes-update_chromeos_merges) 20## Recipe Modules 21 22### *recipe_modules* / [crosvm](/infra/recipe_modules/crosvm) 23 24[DEPS](/infra/recipe_modules/crosvm/__init__.py#7): [depot\_tools/bot\_update][depot_tools/recipe_modules/bot_update], [depot\_tools/gclient][depot_tools/recipe_modules/gclient], [depot\_tools/git][depot_tools/recipe_modules/git], [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket], [recipe\_engine/cipd][recipe_engine/recipe_modules/cipd], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/file][recipe_engine/recipe_modules/file], [recipe\_engine/path][recipe_engine/recipe_modules/path], [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/raw\_io][recipe_engine/recipe_modules/raw_io], [recipe\_engine/step][recipe_engine/recipe_modules/step] 25 26 27#### **class [CrosvmApi](/infra/recipe_modules/crosvm/api.py#11)([RecipeApi][recipe_engine/wkt/RecipeApi]):** 28 29Crosvm specific functionality shared between recipes. 30 31  **@property**<br>— **def [builder\_cache](/infra/recipe_modules/crosvm/api.py#43)(self):** 32 33Dedicated cache directory for each builder. 34 35Luci will try to run each builder on the same bot as previously to keep this cache present. 36 37  **@property**<br>— **def [cargo\_home](/infra/recipe_modules/crosvm/api.py#24)(self):** 38 39CARGO_HOME is cached between runs. 40 41  **@property**<br>— **def [cargo\_target\_dir](/infra/recipe_modules/crosvm/api.py#29)(self):** 42 43CARGO_TARGET_DIR is cleaned up between runs 44 45— **def [container\_build\_context](/infra/recipe_modules/crosvm/api.py#62)(self):** 46 47Prepares source and system to build crosvm via dev container. 48 49Usage: 50 with api.crosvm.container_build_context(): 51 api.crosvm.step_in_container("build crosvm", ["cargo build"]) 52 53— **def [cros\_container\_build\_context](/infra/recipe_modules/crosvm/api.py#79)(self):** 54 55Prepares source and system to build crosvm via cros container. 56 57Usage: 58 with api.crosvm.cros_container_build_context(): 59 api.crosvm.step_in_container("build crosvm", ["cargo build"], cros=True) 60 61  **@property**<br>— **def [dev\_container\_cache](/infra/recipe_modules/crosvm/api.py#39)(self):** 62 63— **def [get\_git\_sha](/infra/recipe_modules/crosvm/api.py#186)(self):** 64 65— **def [host\_build\_context](/infra/recipe_modules/crosvm/api.py#113)(self):** 66 67Prepares source and system to build crosvm directly on the host. 68 69This will install the required rust version via rustup. However no further dependencies 70are installed. 71 72Usage: 73 with api.crosvm.host_build_context(): 74 api.step("build crosvm", ["cargo build"]) 75 76  **@property**<br>— **def [local\_bin](/infra/recipe_modules/crosvm/api.py#34)(self):** 77 78Directory used to install local tools required by the build. 79 80— **def [prepare\_git](/infra/recipe_modules/crosvm/api.py#161)(self):** 81 82  **@property**<br>— **def [rustup\_home](/infra/recipe_modules/crosvm/api.py#19)(self):** 83 84RUSTUP_HOME is cached between runs. 85 86— **def [source\_context](/infra/recipe_modules/crosvm/api.py#52)(self):** 87 88Updates the source to the revision to be tested and drops into the source directory. 89 90Use when no build commands are needed. 91 92  **@property**<br>— **def [source\_dir](/infra/recipe_modules/crosvm/api.py#14)(self):** 93 94Where the crosvm source will be checked out. 95 96— **def [step\_in\_container](/infra/recipe_modules/crosvm/api.py#144)(self, step_name, command, cros=False, \*\*kwargs):** 97 98Runs a luci step inside the crosvm dev container. 99 100— **def [upload\_coverage](/infra/recipe_modules/crosvm/api.py#194)(self, filename):** 101## Recipes 102 103### *recipes* / [build\_chromeos\_hatch](/infra/recipes/build_chromeos_hatch.py) 104 105[DEPS](/infra/recipes/build_chromeos_hatch.py#7): [crosvm](#recipe_modules-crosvm), [depot\_tools/depot\_tools][depot_tools/recipe_modules/depot_tools], [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/step][recipe_engine/recipe_modules/step] 106 107 108— **def [RunSteps](/infra/recipes/build_chromeos_hatch.py#17)(api):** 109### *recipes* / [build\_docs](/infra/recipes/build_docs.py) 110 111[DEPS](/infra/recipes/build_docs.py#7): [crosvm](#recipe_modules-crosvm), [depot\_tools/gsutil][depot_tools/recipe_modules/gsutil], [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/file][recipe_engine/recipe_modules/file], [recipe\_engine/step][recipe_engine/recipe_modules/step] 112 113 114— **def [RunSteps](/infra/recipes/build_docs.py#20)(api):** 115 116Builds crosvm mdbook and api docs, then uploads them to GCS. 117 118This recipe requires ambient luci authentication. To test locally run: 119 $ luci-auth context ./infra/recipes.py run build_docs 120### *recipes* / [build\_linux](/infra/recipes/build_linux.py) 121 122[DEPS](/infra/recipes/build_linux.py#11): [crosvm](#recipe_modules-crosvm), [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/json][recipe_engine/recipe_modules/json], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/raw\_io][recipe_engine/recipe_modules/raw_io], [recipe\_engine/step][recipe_engine/recipe_modules/step] 123 124 125— **def [RunSteps](/infra/recipes/build_linux.py#74)(api, properties):** 126 127— **def [collect\_binary\_sizes](/infra/recipes/build_linux.py#24)(api, properties):** 128### *recipes* / [build\_windows](/infra/recipes/build_windows.py) 129 130[DEPS](/infra/recipes/build_windows.py#7): [crosvm](#recipe_modules-crosvm), [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/step][recipe_engine/recipe_modules/step] 131 132 133— **def [RunSteps](/infra/recipes/build_windows.py#16)(api):** 134### *recipes* / [crosvm:examples/container\_build\_context](/infra/recipe_modules/crosvm/examples/container_build_context.py) 135 136[DEPS](/infra/recipe_modules/crosvm/examples/container_build_context.py#7): [crosvm](#recipe_modules-crosvm) 137 138 139— **def [RunSteps](/infra/recipe_modules/crosvm/examples/container_build_context.py#12)(api):** 140### *recipes* / [crosvm:examples/cros\_container\_build\_context](/infra/recipe_modules/crosvm/examples/cros_container_build_context.py) 141 142[DEPS](/infra/recipe_modules/crosvm/examples/cros_container_build_context.py#7): [crosvm](#recipe_modules-crosvm) 143 144 145— **def [RunSteps](/infra/recipe_modules/crosvm/examples/cros_container_build_context.py#12)(api):** 146### *recipes* / [crosvm:examples/host\_build\_context](/infra/recipe_modules/crosvm/examples/host_build_context.py) 147 148[DEPS](/infra/recipe_modules/crosvm/examples/host_build_context.py#7): [crosvm](#recipe_modules-crosvm), [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/step][recipe_engine/recipe_modules/step] 149 150 151— **def [RunSteps](/infra/recipe_modules/crosvm/examples/host_build_context.py#14)(api):** 152### *recipes* / [crosvm:examples/source\_context](/infra/recipe_modules/crosvm/examples/source_context.py) 153 154[DEPS](/infra/recipe_modules/crosvm/examples/source_context.py#7): [crosvm](#recipe_modules-crosvm), [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket] 155 156 157— **def [RunSteps](/infra/recipe_modules/crosvm/examples/source_context.py#13)(api):** 158### *recipes* / [health\_check](/infra/recipes/health_check.py) 159 160[DEPS](/infra/recipes/health_check.py#7): [crosvm](#recipe_modules-crosvm), [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/raw\_io][recipe_engine/recipe_modules/raw_io], [recipe\_engine/step][recipe_engine/recipe_modules/step] 161 162 163— **def [RunSteps](/infra/recipes/health_check.py#17)(api):** 164### *recipes* / [push\_to\_github](/infra/recipes/push_to_github.py) 165 166[DEPS](/infra/recipes/push_to_github.py#7): [crosvm](#recipe_modules-crosvm), [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/file][recipe_engine/recipe_modules/file], [recipe\_engine/path][recipe_engine/recipe_modules/path], [recipe\_engine/raw\_io][recipe_engine/recipe_modules/raw_io], [recipe\_engine/step][recipe_engine/recipe_modules/step] 167 168 169— **def [RunSteps](/infra/recipes/push_to_github.py#18)(api):** 170### *recipes* / [update\_chromeos\_merges](/infra/recipes/update_chromeos_merges.py) 171 172[DEPS](/infra/recipes/update_chromeos_merges.py#7): [crosvm](#recipe_modules-crosvm), [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/step][recipe_engine/recipe_modules/step] 173 174 175— **def [RunSteps](/infra/recipes/update_chromeos_merges.py#14)(api):** 176 177[depot_tools/recipe_modules/bot_update]: https://chromium.googlesource.com/chromium/tools/depot_tools.git/+/5a584405cae6e1fd08a6054ce9ba61b645b4d591/recipes/README.recipes.md#recipe_modules-bot_update 178[depot_tools/recipe_modules/depot_tools]: https://chromium.googlesource.com/chromium/tools/depot_tools.git/+/5a584405cae6e1fd08a6054ce9ba61b645b4d591/recipes/README.recipes.md#recipe_modules-depot_tools 179[depot_tools/recipe_modules/gclient]: https://chromium.googlesource.com/chromium/tools/depot_tools.git/+/5a584405cae6e1fd08a6054ce9ba61b645b4d591/recipes/README.recipes.md#recipe_modules-gclient 180[depot_tools/recipe_modules/git]: https://chromium.googlesource.com/chromium/tools/depot_tools.git/+/5a584405cae6e1fd08a6054ce9ba61b645b4d591/recipes/README.recipes.md#recipe_modules-git 181[depot_tools/recipe_modules/gsutil]: https://chromium.googlesource.com/chromium/tools/depot_tools.git/+/5a584405cae6e1fd08a6054ce9ba61b645b4d591/recipes/README.recipes.md#recipe_modules-gsutil 182[recipe_engine/recipe_modules/buildbucket]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-buildbucket 183[recipe_engine/recipe_modules/cipd]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-cipd 184[recipe_engine/recipe_modules/context]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-context 185[recipe_engine/recipe_modules/file]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-file 186[recipe_engine/recipe_modules/json]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-json 187[recipe_engine/recipe_modules/path]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-path 188[recipe_engine/recipe_modules/platform]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-platform 189[recipe_engine/recipe_modules/properties]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-properties 190[recipe_engine/recipe_modules/raw_io]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-raw_io 191[recipe_engine/recipe_modules/step]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/README.recipes.md#recipe_modules-step 192[recipe_engine/wkt/RecipeApi]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/f967fa68fd4bd3e76140de7ffa449fa3a45a72f4/recipe_engine/recipe_api.py#471 193