src/chrome/browser/history/shortcuts_database_unittest.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "base/files/scoped_temp_dir.h"
   6 #include "base/format_macros.h"
   7 #include "base/path_service.h"
   8 #include "base/strings/stringprintf.h"
   9 #include "base/strings/utf_string_conversions.h"
  10 #include "base/time/time.h"
  11 #include "chrome/browser/history/shortcuts_database.h"
  12 #include "chrome/common/chrome_constants.h"
  13 #include "chrome/common/chrome_paths.h"
  14 #include "chrome/test/base/testing_profile.h"
  15 #include "sql/statement.h"
  16 #include "sql/test/test_helpers.h"
  17
  18 #include "testing/gtest/include/gtest/gtest.h"
  19
  20
  21 // Helpers --------------------------------------------------------------------
  22
  23 namespace {
  24
  25 struct ShortcutsDatabaseTestInfo {
  26   std::string guid;
  27   std::string text;
  28   std::string fill_into_edit;
  29   std::string destination_url;
  30   std::string contents;
  31   std::string contents_class;
  32   std::string stripped_contents_class;  // |contents_class| with matches removed
  33   std::string description;
  34   std::string description_class;
  35   std::string stripped_description_class;
  36   content::PageTransition transition;
  37   AutocompleteMatch::Type type;
  38   std::string keyword;
  39   int days_from_now;
  40   int number_of_hits;
  41 } shortcut_test_db[] = {
  42   { "BD85DBA2-8C29-49F9-84AE-48E1E90880DF", "goog", "www.google.com",
  43     "http://www.google.com/", "Google", "0,1,4,0", "0,1,4,0", "Google",
  44     "0,3,4,1", "0,1", content::PAGE_TRANSITION_GENERATED,
  45     AutocompleteMatchType::SEARCH_HISTORY, "google.com", 1, 100, },
  46   { "BD85DBA2-8C29-49F9-84AE-48E1E90880E0", "slash", "slashdot.org",
  47     "http://slashdot.org/", "slashdot.org", "0,3,5,1", "0,1",
  48     "Slashdot - News for nerds, stuff that matters", "0,2,5,0", "0,0",
  49     content::PAGE_TRANSITION_TYPED, AutocompleteMatchType::HISTORY_URL, "", 0,
  50     100},
  51   { "BD85DBA2-8C29-49F9-84AE-48E1E90880E1", "news", "slashdot.org",
  52     "http://slashdot.org/", "slashdot.org", "0,1", "0,1",
  53     "Slashdot - News for nerds, stuff that matters", "0,0,11,2,15,0", "0,0",
  54     content::PAGE_TRANSITION_LINK, AutocompleteMatchType::HISTORY_TITLE, "", 0,
  55     5},
  56 };
  57
  58 typedef testing::Test ShortcutsDatabaseMigrationTest;
  59
  60 // Checks that the database at |db| has the version 2 columns iff |is_v2|.
  61 void CheckV2ColumnExistence(const base::FilePath& db_path, bool is_v2) {
  62   sql::Connection connection;
  63   ASSERT_TRUE(connection.Open(db_path));
  64   EXPECT_EQ(is_v2, connection.DoesColumnExist("omni_box_shortcuts",
  65                                               "fill_into_edit"));
  66   EXPECT_EQ(is_v2, connection.DoesColumnExist("omni_box_shortcuts",
  67                                               "transition"));
  68   EXPECT_EQ(is_v2, connection.DoesColumnExist("omni_box_shortcuts", "type"));
  69   EXPECT_EQ(is_v2, connection.DoesColumnExist("omni_box_shortcuts", "keyword"));
  70 }
  71
  72 }  // namespace
  73
  74 namespace history {
  75
  76
  77 // ShortcutsDatabaseTest ------------------------------------------------------
  78
  79 class ShortcutsDatabaseTest : public testing::Test {
  80  public:
  81   virtual void SetUp();
  82   virtual void TearDown();
  83
  84   void ClearDB();
  85   size_t CountRecords() const;
  86
  87   ShortcutsBackend::Shortcut ShortcutFromTestInfo(
  88       const ShortcutsDatabaseTestInfo& info);
  89
  90   void AddAll();
  91
  92   scoped_ptr<TestingProfile> profile_;
  93   scoped_refptr<ShortcutsDatabase> db_;
  94 };
  95
  96 void ShortcutsDatabaseTest::SetUp() {
  97   profile_.reset(new TestingProfile());
  98   db_ = new ShortcutsDatabase(
  99       profile_->GetPath().Append(chrome::kShortcutsDatabaseName));
 100   ASSERT_TRUE(db_->Init());
 101   ClearDB();
 102 }
 103
 104 void ShortcutsDatabaseTest::TearDown() {
 105   db_ = NULL;
 106 }
 107
 108 void ShortcutsDatabaseTest::ClearDB() {
 109   sql::Statement
 110       s(db_->db_.GetUniqueStatement("DELETE FROM omni_box_shortcuts"));
 111   EXPECT_TRUE(s.Run());
 112 }
 113
 114 size_t ShortcutsDatabaseTest::CountRecords() const {
 115   sql::Statement s(db_->db_.GetUniqueStatement(
 116       "SELECT count(*) FROM omni_box_shortcuts"));
 117   EXPECT_TRUE(s.Step());
 118   return static_cast<size_t>(s.ColumnInt(0));
 119 }
 120
 121 ShortcutsBackend::Shortcut ShortcutsDatabaseTest::ShortcutFromTestInfo(
 122     const ShortcutsDatabaseTestInfo& info) {
 123   return ShortcutsBackend::Shortcut(
 124       info.guid, ASCIIToUTF16(info.text),
 125       ShortcutsBackend::Shortcut::MatchCore(
 126           ASCIIToUTF16(info.fill_into_edit), GURL(info.destination_url),
 127           ASCIIToUTF16(info.contents),
 128           AutocompleteMatch::ClassificationsFromString(info.contents_class),
 129           ASCIIToUTF16(info.description),
 130           AutocompleteMatch::ClassificationsFromString(info.description_class),
 131           info.transition, info.type, ASCIIToUTF16(info.keyword)),
 132       base::Time::Now() - base::TimeDelta::FromDays(info.days_from_now),
 133       info.number_of_hits);
 134 }
 135
 136 void ShortcutsDatabaseTest::AddAll() {
 137   ClearDB();
 138   for (size_t i = 0; i < arraysize(shortcut_test_db); ++i)
 139     db_->AddShortcut(ShortcutFromTestInfo(shortcut_test_db[i]));
 140   EXPECT_EQ(arraysize(shortcut_test_db), CountRecords());
 141 }
 142
 143
 144 // Actual tests ---------------------------------------------------------------
 145
 146 TEST_F(ShortcutsDatabaseTest, AddShortcut) {
 147   ClearDB();
 148   EXPECT_EQ(0U, CountRecords());
 149   EXPECT_TRUE(db_->AddShortcut(ShortcutFromTestInfo(shortcut_test_db[0])));
 150   EXPECT_EQ(1U, CountRecords());
 151   EXPECT_TRUE(db_->AddShortcut(ShortcutFromTestInfo(shortcut_test_db[1])));
 152   EXPECT_EQ(2U, CountRecords());
 153   EXPECT_TRUE(db_->AddShortcut(ShortcutFromTestInfo(shortcut_test_db[2])));
 154   EXPECT_EQ(3U, CountRecords());
 155 }
 156
 157 TEST_F(ShortcutsDatabaseTest, UpdateShortcut) {
 158   AddAll();
 159   ShortcutsBackend::Shortcut shortcut(
 160       ShortcutFromTestInfo(shortcut_test_db[1]));
 161   shortcut.match_core.contents = ASCIIToUTF16("gro.todhsals");
 162   EXPECT_TRUE(db_->UpdateShortcut(shortcut));
 163   ShortcutsDatabase::GuidToShortcutMap shortcuts;
 164   db_->LoadShortcuts(&shortcuts);
 165   ShortcutsDatabase::GuidToShortcutMap::const_iterator it(
 166       shortcuts.find(shortcut.id));
 167   EXPECT_TRUE(it != shortcuts.end());
 168   EXPECT_TRUE(it->second.match_core.contents == shortcut.match_core.contents);
 169 }
 170
 171 TEST_F(ShortcutsDatabaseTest, DeleteShortcutsWithIds) {
 172   AddAll();
 173   std::vector<std::string> shortcut_ids;
 174   shortcut_ids.push_back(shortcut_test_db[0].guid);
 175   shortcut_ids.push_back(shortcut_test_db[2].guid);
 176   EXPECT_TRUE(db_->DeleteShortcutsWithIds(shortcut_ids));
 177   EXPECT_EQ(arraysize(shortcut_test_db) - 2, CountRecords());
 178
 179   ShortcutsDatabase::GuidToShortcutMap shortcuts;
 180   db_->LoadShortcuts(&shortcuts);
 181
 182   ShortcutsDatabase::GuidToShortcutMap::iterator it =
 183       shortcuts.find(shortcut_test_db[0].guid);
 184   EXPECT_TRUE(it == shortcuts.end());
 185
 186   it = shortcuts.find(shortcut_test_db[1].guid);
 187   EXPECT_TRUE(it != shortcuts.end());
 188
 189   it = shortcuts.find(shortcut_test_db[2].guid);
 190   EXPECT_TRUE(it == shortcuts.end());
 191 }
 192
 193 TEST_F(ShortcutsDatabaseTest, DeleteShortcutsWithUrl) {
 194   AddAll();
 195
 196   EXPECT_TRUE(db_->DeleteShortcutsWithUrl("http://slashdot.org/"));
 197   EXPECT_EQ(arraysize(shortcut_test_db) - 2, CountRecords());
 198
 199   ShortcutsDatabase::GuidToShortcutMap shortcuts;
 200   db_->LoadShortcuts(&shortcuts);
 201
 202   ShortcutsDatabase::GuidToShortcutMap::iterator it =
 203       shortcuts.find(shortcut_test_db[0].guid);
 204   EXPECT_TRUE(it != shortcuts.end());
 205
 206   it = shortcuts.find(shortcut_test_db[1].guid);
 207   EXPECT_TRUE(it == shortcuts.end());
 208
 209   it = shortcuts.find(shortcut_test_db[2].guid);
 210   EXPECT_TRUE(it == shortcuts.end());
 211 }
 212
 213 TEST_F(ShortcutsDatabaseTest, LoadShortcuts) {
 214   AddAll();
 215   ShortcutsDatabase::GuidToShortcutMap shortcuts;
 216   db_->LoadShortcuts(&shortcuts);
 217
 218   for (size_t i = 0; i < arraysize(shortcut_test_db); ++i) {
 219     SCOPED_TRACE(base::StringPrintf("Comparing shortcut #%" PRIuS, i));
 220     ShortcutsDatabase::GuidToShortcutMap::const_iterator it(
 221         shortcuts.find(shortcut_test_db[i].guid));
 222     ASSERT_TRUE(it != shortcuts.end());
 223     const ShortcutsBackend::Shortcut& shortcut = it->second;
 224     EXPECT_EQ(ASCIIToUTF16(shortcut_test_db[i].text), shortcut.text);
 225     EXPECT_EQ(ASCIIToUTF16(shortcut_test_db[i].fill_into_edit),
 226               shortcut.match_core.fill_into_edit);
 227     EXPECT_EQ(shortcut_test_db[i].destination_url,
 228               shortcut.match_core.destination_url.spec());
 229     EXPECT_EQ(ASCIIToUTF16(shortcut_test_db[i].contents),
 230               shortcut.match_core.contents);
 231     EXPECT_EQ(shortcut_test_db[i].stripped_contents_class,
 232               AutocompleteMatch::ClassificationsToString(
 233                   shortcut.match_core.contents_class));
 234     EXPECT_EQ(ASCIIToUTF16(shortcut_test_db[i].description),
 235               shortcut.match_core.description);
 236     EXPECT_EQ(shortcut_test_db[i].stripped_description_class,
 237               AutocompleteMatch::ClassificationsToString(
 238                   shortcut.match_core.description_class));
 239     EXPECT_EQ(shortcut_test_db[i].transition, shortcut.match_core.transition);
 240     EXPECT_EQ(shortcut_test_db[i].type, shortcut.match_core.type);
 241     EXPECT_EQ(ASCIIToUTF16(shortcut_test_db[i].keyword),
 242               shortcut.match_core.keyword);
 243     EXPECT_EQ(shortcut_test_db[i].number_of_hits, shortcut.number_of_hits);
 244     // We don't bother trying to check the |days_from_now| field, since dealing
 245     // with times in unittests is annoying.
 246   }
 247 }
 248
 249 TEST_F(ShortcutsDatabaseTest, DeleteAllShortcuts) {
 250   AddAll();
 251   ShortcutsDatabase::GuidToShortcutMap shortcuts;
 252   db_->LoadShortcuts(&shortcuts);
 253   EXPECT_EQ(arraysize(shortcut_test_db), shortcuts.size());
 254   EXPECT_TRUE(db_->DeleteAllShortcuts());
 255   db_->LoadShortcuts(&shortcuts);
 256   EXPECT_EQ(0U, shortcuts.size());
 257 }
 258
 259 TEST(ShortcutsDatabaseMigrationTest, MigrateV1ToV2) {
 260   // Open the v1 test file and use it to create a test database in a temp dir.
 261   base::FilePath sql_path;
 262   ASSERT_TRUE(PathService::Get(chrome::DIR_TEST_DATA, &sql_path));
 263   sql_path = sql_path.AppendASCII("History").AppendASCII("Shortcuts.v1.sql");
 264   base::ScopedTempDir temp_dir;
 265   ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
 266   base::FilePath db_path(temp_dir.path().AppendASCII("TestShortcuts.db"));
 267   ASSERT_TRUE(sql::test::CreateDatabaseFromSQL(db_path, sql_path));
 268
 269   CheckV2ColumnExistence(db_path, false);
 270
 271   // Create a ShortcutsDatabase from the test database, which will migrate the
 272   // test database to the current version.
 273   {
 274     scoped_refptr<ShortcutsDatabase> db(new ShortcutsDatabase(db_path));
 275     db->Init();
 276   }
 277
 278   CheckV2ColumnExistence(db_path, true);
 279
 280   // Check the values in each of the new columns.
 281   sql::Connection connection;
 282   ASSERT_TRUE(connection.Open(db_path));
 283   sql::Statement statement(connection.GetUniqueStatement(
 284       "SELECT fill_into_edit, url, transition, type, keyword "
 285       "FROM omni_box_shortcuts"));
 286   ASSERT_TRUE(statement.is_valid());
 287   while (statement.Step()) {
 288     // |fill_into_edit| should have been copied from the |url|.
 289     EXPECT_EQ(statement.ColumnString(1), statement.ColumnString(0));
 290
 291     // The other three columns have default values.
 292     EXPECT_EQ(content::PAGE_TRANSITION_TYPED,
 293               static_cast<content::PageTransition>(statement.ColumnInt(2)));
 294     EXPECT_EQ(AutocompleteMatchType::HISTORY_TITLE,
 295               static_cast<AutocompleteMatch::Type>(statement.ColumnInt(3)));
 296     EXPECT_TRUE(statement.ColumnString(4).empty());
 297   }
 298   EXPECT_TRUE(statement.Succeeded());
 299 }
 300
 301 }  // namespace history