Added member data to classes to support download resumption.

content/browser/download/base_file_unittest.cc

 // Copyright (c) 2011 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 "content/browser/download/base_file.h"
 
 #include "base/file_util.h"
 #include "base/logging.h"
 #include "base/message_loop.h"
 #include "base/scoped_temp_dir.h"
@@ skipping 29 matching lines @@
   BaseFileTest()
       : expect_file_survives_(false),
         expect_in_progress_(true),
         expected_error_(false),
         file_thread_(BrowserThread::FILE, &message_loop_) {
   }
 
   virtual void SetUp() {
     ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
     base_file_.reset(
-        new BaseFile(FilePath(), GURL(), GURL(), 0, file_stream_));
+        new BaseFile(FilePath(), GURL(), GURL(), 0, false, "", file_stream_));
   }
 
   virtual void TearDown() {
     EXPECT_FALSE(base_file_->in_progress());
     if (!expected_error_) {
       EXPECT_EQ(static_cast<int64>(expected_data_.size()),
                 base_file_->bytes_so_far());
     }
 
     FilePath full_path = base_file_->full_path();
 
     if (!expected_data_.empty() && !expected_error_) {
       // Make sure the data has been properly written to disk.
       std::string disk_data;
       EXPECT_TRUE(file_util::ReadFileToString(full_path, &disk_data));
       EXPECT_EQ(expected_data_, disk_data);
     }
 
     // Make sure the mock BrowserThread outlives the BaseFile to satisfy
     // thread checks inside it.
     base_file_.reset();
 
     EXPECT_EQ(expect_file_survives_, file_util::PathExists(full_path));
   }
 
+  void MakeFileWithHash() {
+    base_file_.reset(
+        new BaseFile(FilePath(), GURL(), GURL(), 0, true, "", file_stream_));
+  }
+
   bool OpenMockFileStream() {
     DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
 
     FilePath path;
     if (!file_util::CreateTemporaryFile(&path))
       return false;
 
     // Create a new file stream.
     mock_file_stream_.reset(new net::testing::MockFileStream);
     if (mock_file_stream_->Open(
@@ skipping 28 matching lines @@
     return appended;
   }
 
   void set_expected_data(const std::string& data) { expected_data_ = data; }
 
   // Helper functions.
   // Create a file.  Returns the complete file path.
   static FilePath CreateTestFile() {
     FilePath file_name;
     linked_ptr<net::FileStream> dummy_file_stream;
-    BaseFile file(FilePath(), GURL(), GURL(), 0, dummy_file_stream);
+    BaseFile file(FilePath(), GURL(), GURL(), 0, false, "", dummy_file_stream);
 
-    EXPECT_EQ(net::OK, file.Initialize(false));
+    EXPECT_EQ(net::OK, file.Initialize());
     file_name = file.full_path();
     EXPECT_NE(FilePath::StringType(), file_name.value());
 
     EXPECT_EQ(net::OK, file.AppendDataToFile(kTestData4, kTestDataLength4));
 
     // Keep the file from getting deleted when existing_file_name is deleted.
     file.Detach();
 
     return file_name;
   }
 
   // Create a file with the specified file name.
   static void CreateFileWithName(const FilePath& file_name) {
     EXPECT_NE(FilePath::StringType(), file_name.value());
     linked_ptr<net::FileStream> dummy_file_stream;
-    BaseFile duplicate_file(file_name, GURL(), GURL(), 0, dummy_file_stream);
-    EXPECT_EQ(net::OK, duplicate_file.Initialize(false));
+    BaseFile duplicate_file(
+        file_name, GURL(), GURL(), 0, false, "", dummy_file_stream);
+    EXPECT_EQ(net::OK, duplicate_file.Initialize());
     // Write something into it.
     duplicate_file.AppendDataToFile(kTestData4, kTestDataLength4);
     // Detach the file so it isn't deleted on destruction of |duplicate_file|.
     duplicate_file.Detach();
   }
 
   int64 CurrentSpeedAtTime(base::TimeTicks current_time) {
     EXPECT_TRUE(base_file_.get());
     return base_file_->CurrentSpeedAtTime(current_time);
   }
@@ skipping 31 matching lines @@
 
 // Test the most basic scenario: just create the object and do a sanity check
 // on all its accessors. This is actually a case that rarely happens
 // in production, where we would at least Initialize it.
 TEST_F(BaseFileTest, CreateDestroy) {
   EXPECT_EQ(FilePath().value(), base_file_->full_path().value());
 }
 
 // Cancel the download explicitly.
 TEST_F(BaseFileTest, Cancel) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   EXPECT_TRUE(file_util::PathExists(base_file_->full_path()));
   base_file_->Cancel();
   EXPECT_FALSE(file_util::PathExists(base_file_->full_path()));
   EXPECT_NE(FilePath().value(), base_file_->full_path().value());
 }
 
 // Write data to the file and detach it, so it doesn't get deleted
 // automatically when base_file_ is destructed.
 TEST_F(BaseFileTest, WriteAndDetach) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   base_file_->Finish();
   base_file_->Detach();
   expect_file_survives_ = true;
 }
 
 // Write data to the file and detach it, and calculate its sha256 hash.
 TEST_F(BaseFileTest, WriteWithHashAndDetach) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(true));
