Support filesystem files from BlobURLRequestJob

webkit/blob/blob_url_request_job_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 <stack>
 #include <utility>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop_proxy.h"
 #include "base/scoped_temp_dir.h"
 #include "base/synchronization/waitable_event.h"
 #include "base/threading/thread.h"
 #include "base/time.h"
 #include "net/base/file_stream.h"
 #include "net/base/io_buffer.h"
 #include "net/base/net_errors.h"
 #include "net/http/http_request_headers.h"
 #include "net/http/http_response_headers.h"
 #include "net/url_request/url_request.h"
 #include "net/url_request/url_request_context.h"
 #include "net/url_request/url_request_error_job.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "webkit/blob/blob_data.h"
 #include "webkit/blob/blob_url_request_job.h"
+#include "webkit/fileapi/file_system_context.h"
+#include "webkit/fileapi/file_system_operation_context.h"
+#include "webkit/fileapi/file_system_task_runners.h"
+#include "webkit/fileapi/file_system_util.h"
+#include "webkit/fileapi/mock_file_system_options.h"
+#include "webkit/fileapi/sandbox_mount_point_provider.h"

[kinuko, 2012/10/18 11:57:54]

I think we can avoid including this file. (See comments below)

[hashimoto, 2012/10/18 13:38:13]

Done.

+#include "webkit/quota/mock_special_storage_policy.h"

[kinuko, 2012/10/18 11:57:54]

ditto

[hashimoto, 2012/10/18 13:38:13]

