base/threading/non_thread_safe_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/basictypes.h"
   6 #include "base/logging.h"
   7 #include "base/memory/scoped_ptr.h"
   8 #include "base/threading/non_thread_safe.h"
   9 #include "base/threading/simple_thread.h"
  10 #include "testing/gtest/include/gtest/gtest.h"
  11
  12 // Duplicated from base/threading/non_thread_safe.h so that we can be
  13 // good citizens there and undef the macro.
  14 #if (!defined(NDEBUG) || defined(DCHECK_ALWAYS_ON))
  15 #define ENABLE_NON_THREAD_SAFE 1
  16 #else
  17 #define ENABLE_NON_THREAD_SAFE 0
  18 #endif
  19
  20 namespace base {
  21
  22 namespace {
  23
  24 // Simple class to exersice the basics of NonThreadSafe.
  25 // Both the destructor and DoStuff should verify that they were
  26 // called on the same thread as the constructor.
  27 class NonThreadSafeClass : public NonThreadSafe {
  28  public:
  29   NonThreadSafeClass() {}
  30
  31   // Verifies that it was called on the same thread as the constructor.
  32   void DoStuff() {
  33     DCHECK(CalledOnValidThread());
  34   }
  35
  36   void DetachFromThread() {
  37     NonThreadSafe::DetachFromThread();
  38   }
  39
  40   static void MethodOnDifferentThreadImpl();
  41   static void DestructorOnDifferentThreadImpl();
  42
  43  private:
  44   DISALLOW_COPY_AND_ASSIGN(NonThreadSafeClass);
  45 };
  46
  47 // Calls NonThreadSafeClass::DoStuff on another thread.
  48 class CallDoStuffOnThread : public SimpleThread {
  49  public:
  50   CallDoStuffOnThread(NonThreadSafeClass* non_thread_safe_class)
  51       : SimpleThread("call_do_stuff_on_thread"),
  52         non_thread_safe_class_(non_thread_safe_class) {
  53   }
  54
  55   virtual void Run() OVERRIDE {
  56     non_thread_safe_class_->DoStuff();
  57   }
  58
  59  private:
  60   NonThreadSafeClass* non_thread_safe_class_;
  61
  62   DISALLOW_COPY_AND_ASSIGN(CallDoStuffOnThread);
  63 };
  64
  65 // Deletes NonThreadSafeClass on a different thread.
  66 class DeleteNonThreadSafeClassOnThread : public SimpleThread {
  67  public:
  68   DeleteNonThreadSafeClassOnThread(NonThreadSafeClass* non_thread_safe_class)
  69       : SimpleThread("delete_non_thread_safe_class_on_thread"),
  70         non_thread_safe_class_(non_thread_safe_class) {
  71   }
  72
  73   virtual void Run() OVERRIDE {
  74     non_thread_safe_class_.reset();
  75   }
  76
  77  private:
  78   scoped_ptr<NonThreadSafeClass> non_thread_safe_class_;
  79
  80   DISALLOW_COPY_AND_ASSIGN(DeleteNonThreadSafeClassOnThread);
  81 };
  82
  83 }  // namespace
  84
  85 TEST(NonThreadSafeTest, CallsAllowedOnSameThread) {
  86   scoped_ptr<NonThreadSafeClass> non_thread_safe_class(
  87       new NonThreadSafeClass);
  88
  89   // Verify that DoStuff doesn't assert.
  90   non_thread_safe_class->DoStuff();
  91
  92   // Verify that the destructor doesn't assert.
  93   non_thread_safe_class.reset();
  94 }
  95
  96 TEST(NonThreadSafeTest, DetachThenDestructOnDifferentThread) {
  97   scoped_ptr<NonThreadSafeClass> non_thread_safe_class(
  98       new NonThreadSafeClass);
  99
 100   // Verify that the destructor doesn't assert when called on a different thread
 101   // after a detach.
 102   non_thread_safe_class->DetachFromThread();
 103   DeleteNonThreadSafeClassOnThread delete_on_thread(
 104       non_thread_safe_class.release());
 105
 106   delete_on_thread.Start();
 107   delete_on_thread.Join();
 108 }
 109
 110 #if GTEST_HAS_DEATH_TEST || !ENABLE_NON_THREAD_SAFE
 111
 112 void NonThreadSafeClass::MethodOnDifferentThreadImpl() {
 113   scoped_ptr<NonThreadSafeClass> non_thread_safe_class(
 114       new NonThreadSafeClass);
 115
 116   // Verify that DoStuff asserts in debug builds only when called
 117   // on a different thread.
 118   CallDoStuffOnThread call_on_thread(non_thread_safe_class.get());
 119
 120   call_on_thread.Start();
 121   call_on_thread.Join();
 122 }
 123
 124 #if ENABLE_NON_THREAD_SAFE
 125 TEST(NonThreadSafeDeathTest, MethodNotAllowedOnDifferentThreadInDebug) {
 126   ASSERT_DEATH({
 127       NonThreadSafeClass::MethodOnDifferentThreadImpl();
 128     }, "");
 129 }
 130 #else
 131 TEST(NonThreadSafeTest, MethodAllowedOnDifferentThreadInRelease) {
 132   NonThreadSafeClass::MethodOnDifferentThreadImpl();
 133 }
 134 #endif  // ENABLE_NON_THREAD_SAFE
 135
 136 void NonThreadSafeClass::DestructorOnDifferentThreadImpl() {
 137   scoped_ptr<NonThreadSafeClass> non_thread_safe_class(
 138       new NonThreadSafeClass);
 139
 140   // Verify that the destructor asserts in debug builds only
 141   // when called on a different thread.
 142   DeleteNonThreadSafeClassOnThread delete_on_thread(
 143       non_thread_safe_class.release());
 144
 145   delete_on_thread.Start();
 146   delete_on_thread.Join();
 147 }
 148
 149 #if ENABLE_NON_THREAD_SAFE
 150 TEST(NonThreadSafeDeathTest, DestructorNotAllowedOnDifferentThreadInDebug) {
 151   ASSERT_DEATH({
 152       NonThreadSafeClass::DestructorOnDifferentThreadImpl();
 153     }, "");
 154 }
 155 #else
 156 TEST(NonThreadSafeTest, DestructorAllowedOnDifferentThreadInRelease) {
 157   NonThreadSafeClass::DestructorOnDifferentThreadImpl();
 158 }
 159 #endif  // ENABLE_NON_THREAD_SAFE
 160
 161 #endif  // GTEST_HAS_DEATH_TEST || !ENABLE_NON_THREAD_SAFE
 162
 163 // Just in case we ever get lumped together with other compilation units.
 164 #undef ENABLE_NON_THREAD_SAFE
 165
 166 }  // namespace base