Google Git
Sign in
fuchsia / shac-project / shac / a3abbd1c1d7442e7356dee62c60f1f21498da8fb
commita3abbd1c1d7442e7356dee62c60f1f21498da8fb[log] [tgz]
authorOliver Newman <olivernewman@google.com>Fri Sep 22 23:43:40 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Sep 22 23:43:40 2023 +0000
treec15063b99f53d7160562f84588ee50a18f4e1207
parentfd1ec07dd3ec76ab0a1c0ec4567290a566789ac7 [diff]
[engine] Add check.with_args(...) method

This allows downstream repositories to override arguments to checks in
shared checks repositories, such as the path to an executable to run.

I also added a `with_name()` method, mainly to make it easier to test
`with_args()` (since it's not allowed to register multiple checks with
the same name) but it may also be useful for downstream users.

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

  • [x] Configuring files to exclude from shac analysis in shac.textproto
  • [x] Include unstaged files in analysis, including respecting unstaged shac.star files
  • [x] Automatic fix application with handling for conflicting suggestions
  • [ ] 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
  • [ ] Testing framework for checks

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.