Google Git
Sign in
fuchsia / shac-project / shac / 5d4c817a56fa23b30a6cd42e0508b142092ecaf0
commit5d4c817a56fa23b30a6cd42e0508b142092ecaf0[log] [tgz]
authorOliver Newman <olivernewman@google.com>Wed Sep 13 16:20:06 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Sep 13 16:20:06 2023 +0000
tree763075d48c4877b9e5ed781a983529cc8da7929a
parent868d2877987632b515bc95f3355357a91226c704 [diff]
[engine] Move most of Run logic into runInner

The Run/runInner distinction exists only so that `Run` can handle
creating a temporary directory and cleaning it up after, whether or not
`runInner` fails. The split of business logic between the two functions
was pointless and arbitrary, so move it all into `runInner`.

Change-Id: Id1696ee66d3985e123b62a2621e00cf9085682c1
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/916073
Reviewed-by: Anthony Fandrianto <atyfto@google.com>
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
1 file changed
tree: 763075d48c4877b9e5ed781a983529cc8da7929a
  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.