+  MakeFileWithHash();
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   base_file_->Finish();
 
   std::string hash;
-  base_file_->GetSha256Hash(&hash);
+  base_file_->GetHash(&hash);
   EXPECT_EQ("0B2D3F3F7943AD64B860DF94D05CB56A8A97C6EC5768B5B70B930C5AA7FA9ADE",

[Randy Smith (Not in Mondays), 2011/12/20 17:05:40]

nit, suggestion: An ideal world would have this automatically computed from the
test data you threw at the file (it'd be fine to use the crypto libraries for
this--you aren't testing them).  It's also ok this way; doing it the other way
just makes this test less easily broken by changes.

[ahendrickson, 2011/12/20 22:06:54]

Done.

             base::HexEncode(hash.data(), hash.size()));
 
   base_file_->Detach();
   expect_file_survives_ = true;
 }
 
 // Rename the file after writing to it, then detach.
 TEST_F(BaseFileTest, WriteThenRenameAndDetach) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
 
   FilePath initial_path(base_file_->full_path());
   EXPECT_TRUE(file_util::PathExists(initial_path));
   FilePath new_path(temp_dir_.path().AppendASCII("NewFile"));
   EXPECT_FALSE(file_util::PathExists(new_path));
 
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
 
   EXPECT_EQ(net::OK, base_file_->Rename(new_path));
   EXPECT_FALSE(file_util::PathExists(initial_path));
   EXPECT_TRUE(file_util::PathExists(new_path));
 
   base_file_->Finish();
   base_file_->Detach();
   expect_file_survives_ = true;
 }
 
 // Write data to the file once.
 TEST_F(BaseFileTest, SingleWrite) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   base_file_->Finish();
 }
 
 // Write data to the file multiple times.
 TEST_F(BaseFileTest, MultipleWrites) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData2));
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData3));
   std::string hash;
-  EXPECT_FALSE(base_file_->GetSha256Hash(&hash));
+  EXPECT_FALSE(base_file_->GetHash(&hash));
   base_file_->Finish();
 }
 
 // Write data to the file once and calculate its sha256 hash.
 TEST_F(BaseFileTest, SingleWriteWithHash) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(true));
+  MakeFileWithHash();
+  ASSERT_EQ(net::OK, base_file_->Initialize());
+  // Can get partial hash states before Finish() is called.
+  EXPECT_STRNE(std::string().c_str(), base_file_->GetHashState().c_str());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
+  EXPECT_STRNE(std::string().c_str(), base_file_->GetHashState().c_str());
   base_file_->Finish();
 
   std::string hash;
-  base_file_->GetSha256Hash(&hash);
+  base_file_->GetHash(&hash);
   EXPECT_EQ("0B2D3F3F7943AD64B860DF94D05CB56A8A97C6EC5768B5B70B930C5AA7FA9ADE",
             base::HexEncode(hash.data(), hash.size()));
 }
 
 // Write data to the file multiple times and calculate its sha256 hash.
 TEST_F(BaseFileTest, MultipleWritesWithHash) {
   std::string hash;
 
-  ASSERT_EQ(net::OK, base_file_->Initialize(true));
+  MakeFileWithHash();
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData2));
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData3));
-  // no hash before Finish() is called either.
-  EXPECT_FALSE(base_file_->GetSha256Hash(&hash));
+  // No hash before Finish() is called.
+  EXPECT_FALSE(base_file_->GetHash(&hash));
   base_file_->Finish();
 
-  EXPECT_TRUE(base_file_->GetSha256Hash(&hash));
+  EXPECT_TRUE(base_file_->GetHash(&hash));
   EXPECT_EQ("CBF68BF10F8003DB86B31343AFAC8C7175BD03FB5FC905650F8C80AF087443A8",
             base::HexEncode(hash.data(), hash.size()));
 }
 
+// Write data to the file multiple times, interrupt it, and continue using
+// another file.  Calculate the resulting combined sha256 hash.
+TEST_F(BaseFileTest, MultipleWritesInterruptedWithHash) {
+  MakeFileWithHash();
+  ASSERT_EQ(net::OK, base_file_->Initialize());
+  // Write some data
+  ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
+  ASSERT_EQ(net::OK, AppendDataToFile(kTestData2));
+  // Get the hash state and file name.
+  std::string hash_state;
+  hash_state = base_file_->GetHashState();
+  // Finish the file.
+  base_file_->Finish();
+
+  // Create another file
+  linked_ptr<net::FileStream> second_stream;
+  BaseFile second_file(FilePath(),
+                       GURL(),
+                       GURL(),
+                       base_file_->bytes_so_far(),
+                       true,
+                       hash_state,
+                       second_stream);
+  ASSERT_EQ(net::OK, second_file.Initialize());
+  std::string data(kTestData3);
+  EXPECT_EQ(net::OK, second_file.AppendDataToFile(data.data(), data.size()));
+  second_file.Finish();
+
+  std::string hash;
+  EXPECT_TRUE(second_file.GetHash(&hash));
+  // This will fail until getting the hash state is supported in SecureHash.
+  EXPECT_STREQ(
+      "CBF68BF10F8003DB86B31343AFAC8C7175BD03FB5FC905650F8C80AF087443A8",
+      base::HexEncode(hash.data(), hash.size()).c_str());
+}
+
 // Rename the file after all writes to it.
 TEST_F(BaseFileTest, WriteThenRename) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
 
   FilePath initial_path(base_file_->full_path());
   EXPECT_TRUE(file_util::PathExists(initial_path));
   FilePath new_path(temp_dir_.path().AppendASCII("NewFile"));
   EXPECT_FALSE(file_util::PathExists(new_path));
 
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
 
   EXPECT_EQ(net::OK, base_file_->Rename(new_path));
   EXPECT_FALSE(file_util::PathExists(initial_path));
   EXPECT_TRUE(file_util::PathExists(new_path));
 
   base_file_->Finish();
 }
 
 // Rename the file while the download is still in progress.
 TEST_F(BaseFileTest, RenameWhileInProgress) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
 
   FilePath initial_path(base_file_->full_path());
   EXPECT_TRUE(file_util::PathExists(initial_path));
   FilePath new_path(temp_dir_.path().AppendASCII("NewFile"));
   EXPECT_FALSE(file_util::PathExists(new_path));
 
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
 
   EXPECT_TRUE(base_file_->in_progress());
   EXPECT_EQ(net::OK, base_file_->Rename(new_path));
   EXPECT_FALSE(file_util::PathExists(initial_path));
   EXPECT_TRUE(file_util::PathExists(new_path));
 
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData2));
 
   base_file_->Finish();
 }
 
 // Write data to the file multiple times.
 TEST_F(BaseFileTest, MultipleWritesWithError) {
   ASSERT_TRUE(OpenMockFileStream());
   base_file_.reset(new BaseFile(mock_file_stream_->get_path(),
-                                GURL(), GURL(), 0, mock_file_stream_));
-  EXPECT_EQ(net::OK, base_file_->Initialize(false));
+                                GURL(),
+                                GURL(),
+                                0,
+                                false,
+                                "",
+                                mock_file_stream_));
+  EXPECT_EQ(net::OK, base_file_->Initialize());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData2));
   ForceError(net::ERR_ACCESS_DENIED);
   ASSERT_NE(net::OK, AppendDataToFile(kTestData3));
   std::string hash;
