Initial CL for Downloads resumption.

content/browser/download/download_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.
 
 // This file contains download browser tests that are known to be runnable
 // in a pure content context.  Over time tests should be migrated here.
 
+#include "base/command_line.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "content/browser/download/download_file_factory.h"
 #include "content/browser/download/download_file_impl.h"
 #include "content/browser/download/download_item_impl.h"
 #include "content/browser/download/download_manager_impl.h"
 #include "content/browser/power_save_blocker.h"
 #include "content/browser/web_contents/web_contents_impl.h"
+#include "content/public/common/content_switches.h"
 #include "content/public/test/download_test_observer.h"
 #include "content/public/test/test_utils.h"
 #include "content/shell/shell.h"
 #include "content/shell/shell_browser_context.h"
 #include "content/shell/shell_download_manager_delegate.h"
 #include "content/test/content_browser_test.h"
 #include "content/test/content_browser_test_utils.h"
 #include "content/test/net/url_request_mock_http_job.h"
 #include "content/test/net/url_request_slow_download_job.h"
 #include "googleurl/src/gurl.h"
+#include "net/test/test_server.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using ::testing::_;
 using ::testing::AllOf;
 using ::testing::Field;
 using ::testing::InSequence;
 using ::testing::Property;
 using ::testing::Return;
 using ::testing::StrictMock;
@@ skipping 299 matching lines @@
       std::vector<DownloadOpenDelayedCallback>* callbacks) {
     callbacks->swap(delayed_callbacks_);
   }
  private:
   virtual ~TestShellDownloadManagerDelegate() {}
 
   bool delay_download_open_;
   std::vector<DownloadOpenDelayedCallback> delayed_callbacks_;
 };
 
