plugin: example raises AssertionError when regex does not match #1905
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.
Description
The decorator
example
generates a test function when used with pytest and an expected output. When a regex is used for said test, a fakeassert expected == output
was used to mark the test as failed. It is not adapted because a) if the assert pass, it means the test should not use a regex in the first place and b) it creates a confusing test output. So now, it raises anAssertionError
with a proper error message, which is well understood by any test runner - after all,assert
is a way to raise the exact same error.Note: I use
plugin: ...
in the commit message because it's related to thesopel.plugin.example
decorator, so it makes more sense to me.Checklist
make qa
(runsmake quality
andmake test
)