Google Git
Sign in
fuchsia / shac-project / shac / 4ca3de0e2d6fcf84243755132aab414f2ce78b78
commit4ca3de0e2d6fcf84243755132aab414f2ce78b78[log] [tgz]
authorOliver Newman <olivernewman@google.com>Tue Jul 18 18:24:55 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Jul 18 18:24:55 2023 +0000
tree48623c735f311df2d065cbb9d6b29b904ae0e77f
parentffd04699b978a96f32a3c507c2dac0bddf805a86 [diff]
[engine] Make SCM root read-only by default

... unless the `writable_root` shac.textproto field is set. This will
let us roll out shac more widely to repos where checks don't need
checkout write access, without risking checks silently taking a
dependency on being able to write to the checkout, which would be hard
to fix later.

Change-Id: I0d852e55995f90026b150f165c11d53d75d289a4
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/886352
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Reviewed-by: Marc-Antoine Ruel <maruel@google.com>
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
7 files changed
tree: 48623c735f311df2d065cbb9d6b29b904ae0e77f
  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
    • [x] By default
    • [ ] Unconditionally
  • [ ] 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.