[BlobAsync] Renderer support for blob file writing.

content/child/blob_storage/blob_transport_controller_unittest.cc

 // Copyright 2015 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/child/blob_storage/blob_transport_controller.h"
 
 #include <stddef.h>
 #include <stdint.h>
 
-#include "base/memory/ptr_util.h"
+#include "base/bind.h"
+#include "base/bind_helpers.h"
+#include "base/files/file.h"
+#include "base/files/file_path.h"
+#include "base/files/file_util.h"
 #include "base/memory/shared_memory.h"
+#include "base/message_loop/message_loop.h"
+#include "base/process/process_handle.h"
+#include "base/test/test_file_util.h"
 #include "base/test/test_simple_task_runner.h"
 #include "base/tuple.h"
 #include "content/child/blob_storage/blob_consolidation.h"
 #include "content/child/thread_safe_sender.h"
 #include "content/common/fileapi/webblob_messages.h"
+#include "ipc/ipc_platform_file.h"
 #include "ipc/ipc_sender.h"
 #include "ipc/ipc_sync_message_filter.h"
 #include "ipc/ipc_test_sink.h"
 #include "storage/common/blob_storage/blob_item_bytes_request.h"
 #include "storage/common/blob_storage/blob_item_bytes_response.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
+using base::File;
+using base::FilePath;
+using base::TestSimpleTaskRunner;
 using storage::BlobItemBytesRequest;
 using storage::BlobItemBytesResponse;
 using storage::DataElement;
