Make DownloadHistory observe manager, items

chrome/browser/download/save_page_browsertest.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 "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/command_line.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/path_service.h"
 #include "base/scoped_temp_dir.h"
 #include "base/test/test_file_util.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/api/prefs/pref_member.h"
 #include "chrome/browser/download/chrome_download_manager_delegate.h"
 #include "chrome/browser/download/download_history.h"
 #include "chrome/browser/download/download_prefs.h"
 #include "chrome/browser/download/download_service.h"
 #include "chrome/browser/download/download_service_factory.h"
+#include "chrome/browser/history/download_persistent_store_info.h"
+#include "chrome/browser/history/history_service_factory.h"
 #include "chrome/browser/net/url_request_mock_util.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_commands.h"
 #include "chrome/browser/ui/browser_tabstrip.h"
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/common/chrome_paths.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/common/url_constants.h"
 #include "chrome/test/base/in_process_browser_test.h"
 #include "chrome/test/base/ui_test_utils.h"
 #include "content/public/browser/download_item.h"
 #include "content/public/browser/download_manager.h"
-#include "content/public/browser/download_persistent_store_info.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/test/test_utils.h"
 #include "content/test/net/url_request_mock_http_job.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 #if defined(OS_CHROMEOS)
 #include "chrome/browser/download/save_package_file_picker_chromeos.h"
 #else
 #include "chrome/browser/download/save_package_file_picker.h"
 #endif
 
 using content::BrowserContext;
 using content::BrowserThread;
 using content::DownloadItem;
 using content::DownloadManager;
-using content::DownloadPersistentStoreInfo;
 using content::WebContents;
 
 namespace {
 
+class DownloadPersistedObserver : public DownloadItem::Observer {
+ public:
+  DownloadPersistedObserver(DownloadItem* item)
+    : item_(item) {
+    item->AddObserver(this);
+  }
+
+  ~DownloadPersistedObserver() {
+    if (item_)
+      item_->RemoveObserver(this);
+  }
+
+  void WaitForPersisted() {
+    if (persisted_)
+      return;
+    waiting_ = true;
+    content::RunMessageLoop();
+    waiting_ = false;
+  }
+
+  virtual void OnDownloadDestroyed(DownloadItem* item) {
+    item_->RemoveObserver(this);
+    item_ = NULL;
+  }
+
+  virtual void OnDownloadUpdated(DownloadItem* item) {
+    CHECK_EQ(item_, item);
+    persisted_ = true;
+    if (waiting_)
+      MessageLoopForUI::current()->Quit();
+  }
+
+ private:
+  DownloadItem* item_;
+  bool waiting_;
+  bool persisted_;
+  DISALLOW_COPY_AND_ASSIGN(DownloadPersistedObserver);
+};
+
 static const FilePath::CharType* kTestDir = FILE_PATH_LITERAL("save_page");
 
 static const char* kAppendedExtension =
 #if defined(OS_WIN)
     ".htm";
 #else
     ".html";
 #endif
 
 }  // namespace
@@ skipping 24 matching lines @@
 
     if (!created_item_) {
       waiting_ = true;
       content::RunMessageLoop();
       waiting_ = false;
     }
     return created_item_;
   }
 
  private:
-
   // DownloadManager::Observer
   void OnDownloadCreated(DownloadManager* manager, DownloadItem* item) {
     DCHECK_EQ(manager, manager_);
     if (!created_item_)
       created_item_ = item;
 
     if (waiting_)
       MessageLoopForUI::current()->Quit();
   }
 
@@ skipping 64 matching lines @@
 
   DownloadManager* GetDownloadManager() const {
     DownloadManager* download_manager =
         BrowserContext::GetDownloadManager(browser()->profile());
     EXPECT_TRUE(download_manager);
     return download_manager;
   }
 
   void QueryDownloadHistory() {
     // Query the history system.
-    ChromeDownloadManagerDelegate* delegate =
-      static_cast<ChromeDownloadManagerDelegate*>(
-          GetDownloadManager()->GetDelegate());
-    delegate->download_history()->Load(
-        base::Bind(&SavePageBrowserTest::OnQueryDownloadEntriesComplete,
-                   base::Unretained(this)));
+    HistoryService* hs = HistoryServiceFactory::GetForProfile(
+        browser()->profile(), Profile::EXPLICIT_ACCESS);
+    hs->QueryDownloads(base::Bind(
+        &SavePageBrowserTest::OnQueryDownloadEntriesComplete,
+        base::Unretained(this),
+        MessageLoopForUI::current()->QuitClosure()));
 
     // Run message loop until a quit message is sent from
     // OnQueryDownloadEntriesComplete().
     content::RunMessageLoop();
   }
 
   void OnQueryDownloadEntriesComplete(
-      std::vector<DownloadPersistentStoreInfo>* entries) {
-    history_entries_ = *entries;
-
-    // Indicate thet we have received the history and can continue.
-    MessageLoopForUI::current()->Quit();
+      const base::Closure& done_on_ui,
+      scoped_ptr<std::vector<DownloadPersistentStoreInfo> > entries) {
+    history_entries_ = entries.Pass();
+    BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, done_on_ui);
   }
 
