Rewrite DownloadsDOMHandler

chrome/browser/ui/webui/downloads_dom_handler_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/json/json_reader.h"
+#include "base/scoped_temp_dir.h"
+#include "base/values.h"
+#include "chrome/browser/prefs/pref_service.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/ui/browser.h"
+#include "chrome/browser/ui/webui/downloads_dom_handler.h"
+#include "chrome/common/pref_names.h"
+#include "chrome/test/base/in_process_browser_test.h"
+#include "chrome/test/base/ui_test_utils.h"
+#include "content/public/browser/download_persistent_store_info.h"
+#include "content/public/browser/web_contents.h"
+
+namespace {
+
+// Read |right_json| into a ListValue |left_list|; return true if all key-value

[James Hawkins, 2012/08/22 17:39:01]

nit: Reads

[James Hawkins, 2012/08/22 17:39:01]

nit: returns

[benjhayden, 2012/08/22 20:19:22]

Done.

[benjhayden, 2012/08/22 20:19:22]

Done.

+// pairs in in all dictionaries in |right_list| are also in the corresponding
+// dictionary in |left_list|. Ignores keys in dictionaries in |left_list| that
+// are not in the corresponding dictionary in |right_list|.
+bool ListMatches(base::ListValue* left_list, const std::string& right_json) {
+  scoped_ptr<base::Value> right_value(base::JSONReader::Read(right_json));
+  base::ListValue* right_list = NULL;
+  CHECK(right_value->GetAsList(&right_list));
+  for (size_t i = 0; i < left_list->GetSize(); ++i) {
+    base::DictionaryValue* left_dict = NULL;
+    base::DictionaryValue* right_dict = NULL;
+    CHECK(left_list->GetDictionary(i, &left_dict));
+    CHECK(right_list->GetDictionary(i, &right_dict));
+    for (base::DictionaryValue::Iterator iter(*right_dict);
+          iter.HasNext(); iter.Advance()) {
+      base::Value* left_value = NULL;
+      if (left_dict->HasKey(iter.key()) &&
+          left_dict->Get(iter.key(), &left_value) &&
+          !iter.value().Equals(left_value)) {
+        LOG(WARNING) << iter.key();
+        return false;
+      }
+    }
+  }
+  return true;
+}
+
+// A |DownloadsDOMHandler| that doesn't use a real WebUI object, but is real in
+// all other respects.
+class MockDownloadsDOMHandler : public DownloadsDOMHandler {
+ public:
+  explicit MockDownloadsDOMHandler(content::DownloadManager* dlm)
+    : DownloadsDOMHandler(dlm) {
+  }
+  virtual ~MockDownloadsDOMHandler() {}
+
+  base::ListValue* downloads_list() { return downloads_list_.get(); }
+  base::ListValue* download_updated() { return download_updated_.get(); }
+
+ protected:
+  virtual content::WebContents* GetWebUIWebContents() {
+    return NULL;
+  }
+
+  virtual void CallDownloadsList(const base::ListValue& downloads) {
+    downloads_list_.reset(downloads.DeepCopy());
+    content::BrowserThread::PostTask(
+        content::BrowserThread::UI, FROM_HERE, MessageLoop::QuitClosure());
+  }
+
+  virtual void CallDownloadUpdated(const base::ListValue& download) {
+    download_updated_.reset(download.DeepCopy());
+  }
+
+ private:
+  scoped_ptr<base::ListValue> downloads_list_;
+  scoped_ptr<base::ListValue> download_updated_;
+  DISALLOW_COPY_AND_ASSIGN(MockDownloadsDOMHandler);
+};
+
+}  // namespace
+
+class DownloadsDOMHandlerTest : public InProcessBrowserTest {
+ public:
+  DownloadsDOMHandlerTest() {}
+
+  virtual ~DownloadsDOMHandlerTest() {}
+
+  virtual void SetUpOnMainThread() OVERRIDE {
+    CHECK(downloads_directory_.CreateUniqueTempDir());
+    browser()->profile()->GetPrefs()->SetFilePath(
+        prefs::kDownloadDefaultDirectory,
+        downloads_directory_.path());
+    CHECK(test_server()->Start());
+  }
+
+  content::DownloadManager* download_manager() {
+    return content::BrowserContext::GetDownloadManager(browser()->profile());
+  }
+
+ private:
+  ScopedTempDir downloads_directory_;
+
+  DISALLOW_COPY_AND_ASSIGN(DownloadsDOMHandlerTest);
+};
+
+// Test that DownloadsDOMHandler detects new downloads and relays them to the

[James Hawkins, 2012/08/22 17:39:01]

nit: Tests

[benjhayden, 2012/08/22 20:19:22]

Done.

+// renderer.
+IN_PROC_BROWSER_TEST_F(DownloadsDOMHandlerTest,
+    DownloadsDOMHandlerTest_Created) {
+  MockDownloadsDOMHandler mddh(download_manager());
+
+  GURL url = test_server()->GetURL("files/downloads/image.jpg");
+  base::Time current(base::Time::Now());
+  content::DownloadPersistentStoreInfo population_entries[] = {
+    content::DownloadPersistentStoreInfo(
+        FilePath(FILE_PATH_LITERAL("/path/to/file")),
+        url,
+        GURL(""),
+        current - base::TimeDelta::FromMinutes(5),
+        current,
+        128,
+        128,
+        content::DownloadItem::COMPLETE,
+        1,
+        false),
+  };
+  std::vector<content::DownloadPersistentStoreInfo> entries(
+      population_entries, population_entries + arraysize(population_entries));
+  download_manager()->OnPersistentStoreQueryComplete(&entries);
+  content::RunMessageLoop();
+
+  ASSERT_EQ(1, static_cast<int>(mddh.downloads_list()->GetSize()));
+  ASSERT_EQ(1, static_cast<int>(mddh.download_updated()->GetSize()));
+  EXPECT_TRUE(ListMatches(
+      mddh.downloads_list(),
+      "[{\"file_externally_removed\": false,"
+      "  \"file_name\": \"file\","
+      "  \"id\": 0,"
+      "  \"otr\": false,"
+      "  \"since_string\": \"Today\","
+      "  \"state\": \"COMPLETE\","
+      "  \"total\": 128}]"));
+  EXPECT_TRUE(ListMatches(
+      mddh.download_updated(),
+      "[{\"file_externally_removed\": true,"
+      "  \"id\": 0}]"));
+
+  mddh.HandleClearAll(NULL);
+  content::RunMessageLoop();
+  EXPECT_EQ(0, static_cast<int>(mddh.downloads_list()->GetSize()));
+}
+
+// TODO(benjhayden): Test the extension downloads filter for both
+// mddh.downloads_list() and mddh.download_updated().
+
+// TODO(benjhayden): Test incognito, both downloads_list() and that on-record
+// calls can't access off-record items.
+
+// TODO(benjhayden): Test that bad download ids incoming from the javascript are
+// dropped on the floor.
+
+// TODO(benjhayden): Test that IsTemporary() downloads are not shown.
+
+// TODO(benjhayden): Test that RemoveObserver is called on all download items,
+// including items that crossed IsTemporary() and back.