Fixing SecurityKeySocket unit test issues and cleanup

remoting/host/security_key/security_key_auth_handler_posix_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 <memory>
 #include <string>
 
 #include "base/bind.h"
@@ skipping 27 matching lines @@
     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};
 
+const unsigned char kSshErrorData[] = {0x00, 0x00, 0x00, 0x01, 0x05};

[Sergey Ulanov, 2016/12/14 00:17:03]

Pleaes use uint8_t instead of unsigned char

[joedow, 2016/12/14 00:41:35]

Done.

+
 void RunUntilIdle() {
   base::RunLoop run_loop;
   run_loop.RunUntilIdle();
 }
 
 }  // namespace
 
 class SecurityKeyAuthHandlerPosixTest : public testing::Test {
  public:
   SecurityKeyAuthHandlerPosixTest()
@@ skipping 60 matching lines @@
                                               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 WaitForAndVerifyHostMessage(int connection_id) {
-    WaitForSendMessageToClient();
-    std::string expected_data;
-    expected_data.reserve(sizeof(kRequestData) - 4);
+  void WaitForResponseData(net::UnixDomainClientSocket* client_socket) {
+    // The request data is reused for the response data.
+    WaitForData(client_socket, sizeof(kRequestData));
+  }
 
-    // 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]));
+  void WaitForErrorData(net::UnixDomainClientSocket* client_socket) {
+    WaitForData(client_socket, sizeof(kSshErrorData));
+  }
+
+  void WaitForData(net::UnixDomainClientSocket* socket, int request_len) {
+    scoped_refptr<net::IOBuffer> buffer(new net::IOBuffer(request_len));
+    scoped_refptr<net::DrainableIOBuffer> read_buffer(
+        new net::DrainableIOBuffer(buffer.get(), request_len));
+    net::TestCompletionCallback read_callback;
+    int bytes_read = 0;
+    while (bytes_read < request_len) {
+      int read_result =
+          socket->Read(read_buffer.get(), read_buffer->BytesRemaining(),
+                       read_callback.callback());
+      read_result = read_callback.GetResult(read_result);
+      ASSERT_GT(read_result, 0);
+      bytes_read += read_result;
+      ASSERT_LE(bytes_read, request_len);
+      read_buffer->DidConsume(bytes_read);
+    }
+    ASSERT_EQ(request_len, bytes_read);
+  }
+
+  const std::string& GetExpectedRequestData() {
+    static std::string expected_data;

[Sergey Ulanov, 2016/12/14 00:17:03]

Any reason this needs to be static?
Style guide doesn't allow static vars: Variables of class type with static
storage duration are forbidden: they cause hard-to-find bugs due to
indeterminate order of construction and destruction.

[joedow, 2016/12/14 00:41:35]

No, I'll make it a class member.

+    if (expected_data.empty()) {
+      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) {

[Sergey Ulanov, 2016/12/14 00:17:03]

This loop can be expressed with one assign() call:
expected_data.assign(reinterpret_cast<const char*>(kRequestData + 4), 
                     sizeof(kRequestData) - 4);

[joedow, 2016/12/14 00:41:35]

This is much cleaner, thanks!

+        expected_data.append(1, static_cast<unsigned char>(kRequestData[i]));
+      }
     }
 
-    CheckHostDataMessage(connection_id, expected_data);
+    return expected_data;
   }
 
  protected:
   base::MessageLoopForIO message_loop_;
   std::unique_ptr<base::RunLoop> run_loop_;
 
   base::Thread file_thread_;
 
   // Object under test.
   std::unique_ptr<SecurityKeyAuthHandler> auth_handler_;
@@ skipping 15 matching lines @@
   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));
 
   // Write the request and verify the response.
   WriteRequestData(&client_socket);
-  WaitForAndVerifyHostMessage(1);
+  WaitForSendMessageToClient();
+  CheckHostDataMessage(1, GetExpectedRequestData());
+
+  auth_handler_->SendClientResponse(1, GetExpectedRequestData());
+  WaitForResponseData(&client_socket);
 
   // 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(SecurityKeyAuthHandlerPosixTest, HandleTwoRequests) {
   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));
 
   // Write the request and verify the response.
   WriteRequestData(&client_socket);