-  struct DownloadPersistentStoreInfoMatch
-    : public std::unary_function<DownloadPersistentStoreInfo, bool> {
-
-    DownloadPersistentStoreInfoMatch(const GURL& url,
-                                     const FilePath& path,
-                                     int64 num_files)
-      : url_(url),
-        path_(path),
-        num_files_(num_files) {
-    }
-
-    bool operator() (const DownloadPersistentStoreInfo& info) const {
-      return info.url == url_ &&
-             info.path == path_ &&
-             // For non-MHTML save packages, received_bytes is actually the
-             // number of files.
-             ((num_files_ < 0) ||
-              (info.received_bytes == num_files_)) &&
-             info.total_bytes == 0 &&
-             info.state == DownloadItem::COMPLETE;
-    }
-
-    GURL url_;
-    FilePath path_;
-    int64 num_files_;
-  };
-
   void CheckDownloadHistory(const GURL& url,
                             const FilePath& path,
-                            int64 num_files) {
+                            int64 num_files,
+                            bool expect_found) {
     QueryDownloadHistory();
-
-    std::vector<DownloadPersistentStoreInfo>::iterator found =
-      std::find_if(history_entries_.begin(), history_entries_.end(),
-                   DownloadPersistentStoreInfoMatch(url, path, num_files));
-
-    if (found == history_entries_.end()) {
-      LOG(ERROR) << "Missing url=" << url.spec()
-                 << " path=" << path.value()
-                 << " received=" << num_files;
-      for (size_t index = 0; index < history_entries_.size(); ++index) {
-        LOG(ERROR) << "History@" << index << ": url="
-                   << history_entries_[index].url.spec()
-                   << " path=" << history_entries_[index].path.value()
-                   << " received=" << history_entries_[index].received_bytes
-                   << " total=" << history_entries_[index].total_bytes
-                   << " state=" << history_entries_[index].state;
+    bool found = false;
+    for (std::vector<DownloadPersistentStoreInfo>::iterator it =
+         history_entries_->begin();
+         it != history_entries_->end(); ++it) {
+      if (it->url != url) {
+        LOG(WARNING) << it->url.spec() << " != " << url.spec();
+      } else if (it->path != path) {
+        LOG(WARNING) << it->path.value() << " != " << path.value();
+      } else if ((num_files >= 0) &&
+          (it->received_bytes != num_files)) {
+        LOG(WARNING) << it->received_bytes << " != " << num_files;
+      } else if ((num_files >= 0) &&
+          (it->total_bytes != num_files)) {
+        LOG(WARNING) << it->total_bytes << " != " << num_files;
+      } else if (it->state != DownloadItem::COMPLETE) {
+        LOG(WARNING) << it->state << " != " << DownloadItem::COMPLETE;
+      } else {
+        found = true;
+        break;
       }
-      EXPECT_TRUE(false);
     }
+    EXPECT_EQ(found, expect_found);
   }
 
-  std::vector<DownloadPersistentStoreInfo> history_entries_;
+  scoped_ptr<std::vector<DownloadPersistentStoreInfo> > history_entries_;
 
   // Path to directory containing test data.
   FilePath test_dir_;
 
   // Temporary directory we will save pages to.
   ScopedTempDir save_dir_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(SavePageBrowserTest);
 };
 
 SavePageBrowserTest::~SavePageBrowserTest() {
 }
 
 IN_PROC_BROWSER_TEST_F(SavePageBrowserTest, SaveHTMLOnly) {
   GURL url = NavigateToMockURL("a");
 
   FilePath full_file_name, dir;
   GetDestinationPaths("a", &full_file_name, &dir);
   ASSERT_TRUE(GetCurrentTab()->SavePage(full_file_name, dir,
                                         content::SAVE_PAGE_TYPE_AS_ONLY_HTML));
 
   EXPECT_EQ(url, WaitForSavePackageToFinish());
 
   EXPECT_TRUE(browser()->window()->IsDownloadShelfVisible());
-  CheckDownloadHistory(url, full_file_name, 1);  // a.htm is 1 file.
+  CheckDownloadHistory(url, full_file_name, 1, true);  // a.htm is 1 file.
 
   EXPECT_TRUE(file_util::PathExists(full_file_name));
   EXPECT_FALSE(file_util::PathExists(dir));
   EXPECT_TRUE(file_util::ContentsEqual(
       test_dir_.Append(FilePath(kTestDir)).Append(FILE_PATH_LITERAL("a.htm")),
       full_file_name));
 }
 
 IN_PROC_BROWSER_TEST_F(SavePageBrowserTest, SaveHTMLOnlyCancel) {
   GURL url = NavigateToMockURL("a");
   DownloadManager* manager(GetDownloadManager());
   std::vector<DownloadItem*> downloads;
   manager->SearchDownloads(string16(), &downloads);
   ASSERT_EQ(0u, downloads.size());
 
   FilePath full_file_name, dir;
   GetDestinationPaths("a", &full_file_name, &dir);
   DownloadItemCreatedObserver creation_observer(manager);
   ASSERT_TRUE(GetCurrentTab()->SavePage(full_file_name, dir,
                                         content::SAVE_PAGE_TYPE_AS_ONLY_HTML));
   DownloadItem* item = creation_observer.WaitForNewDownloadItem();
   item->Cancel(true);
 
   // TODO(rdsmith): Fix DII::Cancel() to actually cancel the save package.
   // Currently it's ignored.
   EXPECT_EQ(url, WaitForSavePackageToFinish());
 
   EXPECT_TRUE(browser()->window()->IsDownloadShelfVisible());
-  CheckDownloadHistory(url, full_file_name, 1);  // a.htm is 1 file.
+  CheckDownloadHistory(url, full_file_name, 1, true);  // a.htm is 1 file.
 
   EXPECT_TRUE(file_util::PathExists(full_file_name));
   EXPECT_FALSE(file_util::PathExists(dir));
   EXPECT_TRUE(file_util::ContentsEqual(
       test_dir_.Append(FilePath(kTestDir)).Append(FILE_PATH_LITERAL("a.htm")),
       full_file_name));
 }
 
 // SavePageBrowserTest.SaveHTMLOnlyTabDestroy is flaky.
 // See http://crbug.com/144751.
@@ skipping 28 matching lines @@
   ui_test_utils::NavigateToURL(browser(), view_source_url);
 
   FilePath full_file_name, dir;
   GetDestinationPaths("a", &full_file_name, &dir);
   ASSERT_TRUE(GetCurrentTab()->SavePage(full_file_name, dir,
                                         content::SAVE_PAGE_TYPE_AS_ONLY_HTML));
 
   EXPECT_EQ(actual_page_url, WaitForSavePackageToFinish());
 
   EXPECT_TRUE(browser()->window()->IsDownloadShelfVisible());
-  CheckDownloadHistory(actual_page_url, full_file_name, 1);  // a.htm is 1 file.
+  CheckDownloadHistory(actual_page_url, full_file_name, 1, true);
 
   EXPECT_TRUE(file_util::PathExists(full_file_name));
   EXPECT_FALSE(file_util::PathExists(dir));
   EXPECT_TRUE(file_util::ContentsEqual(
       test_dir_.Append(FilePath(kTestDir)).Append(file_name),
       full_file_name));
 }
 
 IN_PROC_BROWSER_TEST_F(SavePageBrowserTest, SaveCompleteHTML) {
   GURL url = NavigateToMockURL("b");
 
   FilePath full_file_name, dir;
   GetDestinationPaths("b", &full_file_name, &dir);
   ASSERT_TRUE(GetCurrentTab()->SavePage(
       full_file_name, dir, content::SAVE_PAGE_TYPE_AS_COMPLETE_HTML));
 
   EXPECT_EQ(url, WaitForSavePackageToFinish());
 
   EXPECT_TRUE(browser()->window()->IsDownloadShelfVisible());
-  CheckDownloadHistory(url, full_file_name, 3);  // b.htm is 3 files.
+  CheckDownloadHistory(url, full_file_name, 3, true);  // b.htm is 3 files.
 
   EXPECT_TRUE(file_util::PathExists(full_file_name));
   EXPECT_TRUE(file_util::PathExists(dir));
   EXPECT_TRUE(file_util::TextContentsEqual(
       test_dir_.Append(FilePath(kTestDir)).AppendASCII("b.saved1.htm"),
       full_file_name));
   EXPECT_TRUE(file_util::ContentsEqual(
       test_dir_.Append(FilePath(kTestDir)).AppendASCII("1.png"),
       dir.AppendASCII("1.png")));
   EXPECT_TRUE(file_util::ContentsEqual(
@@ skipping 12 matching lines @@
   FilePath full_file_name = save_dir_.path().AppendASCII(
       std::string("Test page for saving page feature") + kAppendedExtension);
   FilePath dir = save_dir_.path().AppendASCII(
       "Test page for saving page feature_files");
   ASSERT_TRUE(GetCurrentTab()->SavePage(
       full_file_name, dir, content::SAVE_PAGE_TYPE_AS_COMPLETE_HTML));
 
   EXPECT_EQ(url, WaitForSavePackageToFinish());
 
   EXPECT_TRUE(browser()->window()->IsDownloadShelfVisible());
-  CheckDownloadHistory(url, full_file_name, 3);  // b.htm is 3 files.
+  CheckDownloadHistory(url, full_file_name, 3, true);  // b.htm is 3 files.
 
   EXPECT_TRUE(file_util::PathExists(full_file_name));
   EXPECT_TRUE(file_util::PathExists(dir));
   EXPECT_TRUE(file_util::TextContentsEqual(
       test_dir_.Append(FilePath(kTestDir)).AppendASCII("b.saved2.htm"),
       full_file_name));
   EXPECT_TRUE(file_util::ContentsEqual(
       test_dir_.Append(FilePath(kTestDir)).AppendASCII("1.png"),
       dir.AppendASCII("1.png")));
   EXPECT_TRUE(file_util::ContentsEqual(
       test_dir_.Append(FilePath(kTestDir)).AppendASCII("1.css"),
       dir.AppendASCII("1.css")));
 }
 
 IN_PROC_BROWSER_TEST_F(SavePageBrowserTest, RemoveFromList) {
   GURL url = NavigateToMockURL("a");
 
   FilePath full_file_name, dir;
   GetDestinationPaths("a", &full_file_name, &dir);
   ASSERT_TRUE(GetCurrentTab()->SavePage(full_file_name, dir,
                                         content::SAVE_PAGE_TYPE_AS_ONLY_HTML));
 
   EXPECT_EQ(url, WaitForSavePackageToFinish());
 
   EXPECT_TRUE(browser()->window()->IsDownloadShelfVisible());
-  CheckDownloadHistory(url, full_file_name, 1);  // a.htm is 1 file.
+  CheckDownloadHistory(url, full_file_name, 1, true);  // a.htm is 1 file.
 
   EXPECT_EQ(GetDownloadManager()->RemoveAllDownloads(), 1);
 
   // Should not be in history.
   QueryDownloadHistory();
-  EXPECT_EQ(std::find_if(history_entries_.begin(), history_entries_.end(),
-      DownloadPersistentStoreInfoMatch(url, full_file_name, 1)),
-      history_entries_.end());
+  CheckDownloadHistory(url, full_file_name, 1, false);
 
   EXPECT_TRUE(file_util::PathExists(full_file_name));
   EXPECT_FALSE(file_util::PathExists(dir));
   EXPECT_TRUE(file_util::ContentsEqual(
       test_dir_.Append(FilePath(kTestDir)).Append(FILE_PATH_LITERAL("a.htm")),
       full_file_name));
 }
 
 // This tests that a webpage with the title "test.exe" is saved as
 // "test.exe.htm".
@@ skipping 52 matching lines @@
 #if defined(OS_CHROMEOS)
   SavePackageFilePickerChromeOS::SetShouldPromptUser(false);
 #else
   SavePackageFilePicker::SetShouldPromptUser(false);
 #endif
   content::WindowedNotificationObserver observer(
         content::NOTIFICATION_SAVE_PACKAGE_SUCCESSFULLY_FINISHED,
         content::NotificationService::AllSources());
   chrome::SavePage(browser());
   observer.Wait();
-  CheckDownloadHistory(url, full_file_name, -1);
+  CheckDownloadHistory(url, full_file_name, -1, true);
 
   EXPECT_TRUE(file_util::PathExists(full_file_name));
   int64 actual_file_size = -1;
   EXPECT_TRUE(file_util::GetFileSize(full_file_name, &actual_file_size));
   EXPECT_LE(kFileSizeMin, actual_file_size);
 }