| commit | 0ae299aac566002ee4c07c78c7971bd7af8706d0 | [log] [tgz] |
|---|---|---|
| author | Oliver Newman <olivernewman@google.com> | Wed Sep 06 16:33:29 2023 +0000 |
| committer | CQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed Sep 06 16:33:29 2023 +0000 |
| tree | af038a95850338f0e3377d0d6181b42117f0c1ef | |
| parent | 903d5f6ed604b5d30c5758532a57a06003f7c818 [diff] |
[engine] Avoid calling git ls-files unnecessarily When files are specified on the command line, only those files should be included in the `scm` object, and as an optimization we should avoid calling `git ls-files` just to discover shac.star files, since it adds notable latency on large repositories. Instead, traverse the filesystem to discover shac.star files that may apply to the listed files. The overhead of the `Run` function (from the start until after all checks have been registered) goes from ~670ms to ~5ms for fuchsia.git when a single file is specified on the command line. The only side effect I'm aware of is that when files are specified on the command line, some `shac.star` files will now be run that wouldn't normally be included. For example: 1. If a `dir1/shac.star` is git-ignored then it wouldn't normally be run, but it will now be run if a file in `dir1` is specified. This is probably going to be very rare, I don't see a reason for individual shac.star files to be gitignored. 2. If a file in a submodule or entire git-ignored directory is specified, then shac files from that directory may be run. This is more of an issue, as it's plausible that a dependency submodule could also use shac and have its own shac.star files that shouldn't be run, because shac should only ever run checks that are registered in the root repository's shac.star file. We can fix both of these eventually by skipping shac.star files that aren't known to the underlying scm, for now they're rare enough that we can ignore them. Change-Id: I4e6e6a81bd6eccb0d3ee3fd32bf9b68d1ceef933 Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/912734 Reviewed-by: Marc-Antoine Ruel <maruel@google.com> Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com> Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
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.
go install go.fuchsia.dev/shac-project/shac@latest shac check shac doc shac.star | less
Planned features/changes, in descending order by priority:
shac.textprotoshac.star files.shac cache directory that checks can write toctx.scmglob arguments to ctx.scm.{all,affected}_files() functions for easier filtering⚠ 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.