-  EXPECT_FALSE(base_file_->GetSha256Hash(&hash));
+  EXPECT_FALSE(base_file_->GetHash(&hash));
   base_file_->Finish();
 }
 
 // Try to write to uninitialized file.
 TEST_F(BaseFileTest, UninitializedFile) {
   expect_in_progress_ = false;
   EXPECT_EQ(net::ERR_INVALID_HANDLE, AppendDataToFile(kTestData1));
 }
 
 // Create two |BaseFile|s with the same file, and attempt to write to both.
 // Overwrite base_file_ with another file with the same name and
 // non-zero contents, and make sure the last file to close 'wins'.
 TEST_F(BaseFileTest, DuplicateBaseFile) {
-  EXPECT_EQ(net::OK, base_file_->Initialize(false));
+  EXPECT_EQ(net::OK, base_file_->Initialize());
 
   // Create another |BaseFile| referring to the file that |base_file_| owns.
   CreateFileWithName(base_file_->full_path());
 
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   base_file_->Finish();
 }
 
 // Create a file and append to it.
 TEST_F(BaseFileTest, AppendToBaseFile) {
   // Create a new file.
   FilePath existing_file_name = CreateTestFile();
 
   set_expected_data(kTestData4);
 
   // Use the file we've just created.
-  base_file_.reset(
-      new BaseFile(existing_file_name, GURL(), GURL(), kTestDataLength4,
-                   file_stream_));
+  base_file_.reset(new BaseFile(existing_file_name,
+                                GURL(),
+                                GURL(),
+                                kTestDataLength4,
+                                false,
+                                "",
+                                file_stream_));
 
-  EXPECT_EQ(net::OK, base_file_->Initialize(false));
+  EXPECT_EQ(net::OK, base_file_->Initialize());
 
   const FilePath file_name = base_file_->full_path();
   EXPECT_NE(FilePath::StringType(), file_name.value());
 
   // Write into the file.
   EXPECT_EQ(net::OK, AppendDataToFile(kTestData1));
 
   base_file_->Finish();
   base_file_->Detach();
   expect_file_survives_ = true;
 }
 
 // Create a read-only file and attempt to write to it.
 TEST_F(BaseFileTest, ReadonlyBaseFile) {
   // Create a new file.
   FilePath readonly_file_name = CreateTestFile();
 
   // Make it read-only.
   EXPECT_TRUE(file_util::MakeFileUnwritable(readonly_file_name));
 
   // Try to overwrite it.
-  base_file_.reset(
-      new BaseFile(readonly_file_name, GURL(), GURL(), 0, file_stream_));
+  base_file_.reset(new BaseFile(readonly_file_name,
+                                GURL(),
+                                GURL(),
+                                0,
+                                false,
+                                "",
+                                file_stream_));
 
   expect_in_progress_ = false;
 
-  int init_error = base_file_->Initialize(false);
+  int init_error = base_file_->Initialize();
   DVLOG(1) << " init_error = " << init_error;
   EXPECT_NE(net::OK, init_error);
 
   const FilePath file_name = base_file_->full_path();
   EXPECT_NE(FilePath::StringType(), file_name.value());
 
   // Write into the file.
   EXPECT_NE(net::OK, AppendDataToFile(kTestData1));
 
   base_file_->Finish();
   base_file_->Detach();
   expect_file_survives_ = true;
 }
 
-TEST_F(BaseFileTest, IsEmptySha256Hash) {
+TEST_F(BaseFileTest, IsEmptyHash) {
   std::string empty(BaseFile::kSha256HashLen, '\x00');
-  EXPECT_TRUE(BaseFile::IsEmptySha256Hash(empty));
+  EXPECT_TRUE(BaseFile::IsEmptyHash(empty));
   std::string not_empty(BaseFile::kSha256HashLen, '\x01');
-  EXPECT_FALSE(BaseFile::IsEmptySha256Hash(not_empty));
-  EXPECT_FALSE(BaseFile::IsEmptySha256Hash(""));
+  EXPECT_FALSE(BaseFile::IsEmptyHash(not_empty));
+  EXPECT_FALSE(BaseFile::IsEmptyHash(""));
 }
 
 // Test that calculating speed after no writes.
 TEST_F(BaseFileTest, SpeedWithoutWrite) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   base::TimeTicks current = StartTick() + kElapsedTimeDelta;
   ASSERT_EQ(0, CurrentSpeedAtTime(current));
   base_file_->Finish();
 }
 
 // Test that calculating speed after a single write.
 TEST_F(BaseFileTest, SpeedAfterSingleWrite) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   base::TimeTicks current = StartTick() + kElapsedTimeDelta;
   int64 expected_speed = kTestDataLength1 / kElapsedTimeSeconds;
   ASSERT_EQ(expected_speed, CurrentSpeedAtTime(current));
   base_file_->Finish();
 }
 
 // Test that calculating speed after a multiple writes.
 TEST_F(BaseFileTest, SpeedAfterMultipleWrite) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData2));
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData3));
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData4));
   base::TimeTicks current = StartTick() + kElapsedTimeDelta;
   int64 expected_speed = (kTestDataLength1 + kTestDataLength2 +
       kTestDataLength3 + kTestDataLength4) / kElapsedTimeSeconds;
   ASSERT_EQ(expected_speed, CurrentSpeedAtTime(current));
   base_file_->Finish();
 }
 
 // Test that calculating speed after no delay - should not divide by 0.
 TEST_F(BaseFileTest, SpeedAfterNoElapsedTime) {
-  ASSERT_EQ(net::OK, base_file_->Initialize(false));
+  ASSERT_EQ(net::OK, base_file_->Initialize());
   ASSERT_EQ(net::OK, AppendDataToFile(kTestData1));
   ASSERT_EQ(0, CurrentSpeedAtTime(StartTick()));
   base_file_->Finish();
 }