contacts: Add UpdateMetadata protocol buffer.

chrome/browser/chromeos/contacts/contact_database_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 "chrome/browser/chromeos/contacts/contact_database.h"
 
 #include <string>
 
 #include "base/bind.h"
 #include "base/file_path.h"
@@ skipping 59 matching lines @@
 
   void DestroyDatabase() {
     if (db_) {
       db_->DestroyOnUIThread();
       db_ = NULL;
     }
   }
 
   // Calls ContactDatabase::SaveContacts() and blocks until the operation is
   // complete.
-  void SaveContacts(scoped_ptr<ContactPointers> contacts, bool is_full_update) {
+  void SaveContacts(scoped_ptr<ContactPointers> contacts,
+                    scoped_ptr<UpdateMetadata> metadata,
+                    bool is_full_update) {
     CHECK(db_);
-    db_->SaveContacts(contacts.Pass(), is_full_update,
+    db_->SaveContacts(contacts.Pass(), metadata.Pass(), is_full_update,
                       base::Bind(&ContactDatabaseTest::OnContactsSaved,
                                  base::Unretained(this)));
     message_loop_.Run();
   }
 
   // Calls ContactDatabase::LoadContacts() and blocks until the operation is
   // complete.
-  scoped_ptr<ScopedVector<Contact> > LoadContacts() {
+  void LoadContacts(scoped_ptr<ScopedVector<Contact> >* contacts_out,
+                    scoped_ptr<UpdateMetadata>* metadata_out) {
     CHECK(db_);
     db_->LoadContacts(base::Bind(&ContactDatabaseTest::OnContactsLoaded,
                                  base::Unretained(this)));
     message_loop_.Run();
-    return loaded_contacts_.Pass();
+    contacts_out->swap(loaded_contacts_);
+    metadata_out->swap(loaded_metadata_);
   }
 
  private:
   void OnDatabaseInitialized(bool success) {
     CHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     CHECK(success);
     // TODO(derat): Move gdata::test::RunBlockingPoolTask() to a shared location
     // and use it for these tests.
     message_loop_.Quit();
   }
 
   void OnContactsSaved(bool success) {
     CHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     CHECK(success);
     message_loop_.Quit();
   }
 
   void OnContactsLoaded(bool success,
-                        scoped_ptr<ScopedVector<Contact> > contacts) {
+                        scoped_ptr<ScopedVector<Contact> > contacts,
+                        scoped_ptr<UpdateMetadata> metadata) {
     CHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     CHECK(success);
     loaded_contacts_.swap(contacts);
+    loaded_metadata_.swap(metadata);
     message_loop_.Quit();
   }
 
   MessageLoopForUI message_loop_;
   content::TestBrowserThread ui_thread_;
 
   // Temporary directory where the database is saved.
   ScopedTempDir temp_dir_;
 
   // This class retains ownership of this object.
   ContactDatabase* db_;
 
-  // Contacts returned by the most-recent ContactDatabase::LoadContacts() call.
-  // Used to pass contacts from OnContactsLoaded() to LoadContacts().
+  // Contacts and metadata returned by the most-recent
+  // ContactDatabase::LoadContacts() call.  Used to pass returned values from
+  // OnContactsLoaded() to LoadContacts().
   scoped_ptr<ScopedVector<Contact> > loaded_contacts_;
+  scoped_ptr<UpdateMetadata> loaded_metadata_;
 
   DISALLOW_COPY_AND_ASSIGN(ContactDatabaseTest);
 };
 
 TEST_F(ContactDatabaseTest, SaveAndReload) {
   // Save a contact to the database and check that we get the same data back
   // when loading it.
   const std::string kProviderId = "provider_id_1";
   scoped_ptr<Contact> contact(new Contact);
   InitContact(kProviderId, "1", false, contact.get());
   AddEmailAddress("email_1", Contact_AddressType_Relation_HOME,
                   "email_label_1", true, contact.get());
   AddEmailAddress("email_2", Contact_AddressType_Relation_WORK,
                   "", false, contact.get());
   AddPhoneNumber("123-456-7890", Contact_AddressType_Relation_HOME,
                  "phone_label", true, contact.get());
   AddPostalAddress("postal_1", Contact_AddressType_Relation_HOME,
                    "postal_label_1", true, contact.get());
   AddPostalAddress("postal_2", Contact_AddressType_Relation_OTHER,
                    "postal_label_2", false, contact.get());
   AddInstantMessagingAddress("im_1",
                              Contact_InstantMessagingAddress_Protocol_AIM,
                              Contact_AddressType_Relation_HOME,
                              "im_label_1", true, contact.get());
   SetPhoto(gfx::Size(20, 20), contact.get());
   scoped_ptr<ContactPointers> contacts_to_save(new ContactPointers);
   contacts_to_save->push_back(contact.get());
-  SaveContacts(contacts_to_save.Pass(), true);
 
-  scoped_ptr<ScopedVector<Contact> > loaded_contacts = LoadContacts();
+  const int64 kLastUpdateTime = 1234;
+  scoped_ptr<UpdateMetadata> metadata_to_save(new UpdateMetadata);
+  metadata_to_save->set_last_update_start_time(kLastUpdateTime);
+
+  SaveContacts(contacts_to_save.Pass(), metadata_to_save.Pass(), true);
+  scoped_ptr<ScopedVector<Contact> > loaded_contacts;
+  scoped_ptr<UpdateMetadata> loaded_metadata;
+  LoadContacts(&loaded_contacts, &loaded_metadata);
   EXPECT_EQ(VarContactsToString(1, contact.get()),
             ContactsToString(*loaded_contacts));
+  EXPECT_EQ(kLastUpdateTime, loaded_metadata->last_update_start_time());
 
   // Modify the contact, save it, and check that the loaded contact is also
   // updated.
   InitContact(kProviderId, "2", false, contact.get());
   AddEmailAddress("email_3", Contact_AddressType_Relation_OTHER,
                   "email_label_2", true, contact.get());
   AddPhoneNumber("phone_2", Contact_AddressType_Relation_OTHER,
                  "phone_label_2", false, contact.get());
   AddPostalAddress("postal_3", Contact_AddressType_Relation_HOME,
                    "postal_label_3", true, contact.get());
   SetPhoto(gfx::Size(64, 64), contact.get());
   contacts_to_save.reset(new ContactPointers);
   contacts_to_save->push_back(contact.get());
-  SaveContacts(contacts_to_save.Pass(), true);
+  metadata_to_save.reset(new UpdateMetadata);
+  const int64 kNewLastUpdateTime = 5678;
+  metadata_to_save->set_last_update_start_time(kNewLastUpdateTime);
+  SaveContacts(contacts_to_save.Pass(), metadata_to_save.Pass(), true);
 
-  loaded_contacts = LoadContacts();
+  LoadContacts(&loaded_contacts, &loaded_metadata);
   EXPECT_EQ(VarContactsToString(1, contact.get()),
             ContactsToString(*loaded_contacts));
+  EXPECT_EQ(kNewLastUpdateTime, loaded_metadata->last_update_start_time());
 }
 
 TEST_F(ContactDatabaseTest, FullAndPartialUpdates) {
   // Do a full update that inserts two contacts into the database.
   const std::string kProviderId1 = "provider_id_1";
   const std::string kSharedEmail = "foo@example.org";
   scoped_ptr<Contact> contact1(new Contact);
   InitContact(kProviderId1, "1", false, contact1.get());
   AddEmailAddress(kSharedEmail, Contact_AddressType_Relation_HOME,
                   "", true, contact1.get());
 
   const std::string kProviderId2 = "provider_id_2";
   scoped_ptr<Contact> contact2(new Contact);
   InitContact(kProviderId2, "2", false, contact2.get());
   AddEmailAddress(kSharedEmail, Contact_AddressType_Relation_WORK,
                   "", true, contact2.get());
 
   scoped_ptr<ContactPointers> contacts_to_save(new ContactPointers);
   contacts_to_save->push_back(contact1.get());
   contacts_to_save->push_back(contact2.get());
-  SaveContacts(contacts_to_save.Pass(), true);
-  scoped_ptr<ScopedVector<Contact> > loaded_contacts = LoadContacts();
+  scoped_ptr<UpdateMetadata> metadata_to_save(new UpdateMetadata);
+  SaveContacts(contacts_to_save.Pass(), metadata_to_save.Pass(), true);
+
+  scoped_ptr<ScopedVector<Contact> > loaded_contacts;
+  scoped_ptr<UpdateMetadata> loaded_metadata;
+  LoadContacts(&loaded_contacts, &loaded_metadata);
   EXPECT_EQ(VarContactsToString(2, contact1.get(), contact2.get()),
             ContactsToString(*loaded_contacts));
 
   // Do a partial update including just the second contact.
   InitContact(kProviderId2, "2b", false, contact2.get());
   AddPostalAddress("postal_1", Contact_AddressType_Relation_HOME,
                    "", true, contact2.get());
   contacts_to_save.reset(new ContactPointers);
   contacts_to_save->push_back(contact2.get());
-  SaveContacts(contacts_to_save.Pass(), false);
-  loaded_contacts = LoadContacts();
+  metadata_to_save.reset(new UpdateMetadata);
+  SaveContacts(contacts_to_save.Pass(), metadata_to_save.Pass(), false);
+  LoadContacts(&loaded_contacts, &loaded_metadata);
   EXPECT_EQ(VarContactsToString(2, contact1.get(), contact2.get()),
             ContactsToString(*loaded_contacts));
 
+  // Do an empty partial update and check that the metadata is still updated.
+  contacts_to_save.reset(new ContactPointers);
+  metadata_to_save.reset(new UpdateMetadata);
+  const int64 kLastUpdateTime = 1234;
+  metadata_to_save->set_last_update_start_time(kLastUpdateTime);
+  SaveContacts(contacts_to_save.Pass(), metadata_to_save.Pass(), false);
+  LoadContacts(&loaded_contacts, &loaded_metadata);
+  EXPECT_EQ(VarContactsToString(2, contact1.get(), contact2.get()),
+            ContactsToString(*loaded_contacts));
+  EXPECT_EQ(kLastUpdateTime, loaded_metadata->last_update_start_time());
+
   // Do a full update including just the first contact.  The second contact
   // should be removed from the database.
   InitContact(kProviderId1, "1b", false, contact1.get());
   AddPostalAddress("postal_2", Contact_AddressType_Relation_WORK,
                    "", true, contact1.get());
   AddPhoneNumber("phone", Contact_AddressType_Relation_HOME,
                  "", true, contact1.get());
   contacts_to_save.reset(new ContactPointers);
   contacts_to_save->push_back(contact1.get());
-  SaveContacts(contacts_to_save.Pass(), true);
-  loaded_contacts = LoadContacts();
+  metadata_to_save.reset(new UpdateMetadata);
+  SaveContacts(contacts_to_save.Pass(), metadata_to_save.Pass(), true);
+  LoadContacts(&loaded_contacts, &loaded_metadata);
   EXPECT_EQ(VarContactsToString(1, contact1.get()),
             ContactsToString(*loaded_contacts));
 
   // Do a full update including no contacts.  The database should be cleared.
   contacts_to_save.reset(new ContactPointers);
-  SaveContacts(contacts_to_save.Pass(), true);
-  loaded_contacts = LoadContacts();
+  metadata_to_save.reset(new UpdateMetadata);
+  SaveContacts(contacts_to_save.Pass(), metadata_to_save.Pass(), true);
+  LoadContacts(&loaded_contacts, &loaded_metadata);
   EXPECT_TRUE(loaded_contacts->empty());
 }
 
 // Test that we create a new database when we encounter a corrupted one.
 TEST_F(ContactDatabaseTest, DeleteWhenCorrupt) {
   DestroyDatabase();
   // Overwrite all of the files in the database with a space character.
   file_util::FileEnumerator enumerator(
       database_path(), false, file_util::FileEnumerator::FILES);
   for (FilePath path = enumerator.Next(); !path.empty();
        path = enumerator.Next()) {
     file_util::WriteFile(path, " ", 1);
   }
   CreateDatabase();
 
   // Make sure that the resulting database is usable.
   scoped_ptr<Contact> contact(new Contact);
   InitContact("1", "1", false, contact.get());
   scoped_ptr<ContactPointers> contacts_to_save(new ContactPointers);
   contacts_to_save->push_back(contact.get());
-  SaveContacts(contacts_to_save.Pass(), true);
-  scoped_ptr<ScopedVector<Contact> > loaded_contacts = LoadContacts();
+  scoped_ptr<UpdateMetadata> metadata_to_save(new UpdateMetadata);
+  SaveContacts(contacts_to_save.Pass(), metadata_to_save.Pass(), true);
+
+  scoped_ptr<ScopedVector<Contact> > loaded_contacts;
+  scoped_ptr<UpdateMetadata> loaded_metadata;
+  LoadContacts(&loaded_contacts, &loaded_metadata);
   EXPECT_EQ(VarContactsToString(1, contact.get()),
             ContactsToString(*loaded_contacts));
 }
 
 }  // namespace test
 }  // namespace contacts