Google Git
Sign in
fuchsia / shac-project / shac / 8717f3912c113f5c775537db02c04db127adb6b4
commit8717f3912c113f5c775537db02c04db127adb6b4[log] [tgz]
authorOliver Newman <olivernewman@google.com>Fri Aug 25 15:57:32 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Aug 25 15:57:32 2023 +0000
tree5296bf514d65c4dbcaa6e079b783bcfce4737dc4
parent32908fc354ea25f7d1f19c1141d022a798cd6627 [diff]
[engine] Add missing error return

This return isn't covered by any tests, and I don't see a way it could
be hit unless there's a significant bug in shac (e.g. non-function
Starlark objects are allowed to be registered as checks, which isn't the
case now) or in the starlark-go implementation. But it's best to be safe
in case such a bug does arise.

Change-Id: I3a87b0234ccdddeea583cd29a73df74b9323ab7a
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/907842
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Reviewed-by: Marc-Antoine Ruel <maruel@google.com>
Commit-Queue: Marc-Antoine Ruel <maruel@google.com>
1 file changed
tree: 5296bf514d65c4dbcaa6e079b783bcfce4737dc4
  1. .github/
  2. checks/
  3. cmd/
  4. doc/
  5. images/
  6. internal/
  7. scripts/
  8. vendor/
  9. .gitignore
  10. AUTHORS
  11. codecov.yml
  12. CONTRIBUTING.md
  13. go.mod
  14. go.sum
  15. LICENSE
  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:

  • [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.