Touch Events capability negotiation

remoting/host/ipc_desktop_environment_unittest.cc

 // Copyright (c) 2013 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/bind.h"
 #include "base/bind_helpers.h"
 #include "base/callback.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop/message_loop.h"
@@ skipping 151 matching lines @@
 
   // Destroys the desktop process object created by CreateDesktopProcess().
   void DestoyDesktopProcess();
 
   void OnDisconnectCallback();
 
   // Invoked when ChromotingDesktopDaemonMsg_DesktopAttached message is
   // received.
   void OnDesktopAttached(IPC::PlatformFileForTransit desktop_pipe);
 
+  void RunMainLoopUntilDone();
+
   // The main message loop.
   base::MessageLoopForUI message_loop_;
 
   // Runs until |desktop_session_proxy_| is connected to the desktop.
   scoped_ptr<base::RunLoop> setup_run_loop_;
 
   // Runs until there are references to |task_runner_|.
   base::RunLoop main_run_loop_;

[Wez, 2015/05/21 22:10:45]

nit: Make this private, so that the derived tests can't mistakenly try to use
it?

[Rintaro Kuroiwa, 2015/05/22 01:04:04]

Done.

 
   scoped_refptr<AutoThreadTaskRunner> task_runner_;
   scoped_refptr<AutoThreadTaskRunner> io_task_runner_;
 
   std::string client_jid_;
 
   // Clipboard stub that receives clipboard events from the desktop process.
   protocol::ClipboardStub* clipboard_stub_;
 
   // The daemons's end of the daemon-to-desktop channel.
@@ skipping 241 matching lines @@
   ASSERT_NE(FALSE, ::DuplicateHandle(GetCurrentProcess(), process_handle,
                                      GetCurrentProcess(), &process_handle,
                                      0, FALSE, DUPLICATE_SAME_ACCESS));
 #endif
 
   // Instruct DesktopSessionProxy to connect to the network-to-desktop pipe.
   desktop_environment_factory_->OnDesktopSessionAgentAttached(
       terminal_id_, process_handle, desktop_pipe);
 }
 
+void IpcDesktopEnvironmentTest::RunMainLoopUntilDone() {
+  task_runner_ = nullptr;
+  io_task_runner_ = nullptr;
+  main_run_loop_.Run();
+}
+
 // Runs until the desktop is attached and exits immediately after that.
 TEST_F(IpcDesktopEnvironmentTest, Basic) {
   scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
       new protocol::MockClipboardStub());
   EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
       .Times(0);
 
   // Start the input injector and screen capturer.
   input_injector_->Start(clipboard_stub.Pass());
 
   // Run the message loop until the desktop is attached.
   setup_run_loop_->Run();
 
   // Stop the test.
   DeleteDesktopEnvironment();
 
-  task_runner_ = nullptr;
-  io_task_runner_ = nullptr;
-  main_run_loop_.Run();
+  RunMainLoopUntilDone();
+}
+
+// Check Capabilities.
+TEST_F(IpcDesktopEnvironmentTest, CapabilitiesNoTouch) {
+  scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
+      new protocol::MockClipboardStub());
+  EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
+      .Times(0);
+
+  EXPECT_EQ("rateLimitResizeRequests", desktop_environment_->GetCapabilities());
+
+  // Start the input injector and screen capturer.
+  input_injector_->Start(clipboard_stub.Pass());
+
+  // Run the message loop until the desktop is attached.
+  setup_run_loop_->Run();
+
+  // Stop the test.
+  DeleteDesktopEnvironment();
+
+  RunMainLoopUntilDone();
+}
+
+// Check touchEvents capability is set when the desktop environment can
+// inject touch events.
+TEST_F(IpcDesktopEnvironmentTest, TouchEventsCapabilities) {
+  // Create an environment with multi touch enabled.
+  desktop_environment_factory_->set_supports_touch_events(true);
+  desktop_environment_ = desktop_environment_factory_->Create(
+      client_session_control_factory_.GetWeakPtr());
+
+  scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
+      new protocol::MockClipboardStub());
+  EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
+      .Times(0);
+
+  EXPECT_EQ("rateLimitResizeRequests touchEvents",
+            desktop_environment_->GetCapabilities());
+
+  // Start the input injector and screen capturer.
+  input_injector_->Start(clipboard_stub.Pass());
+
+  // Run the message loop until the desktop is attached.
+  setup_run_loop_->Run();
+
+  // Stop the test.
+  DeleteDesktopEnvironment();
+
+  RunMainLoopUntilDone();
 }
 
 // Tests that the video capturer receives a frame over IPC.
 TEST_F(IpcDesktopEnvironmentTest, CaptureFrame) {
   scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
       new protocol::MockClipboardStub());
   EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
       .Times(0);
 
   // Start the input injector and screen capturer.
   input_injector_->Start(clipboard_stub.Pass());
   video_capturer_->Start(&desktop_capturer_callback_);
 
   // Run the message loop until the desktop is attached.
   setup_run_loop_->Run();
 
   // Stop the test when the first frame is captured.
   EXPECT_CALL(desktop_capturer_callback_, OnCaptureCompleted(_))
       .WillOnce(DoAll(
           DeleteArg<0>(),
           InvokeWithoutArgs(
               this, &IpcDesktopEnvironmentTest::DeleteDesktopEnvironment)));
 
   // Capture a single frame.
   video_capturer_->Capture(webrtc::DesktopRegion());
 
-  task_runner_ = nullptr;
-  io_task_runner_ = nullptr;
-  main_run_loop_.Run();
+  RunMainLoopUntilDone();
 }
 
 // Tests that attaching to a new desktop works.
 TEST_F(IpcDesktopEnvironmentTest, Reattach) {
   scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
       new protocol::MockClipboardStub());
   EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
       .Times(0);
 
   // Start the input injector and screen capturer.
   input_injector_->Start(clipboard_stub.Pass());
   video_capturer_->Start(&desktop_capturer_callback_);
 
   // Run the message loop until the desktop is attached.
   setup_run_loop_->Run();
 
   // Create and start a new desktop process object.
   setup_run_loop_.reset(new base::RunLoop());
   DestoyDesktopProcess();
   CreateDesktopProcess();
   setup_run_loop_->Run();
 
   // Stop the test.
   DeleteDesktopEnvironment();
 
-  task_runner_ = nullptr;
-  io_task_runner_ = nullptr;
-  main_run_loop_.Run();
+  RunMainLoopUntilDone();
 }
 
 // Tests injection of clipboard events.
 TEST_F(IpcDesktopEnvironmentTest, InjectClipboardEvent) {
   scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
       new protocol::MockClipboardStub());
   clipboard_stub_ = clipboard_stub.get();
 
   // Stop the test when a clipboard event is received from the desktop process.
   EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
@@ skipping 13 matching lines @@
       .Times(1)
       .WillOnce(Invoke(this,
                        &IpcDesktopEnvironmentTest::ReflectClipboardEvent));
 
   // Send a clipboard event.
   protocol::ClipboardEvent event;
   event.set_mime_type(kMimeTypeTextUtf8);
   event.set_data("a");
   input_injector_->InjectClipboardEvent(event);
 
-  task_runner_ = nullptr;
-  io_task_runner_ = nullptr;
-  main_run_loop_.Run();
+  RunMainLoopUntilDone();
 }
 
 // Tests injection of key events.
 TEST_F(IpcDesktopEnvironmentTest, InjectKeyEvent) {
   scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
       new protocol::MockClipboardStub());
   EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
       .Times(0);
 
   // Start the input injector and screen capturer.
   input_injector_->Start(clipboard_stub.Pass());
   video_capturer_->Start(&desktop_capturer_callback_);
 
   // Run the message loop until the desktop is attached.
   setup_run_loop_->Run();
 
   // Expect a single key event.
   EXPECT_CALL(*remote_input_injector_, InjectKeyEvent(_))
       .Times(AtLeast(1))
       .WillRepeatedly(InvokeWithoutArgs(
           this, &IpcDesktopEnvironmentTest::DeleteDesktopEnvironment));
 
   // Send a key event.
   protocol::KeyEvent event;
   event.set_usb_keycode(0x070004);
   event.set_pressed(true);
   input_injector_->InjectKeyEvent(event);
 
