Add support for almost-recursive watches in Linux DirectoryWatcher

base/directory_watcher_unittest.cc

 // Copyright (c) 2008 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/directory_watcher.h"
 
 #include <limits>
 
 #include "base/basictypes.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/message_loop.h"
 #include "base/path_service.h"
 #include "base/platform_thread.h"
 #include "base/string_util.h"
+#include "base/thread.h"
 #if defined(OS_WIN)
 #include "base/win_util.h"
 #endif  // defined(OS_WIN)
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 
 // For tests where we wait a bit to verify nothing happened
 const int kWaitForEventTime = 1000;
 
@@ skipping 118 matching lines @@
 
   // Keep track of original thread id to verify that callbacks are called
   // on the same thread.
   PlatformThreadId original_thread_id_;
 };
 
 // Basic test: add a file and verify we notice it.
 TEST_F(DirectoryWatcherTest, NewFile) {
   DirectoryWatcher watcher;
   TestDelegate delegate(this);
-  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, false));
+  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, NULL, false));
 
   SetExpectedNumberOfNotifiedDelegates(1);
   ASSERT_TRUE(WriteTestFile(test_dir_.AppendASCII("test_file"), "content"));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 
 // Verify that modifying a file is caught.
 TEST_F(DirectoryWatcherTest, ModifiedFile) {
   // Write a file to the test dir.
   ASSERT_TRUE(WriteTestFile(test_dir_.AppendASCII("test_file"), "content"));
   SyncIfPOSIX();
 
   DirectoryWatcher watcher;
   TestDelegate delegate(this);
-  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, false));
+  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, NULL, false));
 
   // Now make sure we get notified if the file is modified.
   SetExpectedNumberOfNotifiedDelegates(1);
   ASSERT_TRUE(WriteTestFile(test_dir_.AppendASCII("test_file"), "new content"));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 
 TEST_F(DirectoryWatcherTest, DeletedFile) {
   // Write a file to the test dir.
   ASSERT_TRUE(WriteTestFile(test_dir_.AppendASCII("test_file"), "content"));
   SyncIfPOSIX();
 
   DirectoryWatcher watcher;
   TestDelegate delegate(this);
-  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, false));
+  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, NULL, false));
 
   // Now make sure we get notified if the file is deleted.
   SetExpectedNumberOfNotifiedDelegates(1);
   ASSERT_TRUE(file_util::Delete(test_dir_.AppendASCII("test_file"), false));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 
 // Verify that letting the watcher go out of scope stops notifications.
 TEST_F(DirectoryWatcherTest, Unregister) {
   TestDelegate delegate(this);
 
   {
     DirectoryWatcher watcher;
-    ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, false));
+    ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, NULL, false));
 
     // And then let it fall out of scope, clearing its watch.
   }
 
   // Write a file to the test dir.
   SetExpectedNumberOfNotifiedDelegates(0);
   ASSERT_TRUE(WriteTestFile(test_dir_.AppendASCII("test_file"), "content"));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 
 TEST_F(DirectoryWatcherTest, SubDirRecursive) {
   FilePath subdir(CreateTestDirDirectoryASCII("SubDir", true));
 
-#if defined(OS_LINUX)
-  // TODO(port): Recursive watches are not implemented on Linux.
-  return;
-#endif  // !defined(OS_WIN)
-
   // Verify that modifications to a subdirectory are noticed by recursive watch.
   TestDelegate delegate(this);
   DirectoryWatcher watcher;
-  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, true));
+  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, NULL, true));
   // Write a file to the subdir.
   SetExpectedNumberOfNotifiedDelegates(1);
   ASSERT_TRUE(WriteTestFile(subdir.AppendASCII("test_file"), "some content"));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 
 TEST_F(DirectoryWatcherTest, SubDirNonRecursive) {
 #if defined(OS_WIN)
   // Disable this test for earlier version of Windows. It turned out to be
   // very difficult to create a reliable test for them.
   if (win_util::GetWinVersion() < win_util::WINVERSION_VISTA)
     return;
 #endif  // defined(OS_WIN)
 
   FilePath subdir(CreateTestDirDirectoryASCII("SubDir", false));
 
   // Create a test file before the test. On Windows we get a notification
   // when creating a file in a subdir even with a non-recursive watch.
   ASSERT_TRUE(WriteTestFile(subdir.AppendASCII("test_file"), "some content"));
 
   SyncIfPOSIX();
 
   // Verify that modifications to a subdirectory are not noticed
   // by a not-recursive watch.
   DirectoryWatcher watcher;
   TestDelegate delegate(this);
-  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, false));
+  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, NULL, false));
 
   // Modify the test file. There should be no notifications.
   SetExpectedNumberOfNotifiedDelegates(0);
   ASSERT_TRUE(WriteTestFile(subdir.AppendASCII("test_file"), "other content"));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 
 namespace {
 // Used by the DeleteDuringNotify test below.
 // Deletes the DirectoryWatcher when it's notified.
@@ skipping 11 matching lines @@
 
   scoped_ptr<DirectoryWatcher> watcher_;
   MessageLoop* loop_;
 };
 }  // anonymous namespace
 
 // Verify that deleting a watcher during the callback
 TEST_F(DirectoryWatcherTest, DeleteDuringNotify) {
   DirectoryWatcher* watcher = new DirectoryWatcher;
   Deleter deleter(watcher, &loop_);  // Takes ownership of watcher.
-  ASSERT_TRUE(watcher->Watch(test_dir_, &deleter, false));
+  ASSERT_TRUE(watcher->Watch(test_dir_, &deleter, NULL, false));
 
   ASSERT_TRUE(WriteTestFile(test_dir_.AppendASCII("test_file"), "content"));
   loop_.Run();
 
   // We win if we haven't crashed yet.
   // Might as well double-check it got deleted, too.
   ASSERT_TRUE(deleter.watcher_.get() == NULL);
 }
 
