Add browser tests for clearing sync registrations with site data

content/browser/background_sync/background_sync_browsertest.cc

 // Copyright 2015 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 <set>
 #include <string>
 #include <vector>
 
 #include "base/command_line.h"
 #include "base/strings/string_split.h"
@@ skipping 91 matching lines @@
 
   void SetUp() override {
     BackgroundSyncNetworkObserver::SetIgnoreNetworkChangeNotifierForTests(true);
     ContentBrowserTest::SetUp();
   }
 
   void SetIncognitoMode(bool incognito) {
     shell_ = incognito ? CreateOffTheRecordBrowser() : shell();
   }
 
-  BackgroundSyncContext* GetSyncContextFromShell(Shell* shell) {
-    StoragePartition* storage = BrowserContext::GetDefaultStoragePartition(
+  StoragePartition* GetStorage() {
+    return BrowserContext::GetDefaultStoragePartition(

[jkarlin, 2015/10/30 13:41:13]

GetDefaultStoragePartition is deprecated, while you're here can you change this
to GetStoragePartition(shell_->web_contents()->GetBrowserContext(), nullptr); ?

[chasej, 2015/10/30 15:59:23]

Done. I changed to pass the actual site instance for the second parameter, as
GetStoragePosition() indicates that will eventually be required.

         shell_->web_contents()->GetBrowserContext());
-    return storage->GetBackgroundSyncContext();
+  }
+
+  BackgroundSyncContext* GetSyncContext() {
+    return GetStorage()->GetBackgroundSyncContext();
   }
 
   void SetUpCommandLine(base::CommandLine* command_line) override {
     // TODO(jkarlin): Remove this once background sync is no longer
     // experimental.
     command_line->AppendSwitch(
         switches::kEnableExperimentalWebPlatformFeatures);
   }
 
   void SetUpOnMainThread() override {
@@ skipping 29 matching lines @@
   // run on the IO thread.
   void SetOnline(bool online);
   void SetOnlineOnIOThread(
       const scoped_refptr<BackgroundSyncContext>& sync_context,
       bool online);
 
   // Returns true if the one-shot sync with tag is currently pending. Fails
   // (assertion failure) if the tag isn't registered.
   bool OneShotPending(const std::string& tag);
 
+  void ClearStoragePartitionData();
+
   std::string PopConsoleString();
   bool PopConsole(const std::string& expected_msg);
   bool RegisterServiceWorker();
   bool RegisterOneShot(const std::string& tag);
   bool RegisterOneShotFromServiceWorker(const std::string& tag);
   bool UnregisterOneShot(const std::string& tag);
   bool UnregisterOneShotTwice(const std::string& tag);
   bool GetRegistrationOneShot(const std::string& tag);
   bool GetRegistrationOneShotFromServiceWorker(const std::string& tag);
   bool MatchRegistrations(const std::string& script_result,
@@ skipping 12 matching lines @@
   Shell* shell_ = nullptr;
 
   DISALLOW_COPY_AND_ASSIGN(BackgroundSyncBrowserTest);
 };
 
 void BackgroundSyncBrowserTest::SetOnline(bool online) {
   ASSERT_TRUE(shell_);
   BrowserThread::PostTask(
       BrowserThread::IO, FROM_HERE,
       base::Bind(&BackgroundSyncBrowserTest::SetOnlineOnIOThread,
-                 base::Unretained(this),
-                 base::Unretained(GetSyncContextFromShell(shell_)), online));
+                 base::Unretained(this), base::Unretained(GetSyncContext()),
+                 online));
   base::RunLoop().RunUntilIdle();
 }
 
 void BackgroundSyncBrowserTest::SetOnlineOnIOThread(
     const scoped_refptr<BackgroundSyncContext>& sync_context,
     bool online) {
   BackgroundSyncManager* sync_manager = sync_context->background_sync_manager();
   BackgroundSyncNetworkObserver* network_observer =
       sync_manager->GetNetworkObserverForTesting();
   if (online) {
-    network_observer->NotifyManagerIfNetworkChanged(
+    network_observer->NotifyManagerIfNetworkChangedForTesting(
         NetworkChangeNotifier::CONNECTION_WIFI);
   } else {
-    network_observer->NotifyManagerIfNetworkChanged(
+    network_observer->NotifyManagerIfNetworkChangedForTesting(
         NetworkChangeNotifier::CONNECTION_NONE);
   }
 }
 
 bool BackgroundSyncBrowserTest::OneShotPending(const std::string& tag) {
   bool is_pending;
   base::RunLoop run_loop;
 
-  StoragePartition* storage = BrowserContext::GetDefaultStoragePartition(
-      shell_->web_contents()->GetBrowserContext());
+  StoragePartition* storage = GetStorage();
   BackgroundSyncContext* sync_context = storage->GetBackgroundSyncContext();
   ServiceWorkerContextWrapper* service_worker_context =
       static_cast<ServiceWorkerContextWrapper*>(
           storage->GetServiceWorkerContext());
 
   base::Callback<void(bool)> callback =
       base::Bind(&OneShotPendingCallback, run_loop.QuitClosure(),
                  base::ThreadTaskRunnerHandle::Get(), &is_pending);
 
   BrowserThread::PostTask(
       BrowserThread::IO, FROM_HERE,
       base::Bind(&OneShotPendingOnIOThread, make_scoped_refptr(sync_context),
                  make_scoped_refptr(service_worker_context), tag,
                  https_server_->GetURL(kDefaultTestURL), callback));
 
   run_loop.Run();
 
   return is_pending;
 }
 
+void BackgroundSyncBrowserTest::ClearStoragePartitionData() {
+  // Clear data from the storage partition.  Parameters are set to clear data
+  // for service workers, for all origins, for an unbounded time range.
+  StoragePartition* storage = GetStorage();
+
+  uint32 storage_partition_mask =
+      StoragePartition::REMOVE_DATA_MASK_SERVICE_WORKERS;
+  uint32 quota_storage_mask = StoragePartition::QUOTA_MANAGED_STORAGE_MASK_ALL;
+  const GURL& delete_origin = GURL();
+  const base::Time delete_begin = base::Time();
+  base::Time delete_end = base::Time::Max();
+
+  base::RunLoop run_loop;
+
+  storage->ClearData(storage_partition_mask, quota_storage_mask, delete_origin,
+                     StoragePartition::OriginMatcherFunction(), delete_begin,
+                     delete_end, run_loop.QuitClosure());
+
+  run_loop.Run();
+}
+
 std::string BackgroundSyncBrowserTest::PopConsoleString() {
   std::string script_result;
   EXPECT_TRUE(RunScript("resultQueue.pop()", &script_result));
   return script_result;
 }
 
 bool BackgroundSyncBrowserTest::PopConsole(const std::string& expected_msg) {
   std::string script_result = PopConsoleString();
   return script_result == expected_msg;
 }
@@ skipping 378 matching lines @@
   SetOnline(true);
   EXPECT_TRUE(RegisterOneShot("delay"));
   EXPECT_FALSE(OneShotPending("delay"));
   EXPECT_TRUE(StoreRegistrationOneShot("delay"));
 
   EXPECT_TRUE(RejectDelayedOneShot());
   EXPECT_TRUE(PopConsole("ok - delay rejected"));
   EXPECT_TRUE(NotifyWhenFinishedImmediateOneShot("ok - delay result: false"));
 }
 
+// Verify that a background sync registration is deleted when site data is
+// cleared.
+IN_PROC_BROWSER_TEST_F(BackgroundSyncBrowserTest,
+                       SyncRegistrationDeletedWhenClearingSiteData) {
+  EXPECT_TRUE(RegisterServiceWorker());
+  EXPECT_TRUE(LoadTestPage(kDefaultTestURL));  // Control the page.
+
+  // Prevent firing by going offline.
+  SetOnline(false);
+  EXPECT_TRUE(RegisterOneShot("foo"));
+  EXPECT_TRUE(GetRegistrationOneShot("foo"));
+  EXPECT_TRUE(OneShotPending("foo"));
+
+  // Simulate a user clearing site data (including Service Workers, crucially),
+  // by clearing data from the storage partition.
+  ClearStoragePartitionData();
+
+  EXPECT_FALSE(GetRegistrationOneShot("foo"));
+}
+
+// Verify that a background sync registration, from a service worker, is deleted
+// when site data is cleared.
+IN_PROC_BROWSER_TEST_F(BackgroundSyncBrowserTest,
+                       SyncRegistrationFromSWDeletedWhenClearingSiteData) {
+  EXPECT_TRUE(RegisterServiceWorker());
+  EXPECT_TRUE(LoadTestPage(kDefaultTestURL));  // Control the page.
+
+  std::vector<std::string> registered_tags;
+  EXPECT_TRUE(GetRegistrationsOneShot(registered_tags));
+
+  SetOnline(false);
+
+  EXPECT_TRUE(RegisterOneShotFromServiceWorker("foo_sw"));
+  EXPECT_TRUE(PopConsole("ok - foo_sw registered in SW"));
+  EXPECT_TRUE(GetRegistrationOneShotFromServiceWorker("foo_sw"));
+
+  // Simulate a user clearing site data (including Service Workers, crucially),
+  // by clearing data from the storage partition.
+  ClearStoragePartitionData();
+
+  EXPECT_FALSE(GetRegistrationOneShotFromServiceWorker("foo"));
+}
+
+// Verify that multiple background sync registrations are deleted when site
+// data is cleared.
+IN_PROC_BROWSER_TEST_F(BackgroundSyncBrowserTest,
+                       SyncRegistrationsDeletedWhenClearingSiteData) {
+  EXPECT_TRUE(RegisterServiceWorker());
+  EXPECT_TRUE(LoadTestPage(kDefaultTestURL));  // Control the page.
+
+  std::vector<std::string> registered_tags;
+  EXPECT_TRUE(GetRegistrationsOneShot(registered_tags));
+
+  SetOnline(false);
+  registered_tags.push_back("foo");
+  registered_tags.push_back("bar");
+
+  for (const std::string& tag : registered_tags)
+    EXPECT_TRUE(RegisterOneShot(tag));
+
+  EXPECT_TRUE(GetRegistrationsOneShot(registered_tags));
+
+  for (const std::string& tag : registered_tags)
+    EXPECT_TRUE(OneShotPending(tag));
+
+  // Simulate a user clearing site data (including Service Workers, crucially),
+  // by clearing data from the storage partition.
+  ClearStoragePartitionData();
+
+  for (const std::string& tag : registered_tags)
+    EXPECT_FALSE(GetRegistrationOneShot(tag));
+}

[jkarlin, 2015/10/30 13:41:13]

Can you also test what happens if a sync is in the middle of firing when the
storage partition is cleared? 

[chasej, 2015/10/30 15:59:23]

Done.

+
 }  // namespace content