Use best practice package name in test examples#6731
Merged
anderseknert merged 1 commit intoopen-policy-agent:mainfrom May 3, 2024
Merged
Use best practice package name in test examples#6731anderseknert merged 1 commit intoopen-policy-agent:mainfrom
anderseknert merged 1 commit intoopen-policy-agent:mainfrom
Conversation
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
anderseknert
reviewed
May 3, 2024
Member
anderseknert
left a comment
There was a problem hiding this comment.
Thanks for doing this! Some suggestions provided, but looks great to me 👍
Best practice according to https://docs.styra.com/regal/rules/testing/test-outside-test-package is to have tests in a package with _test suffix, but this is not documented anywhere. Updating the examples is an easy way to teach readers the best practice Signed-off-by: Aleksander <Aleksander.Sleire@Signicat.com>
anderseknert
approved these changes
May 3, 2024
Member
|
Thanks! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Why the changes in this PR are needed?
Best practice according to https://docs.styra.com/regal/rules/testing/test-outside-test-package is to have tests in a package with
_testsuffix, but this is not documented anywhere.Updating the examples is an easy way to teach readers the best practice
What are the changes in this PR?
Changes to the example rego test files and output snippets
Notes to assist PR review:
Further comments: