[Chromoting] Refactoring DesktopEnvironment and moving screen/audio recorders to ClientSession.

remoting/host/client_session_unittest.cc

 // Copyright (c) 2012 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 "base/message_loop.h"
+#include "remoting/base/auto_thread_task_runner.h"
 #include "remoting/base/constants.h"
+#include "remoting/host/audio_capturer.h"
 #include "remoting/host/client_session.h"
+#include "remoting/host/desktop_environment.h"
 #include "remoting/host/host_mock_objects.h"
 #include "remoting/protocol/protocol_mock_objects.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace remoting {
 
 using protocol::MockClipboardStub;
 using protocol::MockConnectionToClient;
 using protocol::MockConnectionToClientEventHandler;
 using protocol::MockHostStub;
 using protocol::MockInputStub;
 using protocol::MockSession;
+using protocol::SessionConfig;
 
 using testing::_;
+using testing::AnyNumber;
 using testing::DeleteArg;
+using testing::Expectation;
 using testing::InSequence;
 using testing::Return;
 using testing::ReturnRef;
 
 class ClientSessionTest : public testing::Test {
  public:
   ClientSessionTest() {}
 
   virtual void SetUp() OVERRIDE {
+    ui_task_runner_ = new AutoThreadTaskRunner(
+        message_loop_.message_loop_proxy(),
+        base::Bind(&ClientSessionTest::QuitMainMessageLoop,
+                   base::Unretained(this)));
+
+    EXPECT_CALL(context_, ui_task_runner())
+        .Times(AnyNumber())
+        .WillRepeatedly(Return(ui_task_runner_.get()));
+    EXPECT_CALL(context_, capture_task_runner())
+        .Times(AnyNumber())
+        .WillRepeatedly(Return(ui_task_runner_.get()));
+    EXPECT_CALL(context_, encode_task_runner())
+        .Times(AnyNumber())
+        .WillRepeatedly(Return(ui_task_runner_.get()));
+    EXPECT_CALL(context_, network_task_runner())
+        .Times(AnyNumber())
+        .WillRepeatedly(Return(ui_task_runner_.get()));
+
     client_jid_ = "user@domain/rest-of-jid";
 
+    event_executor_ = new MockEventExecutor();
+    capturer_ = new MockVideoFrameCapturer();
+    EXPECT_CALL(*capturer_, Start(_));
+    EXPECT_CALL(*capturer_, Stop());
+    EXPECT_CALL(*capturer_, InvalidateRegion(_)).Times(AnyNumber());
+    EXPECT_CALL(*capturer_, CaptureInvalidRegion(_)).Times(AnyNumber());
+
+    scoped_ptr<DesktopEnvironment> desktop_environment(new DesktopEnvironment(
+        scoped_ptr<AudioCapturer>(NULL),
+        scoped_ptr<EventExecutor>(event_executor_),
+        scoped_ptr<VideoFrameCapturer>(capturer_)));
+
     // Set up a large default screen size that won't affect most tests.
     default_screen_size_.set(1000, 1000);
-    EXPECT_CALL(capturer_, size_most_recent())
+    EXPECT_CALL(*capturer_, size_most_recent())
         .WillRepeatedly(ReturnRef(default_screen_size_));
 
+    session_config_ = SessionConfig::GetDefault();
+
     protocol::MockSession* session = new MockSession();
+    EXPECT_CALL(*session, config()).WillRepeatedly(ReturnRef(session_config_));
     EXPECT_CALL(*session, jid()).WillRepeatedly(ReturnRef(client_jid_));
     EXPECT_CALL(*session, SetEventHandler(_));
     EXPECT_CALL(*session, Close());
     scoped_ptr<protocol::ConnectionToClient> connection(
         new protocol::ConnectionToClient(session));
     connection_ = connection.get();
-    client_session_.reset(new ClientSession(
-        &session_event_handler_, connection.Pass(),
-        &host_clipboard_stub_, &host_input_stub_, &capturer_,
-        base::TimeDelta()));
+
+    client_session_ = new ClientSession(
+        &session_event_handler_,
+        context_.capture_task_runner(),
+        context_.encode_task_runner(),
+        context_.network_task_runner(),
+        connection.Pass(),
+        desktop_environment.Pass(),
+        base::TimeDelta());
   }
 
   virtual void TearDown() OVERRIDE {
-    client_session_.reset();
-    // Run message loop before destroying because protocol::Session is
-    // destroyed asynchronously.
-    message_loop_.RunAllPending();
+    // MockClientSessionEventHandler won't trigger StopAndDelete, so fake it.
+    client_session_->Stop(base::Bind(
+        &ClientSessionTest::OnClientStopped, base::Unretained(this)));
+
+    // Run message loop before destroying because the session is destroyed
+    // asynchronously.
+    ui_task_runner_ = NULL;
+    message_loop_.Run();
+
+    // Verify that the client session has been stopped.
+    EXPECT_TRUE(client_session_.get() == NULL);
   }
 
  protected:
   void DisconnectClientSession() {
     client_session_->Disconnect();
     // MockSession won't trigger OnConnectionClosed, so fake it.
     client_session_->OnConnectionClosed(client_session_->connection(),
                                         protocol::OK);
   }
 
+  void QuitMainMessageLoop() {
+    message_loop_.PostTask(FROM_HERE, MessageLoop::QuitClosure());
+  }
+
+  void OnClientStopped() {
+    client_session_ = NULL;
+  }
+
+  MessageLoop message_loop_;
+  scoped_refptr<AutoThreadTaskRunner> ui_task_runner_;
+  MockChromotingHostContext context_;
   SkISize default_screen_size_;
-  MessageLoop message_loop_;
   std::string client_jid_;
   MockHostStub host_stub_;
-  MockClipboardStub host_clipboard_stub_;
-  MockInputStub host_input_stub_;
-  MockVideoFrameCapturer capturer_;
+  MockEventExecutor* event_executor_;
+  MockVideoFrameCapturer* capturer_;
   MockClientSessionEventHandler session_event_handler_;
-  scoped_ptr<ClientSession> client_session_;
+  scoped_refptr<ClientSession> client_session_;
+  SessionConfig session_config_;
 
   // ClientSession owns |connection_| but tests need it to inject fake events.
   protocol::ConnectionToClient* connection_;
 };
 
 MATCHER_P2(EqualsClipboardEvent, m, d, "") {
   return (strcmp(arg.mime_type().c_str(), m) == 0 &&
       memcmp(arg.data().data(), d, arg.data().size()) == 0);
 }
 
 TEST_F(ClientSessionTest, ClipboardStubFilter) {
   protocol::ClipboardEvent clipboard_event1;
   clipboard_event1.set_mime_type(kMimeTypeTextUtf8);
   clipboard_event1.set_data("a");
 
   protocol::ClipboardEvent clipboard_event2;
   clipboard_event2.set_mime_type(kMimeTypeTextUtf8);
   clipboard_event2.set_data("b");
 
   protocol::ClipboardEvent clipboard_event3;
   clipboard_event3.set_mime_type(kMimeTypeTextUtf8);
   clipboard_event3.set_data("c");
 
   InSequence s;
   EXPECT_CALL(session_event_handler_, OnSessionAuthenticated(_));
+  EXPECT_CALL(*event_executor_, StartPtr(_));
   EXPECT_CALL(session_event_handler_, OnSessionChannelsConnected(_));
-  EXPECT_CALL(host_clipboard_stub_, InjectClipboardEvent(EqualsClipboardEvent(
+  EXPECT_CALL(*event_executor_, InjectClipboardEvent(EqualsClipboardEvent(
       kMimeTypeTextUtf8, "b")));
   EXPECT_CALL(session_event_handler_, OnSessionClosed(_));
+  EXPECT_CALL(*event_executor_, StopAndDeleteMock());
 
   // This event should not get through to the clipboard stub,
   // because the client isn't authenticated yet.
   connection_->clipboard_stub()->InjectClipboardEvent(clipboard_event1);
   client_session_->OnConnectionAuthenticated(client_session_->connection());
   client_session_->OnConnectionChannelsConnected(client_session_->connection());
   // This event should get through to the clipboard stub.
   connection_->clipboard_stub()->InjectClipboardEvent(clipboard_event2);
   DisconnectClientSession();
   // This event should not get through to the clipboard stub,
@@ skipping 38 matching lines @@
   protocol::MouseEvent mouse_event2;
   mouse_event2.set_x(200);
   mouse_event2.set_y(201);
 
   protocol::MouseEvent mouse_event3;
   mouse_event3.set_x(300);
   mouse_event3.set_y(301);
 
   InSequence s;
   EXPECT_CALL(session_event_handler_, OnSessionAuthenticated(_));
+  EXPECT_CALL(*event_executor_, StartPtr(_));
   EXPECT_CALL(session_event_handler_, OnSessionChannelsConnected(_));
-  EXPECT_CALL(host_input_stub_, InjectKeyEvent(EqualsUsbEvent(2, true)));
-  EXPECT_CALL(host_input_stub_, InjectKeyEvent(EqualsUsbEvent(2, false)));
-  EXPECT_CALL(host_input_stub_, InjectMouseEvent(EqualsMouseEvent(200, 201)));
+  EXPECT_CALL(*event_executor_, InjectKeyEvent(EqualsUsbEvent(2, true)));
+  EXPECT_CALL(*event_executor_, InjectKeyEvent(EqualsUsbEvent(2, false)));
+  EXPECT_CALL(*event_executor_, InjectMouseEvent(EqualsMouseEvent(200, 201)));
   EXPECT_CALL(session_event_handler_, OnSessionClosed(_));
+  EXPECT_CALL(*event_executor_, StopAndDeleteMock());
 
   // These events should not get through to the input stub,
   // because the client isn't authenticated yet.
   connection_->input_stub()->InjectKeyEvent(key_event1);
   connection_->input_stub()->InjectMouseEvent(mouse_event1);
   client_session_->OnConnectionAuthenticated(client_session_->connection());
   client_session_->OnConnectionChannelsConnected(client_session_->connection());
   // These events should get through to the input stub.
   connection_->input_stub()->InjectKeyEvent(key_event2_down);
   connection_->input_stub()->InjectKeyEvent(key_event2_up);
@@ skipping 11 matching lines @@
   mouse_event1.set_y(101);
   protocol::MouseEvent mouse_event2;
   mouse_event2.set_x(200);
   mouse_event2.set_y(201);
   protocol::MouseEvent mouse_event3;
   mouse_event3.set_x(300);
   mouse_event3.set_y(301);
 
   InSequence s;
   EXPECT_CALL(session_event_handler_, OnSessionAuthenticated(_));
+  EXPECT_CALL(*event_executor_, StartPtr(_));
   EXPECT_CALL(session_event_handler_, OnSessionChannelsConnected(_));
-  EXPECT_CALL(host_input_stub_, InjectMouseEvent(EqualsMouseEvent(100, 101)));
-  EXPECT_CALL(host_input_stub_, InjectMouseEvent(EqualsMouseEvent(200, 201)));
+  EXPECT_CALL(*event_executor_, InjectMouseEvent(EqualsMouseEvent(100, 101)));
+  EXPECT_CALL(*event_executor_, InjectMouseEvent(EqualsMouseEvent(200, 201)));
   EXPECT_CALL(session_event_handler_, OnSessionClosed(_));
+  EXPECT_CALL(*event_executor_, StopAndDeleteMock());
 
   client_session_->OnConnectionAuthenticated(client_session_->connection());
   client_session_->OnConnectionChannelsConnected(client_session_->connection());
   // This event should get through to the input stub.
   connection_->input_stub()->InjectMouseEvent(mouse_event1);
   // This one should too because the local event echoes the remote one.
   client_session_->LocalMouseMoved(SkIPoint::Make(mouse_event1.x(),
                                                   mouse_event1.y()));
   connection_->input_stub()->InjectMouseEvent(mouse_event2);
   // This one should not.
@@ skipping 13 matching lines @@
   protocol::KeyEvent key2;
   key2.set_pressed(true);
   key2.set_usb_keycode(2);
 
   protocol::MouseEvent mousedown;
   mousedown.set_button(protocol::MouseEvent::BUTTON_LEFT);
   mousedown.set_button_down(true);
 
   InSequence s;
   EXPECT_CALL(session_event_handler_, OnSessionAuthenticated(_));
+  EXPECT_CALL(*event_executor_, StartPtr(_));
   EXPECT_CALL(session_event_handler_, OnSessionChannelsConnected(_));
-  EXPECT_CALL(host_input_stub_, InjectKeyEvent(EqualsUsbEvent(1, true)));
-  EXPECT_CALL(host_input_stub_, InjectKeyEvent(EqualsUsbEvent(2, true)));
-  EXPECT_CALL(host_input_stub_, InjectMouseEvent(EqualsMouseButtonEvent(
+  EXPECT_CALL(*event_executor_, InjectKeyEvent(EqualsUsbEvent(1, true)));
+  EXPECT_CALL(*event_executor_, InjectKeyEvent(EqualsUsbEvent(2, true)));
+  EXPECT_CALL(*event_executor_, InjectMouseEvent(EqualsMouseButtonEvent(
       protocol::MouseEvent::BUTTON_LEFT, true)));
-  EXPECT_CALL(host_input_stub_, InjectKeyEvent(EqualsUsbEvent(1, false)));
-  EXPECT_CALL(host_input_stub_, InjectKeyEvent(EqualsUsbEvent(2, false)));
-  EXPECT_CALL(host_input_stub_, InjectMouseEvent(EqualsMouseButtonEvent(
+  EXPECT_CALL(*event_executor_, InjectKeyEvent(EqualsUsbEvent(1, false)));
+  EXPECT_CALL(*event_executor_, InjectKeyEvent(EqualsUsbEvent(2, false)));
+  EXPECT_CALL(*event_executor_, InjectMouseEvent(EqualsMouseButtonEvent(
       protocol::MouseEvent::BUTTON_LEFT, false)));
   EXPECT_CALL(session_event_handler_, OnSessionClosed(_));
+  EXPECT_CALL(*event_executor_, StopAndDeleteMock());
 
   client_session_->OnConnectionAuthenticated(client_session_->connection());
   client_session_->OnConnectionChannelsConnected(client_session_->connection());
 
   connection_->input_stub()->InjectKeyEvent(key1);
   connection_->input_stub()->InjectKeyEvent(key2);
   connection_->input_stub()->InjectMouseEvent(mousedown);
 
   DisconnectClientSession();
 }
 
 TEST_F(ClientSessionTest, ClampMouseEvents) {
   SkISize screen(SkISize::Make(200, 100));
-  EXPECT_CALL(capturer_, size_most_recent())
+  EXPECT_CALL(*capturer_, size_most_recent())
       .WillRepeatedly(ReturnRef(screen));
 
   EXPECT_CALL(session_event_handler_, OnSessionAuthenticated(_));
-  EXPECT_CALL(session_event_handler_, OnSessionChannelsConnected(_));
+  EXPECT_CALL(*event_executor_, StartPtr(_));
+  Expectation connected =
+      EXPECT_CALL(session_event_handler_, OnSessionChannelsConnected(_));
   EXPECT_CALL(session_event_handler_, OnSessionClosed(_));
+  EXPECT_CALL(*event_executor_, StopAndDeleteMock());
 
   client_session_->OnConnectionAuthenticated(client_session_->connection());
   client_session_->OnConnectionChannelsConnected(client_session_->connection());
 
   int input_x[3] = { -999, 100, 999 };
   int expected_x[3] = { 0, 100, 199 };
   int input_y[3] = { -999, 50, 999 };
   int expected_y[3] = { 0, 50, 99 };
 
   protocol::MouseEvent event;
   for (int j = 0; j < 3; j++) {
     for (int i = 0; i < 3; i++) {
       event.set_x(input_x[i]);
       event.set_y(input_y[j]);
-      EXPECT_CALL(host_input_stub_, InjectMouseEvent(EqualsMouseEvent(
-          expected_x[i], expected_y[j])));
+      connected =
+          EXPECT_CALL(*event_executor_,
+                      InjectMouseEvent(EqualsMouseEvent(expected_x[i],
+                                                        expected_y[j])))
+              .After(connected);
       connection_->input_stub()->InjectMouseEvent(event);
     }
   }
 
   DisconnectClientSession();
 }
 
 }  // namespace remoting