[Sync] Add support for loading, updating and querying delete journals in

sync/syncable/directory_backing_store_unittest.cc

 // Copyright (c) 2012 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 "testing/gtest/include/gtest/gtest.h"
 
 #include <string>
 
 #include "base/file_path.h"
 #include "base/file_util.h"
@@ skipping 28 matching lines @@
   std::string GetUsername() {
     return "nick@chromium.org";
   }
 
   FilePath GetDatabasePath() {
     return temp_dir_.path().Append(Directory::kSyncDatabaseFilename);
   }
 
   static bool LoadAndIgnoreReturnedData(DirectoryBackingStore *dbs) {
     MetahandlesIndex metas;
+    IdsIndex delete_journals;
     STLElementDeleter<MetahandlesIndex> index_deleter(&metas);
     Directory::KernelLoadInfo kernel_load_info;
-    return dbs->Load(&metas, &kernel_load_info) == OPENED;
+    return dbs->Load(&metas, &delete_journals, &kernel_load_info) == OPENED;
   }
 
   void SetUpVersion67Database(sql::Connection* connection);
   void SetUpVersion68Database(sql::Connection* connection);
   void SetUpVersion69Database(sql::Connection* connection);
   void SetUpVersion70Database(sql::Connection* connection);
   void SetUpVersion71Database(sql::Connection* connection);
   void SetUpVersion72Database(sql::Connection* connection);
   void SetUpVersion73Database(sql::Connection* connection);
   void SetUpVersion74Database(sql::Connection* connection);
   void SetUpVersion75Database(sql::Connection* connection);
   void SetUpVersion76Database(sql::Connection* connection);
   void SetUpVersion77Database(sql::Connection* connection);
   void SetUpVersion78Database(sql::Connection* connection);
   void SetUpVersion79Database(sql::Connection* connection);
   void SetUpVersion80Database(sql::Connection* connection);
   void SetUpVersion81Database(sql::Connection* connection);
   void SetUpVersion82Database(sql::Connection* connection);
+  void SetUpVersion83Database(sql::Connection* connection);
 
   void SetUpCurrentDatabaseAndCheckVersion(sql::Connection* connection) {
     SetUpVersion77Database(connection);  // Prepopulates data.
     scoped_ptr<TestDirectoryBackingStore> dbs(
         new TestDirectoryBackingStore(GetUsername(), connection));
 
     ASSERT_TRUE(LoadAndIgnoreReturnedData(dbs.get()));
     ASSERT_FALSE(dbs->needs_column_refresh_);
     ASSERT_EQ(kCurrentDBVersion, dbs->GetVersion());
   }
@@ skipping 1981 matching lines @@
   for (int i = 0; i < V80_ROW_COUNT; i++) {
     sql::Statement s(connection->GetUniqueStatement(insert_stmts[i]));
     std::string ord = V81_Ordinal(i);
     s.BindBlob(0, ord.data(), ord.length());
     ASSERT_TRUE(s.Run());
     s.Reset(true);
   }
   ASSERT_TRUE(connection->CommitTransaction());
 }
 