Done.

 
 namespace webkit_blob {
 
-static const int kBufferSize = 1024;
-static const char kTestData1[] = "Hello";
-static const char kTestData2[] = "Here it is data.";
-static const char kTestFileData1[] = "0123456789";
-static const char kTestFileData2[] = "This is sample file.";
-static const char kTestContentType[] = "foo/bar";
-static const char kTestContentDisposition[] = "attachment; filename=foo.txt";
+namespace {
+
+const int kBufferSize = 1024;
+const char kTestData1[] = "Hello";
+const char kTestData2[] = "Here it is data.";
+const char kTestFileData1[] = "0123456789";
+const char kTestFileData2[] = "This is sample file.";
+const char kTestFileSystemFileData1[] = "abcdefghijklmnop";
+const char kTestFileSystemFileData2[] = "File system file test data.";
+const char kTestContentType[] = "foo/bar";
+const char kTestContentDisposition[] = "attachment; filename=foo.txt";
+
+const char kFileSystemURLOrigin[] = "http://remote";
+
+GURL GetFileSystemURL(const std::string& filename) {
+  std::string url_string = "filesystem:";
+  url_string += kFileSystemURLOrigin;
+  url_string += fileapi::kTemporaryDir;
+  url_string += "/";
+  url_string += filename;
+  return GURL(url_string);

[kinuko, 2012/10/18 11:57:54]

Can we use GetFileSystemRootURI()? something like:

GURL(fileapi::GetFileSystemRootURI(GURL(kFileSystemURLOrigin),
fileapi::kFileSystemTypeTemporary).spec() + filename)

[hashimoto, 2012/10/18 13:38:13]

Done.

+}
+
+}  // namespace
 
 class BlobURLRequestJobTest : public testing::Test {
  public:
 
   // Test Harness -------------------------------------------------------------
   // TODO(jianli): share this test harness with AppCacheURLRequestJobTest
 
   class MockURLRequestDelegate : public net::URLRequest::Delegate {
    public:
     explicit MockURLRequestDelegate(BlobURLRequestJobTest* test)
@@ skipping 107 matching lines @@
 
   template <class Method>
   void RunTestOnIOThread(Method method) {
     test_finished_event_ .reset(new base::WaitableEvent(false, false));
     io_thread_->message_loop()->PostTask(
         FROM_HERE, base::Bind(&BlobURLRequestJobTest::MethodWrapper<Method>,
                               base::Unretained(this), method));
     test_finished_event_->Wait();
   }
 
+  void WriteFileSystemFile(const std::string& filename,
+                           const char* buf, int buf_size,
+                           base::Time* modification_time) {
+    fileapi::FileSystemURL url(GURL(kFileSystemURLOrigin),
+                               fileapi::kFileSystemTypeTemporary,
+                               FilePath().AppendASCII(filename));
+
+    fileapi::FileSystemFileUtil* file_util = file_system_context_->
+        sandbox_provider()->GetFileUtil(fileapi::kFileSystemTypeTemporary);

[kinuko, 2012/10/18 11:57:54]

file_system_context_->GetFileUtil(type) should work.

It might be nicer to define some constant for fileapi::kFileSystemTypeTemporary
so that we can easily change testing fs type if necessary (e.g. we can instead
use kFileSystemTypeTest for simpler tests) & save typing.

[hashimoto, 2012/10/18 13:38:13]

Done.

Here I was mimicking file_system_url_request_job_unittest.cc, and
file_system_file_stream_reader_unitteest.cc is also doing the same thing.
Should I also fix them?
Done.

[kinuko, 2012/10/19 04:07:19]

I see... could you fix them as well in a separate patch?  Directly using
sandbox_provider() is not very portable unless we're specifically interested in
testing the SandboxMountPointProvider.

+
+    fileapi::FileSystemOperationContext context(file_system_context_);
+    context.set_allowed_bytes_growth(1024);
+
+    base::PlatformFile handle = base::kInvalidPlatformFileValue;
+    bool created = false;
+    ASSERT_EQ(base::PLATFORM_FILE_OK, file_util->CreateOrOpen(
+        &context,
+        url,
+        base::PLATFORM_FILE_CREATE | base::PLATFORM_FILE_WRITE,
+        &handle,
+        &created));
+    EXPECT_TRUE(created);
+    ASSERT_NE(base::kInvalidPlatformFileValue, handle);
+    ASSERT_EQ(buf_size,
+        base::WritePlatformFile(handle, 0 /* offset */, buf, buf_size));
+    base::ClosePlatformFile(handle);
+
+    base::PlatformFileInfo file_info;
+    FilePath platform_path;
+    ASSERT_EQ(base::PLATFORM_FILE_OK,
+              file_util->GetFileInfo(&context, url, &file_info,
+                                     &platform_path));
+    if (modification_time)
+      *modification_time = file_info.last_modified;
+  }
+
   void SetUpTest() {
     DCHECK(MessageLoop::current() == io_thread_->message_loop());
 
     net::URLRequest::Deprecated::RegisterProtocolFactory(
         "blob", &BlobURLRequestJobFactory);
     url_request_delegate_.reset(new MockURLRequestDelegate(this));
+
+    // Prepare file system.

[kinuko, 2012/10/18 11:57:54]

It feels a bit heavy to run this setup for every test.  Can we only setup
filesystem env for the tests that use FileSystemURL?

[hashimoto, 2012/10/18 13:38:13]

Sorry, it looks my understanding of webkit/fileapi code is not so good.
You mean there is a light weight utility which can be used to provide
FileSystemContext for tests?

[kinuko, 2012/10/19 04:07:19]

As we chatted I meant we shouldn't always do this but can put this part in a
separate function and call it only in tests that are related to FileSystemURL.

+    special_storage_policy_ = new quota::MockSpecialStoragePolicy;
+    file_system_context_ = new fileapi::FileSystemContext(
+        fileapi::FileSystemTaskRunners::CreateMockTaskRunners(),
+        new quota::MockSpecialStoragePolicy,

[kinuko, 2012/10/18 11:57:54]

special_storage_policy_ ?

Actually I think you can pass NULL here.

[hashimoto, 2012/10/18 13:38:13]

Sorry, something went wrong during merge.
Done.

+        NULL,
+        temp_dir_.path(),
+        fileapi::CreateDisallowFileAccessOptions());
+    file_system_context_->sandbox_provider()->ValidateFileSystemRoot(
+        GURL(kFileSystemURLOrigin), fileapi::kFileSystemTypeTemporary,
+        true /* create */, base::Bind(&OnValidateFileSystem));

[kinuko, 2012/10/18 11:57:54]

Can we instead call file_system_context_->OpenFileSystem() here?

[hashimoto, 2012/10/18 13:38:13]

Done.

+    MessageLoop::current()->RunAllPending();
+
+    ASSERT_EQ(static_cast<int>(arraysize(kTestFileData1) - 1),
+              file_util::WriteFile(temp_file1_, kTestFileData1,
+                                   arraysize(kTestFileData1) - 1));
+
+    // Prepare files on file system.
+    const char kFileSystemFilename1[] = "FileSystemFile1.dat";
+    temp_file_system_file1_ = GetFileSystemURL(kFileSystemFilename1);
+    WriteFileSystemFile(kFileSystemFilename1, kTestFileSystemFileData1,
+                        arraysize(kTestFileSystemFileData1),
+                        &temp_file_system_file_modification_time1_);
+    const char kFileSystemFilename2[] = "FileSystemFile2.dat";
+    temp_file_system_file2_ = GetFileSystemURL(kFileSystemFilename2);
+    WriteFileSystemFile(kFileSystemFilename2, kTestFileSystemFileData2,
+                        arraysize(kTestFileSystemFileData2),
+                        &temp_file_system_file_modification_time2_);
   }
 
   void TearDownTest() {
     DCHECK(MessageLoop::current() == io_thread_->message_loop());
 
+    file_system_context_ = NULL;
+
     request_.reset();
     url_request_delegate_.reset();
 
     DCHECK(!blob_url_request_job_);
     net::URLRequest::Deprecated::RegisterProtocolFactory("blob", NULL);
   }
 
   void TestFinished() {
     // We unwind the stack prior to finishing up to let stack
     // based objects get deleted.
@@ skipping 26 matching lines @@
 
     base::Closure task = task_stack_.top().first;
     bool immediate = task_stack_.top().second;
     task_stack_.pop();
     if (immediate)
       task.Run();
     else
       MessageLoop::current()->PostTask(FROM_HERE, task);
   }
 
+  static void OnValidateFileSystem(base::PlatformFileError result) {
+    ASSERT_EQ(base::PLATFORM_FILE_OK, result);
+  }
+
   void TestSuccessRequest(BlobData* blob_data,
                           const std::string& expected_response) {
     PushNextTask(base::Bind(&BlobURLRequestJobTest::VerifyResponse,
                             base::Unretained(this)));
     expected_status_code_ = 200;
     expected_response_ = expected_response;
     return TestRequest("GET", net::HttpRequestHeaders(), blob_data);
   }
 
   void TestErrorRequest(BlobData* blob_data,
                         int expected_status_code) {
     PushNextTask(base::Bind(&BlobURLRequestJobTest::VerifyResponse,
                             base::Unretained(this)));
     expected_status_code_ = expected_status_code;
     expected_response_ = "";
     return TestRequest("GET", net::HttpRequestHeaders(), blob_data);
   }
 
   void TestRequest(const std::string& method,
                    const net::HttpRequestHeaders& extra_headers,
                    BlobData* blob_data) {
     // This test has async steps.
     request_.reset(empty_context_.CreateRequest(
         GURL("blob:blah"), url_request_delegate_.get()));
     request_->set_method(method);
     blob_url_request_job_ = new BlobURLRequestJob(
         request_.get(),
         empty_context_.network_delegate(),
         blob_data,
+        file_system_context_,
         base::MessageLoopProxy::current());
 
     // Start the request.
     if (!extra_headers.IsEmpty())
       request_->SetExtraRequestHeaders(extra_headers);
     request_->Start();
 
     // Completion is async.
   }
 
@@ skipping 50 matching lines @@
     TestErrorRequest(blob_data, 404);
   }
 
   void TestGetSlicedFileRequest() {
     scoped_refptr<BlobData> blob_data(new BlobData());
     blob_data->AppendFile(temp_file1_, 2, 4, temp_file_modification_time1_);
     std::string result(kTestFileData1 + 2, 4);
     TestSuccessRequest(blob_data, result);
   }
 
+  void TestGetSimpleFileSystemFileRequest() {
+    scoped_refptr<BlobData> blob_data(new BlobData());
+    blob_data->AppendFileSystemFile(temp_file_system_file1_, 0, -1,
+                                    base::Time());
+    TestSuccessRequest(blob_data, kTestFileSystemFileData1);
+  }
+
+  void TestGetLargeFileSystemFileRequest() {
+    std::string large_data;
+    large_data.reserve(kBufferSize * 5);
+    for (int i = 0; i < kBufferSize * 5; ++i)
+      large_data.append(1, static_cast<char>(i % 256));
+
+    const char kFilename[] = "LargeBlob.dat";
+    WriteFileSystemFile(kFilename, large_data.data(), large_data.size(), NULL);
+
+    scoped_refptr<BlobData> blob_data(new BlobData());
+    blob_data->AppendFileSystemFile(GetFileSystemURL(kFilename),
+                                    0, -1, base::Time());
+    TestSuccessRequest(blob_data, large_data);
+  }
+
+  void TestGetNonExistentFileSystemFileRequest() {
+    GURL non_existent_file = GetFileSystemURL("non-existent.dat");
+    scoped_refptr<BlobData> blob_data(new BlobData());
+    blob_data->AppendFileSystemFile(non_existent_file, 0, -1, base::Time());
+    TestErrorRequest(blob_data, 404);
+  }
+
+  void TestGetChangedFileSystemFileRequest() {
+    scoped_refptr<BlobData> blob_data(new BlobData());
+    base::Time old_time =
+        temp_file_system_file_modification_time1_ -
+        base::TimeDelta::FromSeconds(10);
+    blob_data->AppendFileSystemFile(temp_file_system_file1_, 0, 3, old_time);
+    TestErrorRequest(blob_data, 404);
+  }
+
+  void TestGetSlicedFileSystemFileRequest() {
+    scoped_refptr<BlobData> blob_data(new BlobData());
+    blob_data->AppendFileSystemFile(temp_file_system_file1_, 2, 4,
+                                    temp_file_system_file_modification_time1_);
+    std::string result(kTestFileSystemFileData1 + 2, 4);
+    TestSuccessRequest(blob_data, result);
+  }
+
   scoped_refptr<BlobData> BuildComplicatedData(std::string* expected_result) {
     scoped_refptr<BlobData> blob_data(new BlobData());
     blob_data->AppendData(kTestData1 + 1, 2);
     blob_data->AppendFile(temp_file1_, 2, 3, temp_file_modification_time1_);
-    blob_data->AppendData(kTestData2 + 3, 4);
-    blob_data->AppendFile(temp_file2_, 4, 5, temp_file_modification_time2_);
+    blob_data->AppendFileSystemFile(temp_file_system_file1_, 3, 4,
+                                    temp_file_system_file_modification_time1_);
+    blob_data->AppendData(kTestData2 + 4, 5);
+    blob_data->AppendFile(temp_file2_, 5, 6, temp_file_modification_time2_);
+    blob_data->AppendFileSystemFile(temp_file_system_file2_, 6, 7,
+                                    temp_file_system_file_modification_time2_);
     *expected_result = std::string(kTestData1 + 1, 2);
     *expected_result += std::string(kTestFileData1 + 2, 3);
-    *expected_result += std::string(kTestData2 + 3, 4);
-    *expected_result += std::string(kTestFileData2 + 4, 5);
+    *expected_result += std::string(kTestFileSystemFileData1 + 3, 4);
+    *expected_result += std::string(kTestData2 + 4, 5);
+    *expected_result += std::string(kTestFileData2 + 5, 6);
+    *expected_result += std::string(kTestFileSystemFileData2 + 6, 7);
     return blob_data;
   }
 
   void TestGetComplicatedDataAndFileRequest() {
     std::string result;
     scoped_refptr<BlobData> blob_data = BuildComplicatedData(&result);
     TestSuccessRequest(blob_data, result);
   }
 
   void TestGetRangeRequest1() {
@@ skipping 45 matching lines @@
     EXPECT_STREQ(content_disposition.c_str(), kTestContentDisposition);
     TestFinished();
   }
 
  private:
   ScopedTempDir temp_dir_;
   FilePath temp_file1_;
   FilePath temp_file2_;
   base::Time temp_file_modification_time1_;
   base::Time temp_file_modification_time2_;
+  GURL temp_file_system_file1_;
+  GURL temp_file_system_file2_;
+  base::Time temp_file_system_file_modification_time1_;
+  base::Time temp_file_system_file_modification_time2_;
   scoped_ptr<base::Thread> io_thread_;
   static BlobURLRequestJob* blob_url_request_job_;
 
   scoped_ptr<base::WaitableEvent> test_finished_event_;
   std::stack<std::pair<base::Closure, bool> > task_stack_;
   net::URLRequestContext empty_context_;
   scoped_ptr<net::URLRequest> request_;
   scoped_ptr<MockURLRequestDelegate> url_request_delegate_;
+  scoped_refptr<quota::MockSpecialStoragePolicy> special_storage_policy_;
+  scoped_refptr<fileapi::FileSystemContext> file_system_context_;
   int expected_status_code_;
   std::string expected_response_;
 };
 
 // static
 BlobURLRequestJob* BlobURLRequestJobTest::blob_url_request_job_ = NULL;
 
 TEST_F(BlobURLRequestJobTest, TestGetSimpleDataRequest) {
   RunTestOnIOThread(&BlobURLRequestJobTest::TestGetSimpleDataRequest);
 }
@@ skipping 11 matching lines @@
 }
 
 TEST_F(BlobURLRequestJobTest, TestGetNonExistentFileRequest) {
   RunTestOnIOThread(&BlobURLRequestJobTest::TestGetNonExistentFileRequest);
 }
 
 TEST_F(BlobURLRequestJobTest, TestGetChangedFileRequest) {
   RunTestOnIOThread(&BlobURLRequestJobTest::TestGetChangedFileRequest);
 }
 
