Google Git
Sign in
fuchsia / shac-project / shac / 868d2877987632b515bc95f3355357a91226c704
commit868d2877987632b515bc95f3355357a91226c704[log] [tgz]
authorOliver Newman <olivernewman@google.com>Wed Sep 13 16:19:24 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Sep 13 16:19:24 2023 +0000
treec68739dd49232d9066ca506bcbb6cedf959ed429
parent45bc69f39a589772d50f112b8c3875b10e3ee935 [diff]
[engine] Resolve symlinks in tests

Fixes broken tests on Mac (Apple silicon only), where `t.TempDir()`
returns a path under `/var`, which is a symlink to `/private/var`, as
well as in Windows GitHub workflows where there's a similar link.

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