+void MigrationTest::SetUpVersion83Database(sql::Connection* connection) {
+  ASSERT_TRUE(connection->is_open());
+  ASSERT_TRUE(connection->BeginTransaction());
+  ASSERT_TRUE(connection->Execute(
+      "CREATE TABLE share_version (id VARCHAR(128) primary key, data INT);"
+      "INSERT INTO 'share_version' VALUES('nick@chromium.org',81);"
+      "CREATE TABLE models (model_id BLOB primary key, progress_marker BLOB, in"
+          "itial_sync_ended BOOLEAN default 0, transaction_version BIGINT "
+          "default 0);"
+      "INSERT INTO 'models' VALUES(X'C2881000',X'0888810218B605',1, 1);"
+      "CREATE TABLE 'metas'(metahandle bigint primary key ON CONFLICT FAIL,base"
+          "_version bigint default -1,server_version bigint default 0,         "
+          "local_external_id bigint default 0"
+          ",mtime bigint default 0,server_mtime bigint default 0,ctime bigint d"
+          "efault 0,server_ctime bigint default 0,id varchar(255) default 'r',p"
+          "arent_id varchar(255) default 'r',server_parent_id varchar(255) defa"
+          "ult 'r',prev_id varchar(255) default 'r',next_id varchar(255) defaul"
+          "t 'r',is_unsynced bit default 0,is_unapplied_update bit default 0,is"
+          "_del bit default 0,is_dir bit default 0,server_is_dir bit default 0,"
+          "server_is_del bit default 0,non_unique_name varchar,server_non_uniqu"
+          "e_name varchar(255),unique_server_tag varchar,unique_client_tag varc"
+          "har,specifics blob,server_specifics blob, base_server_specifics BLOB"
+          ", server_ordinal_in_parent blob, transaction_verion bigint default 0"
+          ");"
+      "CREATE TABLE 'share_info' (id TEXT primary key, name TEXT, store_birthda"
+          "y TEXT, db_create_version TEXT, db_create_time INT, next_id INT defa"
+          "ult -2, cache_guid TEXT , notification_state BLOB, bag_of_chips "
+          "blob);"
+      "INSERT INTO 'share_info' VALUES('nick@chromium.org','nick@chromium.org',"
+          "'c27e9f59-08ca-46f8-b0cc-f16a2ed778bb','Unknown',1263522064,"
+          "-131078,'9010788312004066376x-6609234393368420856x',NULL, NULL);"));
+
+      const char* insert_stmts[V80_ROW_COUNT] = {
+      "INSERT INTO 'metas' VALUES(1,-1,0,0," META_PROTO_TIMES_VALS(1) ",'r','"
+          "r','r','r','r',0,0,0,1,0,0,NULL,NULL,NULL,NULL,X'',X'',NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(2,669,669,4,"
+          META_PROTO_TIMES_VALS(2) ",'s_ID_2','s_ID_9','s_ID_9','s_ID_2','s_ID_"
+          "2',0,0,1,0,0,1,'Deleted Item','Deleted Item',NULL,NULL,X'C28810220A1"
+          "6687474703A2F2F7777772E676F6F676C652E636F6D2F12084141534741534741',X"
+          "'C28810260A17687474703A2F2F7777772E676F6F676C652E636F6D2F32120B41534"
+          "14447414447414447',NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(4,681,681,3,"
+          META_PROTO_TIMES_VALS(4) ",'s_ID_4','s_ID_9','s_ID_9','s_ID_4','s_ID_"
+          "4',0,0,1,0,0,1,'Welcome to Chromium','Welcome to Chromium',NULL,NULL"
+          ",X'C28810350A31687474703A2F2F7777772E676F6F676C652E636F6D2F6368726F6"
+          "D652F696E746C2F656E2F77656C636F6D652E68746D6C1200',X'C28810350A31687"
+          "474703A2F2F7777772E676F6F676C652E636F6D2F6368726F6D652F696E746C2F656"
+          "E2F77656C636F6D652E68746D6C1200',NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(5,677,677,7,"
+          META_PROTO_TIMES_VALS(5) ",'s_ID_5','s_ID_9','s_ID_9','s_ID_5','s_ID_"
+          "5',0,0,1,0,0,1,'Google','Google',NULL,NULL,X'C28810220A16687474703A2"
+          "F2F7777772E676F6F676C652E636F6D2F12084147415347415347',X'C28810220A1"
+          "6687474703A2F2F7777772E676F6F676C652E636F6D2F12084147464447415347',N"
+          "ULL,?,0);",
+      "INSERT INTO 'metas' VALUES(6,694,694,6,"
+          META_PROTO_TIMES_VALS(6) ",'s_ID_6','s_ID_9','s_ID_9','r','r',0,0,0,1"
+          ",1,0,'The Internet','The Internet',NULL,NULL,X'C2881000',X'C2881000'"
+          ",NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(7,663,663,0,"
+          META_PROTO_TIMES_VALS(7) ",'s_ID_7','r','r','r','r',0,0,0,1,1,0,'Goog"
+          "le Chrome','Google Chrome','google_chrome',NULL,NULL,NULL,NULL,?,0);"
+          "",
+      "INSERT INTO 'metas' VALUES(8,664,664,0,"
+          META_PROTO_TIMES_VALS(8) ",'s_ID_8','s_ID_7','s_ID_7','r','r',0,0,0,1"
+          ",1,0,'Bookmarks','Bookmarks','google_chrome_bookmarks',NULL,X'C28810"
+          "00',X'C2881000',NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(9,665,665,1,"
+          META_PROTO_TIMES_VALS(9) ",'s_ID_9','s_ID_8','s_ID_8','r','s_ID_10',0"
+          ",0,0,1,1,0,'Bookmark Bar','Bookmark Bar','bookmark_bar',NULL,X'C2881"
+          "000',X'C2881000',NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(10,666,666,2,"
+          META_PROTO_TIMES_VALS(10) ",'s_ID_10','s_ID_8','s_ID_8','s_ID_9','r',"
+          "0,0,0,1,1,0,'Other Bookmarks','Other Bookmarks','other_bookmarks',NU"
+          "LL,X'C2881000',X'C2881000',NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(11,683,683,8,"
+          META_PROTO_TIMES_VALS(11) ",'s_ID_11','s_ID_6','s_ID_6','r','s_ID_13'"
+          ",0,0,0,0,0,0,'Home (The Chromium Projects)','Home (The Chromium Proj"
+          "ects)',NULL,NULL,X'C28810220A18687474703A2F2F6465762E6368726F6D69756"
+          "D2E6F72672F1206414741545741',X'C28810290A1D687474703A2F2F6465762E636"
+          "8726F6D69756D2E6F72672F6F7468657212084146414756415346',NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(12,685,685,9,"
+          META_PROTO_TIMES_VALS(12) ",'s_ID_12','s_ID_6','s_ID_6','s_ID_13','s_"
+          "ID_14',0,0,0,1,1,0,'Extra Bookmarks','Extra Bookmarks',NULL,NULL,X'C"
+          "2881000',X'C2881000',NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(13,687,687,10,"
+          META_PROTO_TIMES_VALS(13) ",'s_ID_13','s_ID_6','s_ID_6','s_ID_11','s_"
+          "ID_12',0,0,0,0,0,0,'ICANN | Internet Corporation for Assigned Names "
+          "and Numbers','ICANN | Internet Corporation for Assigned Names and Nu"
+          "mbers',NULL,NULL,X'C28810240A15687474703A2F2F7777772E6963616E6E2E636"
+          "F6D2F120B504E474158463041414646',X'C28810200A15687474703A2F2F7777772"
+          "E6963616E6E2E636F6D2F120744414146415346',NULL,?,0);",
+      "INSERT INTO 'metas' VALUES(14,692,692,11,"
+          META_PROTO_TIMES_VALS(14) ",'s_ID_14','s_ID_6','s_ID_6','s_ID_12','r'"
+          ",0,0,0,0,0,0,'The WebKit Open Source Project','The WebKit Open Sourc"
+          "e Project',NULL,NULL,X'C288101A0A12687474703A2F2F7765626B69742E6F726"
+          "72F1204504E4758',X'C288101C0A13687474703A2F2F7765626B69742E6F72672F7"
+          "81205504E473259',NULL,?,0);" };
+
+  for (int i = 0; i < V80_ROW_COUNT; i++) {
+    sql::Statement s(connection->GetUniqueStatement(insert_stmts[i]));
+    std::string ord = V81_Ordinal(i);
+    s.BindBlob(0, ord.data(), ord.length());
+    ASSERT_TRUE(s.Run());
+    s.Reset(true);
+  }
+  ASSERT_TRUE(connection->CommitTransaction());
+}
+
 TEST_F(DirectoryBackingStoreTest, MigrateVersion67To68) {
   sql::Connection connection;
   ASSERT_TRUE(connection.OpenInMemory());
 
   SetUpVersion67Database(&connection);
 
   // Columns existing before version 67.
   ASSERT_TRUE(connection.DoesColumnExist("metas", "name"));
   ASSERT_TRUE(connection.DoesColumnExist("metas", "unsanitized_name"));
   ASSERT_TRUE(connection.DoesColumnExist("metas", "server_name"));
@@ skipping 302 matching lines @@
 
   scoped_ptr<TestDirectoryBackingStore> dbs(
       new TestDirectoryBackingStore(GetUsername(), &connection));
   ASSERT_FALSE(dbs->needs_column_refresh_);
   ASSERT_TRUE(dbs->MigrateVersion78To79());
   ASSERT_EQ(79, dbs->GetVersion());
   ASSERT_FALSE(dbs->needs_column_refresh_);
 
   // Ensure the next_id has been incremented.
   MetahandlesIndex entry_bucket;
+  IdsIndex delete_journals;
   STLElementDeleter<MetahandlesIndex> deleter(&entry_bucket);
   Directory::KernelLoadInfo load_info;
 
   s.Clear();
-  ASSERT_TRUE(dbs->Load(&entry_bucket, &load_info));
+  ASSERT_TRUE(dbs->Load(&entry_bucket, &delete_journals, &load_info));
   EXPECT_LE(load_info.kernel_info.next_id, kInitialNextId - 65536);
 }
 
 TEST_F(DirectoryBackingStoreTest, MigrateVersion79To80) {
   sql::Connection connection;
   ASSERT_TRUE(connection.OpenInMemory());
   SetUpVersion79Database(&connection);
 
   scoped_ptr<TestDirectoryBackingStore> dbs(
       new TestDirectoryBackingStore(GetUsername(), &connection));
   ASSERT_FALSE(dbs->needs_column_refresh_);
   ASSERT_TRUE(dbs->MigrateVersion79To80());
   ASSERT_EQ(80, dbs->GetVersion());
   ASSERT_FALSE(dbs->needs_column_refresh_);
 
   // Ensure the bag_of_chips has been set.
   MetahandlesIndex entry_bucket;
+  IdsIndex delete_journals;
   STLElementDeleter<MetahandlesIndex> deleter(&entry_bucket);
   Directory::KernelLoadInfo load_info;
 
-  ASSERT_TRUE(dbs->Load(&entry_bucket, &load_info));
+  ASSERT_TRUE(dbs->Load(&entry_bucket, &delete_journals, &load_info));
   // Check that the initial value is the serialization of an empty ChipBag.
   sync_pb::ChipBag chip_bag;
   std::string serialized_chip_bag;
   ASSERT_TRUE(chip_bag.SerializeToString(&serialized_chip_bag));
   EXPECT_EQ(serialized_chip_bag, load_info.kernel_info.bag_of_chips);
 }
 
 TEST_F(DirectoryBackingStoreTest, MigrateVersion80To81) {
   sql::Connection connection;
   ASSERT_TRUE(connection.OpenInMemory());
@@ skipping 37 matching lines @@
   sql::Statement s(connection.GetUniqueStatement(
       "INSERT INTO metas "
       "( id, metahandle, is_dir, ctime, mtime, server_ordinal_in_parent) "
       "VALUES( \"c-invalid\", 9999, 1, ?, ?, \" \")"));
   s.BindInt64(0, now);
   s.BindInt64(1, now);
   ASSERT_TRUE(s.Run());
 
   // Trying to unpack this entry should signal that the DB is corrupted.
   MetahandlesIndex entry_bucket;
+  IdsIndex delete_journals;
   STLElementDeleter<MetahandlesIndex> deleter(&entry_bucket);
   Directory::KernelLoadInfo kernel_load_info;
   ASSERT_EQ(FAILED_DATABASE_CORRUPT,
-            dbs->Load(&entry_bucket, &kernel_load_info));
+            dbs->Load(&entry_bucket, &delete_journals, &kernel_load_info));
 }
 
 TEST_F(DirectoryBackingStoreTest, MigrateVersion81To82) {
   sql::Connection connection;
   ASSERT_TRUE(connection.OpenInMemory());
   SetUpVersion81Database(&connection);
   ASSERT_FALSE(connection.DoesColumnExist("models", "transaction_version"));
 
   scoped_ptr<TestDirectoryBackingStore> dbs(
       new TestDirectoryBackingStore(GetUsername(), &connection));
@@ skipping 12 matching lines @@
   ASSERT_FALSE(connection.DoesColumnExist("metas", "transaction_version"));
 
   scoped_ptr<TestDirectoryBackingStore> dbs(
       new TestDirectoryBackingStore(GetUsername(), &connection));
   ASSERT_TRUE(dbs->MigrateVersion82To83());
   ASSERT_EQ(83, dbs->GetVersion());
 
   ASSERT_TRUE(connection.DoesColumnExist("metas", "transaction_version"));
 }
 
