Google Git
Sign in
chromium / infra / luci / recipes-py.git / ea27cb4d3bbc4556feb13ad4f2b7387abb024904
commitea27cb4d3bbc4556feb13ad4f2b7387abb024904[log] [tgz]
authorOliver Newman <olivernewman@google.com>Mon Jun 10 16:04:55 2024
committerLUCI CQ <infra-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Jun 10 16:04:55 2024
tree6ddcc4553a579de0ae7e4d90cdc36f528bcc263c
parentf698b0fe9786a47d62e0c494fcea3ddc50c1542d [diff]
[test] Surface summary_markdown in case of status mismatch

When a recipe unexpectedly fails in a test, you currently need to dig
into the expectation file to figure out why the recipe failed. Surfacing
the summary_markdown in the stdout of the `recipes.py test` command
makes the debugging process much more streamlined.

Before:

  Errors in ======================================================================
  FAIL (recipe crashed in an unexpected way) - foo.basic
  ----------------------------------------------------------------------
  Status mismatch in RunSteps. The test expected 'FAILURE' but the status was 'INFRA_FAILURE'.

After:

  Errors in ======================================================================
  FAIL (recipe crashed in an unexpected way) - foo.basic
  ----------------------------------------------------------------------
  Status mismatch in RunSteps. The test expected 'FAILURE' but the status was 'INFRA_FAILURE'.
  summary_markdown:
    Infra Failure: Step('bar') (retcode: 1)

Change-Id: I58a7e8ffd55f0e88ee9a288d4125f044b893b62e
Reviewed-on: https://chromium-review.googlesource.com/c/infra/luci/recipes-py/+/5614831
Auto-Submit: Oliver Newman <olivernewman@google.com>
Commit-Queue: Yiwei Zhang <yiwzhang@google.com>
Reviewed-by: Yiwei Zhang <yiwzhang@google.com>
1 file changed
tree: 6ddcc4553a579de0ae7e4d90cdc36f528bcc263c
  1. doc/
  2. infra/
  3. misc/
  4. recipe_engine/
  5. recipe_modules/
  6. recipe_proto/
  7. recipes/
  8. unittests/
  9. .editorconfig
  10. .gitattributes
  11. .gitignore
  12. .pycharm.vpython3
  13. .style.yapf
  14. .vpython3
  15. .vscode.vpython3
  16. AUTHORS
  17. codereview.settings
  18. CONTRIBUTORS
  19. LICENSE
  20. OWNERS
  21. PRESUBMIT.py
  22. pyproject.toml
  23. README.md
  24. README.recipes.md
  25. recipe.warnings
  26. 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.

They allow writing build flows which integrate with the rest of LUCI.

Documentation for the recipe engine (including this file!). Take a look at the user guide for some hints on how to get started. See the implementation details doc for more detailed implementation information about the recipe engine.

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:

# Get `depot_tools` in $PATH if you don't have it
git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git $HOME/src/depot_tools
export PATH="$PATH:$HOME/src/depot_tools"

# Check out the recipe engine repo
git clone https://chromium.googlesource.com/infra/luci/recipes-py $HOME/src/recipes-py

# make your change
cd $HOME/src/recipes-py
git new-branch cool_feature
# 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.