tools/assertions: fail if exception does not match#225
Open
tchaikov wants to merge 1 commit intoapache:trunkfrom
Open
tools/assertions: fail if exception does not match#225tchaikov wants to merge 1 commit intoapache:trunkfrom
tchaikov wants to merge 1 commit intoapache:trunkfrom
Conversation
before this change, we fail the test if repr(e) does *not* match
with the given `matching` regular expression. despite that the
tests pass as expected, this is what we intend to complete with
this verification. let's explain this with a Python REPL session:
```
>>> import re
>>> ex = Exception('foobarhello')
>>> matching = 'foobar'
>>> regex = re.compile(matching)
>>> actual = repr(e)
>>> actual
"Exception('foobarhello')"
>>> regex.match(actual) is None
True
>>> regex.match("c'est la vie") is None
True
```
`repr()` returns a canonical string representation of an object.
that's why it adds "Exception()" around the error message. and, it fails
to match with the the "matching" string. as "Exception('foobarhello')"
does not match at the beginning of this string. but we actually expect
the unmatch! in other words, two negatives make a positive.
to correct this, in this change:
* use str() to stringify the exception, so Python does not include its
type in the output string
* do not check if the return match object is None, but check if it is
*not* None. so the test can fail if the message string in exception
does not match.
* include the message string and regular expression in the raised
AssertionError.
* instead of using 're.match()', use 're.search()' for matching the
regular expression with the message extracted from exception, as
sometimes, we just pass a part of message in hope to match with
the returned message, even if the part is not sitting at the beginning
of the message, for instance, the full message looks like:
```
Cannot execute this query as it might involve data filtering and thus
may have unpredictable performance. If you want to execute this query
despite the performance unpredictability, use ALLOW FILTERING'
````
but we just use "use ALLOW FILTERING". so instead of changing all
the tests, update the assert helper.
* do not compile the re. otherwise we only match it for a single
time, and then drop the compiled re on the floor.
Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
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
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.
before this change, we fail the test if repr(e) does not match with the given
matchingregular expression. despite that the tests pass as expected, this is what we intend to complete with this verification. let's explain this with a Python REPL session:repr()returns a canonical string representation of an object. that's why it adds "Exception()" around the error message. and, it fails to match with the the "matching" string. as "Exception('foobarhello')" does not match at the beginning of this string. but we actually expect the unmatch! in other words, two negatives make a positive.to correct this, in this change: