[Autofill] Migrate ContentAutofillDriver<-->AutofillAgent IPCs to mojo.

components/autofill/content/browser/content_autofill_driver_unittest.cc

 // Copyright 2014 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 "components/autofill/content/browser/content_autofill_driver.h"
 
 #include <stdint.h>
 
 #include <algorithm>
 #include <memory>
 #include <tuple>
 #include <utility>
 #include <vector>
 
 #include "base/command_line.h"
+#include "base/message_loop/message_loop.h"
+#include "base/run_loop.h"
 #include "base/strings/utf_string_conversions.h"
 #include "components/autofill/content/common/autofill_messages.h"
 #include "components/autofill/core/browser/autofill_external_delegate.h"
 #include "components/autofill/core/browser/autofill_manager.h"
 #include "components/autofill/core/browser/autofill_test_utils.h"
 #include "components/autofill/core/browser/test_autofill_client.h"
 #include "components/autofill/core/common/autofill_switches.h"
 #include "components/autofill/core/common/form_data_predictions.h"
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/navigation_details.h"
 #include "content/public/browser/storage_partition.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/frame_navigate_params.h"
+#include "content/public/common/service_registry.h"
 #include "content/public/test/mock_render_process_host.h"
 #include "content/public/test/test_renderer_host.h"
 #include "ipc/ipc_test_sink.h"
+#include "mojo/public/cpp/bindings/binding_set.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace autofill {
 
 namespace {
 
 const char kAppLocale[] = "en-US";
 const AutofillManager::AutofillDownloadManagerState kDownloadState =
     AutofillManager::DISABLE_AUTOFILL_DOWNLOAD_MANAGER;
 
+void RunAllPendingTasks() {
+  base::RunLoop run_loop;
+  base::MessageLoop::current()->PostTask(
+      FROM_HERE, base::MessageLoop::QuitWhenIdleClosure());

[yzshen1, 2016/05/24 16:12:10]

QuitWhenIdleClosure is deprecated according to the comments in message_loop.h.

You might want to use corresponding RunLoop method.

[leonhsl(Using Gerrit), 2016/06/23 10:00:12]

Done.

+  run_loop.Run();
+}
+
 }  // namespace
 
 class MockAutofillManager : public AutofillManager {
  public:
   MockAutofillManager(AutofillDriver* driver, AutofillClient* client)
       : AutofillManager(driver, client, kAppLocale, kDownloadState) {}
   virtual ~MockAutofillManager() {}
 
   MOCK_METHOD0(Reset, void());
 };
 
 class TestContentAutofillDriver : public ContentAutofillDriver {
  public:
   TestContentAutofillDriver(content::RenderFrameHost* rfh,
                             AutofillClient* client)
       : ContentAutofillDriver(rfh, client, kAppLocale, kDownloadState) {
     std::unique_ptr<AutofillManager> autofill_manager(
         new MockAutofillManager(this, client));
     SetAutofillManager(std::move(autofill_manager));
   }
   ~TestContentAutofillDriver() override {}
 
   virtual MockAutofillManager* mock_autofill_manager() {
     return static_cast<MockAutofillManager*>(autofill_manager());
   }
 
   using ContentAutofillDriver::DidNavigateFrame;
 };
 
