Google Git
Sign in
pigweed / infra / recipes / 391f005a0569fb6ca4d32b094ffc1a20849e5f73
commit391f005a0569fb6ca4d32b094ffc1a20849e5f73[log] [tgz]
authorRob Mohr <mohrr@google.com>Wed Aug 14 17:17:14 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Aug 14 17:17:14 2024 +0000
tree228497d5333dc3cf4aa8f64372a834f895872e81
parent2bf74019c878666f5639cb9057450ca781e26051 [diff]
checkout: Reformat tests

Change-Id: I0474a9815280e97679573957f68b4c9bba3a4ef6
Reviewed-on: https://pigweed-review.googlesource.com/c/infra/recipes/+/229393
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Danielle Kay <danikay@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
3 files changed
tree: 228497d5333dc3cf4aa8f64372a834f895872e81
  1. infra/
  2. recipe_modules/
  3. recipes/
  4. scripts/
  5. black ⇨ .cipd/black
  6. .editorconfig
  7. .gitignore
  8. .style.yapf
  9. AUTHORS
  10. cipd.ensure
  11. LICENSE
  12. OWNERS
  13. presubmit.sh
  14. pyproject.toml
  15. README.md
  16. recipes.py
README.md

Pigweed Recipes

This repository contains recipes for Pigweed.

A recipe is a Python script that runs a series of commands, using the recipe engine framework from the LUCI project. We use recipes to automatically check out, build, and test Pigweed and downstream projects using Pigweed in continuous integration jobs. The commands the recipes use are very similar to the ones you would use as a developer to check out, build, and test Pigweed in your local environment.

See go/pigweed-recipe-docs for complete documentation and a guide for getting started with writing recipes.

Getting the Code

The recommended way to get the source code is with git.

git clone https://pigweed.googlesource.com/infra/recipes

In most cases you will need a Chromium depot_tools checkout in your PATH as well.

git clone https://chromium.googlesource.com/chromium/tools/depot_tools ~/depot_tools
echo 'export PATH="$PATH:$HOME/depot_tools"' >> ~/.bashrc

Running Tests

./presubmit.sh runs three different sets of tests:

  • Recipe expectation tests (./recipes.py test train)
  • Formatting (./black --diff --check .)
  • Dependencies (.recipe_deps/fuchsia/scripts/cleanup_deps.py --check)

The formatting check will tell you what‘s wrong but not fix it. For that you need to run ./black .. Similarly, the dependencies check will tell you what’s wrong but you'll need to edit the files to fix issues.

If not using ./presubmit.sh you'll need to run ./scripts/ensure_black.sh before ./black is present.