|author||Garrett Beaty <firstname.lastname@example.org>||Thu Mar 14 21:46:38 2019|
|committer||Commit Bot <email@example.com>||Thu Mar 14 21:46:38 2019|
Add an an implicit check() that the step exists when getting an item from the steps dictionary. Whereas before to avoid a potential KeyError when attempting to access information for a given step you would want to do something similar to: def my_check_fn(check, steps_dict, step): step_present = check(step in steps_dict) if step_present: check('--my-flag' in steps_dict[step]['cmd']) You can now simply do: def my_check_fn(check, steps_dict, step): check('--my-flag' in steps_dict[step]['cmd']) If step is not in steps_dict, the execution of the function will stop and the test will fail with a check failure similar to: CHECK(FAIL): .../recipes-py/recipe_modules/my_module/tests/my_test.py:36 - my_check_fn() `check(('--my-flag' in steps_dict[step]['cmd']))` .../recipes-py/recipe_engine/internal/magic_check_fn.py:428 - __getitem__() `step_present = check((step in steps_dict))` step: 'foo' steps_dict.keys(): ['$result', 'InfraFailure', 'infra failure'] added .../infra/recipes-py/recipe_modules/my_module/tests/my_test.py:41 my_check_fn('foo') Bug: 939115 Change-Id: Id8f33c7ee7618133026c875ad3aa0d494bab127d Reviewed-on: https://chromium-review.googlesource.com/c/infra/luci/recipes-py/+/1516020 Commit-Queue: Garrett Beaty <firstname.lastname@example.org> Reviewed-by: Robbie Iannucci <email@example.com>
Recipes are a domain-specific language (embedded in python) for specifying sequences of subprocess calls in a cross-platform and testable way.
Documentation for the recipe engine (including this file!). See the design doc for more detailed design information about the recipe engine.
Chrome infra config files.
The main entry point to the recipe engine. It has many subcommands and flags; run
recipes.py -h to see them. Include this in your repository to start using recipes.
Recipes in the recipe engine. These are either example recipes, or recipes which are used to test the engine (see run_test.py to see these run)
Built in recipe modules. These are very useful when writing recipes; take a look in there, and look at each of their
examples subfolders to get an idea how to use them in a recipe.
The core functionality of the recipe engine. Noteworthy files include:
main.py-- The main entrypoint for the recipe engine.
recipes_cfg.proto-- The protobuf file which defines the format of a
third_party/-- third_party code which is vendored into the recipe engine.
recipe_api.py-- The api exposed to a recipe module.
unittests-- Unittests for the engine.
There are also several files which correspond to a subcommand of recipes.py;
autoroll are some examples.
Somewhat poorly named, these are higher level integration tests.
user.nameare configured in
Run the following to setup the code review tool and create your first review:
git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git $HOME/src/depot_tools export PATH="$PATH:$HOME/src/depot_tools" git checkout -b work origin/master # hack hack git commit -a -m "This is awesome" # This will ask for your Google Account credentials. git cl upload -s -r firstname.lastname@example.org # Wait for approval over email. # Click "Submit to CQ" button or ask reviewer to do it for you. # Wait for the change to be tested and landed automatically.
git cl help and
git cl help <cmd> for more details.