+using storage::IPCBlobCreationCancelCode;
 
 namespace content {
 namespace {
 
 class OtherThreadTestSimpleTaskRunner : public base::TestSimpleTaskRunner {
  public:
   bool RunsTasksOnCurrentThread() const override { return false; }
 
  protected:
   ~OtherThreadTestSimpleTaskRunner() override {}
@@ skipping 42 matching lines @@
 }
 
 static blink::WebThreadSafeData CreateData(const std::string& str) {
   return blink::WebThreadSafeData(str.c_str(), str.size());
 }
 
 }  // namespace
 
 class BlobTransportControllerTest : public testing::Test {
  public:
-  BlobTransportControllerTest()
-      : io_thread_runner_(new base::TestSimpleTaskRunner()),
-        main_thread_runner_(new OtherThreadTestSimpleTaskRunner()) {}
+  BlobTransportControllerTest() {}
 
   void SetUp() override {
     sender_ = new BlobTransportControllerTestSender(&sink_);
     BlobTransportController::GetInstance()->ClearForTesting();
   }
 
+  BlobTransportController::ResponsesStatus GetResponses(
+      BlobTransportController* holder,
+      const std::string& uuid,
+      const std::vector<BlobItemBytesRequest>& requests,
+      std::vector<base::SharedMemoryHandle>* memory_handles,
+      const std::vector<IPC::PlatformFileForTransit>& file_handles,
+      std::vector<BlobItemBytesResponse>* output) {
+    error_called_ = false;
+    all_async_responses_.clear();
+    return holder->GetResponses(
+        uuid, requests, memory_handles, file_handles, output, io_thread_runner_,
+        file_runner_.get(),
+        base::Bind(&BlobTransportControllerTest::ResponsesCallback,
+                   base::Unretained(this)),
+        base::Bind(&BlobTransportControllerTest::ErrorCallback,
+                   base::Unretained(this)));
+  }
+
+  bool AsyncOperationsCalled() {
+    return error_called_ || !all_async_responses_.empty();
+  }
+
+  bool AsyncOperationsPending() {
+    return io_thread_runner_->HasPendingTask() ||
+           file_runner_->HasPendingTask();
+  }
+
+  FilePath CreateTemporaryFile() {
+    FilePath path;
+    EXPECT_TRUE(base::CreateTemporaryFile(&path));
+    files_opened_.push_back(path);
+    return path;
+  }
+
   void ExpectRegisterAndStartMessage(const std::string& expected_uuid,
                                      const std::string& expected_content_type,
                                      std::vector<DataElement>* descriptions) {
     const IPC::Message* register_message =
         sink_.GetUniqueMessageMatching(BlobStorageMsg_RegisterBlobUUID::ID);
     const IPC::Message* start_message =
         sink_.GetUniqueMessageMatching(BlobStorageMsg_StartBuildingBlob::ID);
     ASSERT_TRUE(register_message);
     ASSERT_TRUE(start_message);
     base::Tuple<std::string, std::string, std::string, std::set<std::string>>
         register_contents;
     base::Tuple<std::string, std::vector<DataElement>> start_contents;
     BlobStorageMsg_RegisterBlobUUID::Read(register_message, &register_contents);
     BlobStorageMsg_StartBuildingBlob::Read(start_message, &start_contents);
     EXPECT_EQ(expected_uuid, base::get<0>(register_contents));
     EXPECT_EQ(expected_uuid, base::get<0>(start_contents));
     EXPECT_EQ(expected_content_type, base::get<1>(register_contents));
     if (descriptions)
       *descriptions = base::get<1>(start_contents);
     // We don't have dispositions from the renderer.
     EXPECT_TRUE(base::get<2>(register_contents).empty());
   }
 
   void TearDown() override {
     BlobTransportController::GetInstance()->ClearForTesting();
+    for (const FilePath& path : files_opened_) {
+      EXPECT_TRUE(base::DeleteFile(path, false));
+    }
   }
 
+ protected:
+  void ResponsesCallback(const std::vector<BlobItemBytesResponse>& responses) {
+    all_async_responses_.insert(all_async_responses_.end(), responses.begin(),
+                                responses.end());
+  }
+
+  void ErrorCallback(IPCBlobCreationCancelCode code) {
+    error_code_ = code;
+    error_called_ = true;
+  }
+
+  bool error_called_ = false;
+  IPCBlobCreationCancelCode error_code_ = IPCBlobCreationCancelCode::UNKNOWN;
+  std::vector<storage::BlobItemBytesResponse> all_async_responses_;
+  std::vector<FilePath> files_opened_;
+
   IPC::TestSink sink_;
   scoped_refptr<BlobTransportControllerTestSender> sender_;
-  scoped_refptr<base::TestSimpleTaskRunner> io_thread_runner_;
-  scoped_refptr<OtherThreadTestSimpleTaskRunner> main_thread_runner_;
+
+  // Thread runners.
+  scoped_refptr<base::TestSimpleTaskRunner> io_thread_runner_ =
+      new TestSimpleTaskRunner();
+  scoped_refptr<OtherThreadTestSimpleTaskRunner> main_thread_runner_ =
+      new OtherThreadTestSimpleTaskRunner();
+  scoped_refptr<TestSimpleTaskRunner> file_runner_ = new TestSimpleTaskRunner();
 };
 
 TEST_F(BlobTransportControllerTest, Descriptions) {
   const std::string kBlobUUID = "uuid";
   const std::string KRefBlobUUID = "refuuid";
   const std::string kBadBlobUUID = "uuuidBad";
   const size_t kShortcutSize = 11;
 
   // The first two data elements should be combined and the data shortcut.
-  std::unique_ptr<BlobConsolidation> consolidation(new BlobConsolidation());
+  scoped_refptr<BlobConsolidation> consolidation(new BlobConsolidation());
   consolidation->AddBlobItem(KRefBlobUUID, 10, 10);
   consolidation->AddDataItem(CreateData("Hello"));
   consolidation->AddDataItem(CreateData("Hello2"));
   consolidation->AddBlobItem(KRefBlobUUID, 0, 10);
   consolidation->AddDataItem(CreateData("Hello3"));
 
   std::vector<DataElement> out;
   BlobTransportController::GetDescriptions(consolidation.get(), kShortcutSize,
                                            &out);
 
   std::vector<DataElement> expected;
   expected.push_back(MakeBlobElement(KRefBlobUUID, 10, 10));
   expected.push_back(MakeDataElement("HelloHello2"));
   expected.push_back(MakeBlobElement(KRefBlobUUID, 0, 10));
   expected.push_back(MakeDataDescriptionElement(6));
   EXPECT_EQ(expected, out);
 }
 
 TEST_F(BlobTransportControllerTest, Responses) {
   using ResponsesStatus = BlobTransportController::ResponsesStatus;
   const std::string kBlobUUID = "uuid";
   const std::string KRefBlobUUID = "refuuid";
   const std::string kBadBlobUUID = "uuuidBad";
   BlobTransportController* holder = BlobTransportController::GetInstance();
 
   // The first two data elements should be combined.
-  BlobConsolidation* consolidation = new BlobConsolidation();
+  scoped_refptr<BlobConsolidation> consolidation = new BlobConsolidation();
   consolidation->AddBlobItem(KRefBlobUUID, 10, 10);
   consolidation->AddDataItem(CreateData("Hello"));
   consolidation->AddDataItem(CreateData("Hello2"));
   consolidation->AddBlobItem(KRefBlobUUID, 0, 10);
   consolidation->AddDataItem(CreateData("Hello3"));
   // See the above test for the expected descriptions layout.
 
-  holder->blob_storage_[kBlobUUID] = base::WrapUnique(consolidation);
+  holder->blob_storage_[kBlobUUID] = consolidation;
 
   std::vector<BlobItemBytesRequest> requests;
   std::vector<base::SharedMemoryHandle> memory_handles;
   std::vector<IPC::PlatformFileForTransit> file_handles;
   std::vector<storage::BlobItemBytesResponse> output;
 
   // Request for all of first data
   requests.push_back(BlobItemBytesRequest::CreateIPCRequest(0, 1, 0, 11));
   EXPECT_EQ(ResponsesStatus::SUCCESS,
-            holder->GetResponses(kBlobUUID, requests, &memory_handles,
-                                 file_handles, &output));
+            GetResponses(holder, kBlobUUID, requests, &memory_handles,
+                         file_handles, &output));
+  EXPECT_FALSE(AsyncOperationsPending());
   EXPECT_EQ(1u, output.size());
   std::vector<storage::BlobItemBytesResponse> expected;
   expected.push_back(ResponseWithData(0, "HelloHello2"));
   EXPECT_EQ(expected, output);
 
   // Part of second data
   output.clear();
   requests[0] = BlobItemBytesRequest::CreateIPCRequest(1000, 3, 1, 5);
   EXPECT_EQ(ResponsesStatus::SUCCESS,
-            holder->GetResponses(kBlobUUID, requests, &memory_handles,
-                                 file_handles, &output));
+            GetResponses(holder, kBlobUUID, requests, &memory_handles,
+                         file_handles, &output));
+  EXPECT_FALSE(AsyncOperationsPending());
   EXPECT_EQ(1u, output.size());
   expected.clear();
   expected.push_back(ResponseWithData(1000, "ello3"));
   EXPECT_EQ(expected, output);
 
   // Both data segments
   output.clear();
   requests[0] = BlobItemBytesRequest::CreateIPCRequest(0, 1, 0, 11);
   requests.push_back(BlobItemBytesRequest::CreateIPCRequest(1, 3, 0, 6));
   EXPECT_EQ(ResponsesStatus::SUCCESS,
-            holder->GetResponses(kBlobUUID, requests, &memory_handles,
-                                 file_handles, &output));
+            GetResponses(holder, kBlobUUID, requests, &memory_handles,
+                         file_handles, &output));
+  EXPECT_FALSE(AsyncOperationsPending());
   EXPECT_EQ(2u, output.size());
   expected.clear();
   expected.push_back(ResponseWithData(0, "HelloHello2"));
   expected.push_back(ResponseWithData(1, "Hello3"));
   EXPECT_EQ(expected, output);
 }
 
 TEST_F(BlobTransportControllerTest, SharedMemory) {
   using ResponsesStatus = BlobTransportController::ResponsesStatus;
   const std::string kBlobUUID = "uuid";
   const std::string KRefBlobUUID = "refuuid";
   const std::string kBadBlobUUID = "uuuidBad";
   BlobTransportController* holder = BlobTransportController::GetInstance();
 
   // The first two data elements should be combined.
-  BlobConsolidation* consolidation = new BlobConsolidation();
+  scoped_refptr<BlobConsolidation> consolidation = new BlobConsolidation();
   consolidation->AddBlobItem(KRefBlobUUID, 10, 10);
   consolidation->AddDataItem(CreateData("Hello"));
   consolidation->AddDataItem(CreateData("Hello2"));
   consolidation->AddBlobItem(KRefBlobUUID, 0, 10);
   consolidation->AddDataItem(CreateData("Hello3"));
   // See the above test for the expected descriptions layout.
 
-  holder->blob_storage_[kBlobUUID] = base::WrapUnique(consolidation);
+  holder->blob_storage_[kBlobUUID] = consolidation;
 
   std::vector<BlobItemBytesRequest> requests;
   std::vector<base::SharedMemoryHandle> memory_handles;
   std::vector<IPC::PlatformFileForTransit> file_handles;
   std::vector<storage::BlobItemBytesResponse> output;
 
   // Request for all data in shared memory
   requests.push_back(
       BlobItemBytesRequest::CreateSharedMemoryRequest(0, 1, 0, 11, 0, 0));
   requests.push_back(
       BlobItemBytesRequest::CreateSharedMemoryRequest(1, 3, 0, 6, 0, 11));
   base::SharedMemory memory;
   memory.CreateAndMapAnonymous(11 + 6);
   base::SharedMemoryHandle handle =
       base::SharedMemory::DuplicateHandle(memory.handle());
   CHECK(base::SharedMemory::NULLHandle() != handle);
   memory_handles.push_back(handle);
 
   EXPECT_EQ(ResponsesStatus::SUCCESS,
-            holder->GetResponses(kBlobUUID, requests, &memory_handles,
-                                 file_handles, &output));
+            GetResponses(holder, kBlobUUID, requests, &memory_handles,
+                         file_handles, &output));
+  EXPECT_FALSE(AsyncOperationsPending());
   EXPECT_EQ(2u, output.size());
   std::vector<storage::BlobItemBytesResponse> expected;
   expected.push_back(BlobItemBytesResponse(0));
   expected.push_back(BlobItemBytesResponse(1));
   EXPECT_EQ(expected, output);
   std::string expected_memory = "HelloHello2Hello3";
   const char* mem_location = static_cast<const char*>(memory.memory());
   std::vector<char> value(mem_location, mem_location + memory.requested_size());
   EXPECT_THAT(value, testing::ElementsAreArray(expected_memory.c_str(),
                                                expected_memory.size()));
 }
 
