Pepper: Introduce ThreadAwareCallback.

ppapi/proxy/ppapi_proxy_test.h

 // 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 <map>
 #include <string>
 
+#include "base/compiler_specific.h"
+#include "base/memory/ref_counted.h"
+#include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
-#include "base/memory/scoped_ptr.h"
 #include "base/synchronization/waitable_event.h"
+#include "base/threading/simple_thread.h"
 #include "base/threading/thread.h"
 #include "ppapi/c/pp_instance.h"
 #include "ppapi/proxy/host_dispatcher.h"
 #include "ppapi/proxy/plugin_dispatcher.h"
 #include "ppapi/proxy/plugin_globals.h"
 #include "ppapi/proxy/plugin_proxy_delegate.h"
 #include "ppapi/proxy/plugin_resource_tracker.h"
 #include "ppapi/proxy/plugin_var_tracker.h"
 #include "ppapi/proxy/resource_message_test_sink.h"
 #include "ppapi/shared_impl/test_globals.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
+namespace base {
+class MessageLoopProxy;
+class RunLoop;
+}
+
 namespace ppapi {
 namespace proxy {
 
+class MessageLoopResource;
+
 // Base class for plugin and host test harnesses. Tests will not use this
 // directly. Instead, use the PluginProxyTest, HostProxyTest, or TwoWayTest.
 class ProxyTestHarnessBase {
  public:
+  enum GlobalsConfiguration {
+    PER_THREAD_GLOBALS,
+    SINGLETON_GLOBALS
+  };
+
   ProxyTestHarnessBase();
   virtual ~ProxyTestHarnessBase();
 
   PP_Module pp_module() const { return pp_module_; }
   PP_Instance pp_instance() const { return pp_instance_; }
   ResourceMessageTestSink& sink() { return sink_; }
 
   virtual PpapiGlobals* GetGlobals() = 0;
   // Returns either the plugin or host dispatcher, depending on the test.
   virtual Dispatcher* GetDispatcher() = 0;
@@ skipping 31 matching lines @@
   PP_Module pp_module_;
   PP_Instance pp_instance_;
 
   // Stores the data for GetInterface/RegisterTestInterface.
   std::map<std::string, const void*> registered_interfaces_;
 };
 
 // Test harness for the plugin side of the proxy.
 class PluginProxyTestHarness : public ProxyTestHarnessBase {
  public:
-  PluginProxyTestHarness();
+  explicit PluginProxyTestHarness(GlobalsConfiguration globals_config);
   virtual ~PluginProxyTestHarness();
 
   PluginDispatcher* plugin_dispatcher() { return plugin_dispatcher_.get(); }
   PluginResourceTracker& resource_tracker() {
     return *plugin_globals_->plugin_resource_tracker();
   }
   PluginVarTracker& var_tracker() {
     return *plugin_globals_->plugin_var_tracker();
   }
 
@@ skipping 45 matching lines @@
    private:
     base::MessageLoopProxy* ipc_message_loop_;  // Weak
     base::WaitableEvent* shutdown_event_;  // Weak
     std::set<PP_Instance> instance_id_set_;
     IPC::Sender* browser_sender_;
 
     DISALLOW_COPY_AND_ASSIGN(PluginDelegateMock);
   };
 
  private:
+  void CreatePluginGlobals();
+
+  GlobalsConfiguration globals_config_;
   scoped_ptr<PluginGlobals> plugin_globals_;
 
   scoped_ptr<PluginDispatcher> plugin_dispatcher_;
   PluginDelegateMock plugin_delegate_mock_;
 };
 
 class PluginProxyTest : public PluginProxyTestHarness, public testing::Test {
  public:
   PluginProxyTest();
   virtual ~PluginProxyTest();
 
   // testing::Test implementation.
   virtual void SetUp();
   virtual void TearDown();
  private:
   MessageLoop message_loop_;
 };
 
+// This class provides support for multi-thread testing. A secondary thread is
+// created with a Pepper message loop.
+// Subclasses need to implement the two SetUpTestOn*Thread() methods to do the
+// actual testing work; and call both PostQuitFor*Thread() when testing is
+// done.
+class PluginProxyMultiThreadTest
+    : public PluginProxyTest,
+      public base::DelegateSimpleThread::Delegate {
+ public:
+  PluginProxyMultiThreadTest();
+  virtual ~PluginProxyMultiThreadTest();
+
+  // Called before the secondary thread is started, but after all the member
+  // variables, including |secondary_thread_| and
+  // |secondary_thread_message_loop_|, are initialized.
+  virtual void SetUpTestOnMainThread() = 0;
+
+  virtual void SetUpTestOnSecondaryThread() = 0;
+
+  // TEST_F() should call this method.
+  void RunTest();
+
+  enum ThreadType {
+    MAIN_THREAD,
+    SECONDARY_THREAD
+  };
+  void CheckOnValidThread(ThreadType thread_type);

[dmichael (off chromium), 2013/01/16 19:21:01]

nit: I think it's clearer now without "Valid"

[yzshen1, 2013/01/16 22:37:37]

Done.

+
+  // These can be called on any thread.
+  void PostQuitForMainThread();
+  void PostQuitForSecondaryThread();
+
+ protected:
+  scoped_refptr<MessageLoopResource> secondary_thread_message_loop_;
+  scoped_refptr<base::MessageLoopProxy> main_thread_message_loop_proxy_;
+
+ private:
+  // base::DelegateSimpleThread::Delegate implementation.
+  virtual void Run() OVERRIDE;
+
+  void QuitNestedLoop();
+
+  static void InternalSetUpTestOnSecondaryThread(void* user_data,
+                                                 int32_t result);
+
+  scoped_ptr<base::DelegateSimpleThread> secondary_thread_;
+  scoped_ptr<base::RunLoop> nested_main_thread_message_loop_;
+};
+
 class HostProxyTestHarness : public ProxyTestHarnessBase {
  public:
-  HostProxyTestHarness();
+  explicit HostProxyTestHarness(GlobalsConfiguration globals_config);
   virtual ~HostProxyTestHarness();
 
   HostDispatcher* host_dispatcher() { return host_dispatcher_.get(); }
   ResourceTracker& resource_tracker() {
     return *host_globals_->GetResourceTracker();
   }
   VarTracker& var_tracker() {
     return *host_globals_->GetVarTracker();
   }
 
@@ skipping 30 matching lines @@
    private:
     base::MessageLoopProxy* ipc_message_loop_;  // Weak
     base::WaitableEvent* shutdown_event_;  // Weak
 
     DISALLOW_COPY_AND_ASSIGN(DelegateMock);
   };
 
  private:
   class MockSyncMessageStatusReceiver;
 
+  void CreateHostGlobals();
+
+  GlobalsConfiguration globals_config_;
   scoped_ptr<ppapi::TestGlobals> host_globals_;
   scoped_ptr<HostDispatcher> host_dispatcher_;
   DelegateMock delegate_mock_;
 
   scoped_ptr<MockSyncMessageStatusReceiver> status_receiver_;
 };
 
 class HostProxyTest : public HostProxyTestHarness, public testing::Test {
  public:
   HostProxyTest();
@@ skipping 60 matching lines @@
 //   EXPECT_VAR_IS_STRING("foo", my_var);
 #define EXPECT_VAR_IS_STRING(str, var) { \
   StringVar* sv = StringVar::FromPPVar(var); \
   EXPECT_TRUE(sv); \
   if (sv) \
     EXPECT_EQ(str, sv->value()); \
 }
 
 }  // namespace proxy
 }  // namespace ppapi