google_apis: Add a test for uploading a large file

chrome/browser/google_apis/gdata_wapi_operations_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 "base/bind.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/json/json_reader.h"
 #include "base/message_loop_proxy.h"
 #include "base/string_number_conversions.h"
+#include "base/string_split.h"
 #include "base/stringprintf.h"
 #include "chrome/browser/google_apis/gdata_wapi_operations.h"
 #include "chrome/browser/google_apis/gdata_wapi_parser.h"
 #include "chrome/browser/google_apis/gdata_wapi_url_generator.h"
 #include "chrome/browser/google_apis/operation_registry.h"
 #include "chrome/browser/google_apis/test_server/http_server.h"
 #include "chrome/browser/google_apis/test_util.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/test/base/testing_browser_process.h"
 #include "chrome/test/base/testing_profile.h"
@@ skipping 103 matching lines @@
 bool RemovePrefix(const std::string& input,
                   const std::string& prefix,
                   std::string* output) {
   if (!StartsWithASCII(input, prefix, true /* case sensitive */))
     return false;
 
   *output = input.substr(prefix.size());
   return true;
 }
 
+// Parses a value of Content-Range header, which looks like
+// "bytes <start_position>-<end_position>/<length>".
+// Returns true on success.
+bool ParseContentRangeHeader(const std::string& value,
+                             int64* start_position,
+                             int64* end_position,
+                             int64* length) {
+  DCHECK(start_position);
+  DCHECK(end_position);
+  DCHECK(length);
+
+  std::string remaining;
+  if (!RemovePrefix(value, "bytes ", &remaining))
+    return false;
+
+  std::vector<std::string> parts;
+  base::SplitString(remaining, '/', &parts);
+  if (parts.size() != 2U)
+    return false;
+
+  const std::string range = parts[0];
+  if (!base::StringToInt64(parts[1], length))
+    return false;
+
+  parts.clear();
+  base::SplitString(range, '-', &parts);
+  if (parts.size() != 2U)
+    return false;
+
+  return (base::StringToInt64(parts[0], start_position) &&
+          base::StringToInt64(parts[1], end_position));
+}
+
 // This class sets a request context getter for testing in
 // |testing_browser_process| and then clears the state when an instance of it
 // goes out of scope.
 class ScopedRequestContextGetterForTesting {
  public:
   ScopedRequestContextGetterForTesting(
       TestingBrowserProcess* testing_browser_process)
       : testing_browser_process_(testing_browser_process) {
     context_getter_ = new net::TestURLRequestContextGetter(
         content::BrowserThread::GetMessageLoopProxyForThread(
@@ skipping 178 matching lines @@
   scoped_ptr<test_server::HttpResponse> HandleUploadRequest(
       const test_server::HttpRequest& request) {
     http_request_ = request;
 
     const GURL absolute_url = test_server_.GetURL(request.relative_url);
     if (absolute_url.path() != "/upload_url")
       return scoped_ptr<test_server::HttpResponse>();
 
     // TODO(satorux): We should create a correct entry for the uploaded file,
     // but for now, just return entry.xml.
-    return CreateHttpResponseFromFile(
-        test_util::GetTestFilePath("gdata/entry.xml"));
+    scoped_ptr<test_server::HttpResponse> response =
+        CreateHttpResponseFromFile(
+            test_util::GetTestFilePath("gdata/entry.xml"));
+
+    // Check if the Content-Range header is present. This must be present if
+    // the request body is not empty.
+    if (!request.content.empty()) {
+      std::map<std::string, std::string>::const_iterator iter =
+          request.headers.find("Content-Range");
+      if (iter == request.headers.end())
+        return scoped_ptr<test_server::HttpResponse>();
+      int64 start_position = 0;
+      int64 end_position = 0;
+      int64 length = 0;
+      if (!ParseContentRangeHeader(iter->second,
+                                   &start_position,
+                                   &end_position,
+                                   &length)) {
+        return scoped_ptr<test_server::HttpResponse>();
+      }
+
+      // Add Range header to the response, based on the values of
+      // Content-Range header in the request.
+      response->AddCustomHeader(
+          "Range",
+          "bytes=" +
+          base::Int64ToString(start_position) + "-" +
+          base::Int64ToString(end_position));
+
+      // Change the response code if this is not the end of an upload.
+      if (end_position + 1 < length)
+        response->set_code(test_server::RESUME_INCOMPLETE);
+    }
+
+    return response.Pass();
   }
 
   MessageLoopForUI message_loop_;
   content::TestBrowserThread ui_thread_;
   content::TestBrowserThread file_thread_;
   content::TestBrowserThread io_thread_;
   test_server::HttpServer test_server_;
   scoped_ptr<TestingProfile> profile_;
   OperationRegistry operation_registry_;
   scoped_ptr<GDataWapiUrlGenerator> url_generator_;
@@ skipping 511 matching lines @@
       new ResumeUploadOperation(
           &operation_registry_,
           base::Bind(&CopyResultFromResumeUploadCallbackAndQuit,
                      &response,
                      &new_entry),
           resume_params);
 
   resume_operation->Start(kTestGDataAuthToken, kTestUserAgent);
   MessageLoop::current()->Run();
 
-  EXPECT_EQ(HTTP_SUCCESS, result_code);
   // METHOD_PUT should be used to upload data.
   EXPECT_EQ(test_server::METHOD_PUT, http_request_.method);
   // Request should go to the upload URL.
   EXPECT_EQ(upload_url.path(), http_request_.relative_url);
   // Content-Range header should be added.
   EXPECT_EQ("bytes 0-" +
             base::Int64ToString(kUploadContent.size() -1) + "/" +
             base::Int64ToString(kUploadContent.size()),
             http_request_.headers["Content-Range"]);
   // The upload content should be set in the HTTP request.
   EXPECT_TRUE(http_request_.has_content);
   EXPECT_EQ(kUploadContent, http_request_.content);
+
+  // Check the response.
+  EXPECT_EQ(HTTP_SUCCESS, response.code);
+  // The start and end positions should be set to -1, if an upload is complete.
+  EXPECT_EQ(-1, response.start_range_received);
+  EXPECT_EQ(-1, response.end_range_received);
 }
 
 // This test exercises InitiateUploadOperation and ResumeUploadOperation for
+// a scenario of uploading a new *large* file, which requires mutiple requests
+// of ResumeUploadOperation.
+TEST_F(GDataWapiOperationsTest, UploadNewLargeFile) {
+  const size_t kMaxNumBytes = 10;
+  // This is big enough to cause multiple requests of ResumeUploadOperation
+  // as we are gonig to send at most kMaxNumBytes at a time.
+  const std::string kUploadContent(kMaxNumBytes + 1, 'a');
+  GDataErrorCode result_code = GDATA_OTHER_ERROR;
+  GURL upload_url;
+
+  // 1) Get the upload URL for uploading a new file.
+  InitiateUploadParams initiate_params(
+      UPLOAD_NEW_FILE,
+      "New file",
+      "text/plain",
+      kUploadContent.size(),
+      test_server_.GetURL("/feeds/upload/create-session/default/private/full"),
+      FilePath::FromUTF8Unsafe("drive/newfile.txt"));
+
+  InitiateUploadOperation* initiate_operation =
+      new InitiateUploadOperation(
+          &operation_registry_,
+          base::Bind(&CopyResultFromInitiateUploadCallbackAndQuit,
+                     &result_code,
+                     &upload_url),
+          initiate_params);
+
+  initiate_operation->Start(kTestGDataAuthToken, kTestUserAgent);
+  MessageLoop::current()->Run();
+
+  EXPECT_EQ(HTTP_SUCCESS, result_code);
+  EXPECT_EQ(test_server_.GetURL("/upload_url"), upload_url);
+  EXPECT_EQ(test_server::METHOD_POST, http_request_.method);
+  // convert=false should be passed as files should be uploaded as-is.
+  EXPECT_EQ("/feeds/upload/create-session/default/private/full?convert=false",
+            http_request_.relative_url);
+  EXPECT_EQ("text/plain", http_request_.headers["X-Upload-Content-Type"]);
+  EXPECT_EQ("application/atom+xml", http_request_.headers["Content-Type"]);
+  EXPECT_EQ(base::Int64ToString(kUploadContent.size()),
+            http_request_.headers["X-Upload-Content-Length"]);
+
+  EXPECT_TRUE(http_request_.has_content);
+  EXPECT_EQ("<?xml version=\"1.0\"?>\n"
+            "<entry xmlns=\"http://www.w3.org/2005/Atom\" "
+            "xmlns:docs=\"http://schemas.google.com/docs/2007\">\n"
+            " <title>New file</title>\n"
+            "</entry>\n",
+            http_request_.content);
+
+  // 2) Upload the content to the upload URL with multiple requests.
+  size_t num_bytes_consumed = 0;
+  for (size_t start_position = 0; start_position < kUploadContent.size();
+       start_position += kMaxNumBytes) {
+    SCOPED_TRACE(testing::Message("start_position: ") << start_position);
+
+    // The payload is at most kMaxNumBytes.
+    const size_t remaining_size = kUploadContent.size() - start_position;
+    const std::string payload = kUploadContent.substr(
+        start_position, std::min(kMaxNumBytes, remaining_size));
+    num_bytes_consumed += payload.size();
+    // The end position is inclusive, hence -1.
+    const size_t end_position = start_position + payload.size() - 1;
+
+    scoped_refptr<net::IOBuffer> buffer = new net::StringIOBuffer(payload);
+    ResumeUploadParams resume_params(
+        UPLOAD_NEW_FILE,
+        start_position,  // start_range
+        end_position,  // end_range
+        kUploadContent.size(),  // content_length,
+        "text/plain",  // content_type
+        buffer,
+        upload_url,
+        FilePath::FromUTF8Unsafe("drive/newfile.txt"));
+
+    ResumeUploadResponse response;
+    scoped_ptr<DocumentEntry> new_entry;
+
+    ResumeUploadOperation* resume_operation =
+        new ResumeUploadOperation(
+            &operation_registry_,
+            base::Bind(&CopyResultFromResumeUploadCallbackAndQuit,
+                       &response,
+                       &new_entry),
+            resume_params);
+
+    resume_operation->Start(kTestGDataAuthToken, kTestUserAgent);
+    MessageLoop::current()->Run();
+
+    // METHOD_PUT should be used to upload data.
+    EXPECT_EQ(test_server::METHOD_PUT, http_request_.method);
+    // Request should go to the upload URL.
+    EXPECT_EQ(upload_url.path(), http_request_.relative_url);
+    // Content-Range header should be added.
+    EXPECT_EQ("bytes " +
+              base::Int64ToString(start_position) + "-" +
+              base::Int64ToString(end_position) + "/" +
+              base::Int64ToString(kUploadContent.size()),
+              http_request_.headers["Content-Range"]);
+    // The upload content should be set in the HTTP request.
+    EXPECT_TRUE(http_request_.has_content);
+    EXPECT_EQ(payload, http_request_.content);
+
+    // Check the response.
+    if (payload.size() == remaining_size) {
+      EXPECT_EQ(HTTP_SUCCESS, response.code);

[kinaba, 2012/12/03 04:37:57]

The expected response code for UPLOAD_NEW_FILE mode is HTTP_CREATED, not
HTTP_SUCCESS. We may want to exercise the difference in the tests here, because
both the internals of ResumeUploadOperation and the client DriveUploader code
are distinguishing them.
 (Sorry I should have noticed this in the previous patch :(.)

[satorux1, 2012/12/03 05:02:22]

Good catch! Fixed!

+      // The start and end positions should be set to -1, if an upload is
+      // complete.
+      EXPECT_EQ(-1, response.start_range_received);
+      EXPECT_EQ(-1, response.end_range_received);
+    } else {
+      EXPECT_EQ(HTTP_RESUME_INCOMPLETE, response.code);
+      EXPECT_EQ(static_cast<int64>(start_position),
+                response.start_range_received);
+      EXPECT_EQ(static_cast<int64>(end_position),
+                response.end_range_received);
+    }
+  }
+
+  EXPECT_EQ(kUploadContent.size(), num_bytes_consumed);
+}
+
+// This test exercises InitiateUploadOperation and ResumeUploadOperation for
 // a scenario of uploading a new *empty* file.
 //
 // The test is almost identical to UploadNewFile. The only difference is the
 // expectation for the Content-Range header.
 TEST_F(GDataWapiOperationsTest, UploadNewEmptyFile) {
   const std::string kUploadContent = "";
   GDataErrorCode result_code = GDATA_OTHER_ERROR;
   GURL upload_url;
 
   // 1) Get the upload URL for uploading a new file.
@@ skipping 54 matching lines @@
       new ResumeUploadOperation(
           &operation_registry_,
           base::Bind(&CopyResultFromResumeUploadCallbackAndQuit,
                      &response,
                      &new_entry),
           resume_params);
 
   resume_operation->Start(kTestGDataAuthToken, kTestUserAgent);
   MessageLoop::current()->Run();
 
-  EXPECT_EQ(HTTP_SUCCESS, result_code);
   // METHOD_PUT should be used to upload data.
   EXPECT_EQ(test_server::METHOD_PUT, http_request_.method);
   // Request should go to the upload URL.
   EXPECT_EQ(upload_url.path(), http_request_.relative_url);
   // Content-Range header should not exit if the content is empty.
   // We should not generate the header with an invalid value "bytes 0--1/0".
   EXPECT_EQ(0U, http_request_.headers.count("Content-Range"));
   // The upload content should be set in the HTTP request.
   EXPECT_TRUE(http_request_.has_content);
   EXPECT_EQ(kUploadContent, http_request_.content);
+
+  // Check the response.
+  EXPECT_EQ(HTTP_SUCCESS, response.code);
+  // The start and end positions should be set to -1, if an upload is complete.
+  EXPECT_EQ(-1, response.start_range_received);
+  EXPECT_EQ(-1, response.end_range_received);
 }
 
 // This test exercises InitiateUploadOperation and ResumeUploadOperation for
 // a scenario of updating an existing file.
 TEST_F(GDataWapiOperationsTest, UploadExistingFile) {
   const std::string kUploadContent = "hello";
   GDataErrorCode result_code = GDATA_OTHER_ERROR;
   GURL upload_url;
 
   // 1) Get the upload URL for uploading an existing file.
@@ skipping 55 matching lines @@
       new ResumeUploadOperation(
           &operation_registry_,
           base::Bind(&CopyResultFromResumeUploadCallbackAndQuit,
                      &response,
                      &new_entry),
           resume_params);
 
   resume_operation->Start(kTestGDataAuthToken, kTestUserAgent);
   MessageLoop::current()->Run();
 
-  EXPECT_EQ(HTTP_SUCCESS, result_code);
   // METHOD_PUT should be used to upload data.
   EXPECT_EQ(test_server::METHOD_PUT, http_request_.method);
   // Request should go to the upload URL.
   EXPECT_EQ(upload_url.path(), http_request_.relative_url);
   // Content-Range header should be added.
   EXPECT_EQ("bytes 0-" +
             base::Int64ToString(kUploadContent.size() -1) + "/" +
             base::Int64ToString(kUploadContent.size()),
             http_request_.headers["Content-Range"]);
   // The upload content should be set in the HTTP request.
   EXPECT_TRUE(http_request_.has_content);
   EXPECT_EQ(kUploadContent, http_request_.content);
+
+  // Check the response.
+  EXPECT_EQ(HTTP_SUCCESS, response.code);
+  // The start and end positions should be set to -1, if an upload is complete.
+  EXPECT_EQ(-1, response.start_range_received);
+  EXPECT_EQ(-1, response.end_range_received);
 }
 
 }  // namespace google_apis