Fixing Intermittent SecurityKey Unittest Failures

remoting/host/security_key/security_key_ipc_client_unittest.cc

 // Copyright 2016 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 "remoting/host/security_key/security_key_ipc_client.h"
 
 #include <memory>
 #include <string>
 
 #include "base/bind.h"
 #include "base/macros.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "ipc/ipc_channel.h"
 #include "mojo/edk/embedder/named_platform_handle_utils.h"
-#include "mojo/edk/embedder/scoped_ipc_support.h"
 #include "remoting/host/security_key/fake_security_key_ipc_server.h"
 #include "remoting/host/security_key/security_key_ipc_constants.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 const int kTestConnectionId = 1;
 const char kNonexistentIpcChannelName[] = "Nonexistent_IPC_Channel";
 const char kValidIpcChannelName[] = "SecurityKeyIpcClientTest";
 const int kLargeMessageSizeBytes = 256 * 1024;
 }  // namespace
@@ skipping 23 matching lines @@
   // back when a security key response is sent.
   void ClientMessageReceived(const std::string& response_payload);
 
  protected:
   // testing::Test interface.
   void SetUp() override;
 
   // Waits until the current |run_loop_| instance is signaled, then resets it.
   void WaitForOperationComplete();
 
+  // Waits until all tasks have been run on the current message loop.
+  void RunPendingTasks();
+
   // Sets up an active IPC connection between |security_key_ipc_client_|
   // and |fake_ipc_server_|.  |expect_connected| defines whether the operation
   // is result in a usable IPC connection.  |expect_error| defines whether the
   // the error callback should be invoked during the connection process.
   void EstablishConnection(bool expect_connected, bool expect_error);
 
   // Sends a security key request from |security_key_ipc_client_| and
   // a response from |fake_ipc_server_| and verifies the payloads for both.
   void SendRequestAndResponse(const std::string& request_data,
                               const std::string& response_data);
 
   // Creates a unique IPC channel name to use for testing.
   std::string GenerateUniqueTestChannelName();
 
   // IPC tests require a valid MessageLoop to run.
   base::MessageLoopForIO message_loop_;
 
-  mojo::edk::ScopedIPCSupport ipc_support_;
-
   // Used to allow |message_loop_| to run during tests.  The instance is reset
   // after each stage of the tests has been completed.
   std::unique_ptr<base::RunLoop> run_loop_;
 
   // The object under test.
   SecurityKeyIpcClient security_key_ipc_client_;
 
   // Used to send/receive security key IPC messages for testing.
   FakeSecurityKeyIpcServer fake_ipc_server_;
 
@@ skipping 14 matching lines @@
   int last_connection_id_received_ = -1;
 
   // Stores the contents of the last IPC message received for validation.
   std::string last_message_received_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(SecurityKeyIpcClientTest);
 };
 
 SecurityKeyIpcClientTest::SecurityKeyIpcClientTest()
-    : ipc_support_(message_loop_.task_runner(),
-                   mojo::edk::ScopedIPCSupport::ShutdownPolicy::FAST),
-      run_loop_(new base::RunLoop()),
+    : run_loop_(new base::RunLoop()),
       fake_ipc_server_(
           kTestConnectionId,
           /*client_session_details=*/nullptr,
           /*initial_connect_timeout=*/base::TimeDelta::FromMilliseconds(500),
           base::Bind(&SecurityKeyIpcClientTest::SendMessageToClient,
                      base::Unretained(this)),
           base::Bind(&SecurityKeyIpcClientTest::SendConnectionMessage,
                      base::Unretained(this)),
           base::Bind(&SecurityKeyIpcClientTest::OperationComplete,
                      base::Unretained(this),
@@ skipping 28 matching lines @@
   } else {
     fake_ipc_server_.SendConnectionReadyMessage();
   }
 }
 
 void SecurityKeyIpcClientTest::WaitForOperationComplete() {
   run_loop_->Run();
   run_loop_.reset(new base::RunLoop());
 }
 
+void SecurityKeyIpcClientTest::RunPendingTasks() {
+  // Run until there are no pending work items in the queue.
+  base::RunLoop().RunUntilIdle();
+}
+
 void SecurityKeyIpcClientTest::SendMessageToClient(int connection_id,
                                                    const std::string& data) {
   last_connection_id_received_ = connection_id;
   last_message_received_ = data;
   OperationComplete(/*failed=*/false);
 }
 
 void SecurityKeyIpcClientTest::ClientMessageReceived(
     const std::string& response_payload) {
   last_message_received_ = response_payload;
@@ skipping 19 matching lines @@
   ASSERT_TRUE(security_key_ipc_client_.CheckForSecurityKeyIpcServerChannel());
 
   // Establish the IPC channel so we can begin sending and receiving security
   // key messages.
   security_key_ipc_client_.EstablishIpcConnection(
       base::Bind(&SecurityKeyIpcClientTest::ConnectionStateHandler,
                  base::Unretained(this)),
       base::Bind(&SecurityKeyIpcClientTest::OperationComplete,
                  base::Unretained(this), /*failed=*/true));
   WaitForOperationComplete();
+  RunPendingTasks();
+
   ASSERT_EQ(expect_connected, connection_established_);
   ASSERT_EQ(expect_error, operation_failed_);
 }
 
 void SecurityKeyIpcClientTest::SendRequestAndResponse(
     const std::string& request_data,
     const std::string& response_data) {
   ASSERT_TRUE(security_key_ipc_client_.SendSecurityKeyRequest(
       request_data, base::Bind(&SecurityKeyIpcClientTest::ClientMessageReceived,
                                base::Unretained(this))));
@@ skipping 187 matching lines @@
   ASSERT_TRUE(operation_failed_);
 
   // Send a third message to ensure no crash occurs both callbacks will have
   // been called and cleared so we don't wait for the operation to complete.
   SendConnectionMessage();
   ASSERT_TRUE(operation_failed_);
 }
 #endif  // defined(OS_WIN)
 
 }  // namespace remoting