+TEST_F(DirectoryBackingStoreTest, MigrateVersion83To84) {
+  sql::Connection connection;
+  ASSERT_TRUE(connection.OpenInMemory());
+  SetUpVersion83Database(&connection);
+  ASSERT_FALSE(connection.DoesTableExist("deleted_metas"));
+
+  scoped_ptr<TestDirectoryBackingStore> dbs(
+      new TestDirectoryBackingStore(GetUsername(), &connection));
+  ASSERT_TRUE(dbs->MigrateVersion83To84());
+  ASSERT_EQ(84, dbs->GetVersion());
+
+  ASSERT_TRUE(connection.DoesTableExist("deleted_metas"));
+}
+
 TEST_P(MigrationTest, ToCurrentVersion) {
   sql::Connection connection;
   ASSERT_TRUE(connection.OpenInMemory());
   switch (GetParam()) {
     case 67:
       SetUpVersion67Database(&connection);
       break;
     case 68:
       SetUpVersion68Database(&connection);
       break;
@@ skipping 32 matching lines @@
       break;
     case 80:
       SetUpVersion80Database(&connection);
       break;
     case 81:
       SetUpVersion81Database(&connection);
       break;
     case 82:
       SetUpVersion82Database(&connection);
       break;
+    case 83:
+      SetUpVersion83Database(&connection);
+      break;
     default:
       // If you see this error, it may mean that you've increased the
       // database version number but you haven't finished adding unit tests
       // for the database migration code.  You need to need to supply a
       // SetUpVersionXXDatabase function with a dump of the test database
       // at the old schema.  Here's one way to do that:
       //   1. Start on a clean tree (with none of your pending schema changes).
       //   2. Set a breakpoint in this function and run the unit test.
       //   3. Allow this test to run to completion (step out of the call),
       //      without allowing ~MigrationTest to execute.
       //   4. Examine this->temp_dir_ to determine the location of the
       //      test database (it is currently of the version you need).
       //   5. Dump this using the sqlite3 command line tool:
       //        > .output foo_dump.sql
       //        > .dump
       //   6. Replace the timestamp columns with META_PROTO_TIMES(x) (or
       //      LEGACY_META_PROTO_TIMES(x) if before Version 77).
       FAIL() << "Need to supply database dump for version " << GetParam();
   }
 
   syncable::Directory::KernelLoadInfo dir_info;
   MetahandlesIndex index;
+  IdsIndex delete_journals;
   STLElementDeleter<MetahandlesIndex> index_deleter(&index);
 
   {
     scoped_ptr<TestDirectoryBackingStore> dbs(
         new TestDirectoryBackingStore(GetUsername(), &connection));
-    ASSERT_EQ(OPENED, dbs->Load(&index, &dir_info));
+    ASSERT_EQ(OPENED, dbs->Load(&index, &delete_journals, &dir_info));
     ASSERT_FALSE(dbs->needs_column_refresh_);
     ASSERT_EQ(kCurrentDBVersion, dbs->GetVersion());
   }
 
   // Columns deleted in Version 67.
   ASSERT_FALSE(connection.DoesColumnExist("metas", "name"));
   ASSERT_FALSE(connection.DoesColumnExist("metas", "unsanitized_name"));
   ASSERT_FALSE(connection.DoesColumnExist("metas", "server_name"));
 
   // Columns added in Version 68.
@@ skipping 245 matching lines @@
 }
 
 TEST_F(DirectoryBackingStoreTest, DeleteEntries) {
   sql::Connection connection;
   ASSERT_TRUE(connection.OpenInMemory());
 
   SetUpCurrentDatabaseAndCheckVersion(&connection);
   scoped_ptr<TestDirectoryBackingStore> dbs(
       new TestDirectoryBackingStore(GetUsername(), &connection));
   MetahandlesIndex index;
+  IdsIndex delete_journals;
   Directory::KernelLoadInfo kernel_load_info;
   STLElementDeleter<MetahandlesIndex> index_deleter(&index);
 
-  dbs->Load(&index, &kernel_load_info);
+  dbs->Load(&index, &delete_journals, &kernel_load_info);
   size_t initial_size = index.size();
   ASSERT_LT(0U, initial_size) << "Test requires entries to delete.";
   int64 first_to_die = (*index.begin())->ref(META_HANDLE);
   MetahandleSet to_delete;
   to_delete.insert(first_to_die);
-  EXPECT_TRUE(dbs->DeleteEntries(to_delete));
+  EXPECT_TRUE(dbs->DeleteEntries(DirectoryBackingStore::DELETE_FROM_METAS,
+                                 to_delete));
 
   STLDeleteElements(&index);
   dbs->LoadEntries(&index);
 
   EXPECT_EQ(initial_size - 1, index.size());
   bool delete_failed = false;
   for (MetahandlesIndex::iterator it = index.begin(); it != index.end();
        ++it) {
     if ((*it)->ref(META_HANDLE) == first_to_die) {
       delete_failed = true;
       break;
     }
   }
   EXPECT_FALSE(delete_failed);
 
   to_delete.clear();
   for (MetahandlesIndex::iterator it = index.begin(); it != index.end();
        ++it) {
     to_delete.insert((*it)->ref(META_HANDLE));
   }
 
-  EXPECT_TRUE(dbs->DeleteEntries(to_delete));
+  EXPECT_TRUE(dbs->DeleteEntries(DirectoryBackingStore::DELETE_FROM_METAS,
+                                 to_delete));
 
   STLDeleteElements(&index);
   dbs->LoadEntries(&index);
   EXPECT_EQ(0U, index.size());
 }
 
 TEST_F(DirectoryBackingStoreTest, GenerateCacheGUID) {
   const std::string& guid1 = TestDirectoryBackingStore::GenerateCacheGUID();
   const std::string& guid2 = TestDirectoryBackingStore::GenerateCacheGUID();
   EXPECT_EQ(24U, guid1.size());
   EXPECT_EQ(24U, guid2.size());
   // In theory this test can fail, but it won't before the universe
   // dies of heat death.
   EXPECT_NE(guid1, guid2);
 }
 
 }  // namespace syncable
 }  // namespace syncer