-  task_runner_ = nullptr;
-  io_task_runner_ = nullptr;
-  main_run_loop_.Run();
+  RunMainLoopUntilDone();
 }
 
 // Tests injection of text events.
 TEST_F(IpcDesktopEnvironmentTest, InjectTextEvent) {
   scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
       new protocol::MockClipboardStub());
   EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
       .Times(0);
 
   // Start the input injector and screen capturer.
   input_injector_->Start(clipboard_stub.Pass());
   video_capturer_->Start(&desktop_capturer_callback_);
 
   // Run the message loop until the desktop is attached.
   setup_run_loop_->Run();
 
   // Expect a single text event.
   EXPECT_CALL(*remote_input_injector_, InjectTextEvent(_))
       .Times(AtLeast(1))
       .WillRepeatedly(InvokeWithoutArgs(
           this, &IpcDesktopEnvironmentTest::DeleteDesktopEnvironment));
 
   // Send a text event.
   protocol::TextEvent event;
   event.set_text("hello");
   input_injector_->InjectTextEvent(event);
 
-  task_runner_ = nullptr;
-  io_task_runner_ = nullptr;
-  main_run_loop_.Run();
+  RunMainLoopUntilDone();
 }
 
 // Tests injection of mouse events.
 TEST_F(IpcDesktopEnvironmentTest, InjectMouseEvent) {
   scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
       new protocol::MockClipboardStub());
   EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
       .Times(0);
 
   // Start the input injector and screen capturer.
   input_injector_->Start(clipboard_stub.Pass());
   video_capturer_->Start(&desktop_capturer_callback_);
 
   // Run the message loop until the desktop is attached.
   setup_run_loop_->Run();
 
   // Expect a single mouse event.
   EXPECT_CALL(*remote_input_injector_, InjectMouseEvent(_))
       .Times(1)
       .WillOnce(InvokeWithoutArgs(
           this, &IpcDesktopEnvironmentTest::DeleteDesktopEnvironment));
 
   // Send a mouse event.
   protocol::MouseEvent event;
   event.set_x(0);
   event.set_y(0);
   input_injector_->InjectMouseEvent(event);
 
-  task_runner_ = nullptr;
-  io_task_runner_ = nullptr;
-  main_run_loop_.Run();
+  RunMainLoopUntilDone();
 }
 
 // Tests injection of touch events.
 TEST_F(IpcDesktopEnvironmentTest, InjectTouchEvent) {
   scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
       new protocol::MockClipboardStub());
   EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
       .Times(0);
 
   // Start the input injector and screen capturer.
@@ skipping 23 matching lines @@
   // And one more call for ReleaseAll().
   EXPECT_CALL(*remote_input_injector_,
               InjectTouchEvent(EqualsTouchEvent(event)));
   EXPECT_CALL(*remote_input_injector_,
               InjectTouchEvent(EqualsTouchEventTypeAndId(
                   protocol::TouchEvent::TOUCH_POINT_CANCEL, 0u)));
 
   // Send the touch event.
   input_injector_->InjectTouchEvent(event);
 
-  task_runner_ = nullptr;
-  io_task_runner_ = nullptr;
-  main_run_loop_.Run();
+  RunMainLoopUntilDone();
 }
 
 // Tests that setting the desktop resolution works.
 TEST_F(IpcDesktopEnvironmentTest, SetScreenResolution) {
   scoped_ptr<protocol::MockClipboardStub> clipboard_stub(
       new protocol::MockClipboardStub());
   EXPECT_CALL(*clipboard_stub, InjectClipboardEvent(_))
       .Times(0);
 
   // Start the input injector and screen capturer.
   input_injector_->Start(clipboard_stub.Pass());
   video_capturer_->Start(&desktop_capturer_callback_);
 
   // Run the message loop until the desktop is attached.
   setup_run_loop_->Run();
 
   EXPECT_CALL(daemon_channel_, SetScreenResolution(_, _))
       .Times(1)
       .WillOnce(InvokeWithoutArgs(
           this, &IpcDesktopEnvironmentTest::DeleteDesktopEnvironment));
 
   // Change the desktop resolution.
   screen_controls_->SetScreenResolution(ScreenResolution(
       webrtc::DesktopSize(100, 100),
       webrtc::DesktopVector(96, 96)));
 
-  task_runner_ = nullptr;
-  io_task_runner_ = nullptr;
-  main_run_loop_.Run();
+  RunMainLoopUntilDone();
 }
 
 }  // namespace remoting