Stronger tracing tests with inline-snapshot
#25
Merged
Conversation
This file contains 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
|
There are more places where this can be done (I just did a find and replace on |
…ex/inline-snapshot
…ex/inline-snapshot
…ex/inline-snapshot
|
This is a great PR, thank you - hadn't seen this library before. Looks like there are some test failures/typecheck failures. I'm happy to take over and send out an updated PR, or let me know if you feel like updating things. |
…ex/inline-snapshot
rm-openai
approved these changes
Mar 17, 2025
rm-openai
added a commit
that referenced
this pull request
Mar 21, 2025
Following up on #25, this removes uses of `fetch_traces` and `fetch_ordered_spans` where there's already a stronger assertion using `fetch_normalized_spans`. This is to help move towards the stronger style as much as possible, since people are still adding weaker assertions such as [this](https://github.com/openai/openai-agents-python/blob/7a0ca7930e31e5d12f7785dfcb0a2f123739b21a/tests/test_concurrency.py#L59-L61) in #91. The next step will be to find remaining uses of `fetch_ordered_spans` that can be replaced.
nakasy000
pushed a commit
to nakasy000/openai-agents-python
that referenced
this pull request
Mar 27, 2025
`assert len(spans) == 12` is a very weak assertion. This PR asserts the exported traces and spans more precisely in a readable tree format. And when the format of an exported trace/span changes (e.g. a new key is added to every span), you can use `pytest --inline-snapshot=fix` to update all relevant tests automatically. See https://15r10nk.github.io/inline-snapshot/latest/ for more info.
smile920423
added a commit
to smile920423/openai-agents-python
that referenced
this pull request
Mar 31, 2025
Following up on openai/openai-agents-python#25, this removes uses of `fetch_traces` and `fetch_ordered_spans` where there's already a stronger assertion using `fetch_normalized_spans`. This is to help move towards the stronger style as much as possible, since people are still adding weaker assertions such as [this](https://github.com/openai/openai-agents-python/blob/7a0ca7930e31e5d12f7785dfcb0a2f123739b21a/tests/test_concurrency.py#L59-L61) in openai/openai-agents-python#91. The next step will be to find remaining uses of `fetch_ordered_spans` that can be replaced.
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.
assert len(spans) == 12is a very weak assertion. This PR asserts the exported traces and spans more precisely in a readable tree format. And when the format of an exported trace/span changes (e.g. a new key is added to every span), you can usepytest --inline-snapshot=fixto update all relevant tests automatically. See https://15r10nk.github.io/inline-snapshot/latest/ for more info.