Add read-only access to POST data for webRequest's onBeforeRequest

chrome/browser/extensions/api/web_request/web_request_api_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 <queue>
 #include <map>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/file_util.h"
@@ skipping 55 matching lines @@
 }
 
 // Searches |key| in |collection| by iterating over its elements and returns
 // true if found.
 template <typename Collection, typename Key>
 bool Contains(const Collection& collection, const Key& key) {
   return std::find(collection.begin(), collection.end(), key) !=
       collection.end();
 }
 
+// Inspects the data attached to the |message| and tries to extract its
+// "postData" section into |post_data|.
+void GetPostData(IPC::Message* message, std::string* post_data, bool* success) {

[battre, 2012/07/16 17:39:45]

nit: return boolean instead of passing bool* success?

[vabr (Chromium), 2012/07/17 11:11:11]

That would not work, ASSERT_* cannot be used in non-void functions.

[battre, 2012/07/17 12:46:07]

You can replace all ASSERT_* statements with CHECK statements because they would
indicate that the input is invalid.

[vabr (Chromium), 2012/07/17 13:04:52]

Done.

+  ASSERT_TRUE(success != NULL);
+  *success = false;
+  ASSERT_EQ(message->type(), ExtensionMsg_MessageInvoke::ID);

[battre, 2012/07/16 17:39:45]

as message is provided and not generated by the tested code, I would use a CHECK
here.

[vabr (Chromium), 2012/07/17 11:11:11]

Done.
QUESTION:
Do you want me to change this also for the first line of TestIPCSender::Send() ?

+  ExtensionMsg_MessageInvoke::Param param;
+  Value* temp_value = NULL;
+  ASSERT_TRUE(ExtensionMsg_MessageInvoke::Read(message, &param));
+  ASSERT_GE(param.c.GetSize(), static_cast<size_t>(2));
+  ASSERT_TRUE(param.c.Get(1, &temp_value));
+  std::string args;
+  ASSERT_TRUE(temp_value->GetAsString(&args));

[battre, 2012/07/16 17:39:45]

nit: new line after 88?

[vabr (Chromium), 2012/07/17 11:11:11]

Done.

+  const char kPostDataHead[] = "\"postData\":{";
+  size_t post_data_start = args.find(kPostDataHead);
+  if (post_data_start == std::string::npos)
+    return;
+  post_data_start += strlen(kPostDataHead);

[battre, 2012/07/16 17:39:45]

nit: new line after 93?

[vabr (Chromium), 2012/07/17 11:11:11]

Done.

+  const size_t post_data_end = args.find("}", post_data_start);
+  ASSERT_NE(post_data_end, std::string::npos);
+  const size_t post_data_length = post_data_end - post_data_start;
+  *post_data = std::string(args, post_data_start, post_data_length);
+  *success = true;
+  return;
+}
+
 }  // namespace
 
 // A mock event router that responds to events with a pre-arranged queue of
 // Tasks.
 class TestIPCSender : public IPC::Sender {
  public:
   typedef std::list<linked_ptr<IPC::Message> > SentMessages;
 
   // Adds a Task to the queue. We will fire these in order as events are
   // dispatched.
@@ skipping 40 matching lines @@
     enable_referrers_.Init(
         prefs::kEnableReferrers, profile_.GetTestingPrefService(), NULL);
     network_delegate_.reset(new ChromeNetworkDelegate(
         event_router_.get(), NULL, NULL, &profile_,
         CookieSettings::Factory::GetForProfile(&profile_), &enable_referrers_));
     context_.reset(new TestURLRequestContext(true));
     context_->set_network_delegate(network_delegate_.get());
     context_->Init();
   }
 
+  void FireURLRequestWithPostData(const char* content_type, const char* bytes);
+
   MessageLoopForIO message_loop_;
   content::TestBrowserThread ui_thread_;
   content::TestBrowserThread io_thread_;
   TestingProfile profile_;
   TestDelegate delegate_;
   BooleanPrefMember enable_referrers_;
   TestIPCSender ipc_sender_;
   scoped_refptr<ExtensionEventRouterForwarder> event_router_;
   scoped_refptr<ExtensionInfoMap> extension_info_map_;
   scoped_ptr<ChromeNetworkDelegate> network_delegate_;
