Enhance assertion output for assert_all_called#224
Merged
lundberg merged 1 commit intolundberg:masterfrom Nov 29, 2022
Merged
Conversation
Codecov ReportBase: 100.00% // Head: 100.00% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## master #224 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 20 20
Lines 2757 2755 -2
Branches 417 417
=========================================
- Hits 2757 2755 -2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
lundberg
reviewed
Nov 28, 2022
respx/router.py
Outdated
| raise AllCalledAssertionError("RESPX: some routes were not called!") | ||
| not_called_routes = {str(route) for route in self.routes if not route.called} | ||
| if not_called_routes: | ||
| formatted_not_called_routes = "* " + "\n* ".join(not_called_routes) |
Owner
There was a problem hiding this comment.
Maybe we can make use of regular failed assertion output, instead of manual rendering 🤔
I'm thinking that this would give us the desired output:
assert not_called_routes == set(), "RESPX: some routes were not called!"
Contributor
Author
|
Yeah, this looks even nicer. Here is a pytest example: I have to use a list instead of a set as the Route object is not hashable. |
Contributor
Author
|
Another example, if we also list called routes with: Tell me which one you prefer and I will update the pull request. |
Owner
👍
I'd say the first implementation aligns better with the assertion, i.e. all called == no remaining non-called A third alternative that might give roughly the same output would be ... assert len(non_called_routes) == 0 |
Contributor
Author
|
So it's ready 😀 |
Owner
Almost .. We should probably drop the |
Owner
|
Once |
When AllCalledAssertionError is raised its hard to guess which route got called and which routes didn't get called. This change aims to provide more details by listing not called routes and by leveraging the __repr__ of route object.
assert_all_called
Owner
|
Thanks @sileht |
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
3 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.
When AllCalledAssertionError is raised its hard to guess which route got
called and which routes didn't get called.
This change aims to provide more details by listing not called routes
and by leveraging the repr of route object.