+TEST_F(BlobTransportControllerTest, Disk) {
+  using ResponsesStatus = BlobTransportController::ResponsesStatus;
+  const std::string kBlobUUID = "uuid";
+  const std::string KRefBlobUUID = "refuuid";
+  const std::string kBadBlobUUID = "uuuidBad";
+  BlobTransportController* holder = BlobTransportController::GetInstance();
+  FilePath path1 = CreateTemporaryFile();
+  File file(path1, File::FLAG_OPEN | File::FLAG_WRITE | File::FLAG_READ);
+  ASSERT_TRUE(file.IsValid());
+  ASSERT_TRUE(file.SetLength(11 + 6));
+  // The first two data elements should be combined.
+  scoped_refptr<BlobConsolidation> consolidation(new BlobConsolidation());
+  consolidation->AddBlobItem(KRefBlobUUID, 10, 10);
+  consolidation->AddDataItem(CreateData("Hello"));
+  consolidation->AddDataItem(CreateData("Hello2"));
+  consolidation->AddBlobItem(KRefBlobUUID, 0, 10);
+  consolidation->AddDataItem(CreateData("Hello3"));
+  // See the above test for the expected descriptions layout.
+  holder->blob_storage_[kBlobUUID] = consolidation;
+  std::vector<BlobItemBytesRequest> requests;
+  std::vector<base::SharedMemoryHandle> memory_handles;
+  std::vector<IPC::PlatformFileForTransit> file_handles;
+  std::vector<storage::BlobItemBytesResponse> output;
+  // Request for all data in shared memory
+  requests.push_back(
+      BlobItemBytesRequest::CreateFileRequest(0, 1, 0, 11, 0, 0));
+  requests.push_back(
+      BlobItemBytesRequest::CreateFileRequest(1, 3, 0, 6, 0, 11));
+  file_handles.push_back(IPC::TakePlatformFileForTransit(std::move(file)));
+  EXPECT_EQ(ResponsesStatus::PENDING_IO,
+            GetResponses(holder, kBlobUUID, requests, &memory_handles,
+                         file_handles, &output));
+  EXPECT_TRUE(file_runner_->HasPendingTask());
+  EXPECT_FALSE(io_thread_runner_->HasPendingTask());
+  EXPECT_FALSE(AsyncOperationsCalled());
+  file_runner_->RunPendingTasks();
+  EXPECT_FALSE(file_runner_->HasPendingTask());
+  EXPECT_TRUE(io_thread_runner_->HasPendingTask());
+  EXPECT_FALSE(AsyncOperationsCalled());
+  io_thread_runner_->RunPendingTasks();
+  EXPECT_TRUE(AsyncOperationsCalled());
+  EXPECT_EQ(0u, output.size());
+  EXPECT_EQ(2u, all_async_responses_.size());
+  std::vector<storage::BlobItemBytesResponse> expected = {
+      BlobItemBytesResponse(0), BlobItemBytesResponse(1)};
+  EXPECT_EQ(expected, all_async_responses_);
+  std::string expected_memory = "HelloHello2Hello3";
+  file = IPC::PlatformFileForTransitToFile(file_handles[0]);
+  file_handles.clear();
+  char data[11 + 6];
+  file.Read(0, data, 11 + 6);
+  std::vector<char> value(data, data + 11 + 6);
+  EXPECT_THAT(value, testing::ElementsAreArray(expected_memory.c_str(),
+                                               expected_memory.size()));
+
+  // Finally, test that we get errors correctly.
+  FilePath path2 = CreateTemporaryFile();
+  EXPECT_TRUE(base::MakeFileUnwritable(path2));
+  File file2(path2, File::FLAG_OPEN | File::FLAG_WRITE);
+  EXPECT_FALSE(file2.IsValid());
+  file_handles.push_back(IPC::TakePlatformFileForTransit(std::move(file2)));
+  EXPECT_EQ(ResponsesStatus::PENDING_IO,
+            GetResponses(holder, kBlobUUID, requests, &memory_handles,
+                         file_handles, &output));
+  EXPECT_FALSE(AsyncOperationsCalled());
+  file_runner_->RunPendingTasks();
+  io_thread_runner_->RunPendingTasks();
+  EXPECT_TRUE(AsyncOperationsCalled());
+  EXPECT_EQ(0u, all_async_responses_.size());
+  EXPECT_TRUE(error_called_);
+  EXPECT_EQ(IPCBlobCreationCancelCode::FILE_WRITE_FAILED, error_code_);
+}
+
 TEST_F(BlobTransportControllerTest, TestPublicMethods) {
   const std::string kBlobUUID = "uuid";
   const std::string kBlobContentType = "content_type";
   const std::string kBlob2UUID = "uuid2";
   const std::string kBlob2ContentType = "content_type2";
   const std::string KRefBlobUUID = "refuuid";
   std::vector<DataElement> message_descriptions;
   BlobTransportController* holder = BlobTransportController::GetInstance();
 
-  BlobConsolidation* consolidation = new BlobConsolidation();
+  scoped_refptr<BlobConsolidation> consolidation = new BlobConsolidation();
   consolidation->AddBlobItem(KRefBlobUUID, 10, 10);
   BlobTransportController::InitiateBlobTransfer(
-      kBlobUUID, kBlobContentType, base::WrapUnique(consolidation), sender_,
+      kBlobUUID, kBlobContentType, consolidation, sender_,
       io_thread_runner_.get(), main_thread_runner_);
   // Check that we have the 'increase ref' pending task.
   EXPECT_TRUE(main_thread_runner_->HasPendingTask());
   // Check that we have the 'store' pending task.
   EXPECT_TRUE(io_thread_runner_->HasPendingTask());
   // Check that we've sent the data.
   ExpectRegisterAndStartMessage(kBlobUUID, kBlobContentType,
                                 &message_descriptions);
   main_thread_runner_->ClearPendingTasks();
 
   // Check that we got the correct start message.
   EXPECT_FALSE(holder->IsTransporting(kBlobUUID));
   io_thread_runner_->RunPendingTasks();
   EXPECT_TRUE(holder->IsTransporting(kBlobUUID));
   base::Tuple<std::string, std::vector<DataElement>> message_contents;
   EXPECT_EQ(MakeBlobElement(KRefBlobUUID, 10, 10), message_descriptions[0]);
 
   holder->OnCancel(kBlobUUID,
-                   storage::IPCBlobCreationCancelCode::OUT_OF_MEMORY);
+                   IPCBlobCreationCancelCode::OUT_OF_MEMORY);
   EXPECT_FALSE(holder->IsTransporting(kBlobUUID));
   // Check we have the 'decrease ref' task.
   EXPECT_TRUE(main_thread_runner_->HasPendingTask());
   main_thread_runner_->ClearPendingTasks();
   sink_.ClearMessages();
 
   // Add the second.
