Fixing Intermittent SecurityKey Unittest Failures

remoting/host/security_key/security_key_auth_handler_win_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_auth_handler.h"
 
 #include <cstdint>
 #include <memory>
 #include <string>
 
 #include "base/bind.h"
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "ipc/ipc_channel.h"
 #include "ipc/ipc_listener.h"
 #include "ipc/ipc_message.h"
 #include "ipc/ipc_message_macros.h"
-#include "mojo/edk/embedder/scoped_ipc_support.h"
 #include "remoting/host/host_mock_objects.h"
 #include "remoting/host/security_key/fake_security_key_ipc_client.h"
 #include "remoting/host/security_key/fake_security_key_ipc_server.h"
 #include "remoting/host/security_key/security_key_ipc_constants.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 const int kConnectionId1 = 1;
 const int kConnectionId2 = 2;
 }  // namespace
 
 namespace remoting {
 
 class SecurityKeyAuthHandlerWinTest : public testing::Test {
  public:
   SecurityKeyAuthHandlerWinTest();
   ~SecurityKeyAuthHandlerWinTest() override;
 
   // Passed to the object used for testing to be called back to signal
   // completion of an IPC channel state change or reception of an IPC message.
   void OperationComplete();
 
  protected:
   // 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 WaitForPendingOperations();
+
   // Used as a callback given to the object under test, expected to be called
   // back when a security key request is received by it.
   void SendMessageToClient(int connection_id, const std::string& data);
 
   // Creates a new security key connection on the object under test.
   void CreateSecurityKeyConnection(
       const mojo::edk::NamedPlatformHandle& channel_handle);
 
   // Uses |fake_ipc_client| to connect to the IPC server channel, it then
   // validates internal state of the object under test and closes the connection
@@ skipping 23 matching lines @@
       const base::WeakPtr<FakeSecurityKeyIpcServer>& fake_ipc_server,
       int connection_id);
 
   // Returns a unique IPC channel handle which prevents conflicts when running
   // tests concurrently.
   std::string GetUniqueTestChannelHandle();
 
   // 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.
   std::unique_ptr<SecurityKeyAuthHandler> auth_handler_;
 
   // Set as the default factory to create SecurityKeyIpcServerFactory
   // instances, this class will track each objects creation and allow the tests
   // to access it and use it for driving tests and validating state.
   FakeSecurityKeyIpcServerFactory ipc_server_factory_;
 
   // Used to validate the object under test uses the correct ID when
   // communicating over the IPC channel.
   int last_connection_id_received_ = -1;
 
   // Stores the contents of the last IPC message received for validation.
   std::string last_message_received_;
 
  private:
   testing::NiceMock<MockClientSessionDetails> mock_client_session_details_;
 
   DISALLOW_COPY_AND_ASSIGN(SecurityKeyAuthHandlerWinTest);
 };
 
 SecurityKeyAuthHandlerWinTest::SecurityKeyAuthHandlerWinTest()
