Removing 'AllowScopedIO' exception from SecurityKeyAuthHandlerLinux

remoting/host/security_key/security_key_auth_handler_linux_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 <stddef.h>
 
+#include "base/bind.h"
+#include "base/bind_helpers.h"
 #include "base/files/file_path.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/macros.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "base/strings/stringprintf.h"
+#include "base/threading/thread.h"
 #include "base/timer/mock_timer.h"
 #include "base/values.h"
 #include "net/base/io_buffer.h"
 #include "net/base/net_errors.h"
 #include "net/base/test_completion_callback.h"
 #include "net/socket/unix_domain_client_socket_posix.h"
 #include "remoting/host/security_key/security_key_auth_handler.h"
 #include "remoting/host/security_key/security_key_socket.h"
 #include "remoting/proto/internal.pb.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace remoting {
 
 namespace {
 
+const size_t kReadBufferSize = 1;
+
 const char kSocketFilename[] = "socket_for_testing";
 
 // Test security key request data.
 const unsigned char kRequestData[] = {
     0x00, 0x00, 0x00, 0x9a, 0x65, 0x1e, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00,
     0x00, 0x90, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x20, 0x60, 0x90,
     0x24, 0x71, 0xf8, 0xf2, 0xe5, 0xdf, 0x7f, 0x81, 0xc7, 0x49, 0xc4, 0xa3,
     0x58, 0x5c, 0xf6, 0xcc, 0x40, 0x14, 0x28, 0x0c, 0xa0, 0xfa, 0x03, 0x18,
     0x38, 0xd8, 0x7d, 0x77, 0x2b, 0x3a, 0x00, 0x00, 0x00, 0x20, 0x64, 0x46,
     0x47, 0x2f, 0xdf, 0x6e, 0xed, 0x7b, 0xf3, 0xc3, 0x37, 0x20, 0xf2, 0x36,
     0x67, 0x6c, 0x36, 0xe1, 0xb4, 0x5e, 0xbe, 0x04, 0x85, 0xdb, 0x89, 0xa3,
     0xcd, 0xfd, 0xd2, 0x4b, 0xd6, 0x9f, 0x00, 0x00, 0x00, 0x40, 0x38, 0x35,
     0x05, 0x75, 0x1d, 0x13, 0x6e, 0xb3, 0x6b, 0x1d, 0x29, 0xae, 0xd3, 0x43,
     0xe6, 0x84, 0x8f, 0xa3, 0x9d, 0x65, 0x4e, 0x2f, 0x57, 0xe3, 0xf6, 0xe6,
     0x20, 0x3c, 0x00, 0xc6, 0xe1, 0x73, 0x34, 0xe2, 0x23, 0x99, 0xc4, 0xfa,
     0x91, 0xc2, 0xd5, 0x97, 0xc1, 0x8b, 0xd0, 0x3c, 0x13, 0xba, 0xf0, 0xd7,
     0x5e, 0xa3, 0xbc, 0x02, 0x5b, 0xec, 0xe4, 0x4b, 0xae, 0x0e, 0xf2, 0xbd,
     0xc8, 0xaa};
 
 }  // namespace
 
 class SecurityKeyAuthHandlerLinuxTest : public testing::Test {
  public:
-  SecurityKeyAuthHandlerLinuxTest()
-      : run_loop_(new base::RunLoop()), last_connection_id_received_(-1) {
-    EXPECT_TRUE(temp_dir_.CreateUniqueTempDir());
-    socket_path_ = temp_dir_.path().Append(kSocketFilename);
-    remoting::SecurityKeyAuthHandler::SetSecurityKeySocketName(socket_path_);
+  SecurityKeyAuthHandlerLinuxTest();
 
-    send_message_callback_ =
-        base::Bind(&SecurityKeyAuthHandlerLinuxTest::SendMessageToClient,
-                   base::Unretained(this));
-    auth_handler_ = remoting::SecurityKeyAuthHandler::Create(
-        nullptr, send_message_callback_);
-  }
+  // Creates a new socket and waits until it is ready to accept new connections.
+  void CreateSocketAndWait();
 
-  void WaitForSendMessageToClient() {
-    run_loop_->Run();
-    run_loop_.reset(new base::RunLoop);
-  }
+  // Used as a callback |auth_handler_|, stores the values received.
+  void SendMessageToClient(int connection_id, const std::string& data);
 
-  void SendMessageToClient(int connection_id, const std::string& data) {
-    last_connection_id_received_ = connection_id;
-    last_message_received_ = data;
-    run_loop_->Quit();
-  }
+  // Writes |kRequestData| to |client_socket|.
+  void WriteRequestData(net::UnixDomainClientSocket* client_socket);
 
-  void CheckHostDataMessage(int id, const std::string& expected_data) {
-    ASSERT_EQ(id, last_connection_id_received_);
-    ASSERT_EQ(expected_data.length(), last_message_received_.length());
-    ASSERT_EQ(expected_data, last_message_received_);
-  }
+  // Helper method which validates message data once it has been received.
+  void WaitForAndVerifyHostMessage(int connection_id);
 
-  void WriteRequestData(net::UnixDomainClientSocket* client_socket) {
-    int request_len = sizeof(kRequestData);
-    scoped_refptr<net::DrainableIOBuffer> request_buffer(
-        new net::DrainableIOBuffer(
-            new net::WrappedIOBuffer(
-                reinterpret_cast<const char*>(kRequestData)),
-            request_len));
-    net::TestCompletionCallback write_callback;
-    int bytes_written = 0;
-    while (bytes_written < request_len) {
-      int write_result = client_socket->Write(request_buffer.get(),
-                                              request_buffer->BytesRemaining(),
-                                              write_callback.callback());
-      write_result = write_callback.GetResult(write_result);
-      ASSERT_GT(write_result, 0);
-      bytes_written += write_result;
-      ASSERT_LE(bytes_written, request_len);
-      request_buffer->DidConsume(write_result);
-    }
-    ASSERT_EQ(request_len, bytes_written);
-  }
+  // Waits until all existing posted tasks on |file_thread_| have been run.
+  void WaitForExistingSocketOperations();
 
-  void WaitForAndVerifyHostMessage(int connection_id) {
-    WaitForSendMessageToClient();
-    std::string expected_data;
-    expected_data.reserve(sizeof(kRequestData) - 4);
-
-    // Skip first four bytes and build up the response string.
-    for (size_t i = 4; i < sizeof(kRequestData); ++i) {
-      expected_data.append(1, static_cast<unsigned char>(kRequestData[i]));
-    }
-
-    CheckHostDataMessage(connection_id, expected_data);
-  }
+  // Waits until |client_socket| has been closed.
+  void WaitForConnectionClosed(net::UnixDomainClientSocket* client_socket);
 
  protected:
+  // Waits for |SendMessageToClient()| to be signaled.
+  void WaitForSendMessageToClient();
+
+  // Verfies the data passed to the |SendMessageToClient| callback was valid.
+  void CheckHostDataMessage(int id, const std::string& expected_data);
+
   base::MessageLoopForIO message_loop_;
   std::unique_ptr<base::RunLoop> run_loop_;
 
+  base::Thread file_thread_;
+
   // Object under test.
   std::unique_ptr<SecurityKeyAuthHandler> auth_handler_;
 
   SecurityKeyAuthHandler::SendMessageCallback send_message_callback_;
 
   int last_connection_id_received_;
   std::string last_message_received_;
 
   base::ScopedTempDir temp_dir_;
   base::FilePath socket_path_;
   base::Closure accept_callback_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(SecurityKeyAuthHandlerLinuxTest);
 };
 