+TEST_F(DirectoryWatcherTest, BackendLoop) {
+  base::Thread thread("test");
+  ASSERT_TRUE(thread.Start());
+
+  DirectoryWatcher watcher;
+  TestDelegate delegate(this);
+  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, thread.message_loop(),
+                            true));
+}
+
 TEST_F(DirectoryWatcherTest, MultipleWatchersSingleFile) {
   DirectoryWatcher watcher1, watcher2;
   TestDelegate delegate1(this), delegate2(this);
-  ASSERT_TRUE(watcher1.Watch(test_dir_, &delegate1, false));
-  ASSERT_TRUE(watcher2.Watch(test_dir_, &delegate2, false));
+  ASSERT_TRUE(watcher1.Watch(test_dir_, &delegate1, NULL, false));
+  ASSERT_TRUE(watcher2.Watch(test_dir_, &delegate2, NULL, false));
 
   SetExpectedNumberOfNotifiedDelegates(2);
   ASSERT_TRUE(WriteTestFile(test_dir_.AppendASCII("test_file"), "content"));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 
 TEST_F(DirectoryWatcherTest, MultipleWatchersDifferentFiles) {
   const int kNumberOfWatchers = 5;
   DirectoryWatcher watchers[kNumberOfWatchers];
   TestDelegate delegates[kNumberOfWatchers] = {this, this, this, this, this};
   FilePath subdirs[kNumberOfWatchers];
   for (int i = 0; i < kNumberOfWatchers; i++) {
     subdirs[i] = CreateTestDirDirectoryASCII("Dir" + IntToString(i), false);
-    ASSERT_TRUE(watchers[i].Watch(subdirs[i], &delegates[i], false));
+    ASSERT_TRUE(watchers[i].Watch(subdirs[i], &delegates[i],
+                                  NULL, ((i % 2) == 0)));
   }
   for (int i = 0; i < kNumberOfWatchers; i++) {
     // Verify that we only get modifications from one watcher (each watcher has
     // different directory).
 
     for (int j = 0; j < kNumberOfWatchers; j++)
       delegates[j].reset();
 
     // Write a file to the subdir.
     SetExpectedNumberOfNotifiedDelegates(1);
     ASSERT_TRUE(WriteTestFile(subdirs[i].AppendASCII("test_file"), "content"));
     VerifyExpectedNumberOfNotifiedDelegates();
 
     loop_.RunAllPending();
   }
 }
 
 #if defined(OS_WIN) || defined(OS_MACOSX)
 // TODO(phajdan.jr): Enable when support for Linux recursive watches is added.
 
 TEST_F(DirectoryWatcherTest, WatchCreatedDirectory) {
   TestDelegate delegate(this);
   DirectoryWatcher watcher;
-  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, true));
+  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, NULL, true));
 
   SetExpectedNumberOfNotifiedDelegates(1);
   FilePath subdir(CreateTestDirDirectoryASCII("SubDir", true));
   VerifyExpectedNumberOfNotifiedDelegates();
 
   delegate.reset();
 
   // Verify that changes inside the subdir are noticed.
   SetExpectedNumberOfNotifiedDelegates(1);
   ASSERT_TRUE(WriteTestFile(subdir.AppendASCII("test_file"), "some content"));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 
 TEST_F(DirectoryWatcherTest, RecursiveWatchDeletedSubdirectory) {
   FilePath subdir(CreateTestDirDirectoryASCII("SubDir", true));
 
   TestDelegate delegate(this);
   DirectoryWatcher watcher;
-  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, true));
+  ASSERT_TRUE(watcher.Watch(test_dir_, &delegate, NULL, true));
 
   // Write a file to the subdir.
   SetExpectedNumberOfNotifiedDelegates(1);
   ASSERT_TRUE(WriteTestFile(subdir.AppendASCII("test_file"), "some content"));
   VerifyExpectedNumberOfNotifiedDelegates();
 
   delegate.reset();
 
   SetExpectedNumberOfNotifiedDelegates(1);
   ASSERT_TRUE(file_util::Delete(subdir, true));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 
 TEST_F(DirectoryWatcherTest, MoveFileAcrossWatches) {
   FilePath subdir1(CreateTestDirDirectoryASCII("SubDir1", true));
   FilePath subdir2(CreateTestDirDirectoryASCII("SubDir2", true));
 
   TestDelegate delegate1(this), delegate2(this);
   DirectoryWatcher watcher1, watcher2;
-  ASSERT_TRUE(watcher1.Watch(subdir1, &delegate1, true));
-  ASSERT_TRUE(watcher2.Watch(subdir2, &delegate2, true));
+  ASSERT_TRUE(watcher1.Watch(subdir1, &delegate1, NULL, true));
+  ASSERT_TRUE(watcher2.Watch(subdir2, &delegate2, NULL, true));
 
   SetExpectedNumberOfNotifiedDelegates(1);
   ASSERT_TRUE(WriteTestFile(subdir1.AppendASCII("file"), "some content"));
   SyncIfPOSIX();
   VerifyExpectedNumberOfNotifiedDelegates();
 
   delegate1.reset();
   delegate2.reset();
 
   SetExpectedNumberOfNotifiedDelegates(2);
   ASSERT_TRUE(file_util::Move(subdir1.AppendASCII("file"),
                               subdir2.AppendASCII("file")));
   VerifyExpectedNumberOfNotifiedDelegates();
 
   delegate1.reset();
   delegate2.reset();
 
   SetExpectedNumberOfNotifiedDelegates(1);
   ASSERT_TRUE(WriteTestFile(subdir2.AppendASCII("file"), "other content"));
   VerifyExpectedNumberOfNotifiedDelegates();
 }
 #endif  // defined(OS_WIN) || defined(OS_MACOSX)
 
 // Verify that watching a directory that doesn't exist fails, but doesn't
 // asssert.
 // Basic test: add a file and verify we notice it.
 TEST_F(DirectoryWatcherTest, NonExistentDirectory) {
   DirectoryWatcher watcher;
-  ASSERT_FALSE(watcher.Watch(test_dir_.AppendASCII("does-not-exist"), NULL,
-                             false));
+  ASSERT_FALSE(watcher.Watch(test_dir_.AppendASCII("does-not-exist"),
+                             NULL, NULL, false));
 }
 
 }  // namespace