-    : ipc_support_(message_loop_.task_runner(),
-                   mojo::edk::ScopedIPCSupport::ShutdownPolicy::FAST),
-      run_loop_(new base::RunLoop()) {
+    : run_loop_(new base::RunLoop()) {
   auth_handler_ = remoting::SecurityKeyAuthHandler::Create(
       &mock_client_session_details_,
       base::Bind(&SecurityKeyAuthHandlerWinTest::SendMessageToClient,
                  base::Unretained(this)),
       /*file_task_runner=*/nullptr);
 }
 
 SecurityKeyAuthHandlerWinTest::~SecurityKeyAuthHandlerWinTest() {}
 
 void SecurityKeyAuthHandlerWinTest::OperationComplete() {
   run_loop_->Quit();
 }
 
 void SecurityKeyAuthHandlerWinTest::WaitForOperationComplete() {
   run_loop_->Run();
   run_loop_.reset(new base::RunLoop());
 }
 
+void SecurityKeyAuthHandlerWinTest::WaitForPendingOperations() {
+  // Ensure we have a new, runnable instance.
+  run_loop_.reset(new base::RunLoop());
+
+  // Run until there are no pending work items in the queue.
+  run_loop_->RunUntilIdle();
+
+  // Create a new instance for future operations.
+  run_loop_.reset(new base::RunLoop());
+}
+
 void SecurityKeyAuthHandlerWinTest::SendMessageToClient(
     int connection_id,
     const std::string& data) {
   last_connection_id_received_ = connection_id;
   last_message_received_ = data;
   OperationComplete();
 }
 
 void SecurityKeyAuthHandlerWinTest::CreateSecurityKeyConnection(
     const mojo::edk::NamedPlatformHandle& channel_handle) {
   ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
 
   remoting::SetSecurityKeyIpcChannelForTest(channel_handle);
 
   // Create a new SecurityKey IPC Server connection.
   auth_handler_->CreateSecurityKeyConnection();
 }
 
 void SecurityKeyAuthHandlerWinTest::EstablishIpcConnection(
     FakeSecurityKeyIpcClient* fake_ipc_client,
     int expected_connection_id,
     const mojo::edk::NamedPlatformHandle& channel_handle,
     bool close_connection) {
   size_t expected_connection_count =
       auth_handler_->GetActiveConnectionCountForTest() + 1;
 
   ASSERT_FALSE(auth_handler_->IsValidConnectionId(expected_connection_id));
+  fake_ipc_client->set_on_channel_connected_callback(
+      base::Bind(&SecurityKeyAuthHandlerWinTest::OperationComplete,
+                 base::Unretained(this)));
   ASSERT_TRUE(fake_ipc_client->ConnectViaIpc(channel_handle));
   WaitForOperationComplete();
 
+  // Retrieve the IPC server instance created when the client connected.
+  base::WeakPtr<FakeSecurityKeyIpcServer> fake_ipc_server =
+      ipc_server_factory_.GetIpcServerObject(expected_connection_id);
+  ASSERT_TRUE(fake_ipc_server.get());
+  fake_ipc_server->SendConnectionReadyMessage();
+  WaitForOperationComplete();
+
   // Verify the internal state of the SecurityKeyAuthHandler is correct.
   ASSERT_TRUE(auth_handler_->IsValidConnectionId(expected_connection_id));
   ASSERT_EQ(expected_connection_count,
             auth_handler_->GetActiveConnectionCountForTest());
 
   if (close_connection) {
     fake_ipc_client->CloseIpcConnection();
     WaitForOperationComplete();
   }
 }
@@ skipping 61 matching lines @@
 std::string SecurityKeyAuthHandlerWinTest::GetUniqueTestChannelHandle() {
   std::string channel_name("Uber_Awesome_Super_Mega_Test_Channel.");
   channel_name.append(IPC::Channel::GenerateUniqueRandomChannelID());
 
   return channel_name;
 }
 
 TEST_F(SecurityKeyAuthHandlerWinTest, HandleSingleSecurityKeyRequest) {
   mojo::edk::NamedPlatformHandle channel_handle(GetUniqueTestChannelHandle());
   CreateSecurityKeyConnection(channel_handle);
-
   ASSERT_FALSE(auth_handler_->IsValidConnectionId(kConnectionId1));
 
   // Create a fake client and connect to the IPC server channel.
   FakeSecurityKeyIpcClient fake_ipc_client(
       base::Bind(&SecurityKeyAuthHandlerWinTest::OperationComplete,
                  base::Unretained(this)));
   EstablishIpcConnection(&fake_ipc_client, kConnectionId1, channel_handle,
                          /*close_connection=*/true);
 
   // Retrieve the IPC server instance created when the client connected.
@@ skipping 161 matching lines @@
   ASSERT_FALSE(fake_ipc_server.get());
   ASSERT_FALSE(auth_handler_->IsValidConnectionId(kConnectionId1));
   ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
 
   // Attempt to connect again after the error.
   EstablishIpcConnection(&fake_ipc_client, kConnectionId2, channel_handle,
                          /*close_connection=*/true);
 }
 
 }  // namespace remoting