Enhanced type checking using Regal AST schema #201
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anderseknert
force-pushed
the
ast-jsonschema
branch
from
ebe9005
to
c252b6b
Compare
| // so while this isn't pretty, we'll use a separate package to carry state from here. If you | ||
| // know of a better way of doing this, don't hesitate to fix this. | ||
| embeds.EmbedBundleFS = bundle | ||
| embeds.ASTSchema = schema |
There was a problem hiding this comment.
thought: hmm, yeah. I don't know of a better way to do this. I think it's best to have the bundle at the top level. I wonder if schema needs to be too though? Perhaps it could sit under embeds
There was a problem hiding this comment.
True. I'll leave it as is for now, but I might move the schema into embeds later 👍
Currently enabled for the `regal test` command, which is the most likely entrypoint for rule authors, whether for built-in Regal rules or custom ones. While it would be useful to provide this also for `regal lint` — we'll probably want to do this together with the strictness rules, as we currently don't require compilation, and it's not clear that we'll want to unless a rule is configured that needs this, like most of the strictness rules would. Additionally, the schema is provided when running the Rego tests via `go test ./...`, which should help catch errors we make ourselves. It would be nice if custom rule authors didn't have to include the schema in the metadata annotation, but I've yet to figure out the best way of doing that, as we can't bundle a custom policy and also have them read from disk without the bundle "owning" that path. I suppose we could just parse a policy from a string, including a subpackage scoped custom.regal.rules package annotation... but I'll need to think more about this. Fixes #52 Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert
force-pushed
the
ast-jsonschema
branch
from
c252b6b
to
1217e28
Compare
charlieegan3
approved these changes
Jul 18, 2023
There was a problem hiding this comment.
This looks good to me! Tried it out too 🙂
$ go run main.go test e2e/testdata/ast_type_failure/
1 error occurred: e2e/testdata/ast_type_failure/custom_type_fail.rego:13: rego_type_error: undefined ref: input.foo
input.foo
^
have: "foo"
want (one of): ["annotations" "comments" "imports" "package" "regal" "rules"]
exit status 1
srenatus
pushed a commit
to srenatus/regal
that referenced
this pull request
Oct 1, 2024
Currently enabled for the `regal test` command, which is the most likely entrypoint for rule authors, whether for built-in Regal rules or custom ones. While it would be useful to provide this also for `regal lint` — we'll probably want to do this together with the strictness rules, as we currently don't require compilation, and it's not clear that we'll want to unless a rule is configured that needs this, like most of the strictness rules would. Additionally, the schema is provided when running the Rego tests via `go test ./...`, which should help catch errors we make ourselves. It would be nice if custom rule authors didn't have to include the schema in the metadata annotation, but I've yet to figure out the best way of doing that, as we can't bundle a custom policy and also have them read from disk without the bundle "owning" that path. I suppose we could just parse a policy from a string, including a subpackage scoped custom.regal.rules package annotation... but I'll need to think more about this. Fixes StyraInc#52 Signed-off-by: Anders Eknert <anders@styra.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently enabled for the
regal testcommand, which is the most likely entrypoint for rule authors, whether for built-in Regal rules or custom ones.While it would be useful to provide this also for
regal lint— we'll probably want to do this together with the strictness rules, as we currently don't require compilation, and it's not clear that we'll want to unless a rule is configured that needs this, like most of the strictness rules would.Additionally, the schema is provided when running the Rego tests via
go test ./..., which should help catch errors we make ourselves.It would be nice if custom rule authors didn't have to include the schema in the metadata annotation, but I've yet to figure out the best way of doing that, as we can't bundle a custom policy and also have them read from disk without the bundle "owning" that path. I suppose we could just parse a policy from a string, including a subpackage scoped custom.regal.rules package annotation... but I'll need to think more about this.
Fixes #52