// 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 "content/browser/download/base_file.h" #include "base/files/file.h" #include "base/files/file_util.h" #include "base/files/scoped_temp_dir.h" #include "base/logging.h" #include "base/message_loop/message_loop.h" #include "base/strings/string_number_conversions.h" #include "base/test/test_file_util.h" #include "content/browser/browser_thread_impl.h" #include "content/public/browser/download_interrupt_reasons.h" #include "crypto/secure_hash.h" #include "crypto/sha2.h" #include "testing/gtest/include/gtest/gtest.h" namespace content { namespace { const char kTestData1[] = "Let's write some data to the file!\n"; const char kTestData2[] = "Writing more data.\n"; const char kTestData3[] = "Final line."; const char kTestData4[] = "supercalifragilisticexpialidocious"; const int kTestDataLength1 = arraysize(kTestData1) - 1; const int kTestDataLength2 = arraysize(kTestData2) - 1; const int kTestDataLength3 = arraysize(kTestData3) - 1; const int kTestDataLength4 = arraysize(kTestData4) - 1; const int kElapsedTimeSeconds = 5; const base::TimeDelta kElapsedTimeDelta = base::TimeDelta::FromSeconds( kElapsedTimeSeconds); } // namespace class BaseFileTest : public testing::Test { public: static const unsigned char kEmptySha256Hash[crypto::kSHA256Length]; BaseFileTest() : expect_file_survives_(false), expect_in_progress_(true), expected_error_(DOWNLOAD_INTERRUPT_REASON_NONE), file_thread_(BrowserThread::FILE, &message_loop_) { } virtual void SetUp() { ResetHash(); ASSERT_TRUE(temp_dir_.CreateUniqueTempDir()); base_file_.reset(new BaseFile(base::FilePath(), GURL(), GURL(), 0, false, std::string(), base::File(), net::BoundNetLog())); } virtual void TearDown() { EXPECT_FALSE(base_file_->in_progress()); if (!expected_error_) { EXPECT_EQ(static_cast(expected_data_.size()), base_file_->bytes_so_far()); } base::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(base::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_, base::PathExists(full_path)); } void ResetHash() { secure_hash_.reset(crypto::SecureHash::Create(crypto::SecureHash::SHA256)); memcpy(sha256_hash_, kEmptySha256Hash, crypto::kSHA256Length); } void UpdateHash(const char* data, size_t length) { secure_hash_->Update(data, length); } std::string GetFinalHash() { std::string hash; secure_hash_->Finish(sha256_hash_, crypto::kSHA256Length); hash.assign(reinterpret_cast(sha256_hash_), sizeof(sha256_hash_)); return hash; } void MakeFileWithHash() { base_file_.reset(new BaseFile(base::FilePath(), GURL(), GURL(), 0, true, std::string(), base::File(), net::BoundNetLog())); } bool InitializeFile() { DownloadInterruptReason result = base_file_->Initialize(temp_dir_.path()); EXPECT_EQ(expected_error_, result); return result == DOWNLOAD_INTERRUPT_REASON_NONE; } bool AppendDataToFile(const std::string& data) { EXPECT_EQ(expect_in_progress_, base_file_->in_progress()); DownloadInterruptReason result = base_file_->AppendDataToFile(data.data(), data.size()); if (result == DOWNLOAD_INTERRUPT_REASON_NONE) EXPECT_TRUE(expect_in_progress_) << " result = " << result; EXPECT_EQ(expected_error_, result); if (base_file_->in_progress()) { expected_data_ += data; if (expected_error_ == DOWNLOAD_INTERRUPT_REASON_NONE) { EXPECT_EQ(static_cast(expected_data_.size()), base_file_->bytes_so_far()); } } return result == DOWNLOAD_INTERRUPT_REASON_NONE; } void set_expected_data(const std::string& data) { expected_data_ = data; } // Helper functions. // Create a file. Returns the complete file path. base::FilePath CreateTestFile() { base::FilePath file_name; BaseFile file(base::FilePath(), GURL(), GURL(), 0, false, std::string(), base::File(), net::BoundNetLog()); EXPECT_EQ(DOWNLOAD_INTERRUPT_REASON_NONE, file.Initialize(temp_dir_.path())); file_name = file.full_path(); EXPECT_NE(base::FilePath::StringType(), file_name.value()); EXPECT_EQ(DOWNLOAD_INTERRUPT_REASON_NONE, 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. void CreateFileWithName(const base::FilePath& file_name) { EXPECT_NE(base::FilePath::StringType(), file_name.value()); BaseFile duplicate_file(file_name, GURL(), GURL(), 0, false, std::string(), base::File(), net::BoundNetLog()); EXPECT_EQ(DOWNLOAD_INTERRUPT_REASON_NONE, duplicate_file.Initialize(temp_dir_.path())); // 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); } base::TimeTicks StartTick() { EXPECT_TRUE(base_file_.get()); return base_file_->start_tick_; } void set_expected_error(DownloadInterruptReason err) { expected_error_ = err; } void ExpectPermissionError(DownloadInterruptReason err) { EXPECT_TRUE(err == DOWNLOAD_INTERRUPT_REASON_FILE_TRANSIENT_ERROR || err == DOWNLOAD_INTERRUPT_REASON_FILE_ACCESS_DENIED) << "Interrupt reason = " << err; } protected: // BaseClass instance we are testing. scoped_ptr base_file_; // Temporary directory for renamed downloads. base::ScopedTempDir temp_dir_; // Expect the file to survive deletion of the BaseFile instance. bool expect_file_survives_; // Expect the file to be in progress. bool expect_in_progress_; // Hash calculator. scoped_ptr secure_hash_; unsigned char sha256_hash_[crypto::kSHA256Length]; private: // Keep track of what data should be saved to the disk file. std::string expected_data_; DownloadInterruptReason expected_error_; // Mock file thread to satisfy debug checks in BaseFile. base::MessageLoop message_loop_; BrowserThreadImpl file_thread_; }; // This will initialize the entire array to zero. const unsigned char BaseFileTest::kEmptySha256Hash[] = { 0 }; // 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(base::FilePath().value(), base_file_->full_path().value()); } // Cancel the download explicitly. TEST_F(BaseFileTest, Cancel) { ASSERT_TRUE(InitializeFile()); EXPECT_TRUE(base::PathExists(base_file_->full_path())); base_file_->Cancel(); EXPECT_FALSE(base::PathExists(base_file_->full_path())); EXPECT_NE(base::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_TRUE(InitializeFile()); ASSERT_TRUE(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) { // Calculate the final hash. ResetHash(); UpdateHash(kTestData1, kTestDataLength1); std::string expected_hash = GetFinalHash(); std::string expected_hash_hex = base::HexEncode(expected_hash.data(), expected_hash.size()); MakeFileWithHash(); ASSERT_TRUE(InitializeFile()); ASSERT_TRUE(AppendDataToFile(kTestData1)); base_file_->Finish(); std::string hash; base_file_->GetHash(&hash); EXPECT_EQ("0B2D3F3F7943AD64B860DF94D05CB56A8A97C6EC5768B5B70B930C5AA7FA9ADE", expected_hash_hex); EXPECT_EQ(expected_hash_hex, 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_TRUE(InitializeFile()); base::FilePath initial_path(base_file_->full_path()); EXPECT_TRUE(base::PathExists(initial_path)); base::FilePath new_path(temp_dir_.path().AppendASCII("NewFile")); EXPECT_FALSE(base::PathExists(new_path)); ASSERT_TRUE(AppendDataToFile(kTestData1)); EXPECT_EQ(DOWNLOAD_INTERRUPT_REASON_NONE, base_file_->Rename(new_path)); EXPECT_FALSE(base::PathExists(initial_path)); EXPECT_TRUE(base::PathExists(new_path)); base_file_->Finish(); base_file_->Detach(); expect_file_survives_ = true; } // Write data to the file once. TEST_F(BaseFileTest, SingleWrite) { ASSERT_TRUE(InitializeFile()); ASSERT_TRUE(AppendDataToFile(kTestData1)); base_file_->Finish(); } // Write data to the file multiple times. TEST_F(BaseFileTest, MultipleWrites) { ASSERT_TRUE(InitializeFile()); ASSERT_TRUE(AppendDataToFile(kTestData1)); ASSERT_TRUE(AppendDataToFile(kTestData2)); ASSERT_TRUE(AppendDataToFile(kTestData3)); std::string 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) { // Calculate the final hash. ResetHash(); UpdateHash(kTestData1, kTestDataLength1); std::string expected_hash = GetFinalHash(); std::string expected_hash_hex = base::HexEncode(expected_hash.data(), expected_hash.size()); MakeFileWithHash(); ASSERT_TRUE(InitializeFile()); // Can get partial hash states before Finish() is called. EXPECT_STRNE(std::string().c_str(), base_file_->GetHashState().c_str()); ASSERT_TRUE(AppendDataToFile(kTestData1)); EXPECT_STRNE(std::string().c_str(), base_file_->GetHashState().c_str()); base_file_->Finish(); std::string hash; base_file_->GetHash(&hash); EXPECT_EQ(expected_hash_hex, base::HexEncode(hash.data(), hash.size())); } // Write data to the file multiple times and calculate its sha256 hash. TEST_F(BaseFileTest, MultipleWritesWithHash) { // Calculate the final hash. ResetHash(); UpdateHash(kTestData1, kTestDataLength1); UpdateHash(kTestData2, kTestDataLength2); UpdateHash(kTestData3, kTestDataLength3); std::string expected_hash = GetFinalHash(); std::string expected_hash_hex = base::HexEncode(expected_hash.data(), expected_hash.size()); std::string hash; MakeFileWithHash(); ASSERT_TRUE(InitializeFile()); ASSERT_TRUE(AppendDataToFile(kTestData1)); ASSERT_TRUE(AppendDataToFile(kTestData2)); ASSERT_TRUE(AppendDataToFile(kTestData3)); // No hash before Finish() is called. EXPECT_FALSE(base_file_->GetHash(&hash)); base_file_->Finish(); EXPECT_TRUE(base_file_->GetHash(&hash)); EXPECT_EQ("CBF68BF10F8003DB86B31343AFAC8C7175BD03FB5FC905650F8C80AF087443A8", expected_hash_hex); EXPECT_EQ(expected_hash_hex, 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) { // Calculate the final hash. ResetHash(); UpdateHash(kTestData1, kTestDataLength1); UpdateHash(kTestData2, kTestDataLength2); UpdateHash(kTestData3, kTestDataLength3); std::string expected_hash = GetFinalHash(); std::string expected_hash_hex = base::HexEncode(expected_hash.data(), expected_hash.size()); MakeFileWithHash(); ASSERT_TRUE(InitializeFile()); // Write some data ASSERT_TRUE(AppendDataToFile(kTestData1)); ASSERT_TRUE(AppendDataToFile(kTestData2)); // Get the hash state and file name. std::string hash_state; hash_state = base_file_->GetHashState(); // Finish the file. base_file_->Finish(); base::FilePath new_file_path(temp_dir_.path().Append( base::FilePath(FILE_PATH_LITERAL("second_file")))); ASSERT_TRUE(base::CopyFile(base_file_->full_path(), new_file_path)); // Create another file BaseFile second_file(new_file_path, GURL(), GURL(), base_file_->bytes_so_far(), true, hash_state, base::File(), net::BoundNetLog()); ASSERT_EQ(DOWNLOAD_INTERRUPT_REASON_NONE, second_file.Initialize(base::FilePath())); std::string data(kTestData3); EXPECT_EQ(DOWNLOAD_INTERRUPT_REASON_NONE, 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(expected_hash_hex.c_str(), base::HexEncode(hash.data(), hash.size()).c_str()); } // Rename the file after all writes to it. TEST_F(BaseFileTest, WriteThenRename) { ASSERT_TRUE(InitializeFile()); base::FilePath initial_path(base_file_->full_path()); EXPECT_TRUE(base::PathExists(initial_path)); base::FilePath new_path(temp_dir_.path().AppendASCII("NewFile")); EXPECT_FALSE(base::PathExists(new_path)); ASSERT_TRUE(AppendDataToFile(kTestData1)); EXPECT_EQ(DOWNLOAD_INTERRUPT_REASON_NONE, base_file_->Rename(new_path)); EXPECT_FALSE(base::PathExists(initial_path)); EXPECT_TRUE(base::PathExists(new_path)); base_file_->Finish(); } // Rename the file while the download is still in progress. TEST_F(BaseFileTest, RenameWhileInProgress) { ASSERT_TRUE(InitializeFile()); base::FilePath initial_path(base_file_->full_path()); EXPECT_TRUE(base::PathExists(initial_path)); base::FilePath new_path(temp_dir_.path().AppendASCII("NewFile")); EXPECT_FALSE(base::PathExists(new_path)); ASSERT_TRUE(AppendDataToFile(kTestData1)); EXPECT_TRUE(base_file_->in_progress()); EXPECT_EQ(DOWNLOAD_INTERRUPT_REASON_NONE, base_file_->Rename(new_path)); EXPECT_FALSE(base::PathExists(initial_path)); EXPECT_TRUE(base::PathExists(new_path)); ASSERT_TRUE(AppendDataToFile(kTestData2)); base_file_->Finish(); } // Test that a failed rename reports the correct error. TEST_F(BaseFileTest, RenameWithError) { ASSERT_TRUE(InitializeFile()); // TestDir is a subdirectory in |temp_dir_| that we will make read-only so // that the rename will fail. base::FilePath test_dir(temp_dir_.path().AppendASCII("TestDir")); ASSERT_TRUE(base::CreateDirectory(test_dir)); base::FilePath new_path(test_dir.AppendASCII("TestFile")); EXPECT_FALSE(base::PathExists(new_path)); { base::FilePermissionRestorer restore_permissions_for(test_dir); ASSERT_TRUE(base::MakeFileUnwritable(test_dir)); ExpectPermissionError(base_file_->Rename(new_path)); } base_file_->Finish(); } // Test that if a rename fails for an in-progress BaseFile, it remains writeable // and renameable. TEST_F(BaseFileTest, RenameWithErrorInProgress) { ASSERT_TRUE(InitializeFile()); base::FilePath test_dir(temp_dir_.path().AppendASCII("TestDir")); ASSERT_TRUE(base::CreateDirectory(test_dir)); base::FilePath new_path(test_dir.AppendASCII("TestFile")); EXPECT_FALSE(base::PathExists(new_path)); // Write some data to start with. ASSERT_TRUE(AppendDataToFile(kTestData1)); ASSERT_TRUE(base_file_->in_progress()); base::FilePath old_path = base_file_->full_path(); { base::FilePermissionRestorer restore_permissions_for(test_dir); ASSERT_TRUE(base::MakeFileUnwritable(test_dir)); ExpectPermissionError(base_file_->Rename(new_path)); // The file should still be open and we should be able to continue writing // to it. ASSERT_TRUE(base_file_->in_progress()); ASSERT_TRUE(AppendDataToFile(kTestData2)); ASSERT_EQ(old_path.value(), base_file_->full_path().value()); // Try to rename again, just for kicks. It should still fail. ExpectPermissionError(base_file_->Rename(new_path)); } // Now that TestDir is writeable again, we should be able to successfully // rename the file. EXPECT_EQ(DOWNLOAD_INTERRUPT_REASON_NONE, base_file_->Rename(new_path)); ASSERT_EQ(new_path.value(), base_file_->full_path().value()); ASSERT_TRUE(AppendDataToFile(kTestData3)); base_file_->Finish(); // The contents of the file should be intact. std::string file_contents; std::string expected_contents(kTestData1); expected_contents += kTestData2; expected_contents += kTestData3; ASSERT_TRUE(base::ReadFileToString(new_path, &file_contents)); EXPECT_EQ(expected_contents, file_contents); } // Test that a failed write reports an error. TEST_F(BaseFileTest, WriteWithError) { base::FilePath path; ASSERT_TRUE(base::CreateTemporaryFile(&path)); // Pass a file handle which was opened without the WRITE flag. // This should result in an error when writing. base::File file(path, base::File::FLAG_OPEN_ALWAYS | base::File::FLAG_READ); base_file_.reset(new BaseFile(path, GURL(), GURL(), 0, false, std::string(), file.Pass(), net::BoundNetLog())); ASSERT_TRUE(InitializeFile()); #if defined(OS_WIN) set_expected_error(DOWNLOAD_INTERRUPT_REASON_FILE_ACCESS_DENIED); #elif defined (OS_POSIX) set_expected_error(DOWNLOAD_INTERRUPT_REASON_FILE_FAILED); #endif ASSERT_FALSE(AppendDataToFile(kTestData1)); base_file_->Finish(); } // Try to write to uninitialized file. TEST_F(BaseFileTest, UninitializedFile) { expect_in_progress_ = false; set_expected_error(DOWNLOAD_INTERRUPT_REASON_FILE_FAILED); EXPECT_FALSE(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) { ASSERT_TRUE(InitializeFile()); // Create another |BaseFile| referring to the file that |base_file_| owns. CreateFileWithName(base_file_->full_path()); ASSERT_TRUE(AppendDataToFile(kTestData1)); base_file_->Finish(); } // Create a file and append to it. TEST_F(BaseFileTest, AppendToBaseFile) { // Create a new file. base::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, false, std::string(), base::File(), net::BoundNetLog())); ASSERT_TRUE(InitializeFile()); const base::FilePath file_name = base_file_->full_path(); EXPECT_NE(base::FilePath::StringType(), file_name.value()); // Write into the file. EXPECT_TRUE(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. base::FilePath readonly_file_name = CreateTestFile(); // Restore permissions to the file when we are done with this test. base::FilePermissionRestorer restore_permissions(readonly_file_name); // Make it read-only. EXPECT_TRUE(base::MakeFileUnwritable(readonly_file_name)); // Try to overwrite it. base_file_.reset(new BaseFile(readonly_file_name, GURL(), GURL(), 0, false, std::string(), base::File(), net::BoundNetLog())); expect_in_progress_ = false; set_expected_error(DOWNLOAD_INTERRUPT_REASON_FILE_ACCESS_DENIED); EXPECT_FALSE(InitializeFile()); const base::FilePath file_name = base_file_->full_path(); EXPECT_NE(base::FilePath::StringType(), file_name.value()); // Write into the file. set_expected_error(DOWNLOAD_INTERRUPT_REASON_FILE_FAILED); EXPECT_FALSE(AppendDataToFile(kTestData1)); base_file_->Finish(); base_file_->Detach(); expect_file_survives_ = true; } TEST_F(BaseFileTest, IsEmptyHash) { std::string empty(crypto::kSHA256Length, '\x00'); EXPECT_TRUE(BaseFile::IsEmptyHash(empty)); std::string not_empty(crypto::kSHA256Length, '\x01'); EXPECT_FALSE(BaseFile::IsEmptyHash(not_empty)); EXPECT_FALSE(BaseFile::IsEmptyHash(std::string())); std::string also_not_empty = empty; also_not_empty[crypto::kSHA256Length - 1] = '\x01'; EXPECT_FALSE(BaseFile::IsEmptyHash(also_not_empty)); } // Test that a temporary file is created in the default download directory. TEST_F(BaseFileTest, CreatedInDefaultDirectory) { ASSERT_TRUE(base_file_->full_path().empty()); ASSERT_TRUE(InitializeFile()); EXPECT_FALSE(base_file_->full_path().empty()); // On Windows, CreateTemporaryFileInDir() will cause a path with short names // to be expanded into a path with long names. Thus temp_dir.path() might not // be a string-wise match to base_file_->full_path().DirName() even though // they are in the same directory. base::FilePath temp_file; ASSERT_TRUE(base::CreateTemporaryFileInDir(temp_dir_.path(), &temp_file)); ASSERT_FALSE(temp_file.empty()); EXPECT_STREQ(temp_file.DirName().value().c_str(), base_file_->full_path().DirName().value().c_str()); base_file_->Finish(); } TEST_F(BaseFileTest, NoDoubleDeleteAfterCancel) { ASSERT_TRUE(InitializeFile()); base::FilePath full_path = base_file_->full_path(); ASSERT_FALSE(full_path.empty()); ASSERT_TRUE(base::PathExists(full_path)); base_file_->Cancel(); ASSERT_FALSE(base::PathExists(full_path)); const char kData[] = "hello"; const int kDataLength = static_cast(arraysize(kData) - 1); ASSERT_EQ(kDataLength, base::WriteFile(full_path, kData, kDataLength)); // The file that we created here should stick around when the BaseFile is // destroyed during TearDown. expect_file_survives_ = true; } } // namespace content