-  WaitForAndVerifyHostMessage(1);
+  WaitForSendMessageToClient();
+  CheckHostDataMessage(1, GetExpectedRequestData());
 
   // Verify the connection is now valid.
   ASSERT_TRUE(auth_handler_->IsValidConnectionId(1));
 
-  // Repeat the request/response cycle.
-  WriteRequestData(&client_socket);
-  WaitForAndVerifyHostMessage(1);
+  // Send a 'client' response to the socket and verify the data is received.
+  auth_handler_->SendClientResponse(1, GetExpectedRequestData());
+  WaitForResponseData(&client_socket);
 
   // Verify the connection is still valid.
   ASSERT_TRUE(auth_handler_->IsValidConnectionId(1));
+
+  // Repeat the request/response cycle.
+  WriteRequestData(&client_socket);
+  WaitForSendMessageToClient();
+  CheckHostDataMessage(1, GetExpectedRequestData());
+
+  // Verify the connection is still valid.
+  ASSERT_TRUE(auth_handler_->IsValidConnectionId(1));
+
+  auth_handler_->SendClientResponse(1, GetExpectedRequestData());
+  WaitForResponseData(&client_socket);
+
+  // 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(SecurityKeyAuthHandlerPosixTest, HandleTwoIndependentRequests) {
   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));
 
   // Write the request and verify the response.
   WriteRequestData(&client_socket);
-  WaitForAndVerifyHostMessage(1);
+  WaitForSendMessageToClient();
+  CheckHostDataMessage(1, GetExpectedRequestData());
 
   // Verify the first connection is now valid.
   ASSERT_TRUE(auth_handler_->IsValidConnectionId(1));
 
+  // Send a 'client' response to the socket and verify the data is received.
+  auth_handler_->SendClientResponse(1, GetExpectedRequestData());
+  WaitForResponseData(&client_socket);
+
+  // Verify the connection is still 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));
 
   // Repeat the request/response cycle.
   WriteRequestData(&client_socket);
-  WaitForAndVerifyHostMessage(2);
+  WaitForSendMessageToClient();
+  CheckHostDataMessage(2, GetExpectedRequestData());
+
+  // Verify the connection is now valid.
+  ASSERT_TRUE(auth_handler_->IsValidConnectionId(2));
+
+  // Send a 'client' response to the socket and verify the data is received.
+  auth_handler_->SendClientResponse(2, GetExpectedRequestData());
+  WaitForResponseData(&client_socket);
 
   // 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(SecurityKeyAuthHandlerPosixTest, DidReadTimeout) {
+TEST_F(SecurityKeyAuthHandlerPosixTest, DoReadTimeout) {
   CreateSocketAndWait();
 
+  auth_handler_->SetRequestTimeoutForTest(base::TimeDelta());
+
   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());
+
+  // SSH Error should be received when the connection times out.
+  WaitForErrorData(&client_socket);
+
+  // Connection should no longer be valid.
+  ASSERT_FALSE(auth_handler_->IsValidConnectionId(1));
   ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
 }
 
 TEST_F(SecurityKeyAuthHandlerPosixTest, ClientErrorMessageDelivered) {
   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));
 
+  // Write the request and verify the response.  This ensures the socket has
+  // been created and is working before sending the error to tear it down.
+  WriteRequestData(&client_socket);
+  WaitForSendMessageToClient();
+  CheckHostDataMessage(1, GetExpectedRequestData());
+
+  // Send a 'client' response to the socket and verify the data is received.
+  auth_handler_->SendClientResponse(1, GetExpectedRequestData());
+  WaitForResponseData(&client_socket);
+
+  ASSERT_TRUE(auth_handler_->IsValidConnectionId(1));
+  ASSERT_EQ(1u, auth_handler_->GetActiveConnectionCountForTest());
+
   auth_handler_->SendErrorAndCloseConnection(1);
+
+  // Connection should be removed immediately.
+  ASSERT_FALSE(auth_handler_->IsValidConnectionId(1));
   ASSERT_EQ(0u, auth_handler_->GetActiveConnectionCountForTest());
+
+  // SSH Error should be received.
+  WaitForErrorData(&client_socket);
 }
 
 }  // namespace remoting