+TEST_F(BlobURLRequestJobTest, TestGetSimpleFileSystemFileRequest) {
+  RunTestOnIOThread(&BlobURLRequestJobTest::TestGetSimpleFileSystemFileRequest);
+}
+
+TEST_F(BlobURLRequestJobTest, TestGetLargeFileSystemFileRequest) {
+  RunTestOnIOThread(&BlobURLRequestJobTest::TestGetLargeFileSystemFileRequest);
+}
+
+TEST_F(BlobURLRequestJobTest, TestGetSlicedFileSystemFileRequest) {
+  RunTestOnIOThread(&BlobURLRequestJobTest::TestGetSlicedFileSystemFileRequest);
+}
+
+TEST_F(BlobURLRequestJobTest, TestGetNonExistentFileSystemFileRequest) {
+  RunTestOnIOThread(
+      &BlobURLRequestJobTest::TestGetNonExistentFileSystemFileRequest);
+}
+
+TEST_F(BlobURLRequestJobTest, TestGetChangedFileSystemFileRequest) {
+  RunTestOnIOThread(
+      &BlobURLRequestJobTest::TestGetChangedFileSystemFileRequest);
+}
+
 TEST_F(BlobURLRequestJobTest, TestGetComplicatedDataAndFileRequest) {
   RunTestOnIOThread(
       &BlobURLRequestJobTest::TestGetComplicatedDataAndFileRequest);
 }
 
 TEST_F(BlobURLRequestJobTest, TestGetRangeRequest1) {
   RunTestOnIOThread(&BlobURLRequestJobTest::TestGetRangeRequest1);
 }
 
 TEST_F(BlobURLRequestJobTest, TestGetRangeRequest2) {
   RunTestOnIOThread(&BlobURLRequestJobTest::TestGetRangeRequest2);
 }
 
 TEST_F(BlobURLRequestJobTest, TestExtraHeaders) {
   RunTestOnIOThread(&BlobURLRequestJobTest::TestExtraHeaders);
 }
 
 }  // namespace webkit_blob