[#362] Clean up generated log files in testDebugLogFiles unit test - #363
Closed
Labreo wants to merge 1 commit into
Closed
[#362] Clean up generated log files in testDebugLogFiles unit test#363Labreo wants to merge 1 commit into
Labreo wants to merge 1 commit into
Conversation
Labreo
requested review from
Alomir,
dlebauer,
mdietze and
mswilburn
as code owners
August 6, 2026 07:17
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses a test hygiene issue in the SIPNET unit test suite by ensuring the testDebugLogFiles test no longer leaves behind untracked debug log artifacts in tests/smoke/russell_1/, keeping the working tree clean after running make test.
Changes:
- Add a post-success cleanup step to remove
debug_logs/anddebug_log_test.loggenerated bytestDebugLogFiles. - Add a corresponding “Fixed” entry in
docs/CHANGELOG.mdto document the change.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/sipnet/test_sipnet_infrastructure/testDebugLogFiles.c | Removes generated debug log artifacts after a successful test run to avoid dirty working trees. |
| docs/CHANGELOG.md | Documents the fix in the Unreleased “Fixed” section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Fixed | ||
|
|
||
| - Fix testDebugLogFiles unit test leaving untracked log files in workspace after execution (#358) |
Comment on lines
+136
to
+139
| if (status == 0) { | ||
| runShell("cd " TEST_WORK_DIR | ||
| " && rm -rf debug_logs && rm -f debug_log_test.log"); | ||
| } |
Collaborator
Collaborator
|
I'm truly sorry about the duplicated effort - to reduce the chances for this in the future, please ask for tickets to be assigned before starting work, which gives us a chance to figure out if the work is being done elsewhere. |
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
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.
Summary
testDebugLogFiles.cto delete the temporary generated log files on successful test completion.debug_logs/anddebug_log_test.log) intests/smoke/russell_1/, causing the git working tree to become dirty.How was this change tested?
Ran
make testlocally, verified that all tests passed, and confirmed thatgit statusreports no untracked files afterwards.Reproduction steps
make teston master branch ->git statusshows untracked log files.make test->git statusremains clean.Related issues
Checklist
docs/CHANGELOG.mdupdated with noteworthy changesclang-format(rungit clang-formatif needed)