-TEST_F(SecurityKeyAuthHandlerLinuxTest, NotClosedAfterRequest) {
+SecurityKeyAuthHandlerLinuxTest::SecurityKeyAuthHandlerLinuxTest()
+    : run_loop_(new base::RunLoop()),
+      file_thread_("SecurityKeyAuthHandlerLinuxTest_FileThread"),
+      last_connection_id_received_(-1) {
+  EXPECT_TRUE(temp_dir_.CreateUniqueTempDir());
+  socket_path_ = temp_dir_.path().Append(kSocketFilename);
+  remoting::SecurityKeyAuthHandler::SetSecurityKeySocketName(socket_path_);
+
+  file_thread_.StartWithOptions(
+      base::Thread::Options(base::MessageLoop::TYPE_IO, 0));
+
+  send_message_callback_ =
+      base::Bind(&SecurityKeyAuthHandlerLinuxTest::SendMessageToClient,
+                 base::Unretained(this));
+
+  auth_handler_ = remoting::SecurityKeyAuthHandler::Create(
+      /*client_session_details=*/nullptr, send_message_callback_,
+      file_thread_.task_runner());
+}
+
+void SecurityKeyAuthHandlerLinuxTest::WaitForExistingSocketOperations() {
+  ASSERT_TRUE(file_thread_.task_runner()->PostTaskAndReply(
+      FROM_HERE, base::Bind(&base::DoNothing), run_loop_->QuitClosure()));
+  run_loop_->Run();
+  run_loop_.reset(new base::RunLoop);
+}
+
+void SecurityKeyAuthHandlerLinuxTest::CreateSocketAndWait() {
   ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
 
   auth_handler_->CreateSecurityKeyConnection();
+  WaitForExistingSocketOperations();
+
+  ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
+}
+
+void SecurityKeyAuthHandlerLinuxTest::SendMessageToClient(
+    int connection_id,
+    const std::string& data) {
+  last_connection_id_received_ = connection_id;
+  last_message_received_ = data;
+  run_loop_->Quit();
+}
+
+void SecurityKeyAuthHandlerLinuxTest::WaitForSendMessageToClient() {
+  run_loop_->Run();
+  run_loop_.reset(new base::RunLoop);
+}
+
+void SecurityKeyAuthHandlerLinuxTest::WriteRequestData(
+    net::UnixDomainClientSocket* client_socket) {
+  int request_len = sizeof(kRequestData);
+  scoped_refptr<net::DrainableIOBuffer> request_buffer(
+      new net::DrainableIOBuffer(
+          new net::WrappedIOBuffer(reinterpret_cast<const char*>(kRequestData)),
+          request_len));
+  net::TestCompletionCallback write_callback;
+  int bytes_written = 0;
+  while (bytes_written < request_len) {
+    int write_result = client_socket->Write(request_buffer.get(),
+                                            request_buffer->BytesRemaining(),
+                                            write_callback.callback());
+    write_result = write_callback.GetResult(write_result);
+    ASSERT_GT(write_result, 0);
+    bytes_written += write_result;
+    ASSERT_LE(bytes_written, request_len);
+    request_buffer->DidConsume(write_result);
+  }
+  ASSERT_EQ(request_len, bytes_written);
+}
+
+void SecurityKeyAuthHandlerLinuxTest::CheckHostDataMessage(
+    int id,
+    const std::string& expected_data) {
+  ASSERT_EQ(id, last_connection_id_received_);
+  ASSERT_EQ(expected_data.length(), last_message_received_.length());
+  ASSERT_EQ(expected_data, last_message_received_);
+}
+
+void SecurityKeyAuthHandlerLinuxTest::WaitForAndVerifyHostMessage(
+    int connection_id) {
+  WaitForSendMessageToClient();
+  std::string expected_data;
+  expected_data.reserve(sizeof(kRequestData) - 4);
+
+  // Skip first four bytes and build up the response string.
+  for (size_t i = 4; i < sizeof(kRequestData); ++i) {
+    expected_data.append(1, static_cast<unsigned char>(kRequestData[i]));
+  }
+
+  CheckHostDataMessage(connection_id, expected_data);
+}
+
+void SecurityKeyAuthHandlerLinuxTest::WaitForConnectionClosed(
+    net::UnixDomainClientSocket* client_socket) {
+  // Ensure there are no pending operations.
+  WaitForExistingSocketOperations();
+
+  // Create a blocking read operation to wait until the socket has been closed.
+  scoped_refptr<net::IOBuffer> read_buffer(new net::IOBuffer(kReadBufferSize));
+  net::TestCompletionCallback read_callback;
+  int read_result = client_socket->Read(read_buffer.get(), kReadBufferSize,
+                                        read_callback.callback());
+
+  // GetResult blocks until the IO is no longer pending.
+  read_result = read_callback.GetResult(read_result);
+  ASSERT_EQ(read_result, static_cast<int>(kReadBufferSize));
+  ASSERT_TRUE(std::string(read_buffer->data()).empty());
+
+  // Ensure all current and pending operations are complete.
+  WaitForExistingSocketOperations();
+}
+
+TEST_F(SecurityKeyAuthHandlerLinuxTest, NotClosedAfterRequest) {
+  CreateSocketAndWait();
 
   net::UnixDomainClientSocket client_socket(socket_path_.value(), false);
   net::TestCompletionCallback connect_callback;
-
   int rv = client_socket.Connect(connect_callback.callback());
   ASSERT_EQ(net::OK, connect_callback.GetResult(rv));
+  WaitForExistingSocketOperations();
 
   // Write the request and verify the response.
   WriteRequestData(&client_socket);
   WaitForAndVerifyHostMessage(1);
 
   // Verify the connection is now valid.
   ASSERT_TRUE(auth_handler_->IsValidConnectionId(1));
 
   // Verify that completing a request/response cycle didn't close the socket.
   ASSERT_EQ(1u, auth_handler_->GetActiveConnectionCountForTest());
 }
 
 TEST_F(SecurityKeyAuthHandlerLinuxTest, HandleTwoRequests) {
-  ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
-
-  auth_handler_->CreateSecurityKeyConnection();
+  CreateSocketAndWait();
 
   net::UnixDomainClientSocket client_socket(socket_path_.value(), false);
   net::TestCompletionCallback connect_callback;
-
   int rv = client_socket.Connect(connect_callback.callback());
   ASSERT_EQ(net::OK, connect_callback.GetResult(rv));
+  WaitForExistingSocketOperations();
 
   // Write the request and verify the response.
   WriteRequestData(&client_socket);
   WaitForAndVerifyHostMessage(1);
 
   // Verify the connection is now valid.
   ASSERT_TRUE(auth_handler_->IsValidConnectionId(1));
 
   // Repeat the request/response cycle.
   WriteRequestData(&client_socket);
   WaitForAndVerifyHostMessage(1);
 
   // Verify the connection is still valid.
   ASSERT_TRUE(auth_handler_->IsValidConnectionId(1));
 
   // Verify that completing two request/response cycles didn't close the
   // socket.
   ASSERT_EQ(1u, auth_handler_->GetActiveConnectionCountForTest());
 }
 
 TEST_F(SecurityKeyAuthHandlerLinuxTest, HandleTwoIndependentRequests) {
-  ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
-
-  auth_handler_->CreateSecurityKeyConnection();
+  CreateSocketAndWait();
 
   net::UnixDomainClientSocket client_socket(socket_path_.value(), false);
   net::TestCompletionCallback connect_callback;
-
   int rv = client_socket.Connect(connect_callback.callback());
   ASSERT_EQ(net::OK, connect_callback.GetResult(rv));
+  WaitForExistingSocketOperations();
 
   // Write the request and verify the response.
   WriteRequestData(&client_socket);
   WaitForAndVerifyHostMessage(1);
 
   // Verify the first connection is now valid.
   ASSERT_TRUE(auth_handler_->IsValidConnectionId(1));
 
   // Disconnect and establish a new connection.
   client_socket.Disconnect();
   rv = client_socket.Connect(connect_callback.callback());
   ASSERT_EQ(net::OK, connect_callback.GetResult(rv));
+  WaitForExistingSocketOperations();
 
   // Repeat the request/response cycle.
   WriteRequestData(&client_socket);
   WaitForAndVerifyHostMessage(2);
 
   // Verify the second connection is valid and the first is not.
   ASSERT_TRUE(auth_handler_->IsValidConnectionId(2));
   ASSERT_FALSE(auth_handler_->IsValidConnectionId(1));
 
   // Verify that the initial socket was released properly.
   ASSERT_EQ(1u, auth_handler_->GetActiveConnectionCountForTest());
 }
 
+TEST_F(SecurityKeyAuthHandlerLinuxTest, HandleNumerousIndependentRequests) {
+  CreateSocketAndWait();
+
+  net::UnixDomainClientSocket client_socket(socket_path_.value(), false);
+  net::TestCompletionCallback connect_callback;
+
+  // Connection IDs start at 1 so start there to simplify the rest of the code.
+  for (int i = 1; i < 11; i++) {
+    int rv = client_socket.Connect(connect_callback.callback());
+    ASSERT_EQ(net::OK, connect_callback.GetResult(rv));
+    WaitForExistingSocketOperations();
+
+    // Verify the connection is now valid.
+    ASSERT_TRUE(auth_handler_->IsValidConnectionId(i));
+
+    // Write the request and verify the response.
+    WriteRequestData(&client_socket);
+    WaitForAndVerifyHostMessage(i);
+
+    // Disconnect and establish a new connection.
+    client_socket.Disconnect();
+    WaitForExistingSocketOperations();
+
+    ASSERT_FALSE(auth_handler_->IsValidConnectionId(i));
+  }
+
+  // Verify that the initial sockets were released properly.
+  ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
+}
+
 TEST_F(SecurityKeyAuthHandlerLinuxTest, DidReadTimeout) {
-  ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
-  auth_handler_->CreateSecurityKeyConnection();
+  auth_handler_->SetRequestTimeoutForTest(base::TimeDelta());
+
+  CreateSocketAndWait();
 
   net::UnixDomainClientSocket client_socket(socket_path_.value(), false);
   net::TestCompletionCallback connect_callback;
   int rv = client_socket.Connect(connect_callback.callback());
   ASSERT_EQ(net::OK, connect_callback.GetResult(rv));
-  auth_handler_->SetRequestTimeoutForTest(base::TimeDelta());
+  WaitForConnectionClosed(&client_socket);
+
   ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
 }
 
 TEST_F(SecurityKeyAuthHandlerLinuxTest, ClientErrorMessageDelivered) {
-  ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
-  auth_handler_->CreateSecurityKeyConnection();
+  CreateSocketAndWait();
 
   net::UnixDomainClientSocket client_socket(socket_path_.value(), false);
   net::TestCompletionCallback connect_callback;
   int rv = client_socket.Connect(connect_callback.callback());
   ASSERT_EQ(net::OK, connect_callback.GetResult(rv));
+  WaitForExistingSocketOperations();
+
+  ASSERT_EQ(1u, auth_handler_->GetActiveConnectionCountForTest());
 
   auth_handler_->SendErrorAndCloseConnection(1);
+  WaitForConnectionClosed(&client_socket);
+
   ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
 }
 
 }  // namespace remoting