remoting/base/auto_thread_unittest.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "base/bind.h"
   6 #include "base/files/file_path.h"
   7 #include "base/memory/ref_counted.h"
   8 #include "base/scoped_native_library.h"
   9 #include "remoting/base/auto_thread.h"
  10 #include "testing/gtest/include/gtest/gtest.h"
  11
  12 #if defined(OS_WIN)
  13 #include <objbase.h>
  14 #include "base/win/windows_version.h"
  15 #endif
  16
  17 namespace {
  18
  19 const char kThreadName[] = "Test thread";
  20 const char kThreadName2[] = "Test thread 2";
  21
  22 void SetFlagTask(bool* success) {
  23   *success = true;
  24 }
  25
  26 void PostSetFlagTask(
  27     scoped_refptr<base::TaskRunner> task_runner,
  28     bool* success) {
  29   task_runner->PostTask(FROM_HERE, base::Bind(&SetFlagTask, success));
  30 }
  31
  32 #if defined(OS_WIN)
  33 void CheckComAptTypeTask(APTTYPE* apt_type_out, HRESULT* hresult) {
  34   typedef HRESULT (WINAPI * CoGetApartmentTypeFunc)
  35       (APTTYPE*, APTTYPEQUALIFIER*);
  36
  37   // CoGetApartmentType requires Windows 7 or above.
  38   if (base::win::GetVersion() < base::win::VERSION_WIN7) {
  39     *hresult = E_NOTIMPL;
  40     return;
  41   }
  42
  43   // Dynamic link to the API so the same test binary can run on older systems.
  44   base::ScopedNativeLibrary com_library(base::FilePath(L"ole32.dll"));
  45   ASSERT_TRUE(com_library.is_valid());
  46   CoGetApartmentTypeFunc co_get_apartment_type =
  47       static_cast<CoGetApartmentTypeFunc>(
  48           com_library.GetFunctionPointer("CoGetApartmentType"));
  49   ASSERT_TRUE(co_get_apartment_type != NULL);
  50
  51   APTTYPEQUALIFIER apt_type_qualifier;
  52   *hresult = (*co_get_apartment_type)(apt_type_out, &apt_type_qualifier);
  53 }
  54 #endif
  55
  56 }  // namespace
  57
  58 namespace remoting {
  59
  60 class AutoThreadTest : public testing::Test {
  61  public:
  62   AutoThreadTest() : message_loop_quit_correctly_(false) {
  63   }
  64
  65   void RunMessageLoop() {
  66     // Release |main_task_runner_|, then run |message_loop_| until other
  67     // references created in tests are gone.  We also post a delayed quit
  68     // task to |message_loop_| so the test will not hang on failure.
  69     main_task_runner_ = NULL;
  70     message_loop_.PostDelayedTask(
  71         FROM_HERE, MessageLoop::QuitClosure(), base::TimeDelta::FromSeconds(5));
  72     message_loop_.Run();
  73   }
  74
  75   virtual void SetUp() OVERRIDE {
  76     main_task_runner_ = new AutoThreadTaskRunner(
  77         message_loop_.message_loop_proxy(),
  78         base::Bind(&AutoThreadTest::QuitMainMessageLoop,
  79                    base::Unretained(this)));
  80   }
  81
  82   virtual void TearDown() OVERRIDE {
  83     // Verify that |message_loop_| was quit by the AutoThreadTaskRunner.
  84     EXPECT_TRUE(message_loop_quit_correctly_);
  85   }
  86
  87  protected:
  88   void QuitMainMessageLoop() {
  89     message_loop_quit_correctly_ = true;
  90     message_loop_.PostTask(FROM_HERE, MessageLoop::QuitClosure());
  91   }
  92
  93   MessageLoop message_loop_;
  94   bool message_loop_quit_correctly_;
  95   scoped_refptr<AutoThreadTaskRunner> main_task_runner_;
  96 };
  97
  98 TEST_F(AutoThreadTest, StartAndStop) {
  99   // Create an AutoThread joined by our MessageLoop.
 100   scoped_refptr<base::TaskRunner> task_runner =
 101       AutoThread::Create(kThreadName, main_task_runner_);
 102   EXPECT_TRUE(task_runner.get());
 103
 104   task_runner = NULL;
 105   RunMessageLoop();
 106 }
 107
 108 TEST_F(AutoThreadTest, ProcessTask) {
 109   // Create an AutoThread joined by our MessageLoop.
 110   scoped_refptr<base::TaskRunner> task_runner =
 111       AutoThread::Create(kThreadName, main_task_runner_);
 112   EXPECT_TRUE(task_runner.get());
 113
 114   // Post a task to it.
 115   bool success = false;
 116   task_runner->PostTask(FROM_HERE, base::Bind(&SetFlagTask, &success));
 117
 118   task_runner = NULL;
 119   RunMessageLoop();
 120
 121   EXPECT_TRUE(success);
 122 }
 123
 124 TEST_F(AutoThreadTest, ThreadDependency) {
 125   // Create two AutoThreads joined by our MessageLoop.
 126   scoped_refptr<base::TaskRunner> task_runner1 =
 127       AutoThread::Create(kThreadName, main_task_runner_);
 128   EXPECT_TRUE(task_runner1.get());
 129   scoped_refptr<base::TaskRunner> task_runner2 =
 130       AutoThread::Create(kThreadName, main_task_runner_);
 131   EXPECT_TRUE(task_runner2.get());
 132
 133   // Post a task to thread 1 that will post a task to thread 2.
 134   bool success = false;
 135   task_runner1->PostTask(FROM_HERE,
 136       base::Bind(&PostSetFlagTask, task_runner2, &success));
 137
 138   task_runner1 = NULL;
 139   task_runner2 = NULL;
 140   RunMessageLoop();
 141
 142   EXPECT_TRUE(success);
 143 }
 144
 145 #if defined(OS_WIN)
 146 TEST_F(AutoThreadTest, ThreadWithComMta) {
 147   scoped_refptr<base::TaskRunner> task_runner =
 148       AutoThread::CreateWithLoopAndComInitTypes(
 149           kThreadName, main_task_runner_, MessageLoop::TYPE_DEFAULT,
 150           AutoThread::COM_INIT_MTA);
 151   EXPECT_TRUE(task_runner.get());
 152
 153   // Post a task to query the COM apartment type.
 154   HRESULT hresult = E_FAIL;
 155   APTTYPE apt_type = APTTYPE_NA;
 156   task_runner->PostTask(FROM_HERE,
 157                         base::Bind(&CheckComAptTypeTask, &apt_type, &hresult));
 158
 159   task_runner = NULL;
 160   RunMessageLoop();
 161
 162   // CoGetApartmentType requires Windows 7 or above.
 163   if (base::win::GetVersion() >= base::win::VERSION_WIN7) {
 164     EXPECT_EQ(S_OK, hresult);
 165     EXPECT_EQ(APTTYPE_MTA, apt_type);
 166   } else {
 167     EXPECT_EQ(E_NOTIMPL, hresult);
 168   }
 169 }
 170
 171 TEST_F(AutoThreadTest, ThreadWithComSta) {
 172   scoped_refptr<base::TaskRunner> task_runner =
 173       AutoThread::CreateWithLoopAndComInitTypes(
 174           kThreadName, main_task_runner_, MessageLoop::TYPE_UI,
 175           AutoThread::COM_INIT_STA);
 176   EXPECT_TRUE(task_runner.get());
 177
 178   // Post a task to query the COM apartment type.
 179   HRESULT hresult = E_FAIL;
 180   APTTYPE apt_type = APTTYPE_NA;
 181   task_runner->PostTask(FROM_HERE,
 182                         base::Bind(&CheckComAptTypeTask, &apt_type, &hresult));
 183
 184   task_runner = NULL;
 185   RunMessageLoop();
 186
 187   // CoGetApartmentType requires Windows 7 or above.
 188   if (base::win::GetVersion() >= base::win::VERSION_WIN7) {
 189     EXPECT_EQ(S_OK, hresult);
 190     // Whether the thread is the "main" STA apartment depends upon previous
 191     // COM activity in this test process, so allow both types here.
 192     EXPECT_TRUE(apt_type == APTTYPE_MAINSTA || apt_type == APTTYPE_STA);
 193   } else {
 194     EXPECT_EQ(E_NOTIMPL, hresult);
 195   }
 196 }
 197 #endif // defined(OS_WIN)
 198
 199 }  // namespace remoting