net: Make UploadDataStream::Init() asynchronous.

net/base/upload_data_stream_unittest.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 "net/base/upload_data_stream.h"
 
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
 #include "base/time.h"
 #include "net/base/io_buffer.h"
 #include "net/base/net_errors.h"
 #include "net/base/upload_data.h"
 #include "net/base/upload_file_element_reader.h"
+#include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "testing/platform_test.h"
 
+using ::testing::DoAll;
+using ::testing::Invoke;
+using ::testing::Return;
+using ::testing::_;
+
 namespace net {
 
 namespace {
 
 const char kTestData[] = "0123456789";
 const size_t kTestDataSize = arraysize(kTestData) - 1;
 const size_t kTestBufferSize = 1 << 14;  // 16KB.
 
 // Reads data from the upload data stream, and returns the data as string.
 std::string ReadFromUploadDataStream(UploadDataStream* stream) {
   std::string data_read;
   scoped_refptr<IOBuffer> buf = new IOBuffer(kTestBufferSize);
   while (!stream->IsEOF()) {
     const int bytes_read = stream->Read(buf, kTestBufferSize);
     data_read.append(buf->data(), bytes_read);
   }
   return data_read;
 }
 
+// A mock class of UploadElementReader.
+class MockUploadElementReader : public UploadElementReader {
+ public:
+  MockUploadElementReader() : init_result_(OK) {}
+  virtual ~MockUploadElementReader() {}
+
+  MOCK_METHOD1(Init, int(const CompletionCallback& callback));
+  MOCK_CONST_METHOD0(GetContentLength, uint64());
+  MOCK_CONST_METHOD0(BytesRemaining, uint64());
+  MOCK_CONST_METHOD0(IsInMemory, bool());
+  MOCK_METHOD2(ReadSync, int(char* buf, int buf_length));
+
+  // Sets expectation to return the specified result from Init() asynchronously.
+  void SetAsyncInitExpectation(int result) {
+    init_result_ = result;
+    EXPECT_CALL(*this, Init(_))
+        .WillOnce(DoAll(Invoke(this, &MockUploadElementReader::OnInit),
+                        Return(ERR_IO_PENDING)));
+  }
+
+ private:
+  void OnInit(const CompletionCallback& callback) {
+    MessageLoop::current()->PostTask(FROM_HERE,
+                                     base::Bind(callback, init_result_));
+  }
+
+  // Result value returned from Init().
+  int init_result_;
+};
+
+// A mock CompletionCallback.
+class MockCompletionCallback {
+ public:
+  MOCK_METHOD1(Run, void(int result));
+
+  CompletionCallback CreateCallback() {
+    return base::Bind(&MockCompletionCallback::Run, base::Unretained(this));
+  }
+};
+
 }  // namespace
 
 class UploadDataStreamTest : public PlatformTest {
  public:
   UploadDataStreamTest() : upload_data_(new UploadData) { }
 
   void FileChangedHelper(const FilePath& file_path,
                          const base::Time& time,
                          bool error_expected);
 
   scoped_refptr<UploadData> upload_data_;
 };
 
 TEST_F(UploadDataStreamTest, EmptyUploadData) {
   upload_data_->AppendBytes("", 0);
   scoped_ptr<UploadDataStream> stream(new UploadDataStream(upload_data_));
-  ASSERT_EQ(OK, stream->Init());
+  ASSERT_EQ(OK, stream->InitSync());
   EXPECT_TRUE(stream->IsInMemory());
   ASSERT_TRUE(stream.get());
   EXPECT_EQ(0U, stream->size());
   EXPECT_EQ(0U, stream->position());
   EXPECT_TRUE(stream->IsEOF());
 }
 
 TEST_F(UploadDataStreamTest, ConsumeAllBytes) {
   upload_data_->AppendBytes(kTestData, kTestDataSize);
   scoped_ptr<UploadDataStream> stream(new UploadDataStream(upload_data_));
-  ASSERT_EQ(OK, stream->Init());
+  ASSERT_EQ(OK, stream->InitSync());
   EXPECT_TRUE(stream->IsInMemory());
   ASSERT_TRUE(stream.get());
   EXPECT_EQ(kTestDataSize, stream->size());
   EXPECT_EQ(0U, stream->position());
   EXPECT_FALSE(stream->IsEOF());
   scoped_refptr<IOBuffer> buf = new IOBuffer(kTestBufferSize);
   while (!stream->IsEOF()) {
     int bytes_read = stream->Read(buf, kTestBufferSize);
     ASSERT_LE(0, bytes_read);  // Not an error.
   }
   EXPECT_EQ(kTestDataSize, stream->position());
   ASSERT_TRUE(stream->IsEOF());
 }
 
 TEST_F(UploadDataStreamTest, File) {
   FilePath temp_file_path;
   ASSERT_TRUE(file_util::CreateTemporaryFile(&temp_file_path));
   ASSERT_EQ(static_cast<int>(kTestDataSize),
             file_util::WriteFile(temp_file_path, kTestData, kTestDataSize));
 
   std::vector<UploadElement> elements;
   UploadElement element;
   element.SetToFilePath(temp_file_path);
   elements.push_back(element);
   upload_data_->SetElements(elements);
 
   scoped_ptr<UploadDataStream> stream(new UploadDataStream(upload_data_));
-  ASSERT_EQ(OK, stream->Init());
+  ASSERT_EQ(OK, stream->InitSync());
   EXPECT_FALSE(stream->IsInMemory());
   ASSERT_TRUE(stream.get());
   EXPECT_EQ(kTestDataSize, stream->size());
   EXPECT_EQ(0U, stream->position());
   EXPECT_FALSE(stream->IsEOF());
   scoped_refptr<IOBuffer> buf = new IOBuffer(kTestBufferSize);
   while (!stream->IsEOF()) {
     int bytes_read = stream->Read(buf, kTestBufferSize);
     ASSERT_LE(0, bytes_read);  // Not an error.
   }
@@ skipping 12 matching lines @@
   UploadFileElementReader::ScopedOverridingContentLengthForTests
       overriding_content_length(kFakeSize);
 
   std::vector<UploadElement> elements;
   UploadElement element;
   element.SetToFilePath(temp_file_path);
   elements.push_back(element);
   upload_data_->SetElements(elements);
 
   scoped_ptr<UploadDataStream> stream(new UploadDataStream(upload_data_));
-  ASSERT_EQ(OK, stream->Init());
+  ASSERT_EQ(OK, stream->InitSync());
   EXPECT_FALSE(stream->IsInMemory());
   ASSERT_TRUE(stream.get());
   EXPECT_EQ(kFakeSize, stream->size());
   EXPECT_EQ(0U, stream->position());
   EXPECT_FALSE(stream->IsEOF());
   uint64 read_counter = 0;
   scoped_refptr<IOBuffer> buf = new IOBuffer(kTestBufferSize);
   while (!stream->IsEOF()) {
     int bytes_read = stream->Read(buf, kTestBufferSize);
     ASSERT_LE(0, bytes_read);  // Not an error.
@@ skipping 16 matching lines @@
 
   const uint64 kFileRangeOffset = 1;
   const uint64 kFileRangeLength = 4;
   upload_data_->AppendFileRange(
       temp_file_path, kFileRangeOffset, kFileRangeLength, base::Time());
 
   upload_data_->AppendBytes(kTestData, kTestDataSize);
 
   const uint64 kStreamSize = kTestDataSize + kFileRangeLength;
   scoped_ptr<UploadDataStream> stream(new UploadDataStream(upload_data_));
-  ASSERT_EQ(OK, stream->Init());
+  ASSERT_EQ(OK, stream->InitSync());
   EXPECT_FALSE(stream->IsInMemory());
   ASSERT_TRUE(stream.get());
   EXPECT_EQ(kStreamSize, stream->size());
   EXPECT_EQ(0U, stream->position());
   EXPECT_FALSE(stream->IsEOF());
   scoped_refptr<IOBuffer> buf = new IOBuffer(kTestBufferSize);
   while (!stream->IsEOF()) {
     int bytes_read = stream->Read(buf, kTestBufferSize);
     ASSERT_LE(0, bytes_read);  // Not an error.
   }
   EXPECT_EQ(kStreamSize, stream->position());
   ASSERT_TRUE(stream->IsEOF());
 
   file_util::Delete(temp_file_path, false);
 }
 
 TEST_F(UploadDataStreamTest, Chunk) {
   upload_data_->set_is_chunked(true);
   upload_data_->AppendChunk(kTestData, kTestDataSize, false);
   upload_data_->AppendChunk(kTestData, kTestDataSize, true);
 
   const uint64 kStreamSize = kTestDataSize*2;
   scoped_ptr<UploadDataStream> stream(new UploadDataStream(upload_data_));
-  ASSERT_EQ(OK, stream->Init());
+  ASSERT_EQ(OK, stream->InitSync());
   EXPECT_FALSE(stream->IsInMemory());
   ASSERT_TRUE(stream.get());
   EXPECT_EQ(0U, stream->size());  // Content-Length is 0 for chunked data.
   EXPECT_EQ(0U, stream->position());
   EXPECT_FALSE(stream->IsEOF());
   scoped_refptr<IOBuffer> buf = new IOBuffer(kTestBufferSize);
   while (!stream->IsEOF()) {
     int bytes_read = stream->Read(buf, kTestBufferSize);
     ASSERT_LE(0, bytes_read);  // Not an error.
   }
   EXPECT_EQ(kStreamSize, stream->position());
   ASSERT_TRUE(stream->IsEOF());
 }
 
+// Init() with on-memory and not-on-memory readers.
+TEST_F(UploadDataStreamTest, InitAsync) {
+  // Create stream without element readers.
+  UploadDataStream stream(upload_data_);
+
+  // Set mock readers to the stream.
+  MockUploadElementReader* reader = NULL;
+
+  reader = new MockUploadElementReader;
+  EXPECT_CALL(*reader, Init(_)).WillOnce(Return(OK));
+  EXPECT_CALL(*reader, GetContentLength()).WillRepeatedly(Return(0));
+  EXPECT_CALL(*reader, IsInMemory()).WillRepeatedly(Return(true));
+  stream.element_readers_.push_back(reader);
+
+  reader = new MockUploadElementReader;
+  EXPECT_CALL(*reader, Init(_)).WillOnce(Return(OK));
+  EXPECT_CALL(*reader, GetContentLength()).WillRepeatedly(Return(0));
+  EXPECT_CALL(*reader, IsInMemory()).WillRepeatedly(Return(true));
+  stream.element_readers_.push_back(reader);
+
+  reader = new MockUploadElementReader;
+  reader->SetAsyncInitExpectation(OK);
+  EXPECT_CALL(*reader, GetContentLength()).WillRepeatedly(Return(0));
+  EXPECT_CALL(*reader, IsInMemory()).WillRepeatedly(Return(false));
+  stream.element_readers_.push_back(reader);
+
+  reader = new MockUploadElementReader;
+  reader->SetAsyncInitExpectation(OK);
+  EXPECT_CALL(*reader, GetContentLength()).WillRepeatedly(Return(0));
+  EXPECT_CALL(*reader, IsInMemory()).WillRepeatedly(Return(false));
+  stream.element_readers_.push_back(reader);
+
+  reader = new MockUploadElementReader;
+  EXPECT_CALL(*reader, Init(_)).WillOnce(Return(OK));
+  EXPECT_CALL(*reader, GetContentLength()).WillRepeatedly(Return(0));
+  EXPECT_CALL(*reader, IsInMemory()).WillRepeatedly(Return(true));
+  stream.element_readers_.push_back(reader);
+
+  // Run Init().
+  MockCompletionCallback mock_callback;
+  EXPECT_CALL(mock_callback, Run(OK)).Times(1);
+  EXPECT_EQ(stream.Init(mock_callback.CreateCallback()), ERR_IO_PENDING);
+  MessageLoop::current()->RunAllPending();
+}
+
+// Init() of a reader fails asynchronously.
+TEST_F(UploadDataStreamTest, InitAsyncFailureAsync) {
+  // Create stream without element readers.
+  UploadDataStream stream(upload_data_);
+
+  // Set a mock reader to the stream.
+  MockUploadElementReader* reader = NULL;
+
+  reader = new MockUploadElementReader;
+  reader->SetAsyncInitExpectation(ERR_FAILED);
+  EXPECT_CALL(*reader, IsInMemory()).WillRepeatedly(Return(false));
+  stream.element_readers_.push_back(reader);
+
+  // Run Init().
+  MockCompletionCallback mock_callback;
+  EXPECT_CALL(mock_callback, Run(ERR_FAILED)).Times(1);
+  EXPECT_EQ(stream.Init(mock_callback.CreateCallback()), ERR_IO_PENDING);
+  MessageLoop::current()->RunAllPending();
+}
+
+// Init() of a reader fails synchronously.
+TEST_F(UploadDataStreamTest, InitAsyncFailureSync) {
+  // Create stream without element readers.
+  UploadDataStream stream(upload_data_);
+
+  // Set mock readers to the stream.
+  MockUploadElementReader* reader = NULL;
+
+  reader = new MockUploadElementReader;
+  reader->SetAsyncInitExpectation(OK);
+  EXPECT_CALL(*reader, IsInMemory()).WillRepeatedly(Return(false));
+  stream.element_readers_.push_back(reader);
+
+  reader = new MockUploadElementReader;
+  EXPECT_CALL(*reader, Init(_)).WillOnce(Return(ERR_FAILED));
+  EXPECT_CALL(*reader, IsInMemory()).WillRepeatedly(Return(true));
+  stream.element_readers_.push_back(reader);
+
+  // Run Init().
+  MockCompletionCallback mock_callback;
+  EXPECT_CALL(mock_callback, Run(ERR_FAILED)).Times(1);
+  EXPECT_EQ(stream.Init(mock_callback.CreateCallback()), ERR_IO_PENDING);
+  MessageLoop::current()->RunAllPending();
+}
+
 void UploadDataStreamTest::FileChangedHelper(const FilePath& file_path,
                                              const base::Time& time,
                                              bool error_expected) {
   std::vector<UploadElement> elements;
   UploadElement element;
   element.SetToFilePathRange(file_path, 1, 2, time);
   elements.push_back(element);
   // Don't use upload_data_ here, as this function is called twice, and
   // reusing upload_data_ is wrong.
   scoped_refptr<UploadData> upload_data(new UploadData);
   upload_data->SetElements(elements);
 
   scoped_ptr<UploadDataStream> stream(new UploadDataStream(upload_data));
-  int error_code = stream->Init();
+  int error_code = stream->InitSync();
   if (error_expected)
     ASSERT_EQ(ERR_UPLOAD_FILE_CHANGED, error_code);
   else
     ASSERT_EQ(OK, error_code);
 }
 
 TEST_F(UploadDataStreamTest, FileChanged) {
   FilePath temp_file_path;
   ASSERT_TRUE(file_util::CreateTemporaryFile(&temp_file_path));
   ASSERT_EQ(static_cast<int>(kTestDataSize),
@@ skipping 22 matching lines @@
   // Prepare |upload_data_| that contains a file.
   std::vector<UploadElement> elements;
   UploadElement element;
   element.SetToFilePath(temp_file_path);
   elements.push_back(element);
   upload_data_->SetElements(elements);
 
   // Confirm that the file is read properly.
   {
     UploadDataStream stream(upload_data_);
-    ASSERT_EQ(OK, stream.Init());
+    ASSERT_EQ(OK, stream.InitSync());
     EXPECT_EQ(kTestDataSize, stream.size());
     EXPECT_EQ(kTestData, ReadFromUploadDataStream(&stream));
   }
 
   // Reuse |upload_data_| for another UploadDataStream, and confirm that the
   // file is read properly.
   {
     UploadDataStream stream(upload_data_);
-    ASSERT_EQ(OK, stream.Init());
+    ASSERT_EQ(OK, stream.InitSync());
     EXPECT_EQ(kTestDataSize, stream.size());
     EXPECT_EQ(kTestData, ReadFromUploadDataStream(&stream));
   }
 
   file_util::Delete(temp_file_path, false);
 }
 
 }  // namespace net