Add tests to FetchBlobDataConsumerHandle

Source/modules/fetch/FetchBlobDataConsumerHandleTest.cpp

+// 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 "config.h"
+#include "modules/fetch/FetchBlobDataConsumerHandle.h"
+
+#include "core/dom/ExecutionContext.h"
+#include "core/fetch/ResourceLoaderOptions.h"
+#include "core/loader/ThreadableLoader.h"
+#include "core/loader/ThreadableLoaderClient.h"
+#include "core/testing/DummyPageHolder.h"
+#include "modules/fetch/DataConsumerHandleTestUtil.h"
+#include "platform/blob/BlobData.h"
+#include "platform/blob/BlobURL.h"
+#include "platform/network/ResourceError.h"
+#include "platform/network/ResourceRequest.h"
+#include "platform/network/ResourceResponse.h"
+#include "platform/testing/UnitTestHelpers.h"
+#include "wtf/PassRefPtr.h"
+#include "wtf/RefPtr.h"
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+#include <string.h>
+
+namespace blink {
+namespace {
+
+using Result = WebDataConsumerHandle::Result;
+const Result kUnexpectedError = WebDataConsumerHandle::UnexpectedError;
+const Result kDone = WebDataConsumerHandle::Done;
+using Flags = WebDataConsumerHandle::Flags;
+const Flags kNone = WebDataConsumerHandle::FlagNone;
+using Thread = DataConsumerHandleTestUtil::Thread;
+using HandleReader = DataConsumerHandleTestUtil::HandleReader;
+using HandleTwoPhaseReader = DataConsumerHandleTestUtil::HandleTwoPhaseReader;
+using HandleReadResult = DataConsumerHandleTestUtil::HandleReadResult;
+using ReplayingHandle = DataConsumerHandleTestUtil::ReplayingHandle;
+using Command = DataConsumerHandleTestUtil::Command;
+template <typename T>
+using HandleReaderRunner = DataConsumerHandleTestUtil::HandleReaderRunner<T>;
+
+using ::testing::_;
+using ::testing::DoAll;
+using ::testing::InSequence;
+using ::testing::Ref;
+using ::testing::Return;
+using ::testing::SaveArg;
+using ::testing::StrictMock;
+using Checkpoint = StrictMock<::testing::MockFunction<void(int)>>;
+
+class MockLoaderFactory : public FetchBlobDataConsumerHandle::LoaderFactory {
+public:
+    MOCK_METHOD5(create, PassRefPtr<ThreadableLoader>(ExecutionContext&, ThreadableLoaderClient*, const ResourceRequest&, const ThreadableLoaderOptions&, const ResourceLoaderOptions&));
+};
+
+class MockThreadableLoader : public ThreadableLoader {
+public:
+    static PassRefPtr<MockThreadableLoader> create() { return adoptRef(new StrictMock<MockThreadableLoader>); }
+
+    MOCK_METHOD1(overrideTimeout, void(unsigned long));
+    MOCK_METHOD0(cancel, void());
+
+protected:
+    MockThreadableLoader() = default;
+};
+
+PassRefPtr<BlobDataHandle> createBlobDataHandle(const char* s)
+{
+    OwnPtr<BlobData> data = BlobData::create();
+    data->appendText(s, false);
+    auto size = data->length();
+    return BlobDataHandle::create(data.release(), size);
+}
+
+String toString(const Vector<char>& data)
+{
+    return String(data.data(), data.size());
+}
+
+class FetchBlobDataConsumerHandleTest : public ::testing::Test {
+public:
+    FetchBlobDataConsumerHandleTest()
+        : m_dummyPageHolder(DummyPageHolder::create(IntSize(1, 1)))
+    {
+    }
+
+    ~FetchBlobDataConsumerHandleTest() override
+    {
+        m_dummyPageHolder = nullptr;
+        // We need this to collect garbage-collected mocks.
+        Heap::collectAllGarbage();
+    }
+
+protected:
+    Document& document() { return m_dummyPageHolder->document(); }
+
+    OwnPtr<DummyPageHolder> m_dummyPageHolder;

[hiroshige, 2015/07/15 11:27:55]

|m_dummyPageHolder| can be private.

[yhirano, 2015/07/16 05:29:10]

Done.

+};
+
+TEST_F(FetchBlobDataConsumerHandleTest, CreateLoader)
+{
+    auto factory = new StrictMock<MockLoaderFactory>;
+    Checkpoint checkpoint;
+
+    ResourceRequest request;
+    ThreadableLoaderOptions options;
+    ResourceLoaderOptions resourceLoaderOptions;
+
+    RefPtr<MockThreadableLoader> loader = MockThreadableLoader::create();
+
+    InSequence s;
+    EXPECT_CALL(checkpoint, Call(1));
+    EXPECT_CALL(*factory, create(Ref(document()), _, _, _, _)).WillOnce(DoAll(
+        SaveArg<2>(&request),
+        SaveArg<3>(&options),
+        SaveArg<4>(&resourceLoaderOptions),
+        Return(loader.get())));
+    EXPECT_CALL(checkpoint, Call(2));
+    EXPECT_CALL(*loader, cancel());
+
+    RefPtr<BlobDataHandle> blobDataHandle = createBlobDataHandle("Once upon a time");
+    OwnPtr<WebDataConsumerHandle> handle
+        = FetchBlobDataConsumerHandle::create(&document(), blobDataHandle, factory);
+    testing::runPendingTasks();
+
+    size_t size = 0;
+    handle->obtainReader(nullptr)->read(nullptr, 0, kNone, &size);
+    checkpoint.Call(1);
+    testing::runPendingTasks();
+    checkpoint.Call(2);
+
+    EXPECT_TRUE(request.url().string().startsWith("blob:"));
+    EXPECT_TRUE(request.useStreamOnResponse());
+
+    EXPECT_EQ(ConsiderPreflight, options.preflightPolicy);
+    EXPECT_EQ(DenyCrossOriginRequests, options.crossOriginRequestPolicy);
+    EXPECT_EQ(DoNotEnforceContentSecurityPolicy, options.contentSecurityPolicyEnforcement);
+
+    EXPECT_EQ(DoNotBufferData, resourceLoaderOptions.dataBufferingPolicy);
+    EXPECT_EQ(DoNotAllowStoredCredentials, resourceLoaderOptions.allowCredentials);
+    EXPECT_EQ(ClientDidNotRequestCredentials, resourceLoaderOptions.credentialsRequested);
+    EXPECT_EQ(CheckContentSecurityPolicy, resourceLoaderOptions.contentSecurityPolicyOption);
+    EXPECT_EQ(DocumentContext, resourceLoaderOptions.requestInitiatorContext);
+    EXPECT_EQ(RequestAsynchronously, resourceLoaderOptions.synchronousPolicy);
+    EXPECT_EQ(NotCORSEnabled, resourceLoaderOptions.corsEnabled);
+}
+
+TEST_F(FetchBlobDataConsumerHandleTest, CancelLoaderWhenStopped)
+{
+    auto factory = new StrictMock<MockLoaderFactory>;
+    Checkpoint checkpoint;
+
+    RefPtr<MockThreadableLoader> loader = MockThreadableLoader::create();
+
+    InSequence s;
+    EXPECT_CALL(checkpoint, Call(1));
+    EXPECT_CALL(*factory, create(Ref(document()), _, _, _, _)).WillOnce(Return(loader.get()));
+    EXPECT_CALL(checkpoint, Call(2));
+    EXPECT_CALL(*loader, cancel());
+    EXPECT_CALL(checkpoint, Call(3));
+
+    RefPtr<BlobDataHandle> blobDataHandle = createBlobDataHandle("Once upon a time");
+    OwnPtr<WebDataConsumerHandle> handle
+        = FetchBlobDataConsumerHandle::create(&document(), blobDataHandle, factory);
+    testing::runPendingTasks();
+
+    size_t size = 0;
+    handle->obtainReader(nullptr)->read(nullptr, 0, kNone, &size);
+    checkpoint.Call(1);
+    testing::runPendingTasks();
+    checkpoint.Call(2);
+    document().stopActiveDOMObjects();
+    checkpoint.Call(3);
+}
+
+TEST_F(FetchBlobDataConsumerHandleTest, CancelLoaderWhenDestinationDetached)
+{
+    auto factory = new StrictMock<MockLoaderFactory>;
+    Checkpoint checkpoint;
+
+    RefPtr<MockThreadableLoader> loader = MockThreadableLoader::create();
+
+    InSequence s;
+    EXPECT_CALL(checkpoint, Call(1));
+    EXPECT_CALL(*factory, create(Ref(document()), _, _, _, _)).WillOnce(Return(loader.get()));
+    EXPECT_CALL(checkpoint, Call(2));
+    EXPECT_CALL(checkpoint, Call(3));
+    EXPECT_CALL(*loader, cancel());
+    EXPECT_CALL(checkpoint, Call(4));
+
+    RefPtr<BlobDataHandle> blobDataHandle = createBlobDataHandle("Once upon a time");
+    OwnPtr<WebDataConsumerHandle> handle
+        = FetchBlobDataConsumerHandle::create(&document(), blobDataHandle, factory);
+    OwnPtr<WebDataConsumerHandle::Reader> reader = handle->obtainReader(nullptr);
+    testing::runPendingTasks();
+
+    size_t size = 0;
+    reader->read(nullptr, 0, kNone, &size);
+    checkpoint.Call(1);
+    testing::runPendingTasks();
+    checkpoint.Call(2);
+    handle = nullptr;
+    reader = nullptr;
+    checkpoint.Call(3);
+    Heap::collectAllGarbage();
+    checkpoint.Call(4);
+}
+
+TEST_F(FetchBlobDataConsumerHandleTest, ReadTest)
+{
+    auto factory = new StrictMock<MockLoaderFactory>;
+    Checkpoint checkpoint;
+
+    RefPtr<MockThreadableLoader> loader = MockThreadableLoader::create();
+    ThreadableLoaderClient* client = nullptr;
+
+    InSequence s;
+    EXPECT_CALL(checkpoint, Call(1));
+    EXPECT_CALL(*factory, create(Ref(document()), _, _, _, _)).WillOnce(DoAll(SaveArg<1>(&client), Return(loader.get())));
+    EXPECT_CALL(checkpoint, Call(2));
+    EXPECT_CALL(*loader, cancel());
+
+    RefPtr<BlobDataHandle> blobDataHandle = createBlobDataHandle("Once upon a time");
+    OwnPtr<WebDataConsumerHandle> handle
+        = FetchBlobDataConsumerHandle::create(&document(), blobDataHandle, factory);
+
+    OwnPtr<ReplayingHandle> src = ReplayingHandle::create();
+    src->add(Command(Command::Wait));
+    src->add(Command(Command::Data, "hello, "));
+    src->add(Command(Command::Data, "world"));
+    src->add(Command(Command::Wait));
+    src->add(Command(Command::Done));
+
+    size_t size = 0;
+    handle->obtainReader(nullptr)->read(nullptr, 0, kNone, &size);

[hiroshige, 2015/07/15 11:27:54]

optional: can we read() here and the following runPendingTasks()? Because
HandleReader should work without these.
(unless writing the test becomes harder if we don't explicitly start the loader
by the read() here)

[yhirano, 2015/07/15 13:07:08]

Sorry, I'm not sure what you propose: can you restate?

[hiroshige, 2015/07/16 05:01:36]

Er, I originally thought as the following but changed my mind:
in this test we call
  handle->obtainReader(nullptr)->read(nullptr, 0, kNone, &size);
explicitly only to start a loader in L237 but this seems artificial for me.
I thought the code L242-L245 would work without such call to read() because the
loader will be started by read() etc. called from HandleReader, except for
factory->create() and client->didReceiveResponse() are called with different
timings.
However, I noticed controlling the timings would be trickier if I remove read()
and let HandleReader to trigger loader starting, so the current code is now fine
with me.

[yhirano, 2015/07/16 05:29:10]

Acknowledged.

+    checkpoint.Call(1);
+    testing::runPendingTasks();
+    checkpoint.Call(2);
+    client->didReceiveResponse(0, ResourceResponse(), src.release());
+    HandleReaderRunner<HandleReader> runner(handle.release());
+    OwnPtr<HandleReadResult> r = runner.wait();
+    EXPECT_EQ(kDone, r->result());
+    EXPECT_EQ("hello, world", toString(r->data()));
+}
+
+TEST_F(FetchBlobDataConsumerHandleTest, TwoPhaseReadTest)
+{
+    auto factory = new StrictMock<MockLoaderFactory>;
+    Checkpoint checkpoint;
+
+    RefPtr<MockThreadableLoader> loader = MockThreadableLoader::create();
+    ThreadableLoaderClient* client = nullptr;
+
+    InSequence s;
+    EXPECT_CALL(checkpoint, Call(1));
+    EXPECT_CALL(*factory, create(Ref(document()), _, _, _, _)).WillOnce(DoAll(SaveArg<1>(&client), Return(loader.get())));
+    EXPECT_CALL(checkpoint, Call(2));
+    EXPECT_CALL(*loader, cancel());
+
+    RefPtr<BlobDataHandle> blobDataHandle = createBlobDataHandle("Once upon a time");
+    OwnPtr<WebDataConsumerHandle> handle
+        = FetchBlobDataConsumerHandle::create(&document(), blobDataHandle, factory);
+
+    OwnPtr<ReplayingHandle> src = ReplayingHandle::create();
+    src->add(Command(Command::Wait));
+    src->add(Command(Command::Data, "hello, "));
+    src->add(Command(Command::Data, "world"));
+    src->add(Command(Command::Wait));
+    src->add(Command(Command::Done));
+
+    size_t size = 0;
+    handle->obtainReader(nullptr)->read(nullptr, 0, kNone, &size);

[hiroshige, 2015/07/15 11:27:55]

ditto.

[yhirano, 2015/07/16 05:29:10]

Acknowledged.

+    checkpoint.Call(1);
+    testing::runPendingTasks();
+    checkpoint.Call(2);
+    client->didReceiveResponse(0, ResourceResponse(), src.release());
+    HandleReaderRunner<HandleTwoPhaseReader> runner(handle.release());
+    OwnPtr<HandleReadResult> r = runner.wait();
+    EXPECT_EQ(kDone, r->result());
+    EXPECT_EQ("hello, world", toString(r->data()));
+}
+
+TEST_F(FetchBlobDataConsumerHandleTest, LoadErrorTest)
+{
+    auto factory = new StrictMock<MockLoaderFactory>;
+    Checkpoint checkpoint;
+
+    RefPtr<MockThreadableLoader> loader = MockThreadableLoader::create();
+    ThreadableLoaderClient* client = nullptr;
+
+    InSequence s;
+    EXPECT_CALL(checkpoint, Call(1));
+    EXPECT_CALL(*factory, create(Ref(document()), _, _, _, _)).WillOnce(DoAll(SaveArg<1>(&client), Return(loader.get())));
+    EXPECT_CALL(checkpoint, Call(2));
+
+    RefPtr<BlobDataHandle> blobDataHandle = createBlobDataHandle("Once upon a time");
+    OwnPtr<WebDataConsumerHandle> handle
+        = FetchBlobDataConsumerHandle::create(&document(), blobDataHandle, factory);
+
+    size_t size = 0;
+    handle->obtainReader(nullptr)->read(nullptr, 0, kNone, &size);
+    checkpoint.Call(1);
+    testing::runPendingTasks();
+    checkpoint.Call(2);
+    client->didFail(ResourceError());
+    HandleReaderRunner<HandleReader> runner(handle.release());
+    OwnPtr<HandleReadResult> r = runner.wait();
+    EXPECT_EQ(kUnexpectedError, r->result());
+}
+
+TEST_F(FetchBlobDataConsumerHandleTest, BodyLoadErrorTest)
+{
+    auto factory = new StrictMock<MockLoaderFactory>;
+    Checkpoint checkpoint;
+
+    RefPtr<MockThreadableLoader> loader = MockThreadableLoader::create();
+    ThreadableLoaderClient* client = nullptr;
+
+    InSequence s;
+    EXPECT_CALL(checkpoint, Call(1));
+    EXPECT_CALL(*factory, create(Ref(document()), _, _, _, _)).WillOnce(DoAll(SaveArg<1>(&client), Return(loader.get())));
+    EXPECT_CALL(checkpoint, Call(2));
+    EXPECT_CALL(*loader, cancel());
+
+    RefPtr<BlobDataHandle> blobDataHandle = createBlobDataHandle("Once upon a time");
+    OwnPtr<WebDataConsumerHandle> handle
+        = FetchBlobDataConsumerHandle::create(&document(), blobDataHandle, factory);
+
+    OwnPtr<ReplayingHandle> src = ReplayingHandle::create();
+    src->add(Command(Command::Wait));
+    src->add(Command(Command::Data, "hello, "));
+    src->add(Command(Command::Error));
+
+    size_t size = 0;
+    handle->obtainReader(nullptr)->read(nullptr, 0, kNone, &size);
+    checkpoint.Call(1);
+    testing::runPendingTasks();
+    checkpoint.Call(2);
+    client->didReceiveResponse(0, ResourceResponse(), src.release());
+    HandleReaderRunner<HandleReader> runner(handle.release());
+    OwnPtr<HandleReadResult> r = runner.wait();
+    EXPECT_EQ(kUnexpectedError, r->result());
+}
+
+} // namespace
+} // namespace blink