feat: Use caplog to test log messages #4315
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
Glutexo
force-pushed
the
caplog
branch
2 times, most recently
from
f742a17 to
2df12ba
Compare
pkoprda
suggested changes
Dec 19, 2024
Glutexo
commented
Dec 19, 2024
There was a problem hiding this comment.
Thank you, @pkoprda, for a precise review! ❤️ I fixed the issues you spotted and looked through the code for other instances. You spotted them all. Good job!
I was not sure about the squash: I kept the commits separate intentionally. But I have no problems doing so. So squashed and rebased.
Re-requesting a review.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4315 +/- ##
=======================================
Coverage 77.17% 77.17%
=======================================
Files 765 765
Lines 41770 41770
Branches 8821 8821
=======================================
Hits 32238 32238
Misses 8464 8464
Partials 1068 1068
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Thanks, @pkoprda! One more round? |
|
@Glutexo looks good, just squash the commits and then I will approve it |
Logger asserts are error-prone, because they assert calls, not actual messages. The caplog fixture is Pytest-native way to test logs. This makes integration-level unit tests easier to add. For the caplog fixture to work on Python 2.6 (RHEL 6), pytest_catchlog needs to be installed. On more recent version of python, the fixture is included in Pytest. pytest_catchlog caused pidfile write tests to fail. The fixture itself calls os.getpid, interfering with the patch. Every log message makes a getpid call that is recorded in the patch. assert_not_called patches then stopped working. Fixed by removing the os.getpid patch. The original function is safe to use. test_write_pidfile_not_called verifies several calls among which write_to_disk is the important one, not getpid. Card IDs: * CCT-774 * CCT-963 * CCT-1084 Signed-off-by: Štěpán Tomsa <[email protected]>
|
Sure thing! Squashed. @pkoprda |
pkoprda
approved these changes
Dec 19, 2024
There was a problem hiding this comment.
Thank you @Glutexo, LGTM! The failing test is not related to this change.
@xiangce can we merge this?
EDIT: I opened PR insights-core#4316 to fix that failing test.
xiangce
added
the
RHEL 6
|
@pkoprda You were faster. 😃 I wanted to do that too. |
xiangce
pushed a commit
that referenced
this pull request
Jan 2, 2025
Logger asserts are error-prone, because they assert calls, not actual messages. The caplog fixture is Pytest-native way to test logs. This makes integration-level unit tests easier to add. For the caplog fixture to work on Python 2.6 (RHEL 6), pytest_catchlog needs to be installed. On more recent version of python, the fixture is included in Pytest. pytest_catchlog caused pidfile write tests to fail. The fixture itself calls os.getpid, interfering with the patch. Every log message makes a getpid call that is recorded in the patch. assert_not_called patches then stopped working. Fixed by removing the os.getpid patch. The original function is safe to use. test_write_pidfile_not_called verifies several calls among which write_to_disk is the important one, not getpid. Card IDs: * CCT-774 * CCT-963 * CCT-1084 Signed-off-by: Štěpán Tomsa <[email protected]> (cherry picked from commit 644d314)
xiangce
pushed a commit
that referenced
this pull request
Jan 2, 2025
Logger asserts are error-prone, because they assert calls, not actual messages. The caplog fixture is Pytest-native way to test logs. This makes integration-level unit tests easier to add. For the caplog fixture to work on Python 2.6 (RHEL 6), pytest_catchlog needs to be installed. On more recent version of python, the fixture is included in Pytest. pytest_catchlog caused pidfile write tests to fail. The fixture itself calls os.getpid, interfering with the patch. Every log message makes a getpid call that is recorded in the patch. assert_not_called patches then stopped working. Fixed by removing the os.getpid patch. The original function is safe to use. test_write_pidfile_not_called verifies several calls among which write_to_disk is the important one, not getpid. Card IDs: * CCT-774 * CCT-963 * CCT-1084 Signed-off-by: Štěpán Tomsa <[email protected]> (cherry picked from commit 644d314) (cherry picked from commit b22745e)
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.
All Pull Requests:
Check all that apply:
Logger asserts are error-prone, because they assert calls, not actual messages. The
caplogfixture is Pytest-native way to test logs. This makes integration-level unit tests easier to add.For the
caplogfixture to work on Python 2.6 (RHEL 6),pytest_catchlogneeds to be installed. On more recent version of Python, the fixture is included in Pytest.pytest_catchlogcaused PID file write tests to fail. The fixture itself callsos.getpid, interfering with the patch. Every log message makes agetpidcall that is recorded in the patch.assert_not_calledpatches then stopped working.Fixed by removing the
os.getpidpatch. The original function is safe to use.test_write_pidfile_not_calledverifies several calls among whichwrite_to_diskis the important one, notgetpid.Card IDs: