Fix a flaky test by cleaning a polluted state. #33
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.
What is the purpose of the change
This PR is to fix a flaky test
tests/test_api_client.py::TestApiClient::test_authentication_error
, which can fail after runningtests/test_api_client.py::TestApiClient::test_param_required_error
, but passes when it is run in isolation.Reproduce the test failure
Run the following command:
Expected result
Test
tests/test_api_client.py::TestApiClient::test_authentication_error
should pass when it is run after testtests/test_api_client.py::TestApiClient::test_param_required_error
.Actual result
Test
tests/test_api_client.py::TestApiClient::test_authentication_error
fails:Why the test fails
The error return value of
mock.MagicMock.content
is polluted aftertests/test_api_client.py::TestApiClient::test_param_required_error
.Fix
Reset
mock.MagicMock.content
at the start oftests/test_api_client.py::TestApiClient::test_authentication_error
.