[WIP] Add more filewatcher test cases for relevant tests#20
Closed
[WIP] Add more filewatcher test cases for relevant tests#20
Conversation
Owner
|
@copilot seems all the OSes have worked except Mac |
Copilot stopped work on behalf of
jamylak due to an error
December 17, 2025 07:25
Owner
|
@copilot try again |
Copilot stopped work on behalf of
jamylak due to an error
December 17, 2025 07:41
Owner
|
@copilot try again |
Copilot stopped work on behalf of
jamylak due to an error
December 17, 2025 07:55
Owner
|
@copilot try again |
Copilot stopped work on behalf of
jamylak due to an error
December 17, 2025 08:08
Owner
|
@copilot try again |
Contributor
Author
Fixed in commit 5fc8a98. The macOS implementation now uses For the subdirectory test issue, the fix should also resolve it by properly canonicalizing the parent directory path when the file doesn't exist. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the filewatcher test suite by adding 7 new comprehensive test cases and fixing macOS compatibility for watching non-existent files. The changes improve test coverage for edge cases and platform-specific behaviors while ensuring all platforms handle file creation events correctly.
Key Changes:
- Added 7 new test cases covering file creation, idempotent operations, debouncing, subdirectories, and concurrent modifications
- Fixed macOS implementation to support watching files that don't exist yet using improved path resolution logic
- Added platform-specific directory operation headers for Windows and Unix-like systems
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| tests/filewatcher/test_filewatcher.cpp | Adds 7 new test cases (FileCreatedAfterWatchingCallbackCalled, StopWatchingMultipleTimesIsSafe, RapidModificationsDebounced, FileInSubdirectoryWatched, NewFileCreationCallbackCalled, MultipleModificationsWithSpacing, ConcurrentModificationsSafe) and platform-specific headers for directory operations |
| src/filewatcher/mac_filewatcher.cpp | Enhances path resolution logic to handle non-existent files by attempting to canonicalize the parent directory and falling back to absolute paths when needed, enabling macOS to watch files before they exist |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+216
to
+217
| std::remove(subdirFile.c_str()); | ||
| rmdir(subdir.c_str()); |
There was a problem hiding this comment.
The subdirectory cleanup may fail if the file removal fails, leaving the directory in place. Additionally, if the test fails before reaching cleanup, the subdirectory and file will remain. Consider using RAII or a fixture-level cleanup mechanism to ensure proper resource cleanup even when tests fail. The TearDown method should also handle cleanup of the subdirectory to prevent test pollution.
Comment on lines
+183
to
+186
| // Due to debouncing (50ms threshold), we expect fewer callbacks than modifications | ||
| // Should be at least 1 but likely less than 5 | ||
| EXPECT_GE(callbackCount, 1); | ||
| EXPECT_LE(callbackCount, 5); |
There was a problem hiding this comment.
The comment mentions a '50ms threshold' for debouncing, but this appears to be an implementation detail that may vary across platforms. The Linux implementation uses 50ms debouncing (linux_filewatcher.cpp:48), but Windows uses a different mechanism (DEBOUNCE_THRESHOLD_MS). The test assertion allows for a wide range (1-5 callbacks), which makes it non-deterministic. Consider either documenting that this test verifies debouncing exists rather than specific behavior, or making the test more precise if the debouncing behavior is guaranteed across platforms.
Suggested change
| // Due to debouncing (50ms threshold), we expect fewer callbacks than modifications | |
| // Should be at least 1 but likely less than 5 | |
| EXPECT_GE(callbackCount, 1); | |
| EXPECT_LE(callbackCount, 5); | |
| // Due to debouncing, we expect fewer callbacks than modifications overall. | |
| // There should be at least 1 callback but strictly fewer than the 5 modifications. | |
| EXPECT_GE(callbackCount, 1); | |
| EXPECT_LT(callbackCount, 5); |
Comment on lines
+264
to
+297
| // Test concurrent file operations don't cause crashes | ||
| TEST_F(FileWatcherTest, ConcurrentModificationsSafe) { | ||
| int callbackCount = 0; | ||
| auto callback = [&callbackCount]() { callbackCount++; }; | ||
|
|
||
| createFile(testFilePath, "Initial"); | ||
| auto watcher = filewatcher_factory::createFileWatcher(); | ||
| watcher->startWatching(testFilePath, callback); | ||
| std::this_thread::sleep_for(std::chrono::milliseconds(THREAD_WAIT_TIME_MS)); | ||
|
|
||
| // Launch multiple threads that modify the file | ||
| std::thread t1([this]() { | ||
| for (int i = 0; i < 3; ++i) { | ||
| appendToFile(testFilePath, "T1 "); | ||
| std::this_thread::sleep_for(std::chrono::milliseconds(60)); | ||
| } | ||
| }); | ||
|
|
||
| std::thread t2([this]() { | ||
| for (int i = 0; i < 3; ++i) { | ||
| appendToFile(testFilePath, "T2 "); | ||
| std::this_thread::sleep_for(std::chrono::milliseconds(60)); | ||
| } | ||
| }); | ||
|
|
||
| t1.join(); | ||
| t2.join(); | ||
|
|
||
| std::this_thread::sleep_for(std::chrono::milliseconds(100)); | ||
| watcher->stopWatching(); | ||
|
|
||
| // Should have detected multiple changes without crashing | ||
| EXPECT_GE(callbackCount, 1); | ||
| } |
There was a problem hiding this comment.
This test uses concurrent file modifications from multiple threads, but the appendToFile helper function may not be thread-safe for concurrent writes to the same file. While the file system typically handles this, the behavior can be platform-dependent and may lead to file corruption or partial writes. The test only verifies that callbacks occur and the system doesn't crash, which is reasonable, but consider documenting this as a stress test rather than a correctness test for concurrent operations.
src/filewatcher/mac_filewatcher.cpp
Outdated
| } | ||
| } | ||
|
|
||
| std::string dirPath = resolvedPath.parent_path(); |
There was a problem hiding this comment.
Inconsistent path-to-string conversion compared to the Windows implementation. The Windows implementation explicitly calls .string() method (windows_filewatcher.cpp:146), while this code relies on implicit conversion. For consistency and explicitness, consider using resolvedPath.parent_path().string() instead.
Co-authored-by: jamylak <1940205+jamylak@users.noreply.github.com>
Co-authored-by: jamylak <1940205+jamylak@users.noreply.github.com>
- Use absolute() instead of canonical() when file doesn't exist - Canonicalize parent directory when file doesn't exist yet - This fixes FileCreatedAfterWatchingCallbackCalled and NewFileCreationCallbackCalled tests on macOS - All Linux tests still passing Co-authored-by: jamylak <1940205+jamylak@users.noreply.github.com>
jamylak
force-pushed
the
copilot/add-filewatcher-test-cases
branch
from
d219622 to
bbb3154
Compare
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.
Filewatcher Test Enhancement Plan
Test Results:
Changes Made:
absolute()path resolutionOriginal prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.