Google Git
Sign in
fuchsia / shac-project / shac / 4bfd1e0c2ca9f8b8cc271d1273ab4642f3015c2f
commit4bfd1e0c2ca9f8b8cc271d1273ab4642f3015c2f[log] [tgz]
authorOliver Newman <olivernewman@google.com>Wed Aug 30 20:16:36 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Aug 30 20:16:36 2023 +0000
tree02072b5a87194a6360f79796b50c068dc8dec15f
parentd09e85771b373d572b4267e682f23b35c67b74c7 [diff]
[engine] Resolve relative paths correctly

When running `shac check --root <other-dir>`, relative paths of
executables run by `ctx.os.exec()` should be resolved relative to the
root directory, not the current working directory (which may differ from
the root directory).

Change-Id: I8ddf2169b7a51a975890852aa7292dc30d93a8b0
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/909854
Reviewed-by: Marc-Antoine Ruel <maruel@google.com>
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
5 files changed
tree: 02072b5a87194a6360f79796b50c068dc8dec15f
  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.