[Sync] Erase sync DB when corrupted

chrome/browser/sync/test/integration/single_client_directory_sync_test.cc

 // Copyright (c) 2014 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/message_loop/message_loop.h"
 #include "base/run_loop.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/synchronization/waitable_event.h"
 #include "base/time/time.h"
 #include "chrome/browser/sync/profile_sync_service.h"
+#include "chrome/browser/sync/test/integration/bookmarks_helper.h"
+#include "chrome/browser/sync/test/integration/single_client_status_change_checker.h"
+#include "chrome/browser/sync/test/integration/sync_integration_test_util.h"
 #include "chrome/browser/sync/test/integration/sync_test.h"
 #include "content/public/browser/browser_thread.h"
+#include "sync/syncable/directory.h"
+#include "sync/test/directory_backing_store_corruption_testing.h"
+#include "url/gurl.h"
 
 using content::BrowserThread;
+using sync_integration_test_util::AwaitCommitActivityCompletion;
+using syncer::syncable::corruption_testing::kNumEntriesRequiredForCorruption;
+using syncer::syncable::corruption_testing::CorruptDatabase;
 
 class SingleClientDirectorySyncTest : public SyncTest {
  public:
   SingleClientDirectorySyncTest() : SyncTest(SINGLE_CLIENT) {}
   ~SingleClientDirectorySyncTest() override {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(SingleClientDirectorySyncTest);
 };
 
 void SignalEvent(base::WaitableEvent* e) {
   e->Signal();
 }
 
 bool WaitForExistingTasksOnLoop(base::MessageLoop* loop) {
   base::WaitableEvent e(true, false);
   loop->PostTask(FROM_HERE, base::Bind(&SignalEvent, &e));
   // Timeout stolen from StatusChangeChecker::GetTimeoutDuration().
   return e.TimedWait(base::TimeDelta::FromSeconds(45));
 }
 
+// A status change checker that waits for an unrecoverable sync error to occur.
+class SyncUnrecoverableErrorChecker : public SingleClientStatusChangeChecker {
+ public:
+  explicit SyncUnrecoverableErrorChecker(ProfileSyncService* service)
+      : SingleClientStatusChangeChecker(service) {}
+
+  bool IsExitConditionSatisfied() override {
+    return service()->HasUnrecoverableError();
+  }
+
+  std::string GetDebugMessage() const override {
+    return "Sync Unrecoverable Error";
+  }
+};
+
 IN_PROC_BROWSER_TEST_F(SingleClientDirectorySyncTest,
                        StopThenDisableDeletesDirectory) {
   ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
   ProfileSyncService* sync_service = GetSyncService(0);
   base::FilePath directory_path = sync_service->GetDirectoryPathForTest();
   ASSERT_TRUE(base::DirectoryExists(directory_path));
   sync_service->StopAndSuppress();
   sync_service->DisableForUser();
 
   // Wait for StartupController::StartUp()'s tasks to finish.
   base::RunLoop run_loop;
   base::MessageLoop::current()->PostTask(FROM_HERE, run_loop.QuitClosure());
   run_loop.Run();
   // Wait for the directory deletion to finish.
   base::MessageLoop* sync_loop = sync_service->GetSyncLoopForTest();
   ASSERT_TRUE(WaitForExistingTasksOnLoop(sync_loop));
 
   ASSERT_FALSE(base::DirectoryExists(directory_path));
 }
+
+// Verify that when the sync directory's backing store becomes corrupted, we
+// trigger an unrecoverable error and delete the database.
+//
+// If this test fails, see the definition of kNumEntriesRequiredForCorruption
+// for one possible cause.
+IN_PROC_BROWSER_TEST_F(SingleClientDirectorySyncTest,
+                       DeleteDirectoryWhenCorrupted) {
+  ASSERT_TRUE(SetupClients()) << "SetupClients() failed.";
+
+  // Create some bookmarks.
+  const GURL url("https://www.google.com");
+  const bookmarks::BookmarkNode* top = bookmarks_helper::AddFolder(
+      0, bookmarks_helper::GetOtherNode(0), 0, "top");
+  for (int i = 0; i < kNumEntriesRequiredForCorruption; ++i) {
+    ASSERT_TRUE(
+        bookmarks_helper::AddURL(0, top, 0, base::Int64ToString(i), url));
+  }
+
+  // Sync and wait for syncing to complete.
+  ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
+  ASSERT_TRUE(AwaitCommitActivityCompletion(GetSyncService((0))));
+  ASSERT_TRUE(bookmarks_helper::ModelMatchesVerifier(0));
+
+  // Flush the directory to the backing store and wait until the flush
+  // completes.
+  ProfileSyncService* sync_service = GetSyncService(0);
+  sync_service->FlushDirectory();
+  base::MessageLoop* sync_loop = sync_service->GetSyncLoopForTest();
+  ASSERT_TRUE(WaitForExistingTasksOnLoop(sync_loop));
+
+  // Now corrupt the database.
+  const base::FilePath directory_path(sync_service->GetDirectoryPathForTest());
+  const base::FilePath sync_db(directory_path.Append(
+      syncer::syncable::Directory::kSyncDatabaseFilename));
+  ASSERT_TRUE(CorruptDatabase(sync_db));
+
+  // Write a bunch more bookmarks to ensure the sync DB notices the corruption.

[pval...(no longer on Chromium), 2015/04/27 19:09:34]

Re: "sync DB notices the corruption"

Does this happen because adding the bookmarks triggers a sync cycle? If so,
consider mentioning it in this comment.

[maniscalco, 2015/04/27 19:16:41]

Good point.  Flushing the directory is an important part of forcing sync to
notice the corruption.  I've updated the comment to clarify this.  Done.

+  for (int i = 0; i < kNumEntriesRequiredForCorruption; ++i) {
+    ASSERT_TRUE(
+        bookmarks_helper::AddURL(0, top, 0, base::Int64ToString(i), url));
+  }
+  sync_service->FlushDirectory();
+
+  // Wait for an unrecoverable error to occur.
+  SyncUnrecoverableErrorChecker checker(sync_service);
+  checker.Wait();
+  ASSERT_TRUE(!checker.TimedOut());
+  ASSERT_TRUE(sync_service->HasUnrecoverableError());
+
+  // Wait until the sync loop has processed any existing tasks and see that the
+  // directory no longer exists.
+  ASSERT_TRUE(WaitForExistingTasksOnLoop(sync_loop));
+  ASSERT_FALSE(base::DirectoryExists(directory_path));
+}