Google Git
Sign in
fuchsia / shac-project / shac / aa2ee98881db08534bdf29383fc86bfe5b9f8a65
commitaa2ee98881db08534bdf29383fc86bfe5b9f8a65[log] [tgz]
authorOliver Newman <olivernewman@google.com>Wed Aug 09 15:15:49 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Aug 09 15:15:49 2023 +0000
treed57c6369ee891381dcf82ced6946b3d338a6a5b6
parent8e7f250456d15d150c4bba78f184ba169bbdae05 [diff]
[tests] Unzip contents of test module

To comply with licensing requirements, check in the unzipped contents of
the `ut` package instead of a zip file.

We can't use the normal Go vendoring process because it strips out
`_test.go` files and .git files, which are included in the go.sum hash
calculation and thus need to be available for the test.

Bug: 131750
Change-Id: I11333ff9bbb2a86fa53ef93da3f199a15c0307d2
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/898278
Reviewed-by: Marc-Antoine Ruel <maruel@google.com>
Commit-Queue: Oliver Newman <olivernewman@google.com>
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
10 files changed
tree: d57c6369ee891381dcf82ced6946b3d338a6a5b6
  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.