Moves SQLitePersistentCookieStore to net/extras/sqlite.

content/browser/net/quota_policy_cookie_store_unittest.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 "base/bind.h"
+#include "base/files/file_util.h"
+#include "base/files/scoped_temp_dir.h"
+#include "base/memory/ref_counted.h"
+#include "base/memory/scoped_vector.h"
+#include "base/message_loop/message_loop.h"
+#include "base/run_loop.h"
+#include "base/stl_util.h"
+#include "base/test/sequenced_worker_pool_owner.h"
+#include "base/thread_task_runner_handle.h"
+#include "base/threading/sequenced_worker_pool.h"
+#include "base/time/time.h"
+#include "content/browser/net/quota_policy_cookie_store.h"
+#include "content/public/test/mock_special_storage_policy.h"
+#include "content/public/test/test_browser_thread_bundle.h"
+#include "net/base/test_data_directory.h"
+#include "net/cookies/cookie_util.h"
+#include "net/ssl/ssl_client_cert_type.h"
+#include "net/test/cert_test_util.h"
+#include "sql/statement.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace {
+const base::FilePath::CharType kTestCookiesFilename[] =
+    FILE_PATH_LITERAL("Cookies");
+}
+
+namespace content {
+namespace {
+
+typedef std::vector<net::CanonicalCookie*> CanonicalCookieVector;
+
+class QuotaPolicyCookieStoreTest : public testing::Test {
+ public:
+  QuotaPolicyCookieStoreTest()
+      : pool_owner_(new base::SequencedWorkerPoolOwner(3, "Background Pool")) {
+  }
+
+  void OnLoaded(const CanonicalCookieVector& cookies) {
+    cookies_ = cookies;
+    base::MessageLoop::current()->Quit();
+  }
+
+  void Load(CanonicalCookieVector* cookies) {
+    store_->Load(base::Bind(&QuotaPolicyCookieStoreTest::OnLoaded,
+                            base::Unretained(this)));
+    base::MessageLoop::current()->Run();

[Ryan Sleevi, 2015/05/14 01:19:35]

note for future: Use RunLoops for this

[rohitrao (ping after 24h), 2015/05/14 15:48:34]

Acknowledged.

+    *cookies = cookies_;
+  }
+
+  void FailIfOnLoadedCalled(const CanonicalCookieVector& cookies) {
+    FAIL();
+  }
+
+ protected:
+  scoped_refptr<base::SequencedTaskRunner> background_task_runner() {
+    if (!background_task_runner_.get()) {
+      background_task_runner_ = pool_owner_->pool()->GetSequencedTaskRunner(
+          pool_owner_->pool()->GetNamedSequenceToken("background"));
+    }
+    return background_task_runner_;
+  }
+
+  scoped_refptr<base::SequencedTaskRunner> client_task_runner() {
+    if (!client_task_runner_.get()) {
+      client_task_runner_ = base::ThreadTaskRunnerHandle::Get();
+    }
+    return client_task_runner_;
+  }
+
+  void CreateAndLoad(storage::SpecialStoragePolicy* storage_policy,
+                     CanonicalCookieVector* cookies) {
+    scoped_refptr<net::SQLitePersistentCookieStore> sqlite_store(
+        new net::SQLitePersistentCookieStore(
+            temp_dir_.path().Append(kTestCookiesFilename),
+            client_task_runner(),
+            background_task_runner(),
+            true, nullptr));
+    store_ = new QuotaPolicyCookieStore(sqlite_store.get(), storage_policy);
+    Load(cookies);
+  }
+
+  // Adds a persistent cookie to store_.
+  void AddCookie(const std::string& name,
+                 const std::string& value,
+                 const std::string& domain,
+                 const std::string& path,
+                 const base::Time& creation) {
+    store_->AddCookie(
+        net::CanonicalCookie(
+            GURL(), name, value, domain, path, creation, creation, creation,
+            false, false, false, net::COOKIE_PRIORITY_DEFAULT));
+  }
+
+  void DestroyStore() {
+    store_ = nullptr;
+    // Ensure that |store_|'s destructor has run by shutting down the pool and
+    // then forcing the pool to be destructed. This will ensure that all the
+    // tasks that block pool shutdown (e.g. |store_|'s cleanup) have run before
+    // yielding control.
+    background_task_runner_ = nullptr;
+    client_task_runner_ = nullptr;
+    pool_owner_->pool()->FlushForTesting();
+    pool_owner_->pool()->Shutdown();
+    pool_owner_.reset(new base::SequencedWorkerPoolOwner(3, "Background Pool"));
+  }
+
+  void SetUp() override {
+    ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
+  }
+
+  void TearDown() override {
+    DestroyStore();
+    pool_owner_->pool()->Shutdown();
+  }
+
+  TestBrowserThreadBundle bundle_;
+  scoped_ptr<base::SequencedWorkerPoolOwner> pool_owner_;
+  scoped_refptr<base::SequencedTaskRunner> background_task_runner_;
+  scoped_refptr<base::SequencedTaskRunner> client_task_runner_;
+  base::ScopedTempDir temp_dir_;
+  scoped_refptr<QuotaPolicyCookieStore> store_;
+  CanonicalCookieVector cookies_;
+};
+
+// Test if data is stored as expected in the QuotaPolicy database.
+TEST_F(QuotaPolicyCookieStoreTest, TestPersistence) {
+  CanonicalCookieVector cookies;
+  CreateAndLoad(nullptr, &cookies);
+  ASSERT_EQ(0U, cookies.size());
+
+  base::Time t = base::Time::Now();
+  AddCookie("A", "B", "foo.com", "/", t);
+  t += base::TimeDelta::FromInternalValue(10);
+  AddCookie("A", "B", "persistent.com", "/", t);
+
+  // Replace the store effectively destroying the current one and forcing it
+  // to write its data to disk. Then we can see if after loading it again it
+  // is still there.
+  DestroyStore();
+
+  // Reload and test for persistence.
+  STLDeleteElements(&cookies);
+  CreateAndLoad(nullptr, &cookies);
+  EXPECT_EQ(2U, cookies.size());
+  bool found_foo_cookie = false;
+  bool found_persistent_cookie = false;
+  for (const auto& cookie : cookies) {
+    if (cookie->Domain() == "foo.com")
+      found_foo_cookie = true;
+    else if (cookie->Domain() == "persistent.com")
+      found_persistent_cookie = true;
+  }
+  EXPECT_TRUE(found_foo_cookie);
+  EXPECT_TRUE(found_persistent_cookie);

[Ryan Sleevi, 2015/05/14 01:19:35]

For this case, I doubt it's fully justified, but gmock has a container matcher
that is nifty with this

https://code.google.com/p/googlemock/wiki/CheatSheet#Container_Matchers

EXPECT_THAT(cookies, UnorderedElementsAre(CookieDomainEquals("foo.com"),
CookieDomainEquals("persistent.com")));

MATCHER_P(CookieDomainEquals, domain, std::string("cookie domain ") + (negation
? "isn't : "is") + " " + domain) {
  return arg->Domain == domain;
}


But I mean, who would do that? :P

[rohitrao (ping after 24h), 2015/05/14 15:48:34]

Acknowledged.

+
+  // Now delete the cookies and check persistence again.
+  store_->DeleteCookie(*cookies[0]);
+  store_->DeleteCookie(*cookies[1]);
+  DestroyStore();
+
+  // Reload and check if the cookies have been removed.
+  STLDeleteElements(&cookies);
+  CreateAndLoad(nullptr, &cookies);
+  EXPECT_EQ(0U, cookies.size());
+  STLDeleteElements(&cookies);
+}
+
+// Test if data is stored as expected in the QuotaPolicy database.
+TEST_F(QuotaPolicyCookieStoreTest, TestPolicy) {
+  CanonicalCookieVector cookies;
+  CreateAndLoad(nullptr, &cookies);
+  ASSERT_EQ(0U, cookies.size());
+
+  base::Time t = base::Time::Now();
+  AddCookie("A", "B", "foo.com", "/", t);
+  t += base::TimeDelta::FromInternalValue(10);
+  AddCookie("A", "B", "persistent.com", "/", t);
+  t += base::TimeDelta::FromInternalValue(10);
+  AddCookie("A", "B", "nonpersistent.com", "/", t);
+
+  // Replace the store effectively destroying the current one and forcing it
+  // to write its data to disk. Then we can see if after loading it again it
+  // is still there.
+  DestroyStore();
+  // Specify storage policy that makes "nonpersistent.com" session only.
+  scoped_refptr<content::MockSpecialStoragePolicy> storage_policy =
+      new content::MockSpecialStoragePolicy();
+  storage_policy->AddSessionOnly(
+      net::cookie_util::CookieOriginToURL("nonpersistent.com", false));
+
+  // Reload and test for persistence
+  STLDeleteElements(&cookies);
+  CreateAndLoad(storage_policy.get(), &cookies);
+  EXPECT_EQ(3U, cookies.size());
+
+  t += base::TimeDelta::FromInternalValue(10);
+  AddCookie("A", "B", "nonpersistent.com", "/second", t);
+
+  // Now close the store, and "nonpersistent.com" should be deleted according to
+  // policy.
+  DestroyStore();
+  STLDeleteElements(&cookies);
+  CreateAndLoad(nullptr, &cookies);
+
+  EXPECT_EQ(2U, cookies.size());
+  for (const auto& cookie : cookies) {
+    EXPECT_NE("nonpersistent.com", cookie->Domain());
+  }
+  STLDeleteElements(&cookies);
+}
+
+TEST_F(QuotaPolicyCookieStoreTest, ForceKeepSessionState) {
+  CanonicalCookieVector cookies;
+  CreateAndLoad(nullptr, &cookies);
+  ASSERT_EQ(0U, cookies.size());
+
+  base::Time t = base::Time::Now();
+  AddCookie("A", "B", "foo.com", "/", t);
+
+  // Recreate |store_| with a storage policy that makes "nonpersistent.com"
+  // session only, but then instruct the store to forcibly keep all cookies.
+  DestroyStore();
+  scoped_refptr<content::MockSpecialStoragePolicy> storage_policy =
+      new content::MockSpecialStoragePolicy();
+  storage_policy->AddSessionOnly(
+      net::cookie_util::CookieOriginToURL("nonpersistent.com", false));
+
+  // Reload and test for persistence
+  STLDeleteElements(&cookies);
+  CreateAndLoad(storage_policy.get(), &cookies);
+  EXPECT_EQ(1U, cookies.size());
+
+  t += base::TimeDelta::FromInternalValue(10);
+  AddCookie("A", "B", "persistent.com", "/", t);
+  t += base::TimeDelta::FromInternalValue(10);
+  AddCookie("A", "B", "nonpersistent.com", "/", t);
+
+  // Now close the store, but the "nonpersistent.com" cookie should not be
+  // deleted.
+  store_->SetForceKeepSessionState();
+  DestroyStore();
+  STLDeleteElements(&cookies);
+  CreateAndLoad(nullptr, &cookies);
+
+  EXPECT_EQ(3U, cookies.size());
+  STLDeleteElements(&cookies);
+}
+
+// Tests that the store does not keep a strong reference to itself when creating
+// the callback for Load().
+TEST_F(QuotaPolicyCookieStoreTest, DBGoesOutOfScope) {
+  // Used to determine whether |quota_store| is destroyed when it goes out of
+  // scope.
+  base::WeakPtr<QuotaPolicyCookieStore> weak_store;
+  {
+    scoped_refptr<net::SQLitePersistentCookieStore> sqlite_store(
+        new net::SQLitePersistentCookieStore(
+            temp_dir_.path().Append(kTestCookiesFilename),
+            client_task_runner(),
+            background_task_runner(),
+            true, nullptr));
+    scoped_refptr<QuotaPolicyCookieStore> quota_store(
+        new QuotaPolicyCookieStore(sqlite_store.get(), nullptr));
+    quota_store->Load(
+        base::Bind(&QuotaPolicyCookieStoreTest::FailIfOnLoadedCalled,
+                   base::Unretained(this)));
+
+    weak_store = quota_store->AsWeakPtr();
+    // Allow |quota_store| to go out of scope and be destroyed here.
+  }
+
+  // If |weak_store| is NULL, then |quota_store| was destroyed when it went out
+  // of scope and Load() could not have kept a strong reference to the store.
+  EXPECT_EQ(NULL, weak_store.get());
+}
+
+}  // namespace
+}  // namespace content