Google Git
Sign in
fuchsia / shac-project / shac / 822e10a0aadf6a7fb0e73ecefd07a2df55da3db2
commit822e10a0aadf6a7fb0e73ecefd07a2df55da3db2[log] [tgz]
authorOliver Newman <olivernewman@google.com>Tue Jul 11 18:05:36 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Jul 11 18:05:36 2023 +0000
tree01c2ab36c3f004748ad5f23c313f616d2525a549
parentce81d0a53da1da422858d4f59959a9587eaa678b [diff]
[engine] Make scm tests table-driven

Improves consistency and reduces some duplication.

Test only change.

Change-Id: Ib2ed4bf1d9b62084de5efef5e2d43332a51ba340
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/882971
Reviewed-by: Marc-Antoine Ruel <maruel@google.com>
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Commit-Queue: Oliver Newman <olivernewman@google.com>
Reviewed-by: Oliver Newman <olivernewman@google.com>
1 file changed
tree: 01c2ab36c3f004748ad5f23c313f616d2525a549
  1. .github/
  2. doc/
  3. images/
  4. internal/
  5. scripts/
  6. .gitignore
  7. AUTHORS
  8. check_doc.star
  9. codecov.yml
  10. CONTRIBUTING.md
  11. go.mod
  12. go.star
  13. go.sum
  14. LICENSE
  15. licenses.star
  16. main.go
  17. OWNERS
  18. PATENTS
  19. README.md
  20. shac.star
  21. 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.