-  BlobConsolidation* consolidation2 = new BlobConsolidation();
+  scoped_refptr<BlobConsolidation> consolidation2 = new BlobConsolidation();
   consolidation2->AddBlobItem(KRefBlobUUID, 10, 10);
   BlobTransportController::InitiateBlobTransfer(
-      kBlob2UUID, kBlob2ContentType, base::WrapUnique(consolidation2), sender_,
+      kBlob2UUID, kBlob2ContentType, consolidation2, sender_,
       io_thread_runner_.get(), main_thread_runner_);
   EXPECT_TRUE(main_thread_runner_->HasPendingTask());
   main_thread_runner_->ClearPendingTasks();
   sink_.ClearMessages();
 
   io_thread_runner_->RunPendingTasks();
   EXPECT_TRUE(holder->IsTransporting(kBlob2UUID));
 
   // Finish the second one.
   holder->OnDone(kBlob2UUID);
   EXPECT_FALSE(holder->IsTransporting(kBlob2UUID));
   EXPECT_TRUE(main_thread_runner_->HasPendingTask());
   main_thread_runner_->ClearPendingTasks();
 }
 
 TEST_F(BlobTransportControllerTest, ResponsesErrors) {
   using ResponsesStatus = BlobTransportController::ResponsesStatus;
   const std::string kBlobUUID = "uuid";
   const std::string KRefBlobUUID = "refuuid";
   const std::string kBadBlobUUID = "uuuidBad";
   BlobTransportController* holder = BlobTransportController::GetInstance();
 
-  BlobConsolidation* consolidation = new BlobConsolidation();
+  scoped_refptr<BlobConsolidation> consolidation = new BlobConsolidation();
   consolidation->AddBlobItem(KRefBlobUUID, 10, 10);
 
-  holder->blob_storage_[kBlobUUID] = base::WrapUnique(consolidation);
+  holder->blob_storage_[kBlobUUID] = consolidation;
 
   std::vector<BlobItemBytesRequest> requests;
   std::vector<base::SharedMemoryHandle> memory_handles;
   std::vector<IPC::PlatformFileForTransit> file_handles;
   std::vector<storage::BlobItemBytesResponse> output;
 
   // Error conditions
   EXPECT_EQ(ResponsesStatus::BLOB_NOT_FOUND,
-            holder->GetResponses(kBadBlobUUID, requests, &memory_handles,
-                                 file_handles, &output));
+            GetResponses(holder, kBadBlobUUID, requests, &memory_handles,
+                         file_handles, &output));
+  EXPECT_FALSE(AsyncOperationsPending());
   EXPECT_EQ(0u, output.size());
 }
 
 }  // namespace content