Fix test warnings and errors under pytest #167
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
I tried running the test suite using pytest, and while it mostly works,
there were a number of errors and warnings that cropped up. Primarily:
1. We need to catch exceptions in threads spawned during the test process.
2. We need to pass valid UUIDs to anything expecting a UUID; failure to do
so yields a warning. So many warnings.
With this commit, the tests -- with the exception of
TestRequestContextSerializer -- run cleanly under pytest. There are still
warnings, but they all come from third party modules and so are somebody
else's problem.
The issues with TestRequestContextSerializer are resolved in the
following commit.
Use mock.patch to mock out `rpc.TestRequestContextSerializer` instead of an
explicit assignment statement. Doing something like this in a test...
rpc.RequestContextSerializer = mock.Mock()
...has side effects for any subsequent tests that rely on
`rpc.RequestContextSerializer`. Using `mock.patch` ensures that the
original value is replaced when the test is complete so that other tests
can use the original code.
tzumainn
reviewed
Jul 19, 2024
Classes that start with `Test` are identified as test cases, causing warnings during test discovery. In this commit we rename `TestNode` to `FakeNode` to prevent it from being erroneously collected as a test.
tzumainn
approved these changes
Jul 19, 2024
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.
This is prep work for adding some integration tests to this repository. I would like to be able to use pytest fixtures as part of the integration tests, but in order to do that we need to ensure that the existing tests run cleanly under pytest.
I tried running the test suite using pytest, and while it mostly works, there were a number of errors and warnings that cropped up. Primarily:
We need to catch exceptions in threads spawned during the test process.
We need to pass valid UUIDs to anything expecting a UUID; failure to do so yields a warning. So many warnings.
With this pull request, all tests run cleanly under pytest. There are still warnings, but they all come from third party modules and so are somebody else's problem.