@@ skipping 245 matching lines @@
   EXPECT_TRUE(!request.is_pending());
   EXPECT_EQ(net::URLRequestStatus::CANCELED, request.status().status());
   EXPECT_EQ(net::ERR_ABORTED, request.status().error());
   EXPECT_EQ(request_url, request.url());
   EXPECT_EQ(1U, request.url_chain().size());
   EXPECT_EQ(0U, ipc_sender_.GetNumTasks());
 
   ExtensionWebRequestEventRouter::GetInstance()->RemoveEventListener(
       &profile_, extension_id, kEventName + "/1");
   ExtensionWebRequestEventRouter::GetInstance()->RemoveEventListener(
-        &profile_, extension_id, kEventName2 + "/1");
+      &profile_, extension_id, kEventName2 + "/1");
+}
+
+// Fires a URLRequest with the specified |content_type|. Method will be "POST"
+// and the data will be |bytes|.

[battre, 2012/07/16 17:39:45]

the comment goes to the declaration above.

[vabr (Chromium), 2012/07/17 11:11:11]

Done.

+void ExtensionWebRequestTest::FireURLRequestWithPostData(
+    const char* content_type,
+    const char* bytes) {
+  // The request URL can be arbitrary but must have a HTTP or HTTPS scheme.

[battre, 2012/07/16 17:39:45]

nit: s/a HTTP/an HTTP/

[vabr (Chromium), 2012/07/17 11:11:11]

Done.

+  GURL request_url("http://www.example.com");
+  net::URLRequest request(request_url, &delegate_, context_.get());
+  request.set_method("POST");
+  request.SetExtraRequestHeaderByName("Content-Type", content_type, true);
+  request.AppendBytesToUpload(bytes, strlen(bytes));
+  ipc_sender_.PushTask(base::Bind(&base::DoNothing));
+  request.Start();
+}

[battre, 2012/07/16 17:39:45]

nit: empty line

[vabr (Chromium), 2012/07/17 11:11:11]

Done.

+TEST_F(ExtensionWebRequestTest, AccessPostData) {
+  // We verify that POST data are accessible to OnBeforeRequest listeners.
+  // Construct the test data.
+#define kBoundary "THIS_IS_A_BOUNDARY"
+#define kBlock "--" kBoundary "\r\n" \
+    "Content-Disposition: form-data; name=\"text\"\r\n" \
+    "\r\n" \
+    "test text\r\n" \
+    "--" kBoundary "--"
+  // POST data input.
+  const char kMultipartBytes[] = kBlock;
+  // POST data output.
+  const char kResultString[] = "\"text\":[\"test text\"]";
+  // Header.
+  const char kMultipart[] = "multipart/form-data; boundary=" kBoundary;
+#undef kBlock
+#undef kBoundary
+  bool kSuccessExpected[] = {true, false};
+
+  // Set up a dummy extension name.
+  ExtensionWebRequestEventRouter::RequestFilter filter;
+  std::string extension_id("1");
+  int extra_info_spec_post =
+      ExtensionWebRequestEventRouter::ExtraInfoSpec::BLOCKING |
+      ExtensionWebRequestEventRouter::ExtraInfoSpec::REQUEST_POST_DATA;
+  int extra_info_spec_no_post =
+      ExtensionWebRequestEventRouter::ExtraInfoSpec::BLOCKING;
+
+  // Subscribe to OnBeforeRequest with POST data requirement.
+  const std::string kEventName(keys::kOnBeforeRequest);
+  base::WeakPtrFactory<TestIPCSender> ipc_sender_factory(&ipc_sender_);
+  ExtensionWebRequestEventRouter::GetInstance()->AddEventListener(
+    &profile_, extension_id, extension_id, kEventName, kEventName + "/1",

[battre, 2012/07/16 17:39:45]

nit: +2 spaces

[vabr (Chromium), 2012/07/17 11:11:11]

Done.

+    filter, extra_info_spec_post, ipc_sender_factory.GetWeakPtr());
+
+  FireURLRequestWithPostData(kMultipart, kMultipartBytes);
+
+  MessageLoop::current()->RunAllPending();
+
+  // Now remove the requirement of POST data.
+  ExtensionWebRequestEventRouter::GetInstance()->RemoveEventListener(
+      &profile_, extension_id, kEventName + "/1");
+  ExtensionWebRequestEventRouter::GetInstance()->AddEventListener(
+    &profile_, extension_id, extension_id, kEventName, kEventName + "/1",

[battre, 2012/07/16 17:39:45]

+2 spaces

[vabr (Chromium), 2012/07/17 11:11:11]

Done.

+    filter, extra_info_spec_no_post, ipc_sender_factory.GetWeakPtr());
+
+  FireURLRequestWithPostData(kMultipart, kMultipartBytes);
+
+  MessageLoop::current()->RunAllPending();
+
+  IPC::Message* message = NULL;
+  std::string post_data;
+  TestIPCSender::SentMessages::const_iterator i = ipc_sender_.sent_begin();
+  for (size_t test = 0; test < arraysize(kSuccessExpected); ++test) {
+    EXPECT_NE(i, ipc_sender_.sent_end());
+    message = (i++)->get();
+    bool post_data_found;
+    GetPostData(message, &post_data, &post_data_found);
+    if (kSuccessExpected[test]) {
+      EXPECT_TRUE(post_data_found);

[battre, 2012/07/16 17:39:45]

if you write
EXPECT_TRUE(post_data_found) << test;
an error message is slightly simpler to analyze.

[vabr (Chromium), 2012/07/17 11:11:11]

Done. Thanks for teaching me this. :)

+      EXPECT_EQ(kResultString, post_data);
+    } else {
+      EXPECT_FALSE(post_data_found);
+    }
+  }
+
+  EXPECT_TRUE(i == ipc_sender_.sent_end());

