fix[pytest]: Default parameter JSON encoding to use repr #2684
Conversation
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
…ntation of parameters
Kyle-Verhoog
approved these changes
Jul 21, 2021
|
|
||
| class A: | ||
| def __repr__(self): | ||
| raise Exception("Cannot __repr__") |
| params = {"arguments": item.callspec.params, "metadata": {}} | ||
| span.set_tag(test.PARAMETERS, json.dumps(params, default=repr)) | ||
| parameters = {"arguments": {}, "metadata": {}} # type: Dict[str, Dict[str, str]] | ||
| for param_name, param_val in item.callspec.params.items(): |
There was a problem hiding this comment.
item.callspec.params is always a Dict[str, Any] ?
There was a problem hiding this comment.
if so, then all good, if not, then we are probably missing some test cases
There was a problem hiding this comment.
Yes! item.callspec.params is a dictionary that contains all parameter objects. You can see here in the pytest docs:
https://docs.pytest.org/en/6.2.x/reference.html?highlight=callspec#function
If given, this is function has been parametrized and the callspec contains meta information about the parametrization.
brettlangdon
approved these changes
Jul 21, 2021
|
@Mergifyio backport 0.50 |
mergify bot
pushed a commit
that referenced
this pull request
Jul 22, 2021
* Remove JSON encoding for pytest parameters, default to string representation of parameters * Added type hinting (cherry picked from commit f5bc986)
|
Command
|
mergify bot
added a commit
that referenced
this pull request
Jul 22, 2021
) (#2691) * fix[pytest]: Default parameter JSON encoding to use repr (#2684) * Remove JSON encoding for pytest parameters, default to string representation of parameters * Added type hinting (cherry picked from commit f5bc986) * Added logger import Co-authored-by: Yun Kim <[email protected]> Co-authored-by: Yun Kim <[email protected]>
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.
Description
A bug was caught with the pytest plugin where parameterized tests with dictionary arguments containing tuple keys raised a TypeError and failed to encode. This is due to the JSON library not being able to encode non-basic (str, int, float, bool, None) key types. To allow the tracer to handle arbitrary key types, the pytest plugin now defaults to encoding the string
__repr__representation of each parameter argument.