-class ContentAutofillDriverTest : public content::RenderViewHostTestHarness {
+class ContentAutofillDriverTest : public content::RenderViewHostTestHarness,
+                                  public mojom::AutofillAgent {

[vabr (Chromium), 2016/05/24 08:08:20]

Please aggregate a test version of an mojom::AutofillAgent into
ContentAutofillDriverTest as a data member instead of inheriting from it. You
need the fixture to provide a mojom::AutofillAgent, not to be one. Splitting the
AutofillAgent implementation into a separate class (in the anonymous namespace)
will make the fixture smaller and easier to understand. It will also make it
easier to locate the mojom::AutofillAgent-specific bits.

[leonhsl(Using Gerrit), 2016/06/23 10:00:12]

Done.

  public:
   void SetUp() override {
     content::RenderViewHostTestHarness::SetUp();
 
     test_autofill_client_.reset(new TestAutofillClient());
     driver_.reset(new TestContentAutofillDriver(web_contents()->GetMainFrame(),
                                                 test_autofill_client_.get()));
+
+    id_sent_ = -1;

[vabr (Chromium), 2016/05/24 08:08:20]

Please initialise this in the constructor or via a non-static class member
initializer in the class definition. This will ensure that the data member has a
sane value through the whole existence of the text fixture.

[leonhsl(Using Gerrit), 2016/06/23 10:00:12]

Done.

+    form_sent_.reset();

[vabr (Chromium), 2016/05/24 08:08:20]

No need for this, it is null since construction, and you are already relying on
SetUp being called before anything else touching |form_sent_|.

[leonhsl(Using Gerrit), 2016/06/23 10:00:12]

Done.

+
+    content::ServiceRegistry* registry =
+        web_contents()->GetMainFrame()->GetServiceRegistry();
+    registry->AddServiceOverrideForTesting(
+        mojom::AutofillAgent::Name_,
+        base::Bind(&ContentAutofillDriverTest::BindFakeAutofillAgent,
+                   base::Unretained(this)));
   }
 
   void TearDown() override {
     // Reset the driver now to cause all pref observers to be removed and avoid
     // crashes that otherwise occur in the destructor.
     driver_.reset();
     content::RenderViewHostTestHarness::TearDown();
   }
 
+  void BindFakeAutofillAgent(mojo::ScopedMessagePipeHandle handle) {
+    bindings_.AddBinding(
+        this, mojo::MakeRequest<mojom::AutofillAgent>(std::move(handle)));
+  }
+
  protected:
-  // Searches for an |AutofillMsg_FillForm| message in the queue of sent IPC
-  // messages. If none is present, returns false. Otherwise, extracts the first
-  // |AutofillMsg_FillForm| message, fills the output parameters with the values
-  // of the message's parameters, and clears the queue of sent messages.
+  // mojom::AutofillAgent methods:
+  void FirstUserGestureObservedInTab() override {}
+
+  void FillForm(int32_t id,
+                const FormData& form,
+                const FillFormCallback& callback) override {
+    id_sent_ = id;
+    form_sent_.reset(new FormData(form));
+    callback.Run(form, 0);
+  }
+
+  // Returns the id and formdata received via
+  // mojo interface method mojom::AutofillAgent::FillForm().
   bool GetAutofillFillFormMessage(int* page_id, FormData* results) {
-    const uint32_t kMsgID = AutofillMsg_FillForm::ID;
-    const IPC::Message* message =
-        process()->sink().GetFirstMessageMatching(kMsgID);
-    if (!message)
+    if (id_sent_ == -1)
       return false;
-    std::tuple<int, FormData> autofill_param;
-    if (!AutofillMsg_FillForm::Read(message, &autofill_param))
+    if (!form_sent_)
       return false;
+
     if (page_id)
-      *page_id = std::get<0>(autofill_param);
+      *page_id = id_sent_;
     if (results)
-      *results = std::get<1>(autofill_param);
-    process()->sink().ClearMessages();
+      *results = *form_sent_;
     return true;
   }
 
   // Searches for an |AutofillMsg_PreviewForm| message in the queue of sent IPC
   // messages. If none is present, returns false. Otherwise, extracts the first
   // |AutofillMsg_PreviewForm| message, fills the output parameters with the
   // values of the message's parameters, and clears the queue of sent messages.
   bool GetAutofillPreviewFormMessage(int* page_id, FormData* results) {
     const uint32_t kMsgID = AutofillMsg_PreviewForm::ID;
     const IPC::Message* message =
@@ skipping 74 matching lines @@
     const IPC::Message* message =
         process()->sink().GetFirstMessageMatching(messageID);
     if (!message)
       return false;
     process()->sink().ClearMessages();
     return true;
   }
 
   std::unique_ptr<TestAutofillClient> test_autofill_client_;
   std::unique_ptr<TestContentAutofillDriver> driver_;
+  mojo::BindingSet<mojom::AutofillAgent> bindings_;
+
+  int32_t id_sent_;

[vabr (Chromium), 2016/05/24 08:08:20]

nit: Please comment about what |id_sent_| and |form_sent_| are used for.

[leonhsl(Using Gerrit), 2016/06/23 10:00:12]

Done.

+  std::unique_ptr<FormData> form_sent_;
 };
 
 TEST_F(ContentAutofillDriverTest, GetURLRequestContext) {
   net::URLRequestContextGetter* request_context =
       driver_->GetURLRequestContext();
   net::URLRequestContextGetter* expected_request_context =
       content::BrowserContext::GetDefaultStoragePartition(
           web_contents()->GetBrowserContext())->GetURLRequestContext();
   EXPECT_EQ(request_context, expected_request_context);
 }
@@ skipping 14 matching lines @@
   details.is_main_frame = false;
   ASSERT_TRUE(!details.is_navigation_to_different_page());
   content::FrameNavigateParams params = content::FrameNavigateParams();
   driver_->DidNavigateFrame(details, params);
 }
 
 TEST_F(ContentAutofillDriverTest, FormDataSentToRenderer_FillForm) {
   int input_page_id = 42;
   FormData input_form_data;
   test::CreateTestAddressFormData(&input_form_data);
   driver_->SendFormDataToRenderer(

[yzshen1, 2016/05/24 16:12:10]

I am not familiar with auto fill code. Does this call somehow make a mojo call
of mojom::AutofillAgent::FillForm() which will be handled by line 120?

It is potentially flaky to use RunAllPendingTasks() below. There is no guarantee
that the message loop stays busy between you make a mojo call of FillFrom() and
receive this call, even if they are on the same thread.

The safer way is to signal run loop to exit from
mojom::AutofillAgent::FillForm() implementation.

[leonhsl(Using Gerrit), 2016/06/23 10:00:12]

Done.

       input_page_id, AutofillDriver::FORM_DATA_ACTION_FILL, input_form_data);
 
+  RunAllPendingTasks();
+
   int output_page_id = 0;
   FormData output_form_data;
   EXPECT_FALSE(
       GetAutofillPreviewFormMessage(&output_page_id, &output_form_data));
   EXPECT_TRUE(GetAutofillFillFormMessage(&output_page_id, &output_form_data));
   EXPECT_EQ(input_page_id, output_page_id);
   EXPECT_TRUE(input_form_data.SameFormAs(output_form_data));
 }
 
 TEST_F(ContentAutofillDriverTest, FormDataSentToRenderer_PreviewForm) {
   int input_page_id = 42;
   FormData input_form_data;
   test::CreateTestAddressFormData(&input_form_data);
   driver_->SendFormDataToRenderer(
       input_page_id, AutofillDriver::FORM_DATA_ACTION_PREVIEW, input_form_data);
 
+  RunAllPendingTasks();
+
   int output_page_id = 0;
   FormData output_form_data;
   EXPECT_FALSE(GetAutofillFillFormMessage(&output_page_id, &output_form_data));
   EXPECT_TRUE(
       GetAutofillPreviewFormMessage(&output_page_id, &output_form_data));
   EXPECT_EQ(input_page_id, output_page_id);
   EXPECT_TRUE(input_form_data.SameFormAs(output_form_data));
 }
 
 TEST_F(ContentAutofillDriverTest,
@@ skipping 56 matching lines @@
   base::string16 input_value(base::ASCIIToUTF16("barqux"));
   base::string16 output_value;
   driver_->RendererShouldPreviewFieldWithValue(input_value);
   EXPECT_TRUE(GetString16FromMessageWithID(
       AutofillMsg_PreviewFieldWithValue::ID,
       &output_value));
   EXPECT_EQ(input_value, output_value);
 }
 
 }  // namespace autofill