+// Filter for handling resumption; don't return true until
+// we see first a transition to IN_PROGRESS then a transition to
+// some final state.  Since this is a stateful filter, we
+// must provide a flag in which to store the state; that flag
+// must be false on initialization.
+bool DownloadResumptionFilter(bool* state_flag, DownloadItem* download) {

[ahendrickson, 2012/12/27 17:10:27]

I may be mis-remembering the coding style, but shouldn't modifiable pointer
parameters be at the end?

[Randy Smith (Not in Mondays), 2012/12/27 17:51:00]

Unfortunately, I don't have the option.  The DownloadUpdatedObserver takes a
callback that takes a DownloadItem.  But the callback needs to have state stored
between callbacks.  I could do it in a global variable (and my first pass did)
but that means I have to remember to clear the global variable between uses fo
the filter.  This allows me to bind to a local variable, but Bind() semantics
require that argument to be first.  

I'll add a comment to that effect.

+  if (*state_flag && DownloadItem::IN_PROGRESS != download->GetState()) {
+    return true;
+  }
+
+  if (DownloadItem::IN_PROGRESS == download->GetState())
+    *state_flag = true;
+
+  return false;
+}
+
+// Filter for waiting for intermediate file rename.
+bool IntermediateFileRenameFilter(DownloadItem* download) {
+  return !download->GetFullPath().empty();
+}
+
 }  // namespace
 
 class DownloadContentTest : public ContentBrowserTest {
  protected:
   virtual void SetUpOnMainThread() OVERRIDE {
     ASSERT_TRUE(downloads_directory_.CreateUniqueTempDir());
 
     TestShellDownloadManagerDelegate* delegate =
         new TestShellDownloadManagerDelegate();
     delegate->SetDownloadBehaviorForTesting(downloads_directory_.path());
@@ skipping 43 matching lines @@
   bool EnsureNoPendingDownloads() {
     bool result = true;
     BrowserThread::PostTask(
         BrowserThread::IO, FROM_HERE,
         base::Bind(&EnsureNoPendingDownloadJobsOnIO, &result));
     MessageLoop::current()->Run();
     return result &&
         (CountingDownloadFile::GetNumberActiveFilesFromFileThread() == 0);
   }
 
-  void DownloadAndWait(Shell* shell, const GURL& url) {
+  void DownloadAndWait(Shell* shell, const GURL& url,
+                       DownloadItem::DownloadState expected_terminal_state) {
     scoped_ptr<DownloadTestObserver> observer(CreateWaiter(shell, 1));
     NavigateToURL(shell, url);
     observer->WaitForFinished();
-    EXPECT_EQ(1u, observer->NumDownloadsSeenInState(DownloadItem::COMPLETE));
+    EXPECT_EQ(1u, observer->NumDownloadsSeenInState(expected_terminal_state));
   }
 
   // Checks that |path| is has |file_size| bytes, and matches the |value|
   // string.
   bool VerifyFile(const FilePath& path,
                   const std::string& value,
                   const int64 file_size) {
     std::string file_contents;
 
     bool read = file_util::ReadFileToString(path, &file_contents);
@@ skipping 69 matching lines @@
   std::vector<DownloadItem*> downloads;
   DownloadManagerForShell(shell())->GetAllDownloads(&downloads);
   ASSERT_EQ(1u, downloads.size());
   ASSERT_EQ(DownloadItem::IN_PROGRESS, downloads[0]->GetState());
   DownloadItem* download1 = downloads[0];  // The only download.
 
   // Start the second download and wait until it's done.
   FilePath file(FILE_PATH_LITERAL("download-test.lib"));
   GURL url(URLRequestMockHTTPJob::GetMockUrl(file));
   // Download the file and wait.
-  DownloadAndWait(shell(), url);
+  DownloadAndWait(shell(), url, DownloadItem::COMPLETE);
 
   // Should now have 2 items on the manager.
   downloads.clear();
   DownloadManagerForShell(shell())->GetAllDownloads(&downloads);
   ASSERT_EQ(2u, downloads.size());
   // We don't know the order of the downloads.
   DownloadItem* download2 = downloads[(download1 == downloads[0]) ? 1 : 0];
 
   ASSERT_EQ(DownloadItem::IN_PROGRESS, download1->GetState());
   ASSERT_EQ(DownloadItem::COMPLETE, download2->GetState());
@@ skipping 212 matching lines @@
 
   MockDownloadItemObserver observer;
   items[0]->AddObserver(&observer);
   EXPECT_CALL(observer, OnDownloadDestroyed(items[0]));
 
   // Shutdown the download manager.  Mostly this is confirming a lack of
   // crashes.
   DownloadManagerForShell(shell())->Shutdown();
 }
 
+IN_PROC_BROWSER_TEST_F(DownloadContentTest, ResumeInterruptedDownload) {
+  CommandLine::ForCurrentProcess()->AppendSwitch(
+      switches::kEnableDownloadResumption);
+  ASSERT_TRUE(test_server()->Start());
+  // Default behavior is a 15K file with a RST at 10K.  We request
+  // a hold on the response so that we can get the target name determined
+  // before handling the RST.
+  // TODO(rdsmith): Figure out how to handle the races needed
+  // so that we don't have to wait for the target name determination.
+  GURL url = test_server()->GetURL("rangereset?hold");
+
+  // Download and wait for file determination.
+  scoped_ptr<DownloadTestObserver> observer(CreateInProgressWaiter(shell(), 1));
+  NavigateToURL(shell(), url);
+  observer->WaitForFinished();
+
+  std::vector<DownloadItem*> downloads;
+  DownloadManagerForShell(shell())->GetAllDownloads(&downloads);
+  ASSERT_EQ(1u, downloads.size());
+  DownloadItem* download(downloads[0]);
+  if (download->GetFullPath().empty()) {
+    DownloadUpdatedObserver intermediate_observer(
+        download, base::Bind(&IntermediateFileRenameFilter));
+    intermediate_observer.WaitForEvent();
+  }
+
+  // Unleash the RST!
+  scoped_ptr<DownloadTestObserver> rst_observer(CreateWaiter(shell(), 1));
+  GURL release_url = test_server()->GetURL("download-finish");
+  NavigateToURL(shell(), release_url);
+  rst_observer->WaitForFinished();
+  EXPECT_EQ(DownloadItem::INTERRUPTED, download->GetState());
+  EXPECT_EQ(10000u, download->GetReceivedBytes());
+  EXPECT_EQ(15000u, download->GetTotalBytes());
+  EXPECT_EQ(FILE_PATH_LITERAL("rangereset.crdownload"),
+            download->GetFullPath().BaseName().value());
+
+  {
+    std::string file_contents;
+    std::string expected_contents(10000, 'X');
+    ASSERT_TRUE(file_util::ReadFileToString(
+        download->GetFullPath(), &file_contents));
+    EXPECT_EQ(10000u, file_contents.size());
+    // In conditional to avoid spamming the console with two 15000 char strings.
+    if (expected_contents != file_contents)
+      EXPECT_TRUE(false) << "File contents do not have expected value.";
+  }
+
+  // Resume; should get entire file (note that a restart will fail
+  // here because it'll produce another RST).
+  bool flag(false);
+  DownloadUpdatedObserver complete_observer(
+      download, base::Bind(&DownloadResumptionFilter, &flag));
+  download->ResumeInterruptedDownload();
+  NavigateToURL(shell(), release_url);  // Needed to get past hold.
+  complete_observer.WaitForEvent();
+  EXPECT_EQ(DownloadItem::COMPLETE, download->GetState());
+  EXPECT_EQ(15000u, download->GetReceivedBytes());
+  EXPECT_EQ(15000u, download->GetTotalBytes());
+  EXPECT_EQ(FILE_PATH_LITERAL("rangereset"),
+            download->GetFullPath().BaseName().value())
+      << "Target path name: " << download->GetTargetFilePath().value();
+
+  {
+    std::string file_contents;
+    std::string expected_contents(15000, 'X');
+    ASSERT_TRUE(file_util::ReadFileToString(
+        download->GetFullPath(), &file_contents));
+    EXPECT_EQ(15000u, file_contents.size());
+    // In conditional to avoid spamming the console with two 15000 char strings.
+    if (expected_contents != file_contents)
+      EXPECT_TRUE(false) << "File contents do not have expected value.";
+  }
+}
+
 }  // namespace content