Google Git
Sign in
chromium / infra / luci / recipes-py / 1cfbbd6688934edac32840957690407a36eb153f
commit1cfbbd6688934edac32840957690407a36eb153f[log] [tgz]
authorJoshua Seaton <joshuaseaton@google.com>Thu Feb 07 17:38:28 2019
committerCommit Bot <commit-bot@chromium.org>Thu Feb 07 17:38:28 2019
tree4c375eb5072fd9464888762102315319472a1c39
parent3fd6d5382c9a43f9bcd7ed8cf855b0f60889cc0e [diff]
[swarming] Fix bugs once and for all!

(1) s/hard_timeout/execution_timeout (the former is not a valid RPC
request field)
(2) only assert on duration at callsite
(3) use swarming root directory as default  CIPD package donwload path
(4) Allow client to pass trigger() step name

Test: tested against fuchsia's recipes.
Change-Id: Ia4c8010509e9030971fb74412bed04fca4fa0df0
Reviewed-on: https://chromium-review.googlesource.com/c/1457677
Commit-Queue: Joshua Seaton <joshuaseaton@google.com>
Reviewed-by: Robbie Iannucci <iannucci@chromium.org>
16 files changed
tree: 4c375eb5072fd9464888762102315319472a1c39
  1. doc/
  2. infra/
  3. misc/
  4. recipe_engine/
  5. recipe_modules/
  6. recipes/
  7. unittests/
  8. .gitattributes
  9. .gitignore
  10. .vpython
  11. AUTHORS
  12. codereview.settings
  13. CONTRIBUTORS
  14. LICENSE
  15. OWNERS
  16. PRESUBMIT.py
  17. README.md
  18. README.recipes.md
  19. recipes.py
README.md

Recipes

Recipes are a domain-specific language (embedded in python) for specifying sequences of subprocess calls in a cross-platform and testable way.

Files

  • README.md

    This file!

  • doc/

    Documentation for the recipe engine (including this file!). See the design doc for more detailed design information about the recipe engine.

  • infra/

    Chrome infra config files.

  • recipes.py

    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/

    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)

  • recipe_modules/

    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.

  • recipe_engine/

    The core functionality of the recipe engine. Noteworthy files include:

    • main.py -- The main entrypoint for the recipe engine.
    • package.proto -- The protobuf file which defines the format of a recipes.cfg file.
    • 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; run, and autoroll are some examples.

  • unittests/

    Somewhat poorly named, these are higher level integration tests.

Contributing

  • Sign the Google CLA.
  • Make sure your user.email and user.name are configured in git config.

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 joe@example.com
# 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.

Use git cl help and git cl help <cmd> for more details.