Google Git
Sign in
fuchsia / shac-project / shac / ffd04699b978a96f32a3c507c2dac0bddf805a86
commitffd04699b978a96f32a3c507c2dac0bddf805a86[log] [tgz]
authorOliver Newman <olivernewman@google.com>Tue Jul 18 18:21:37 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Jul 18 18:21:37 2023 +0000
tree439ccb41817f9c39c26fa45aa7c148a81a50e5d1
parentb4da47cbf3582738770abc0920bda134d6c27b80 [diff]
[engine] Add writable_root field to shac.textproto

Eventually repos can set it to give subprocesses write access to the
checkout directory. For now it's a no-op so we can start setting it in
repos that depend on writable checkouts before enabling the behavior, to
prevent a breaking change.

Change-Id: I6085b1f6fa7b90ef43d4b8b1cc18c9ccafdbe282
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/886351
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Reviewed-by: Marc-Antoine Ruel <maruel@google.com>
2 files changed
tree: 439ccb41817f9c39c26fa45aa7c148a81a50e5d1
  1. .github/
  2. doc/
  3. images/
  4. internal/
  5. scripts/
  6. vendor/
  7. .gitignore
  8. AUTHORS
  9. check_doc.star
  10. codecov.yml
  11. CONTRIBUTING.md
  12. go.mod
  13. go.star
  14. go.sum
  15. LICENSE
  16. licenses.star
  17. main.go
  18. OWNERS
  19. PATENTS
  20. README.md
  21. shac.star
  22. shac.textproto
README.md

shac

Shac (Scalable Hermetic Analysis and Checks) is a unified and ergonomic tool and framework for writing and running static analysis checks.

Shac checks are written in Starlark.

usage demonstration

Usage

go install go.fuchsia.dev/shac-project/shac@latest
shac check
shac doc shac.star | less

Documentation

Road map

Planned features/changes, in descending order by priority:

  • [ ] Automatic fix application with handling for conflicting suggestions
  • [ ] Configuring files to exclude from shac analysis in shac.textproto
  • [ ] Include unstaged files in analysis, including respecting unstaged shac.star files
  • [ ] Provide a .shac cache directory that checks can write to
  • [ ] Mount checkout directory read-only
  • [ ] Give checks access to the commit message via ctx.scm
  • [ ] Built-in formatting of Starlark files
  • [ ] Configurable “pass-throughs” - non-default environment variables and mounts that can optionally be passed through to the sandbox
  • [ ] Add glob arguments to ctx.scm.{all,affected}_files() functions for easier filtering
  • [ ] Filesystem sandboxing on MacOS
  • [ ] Windows sandboxing

Contributing

⚠ The source of truth is at https://fuchsia.googlesource.com/shac-project/shac.git and uses Gerrit for code review.

See CONTRIBUTING.md to submit changes.