[battre, 2012/07/16 17:39:45]

Does EXPECT_EQ work?

[vabr (Chromium), 2012/07/17 11:11:11]

Done. It seems to work, just as the EXPECT_NE a couple of lines above. I don't
know why I started with EXPECT_TRUE.

+
+  // Clean-up.
+  ExtensionWebRequestEventRouter::GetInstance()->RemoveEventListener(
+      &profile_, extension_id, kEventName + "/1");
 }
 
 struct HeaderModificationTest_Header {
   const char* name;
   const char* value;
 };
 
 struct HeaderModificationTest_Modification {
   enum Type {
     SET,
@@ skipping 244 matching lines @@
       true,
       ExtensionWebRequestEventRouter::ExtraInfoSpec::RESPONSE_HEADERS);
   TestInitFromValue(
       "blocking",
       true,
       ExtensionWebRequestEventRouter::ExtraInfoSpec::BLOCKING);
   TestInitFromValue(
       "asyncBlocking",
       true,
       ExtensionWebRequestEventRouter::ExtraInfoSpec::ASYNC_BLOCKING);
+  TestInitFromValue(
+      "requestPostData",
+      true,
+      ExtensionWebRequestEventRouter::ExtraInfoSpec::REQUEST_POST_DATA);
 
   // Multiple valid values are bitwise-or'ed.
   TestInitFromValue(
       "requestHeaders,blocking",
       true,
       ExtensionWebRequestEventRouter::ExtraInfoSpec::REQUEST_HEADERS |
       ExtensionWebRequestEventRouter::ExtraInfoSpec::BLOCKING);
 
   // Any invalid values lead to a bad parse.
   TestInitFromValue("invalidValue", false, 0);
@@ skipping 849 matching lines @@
   // Check that requests are rejected if their first party url is sensitive.
   ASSERT_GE(arraysize(non_sensitive_urls), 1u);
   GURL non_sensitive_url(non_sensitive_urls[0]);
   for (size_t i = 0; i < arraysize(sensitive_urls); ++i) {
     TestURLRequest request(non_sensitive_url, NULL, &context);
     GURL sensitive_url(sensitive_urls[i]);
     request.set_first_party_for_cookies(sensitive_url);
     EXPECT_TRUE(helpers::HideRequest(&request)) << sensitive_urls[i];
   }
 }