ppapi/proxy/ppapi_proxy_test.h

   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 <map>
   6 #include <string>
   7
   8 #include "base/compiler_specific.h"
   9 #include "base/memory/ref_counted.h"
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/message_loop/message_loop.h"
  12 #include "base/synchronization/waitable_event.h"
  13 #include "base/task_runner.h"
  14 #include "base/threading/simple_thread.h"
  15 #include "base/threading/thread.h"
  16 #include "ppapi/c/pp_instance.h"
  17 #include "ppapi/proxy/host_dispatcher.h"
  18 #include "ppapi/proxy/plugin_dispatcher.h"
  19 #include "ppapi/proxy/plugin_globals.h"
  20 #include "ppapi/proxy/plugin_proxy_delegate.h"
  21 #include "ppapi/proxy/plugin_resource_tracker.h"
  22 #include "ppapi/proxy/plugin_var_tracker.h"
  23 #include "ppapi/proxy/resource_message_test_sink.h"
  24 #include "ppapi/shared_impl/proxy_lock.h"
  25 #include "ppapi/shared_impl/test_globals.h"
  26 #include "testing/gtest/include/gtest/gtest.h"
  27
  28 namespace base {
  29 class MessageLoopProxy;
  30 class RunLoop;
  31 }
  32
  33 namespace ppapi {
  34 namespace proxy {
  35
  36 class MessageLoopResource;
  37
  38 // Base class for plugin and host test harnesses. Tests will not use this
  39 // directly. Instead, use the PluginProxyTest, HostProxyTest, or TwoWayTest.
  40 class ProxyTestHarnessBase {
  41  public:
  42   enum GlobalsConfiguration {
  43     PER_THREAD_GLOBALS,
  44     SINGLETON_GLOBALS
  45   };
  46
  47   ProxyTestHarnessBase();
  48   virtual ~ProxyTestHarnessBase();
  49
  50   PP_Module pp_module() const { return pp_module_; }
  51   PP_Instance pp_instance() const { return pp_instance_; }
  52   ResourceMessageTestSink& sink() { return sink_; }
  53
  54   virtual PpapiGlobals* GetGlobals() = 0;
  55   // Returns either the plugin or host dispatcher, depending on the test.
  56   virtual Dispatcher* GetDispatcher() = 0;
  57
  58   // Set up the harness using an IPC::TestSink to capture messages.
  59   virtual void SetUpHarness() = 0;
  60
  61   // Set up the harness using a real IPC channel.
  62   virtual void SetUpHarnessWithChannel(const IPC::ChannelHandle& channel_handle,
  63                                        base::MessageLoopProxy* ipc_message_loop,
  64                                        base::WaitableEvent* shutdown_event,
  65                                        bool is_client) = 0;
  66
  67   virtual void TearDownHarness() = 0;
  68
  69   // Implementation of GetInterface for the dispatcher. This will
  70   // return NULL for all interfaces unless one is registered by calling
  71   // RegisterTestInterface();
  72   const void* GetInterface(const char* name);
  73
  74   // Allows the test to specify an interface implementation for a given
  75   // interface name. This will be returned when any of the proxy logic
  76   // requests a local interface.
  77   void RegisterTestInterface(const char* name, const void* test_interface);
  78
  79   // Sends a "supports interface" message to the current dispatcher and returns
  80   // true if it's supported. This is just for the convenience of tests.
  81   bool SupportsInterface(const char* name);
  82
  83  private:
  84   // Destination for IPC messages sent by the test.
  85   ResourceMessageTestSink sink_;
  86
  87   // The module and instance ID associated with the plugin dispatcher.
  88   PP_Module pp_module_;
  89   PP_Instance pp_instance_;
  90
  91   // Stores the data for GetInterface/RegisterTestInterface.
  92   std::map<std::string, const void*> registered_interfaces_;
  93 };
  94
  95 // Test harness for the plugin side of the proxy.
  96 class PluginProxyTestHarness : public ProxyTestHarnessBase {
  97  public:
  98   explicit PluginProxyTestHarness(GlobalsConfiguration globals_config);
  99   virtual ~PluginProxyTestHarness();
 100
 101   PluginDispatcher* plugin_dispatcher() { return plugin_dispatcher_.get(); }
 102   PluginResourceTracker& resource_tracker() {
 103     return *plugin_globals_->plugin_resource_tracker();
 104   }
 105   PluginVarTracker& var_tracker() {
 106     return *plugin_globals_->plugin_var_tracker();
 107   }
 108
 109   // ProxyTestHarnessBase implementation.
 110   virtual PpapiGlobals* GetGlobals();
 111   virtual Dispatcher* GetDispatcher();
 112   virtual void SetUpHarness();
 113   virtual void SetUpHarnessWithChannel(const IPC::ChannelHandle& channel_handle,
 114                                        base::MessageLoopProxy* ipc_message_loop,
 115                                        base::WaitableEvent* shutdown_event,
 116                                        bool is_client);
 117   virtual void TearDownHarness();
 118
 119   class PluginDelegateMock : public PluginDispatcher::PluginDelegate,
 120                              public PluginProxyDelegate {
 121    public:
 122     PluginDelegateMock() : ipc_message_loop_(NULL), shutdown_event_() {}
 123     virtual ~PluginDelegateMock() {}
 124
 125     void Init(base::MessageLoopProxy* ipc_message_loop,
 126               base::WaitableEvent* shutdown_event) {
 127       ipc_message_loop_ = ipc_message_loop;
 128       shutdown_event_ = shutdown_event;
 129     }
 130
 131     void set_browser_sender(IPC::Sender* browser_sender) {
 132       browser_sender_ = browser_sender;
 133     }
 134
 135     // ProxyChannel::Delegate implementation.
 136     virtual base::MessageLoopProxy* GetIPCMessageLoop() override;
 137     virtual base::WaitableEvent* GetShutdownEvent() override;
 138     virtual IPC::PlatformFileForTransit ShareHandleWithRemote(
 139         base::PlatformFile handle,
 140         base::ProcessId remote_pid,
 141         bool should_close_source) override;
 142
 143     // PluginDispatcher::PluginDelegate implementation.
 144     virtual std::set<PP_Instance>* GetGloballySeenInstanceIDSet() override;
 145     virtual uint32 Register(PluginDispatcher* plugin_dispatcher) override;
 146     virtual void Unregister(uint32 plugin_dispatcher_id) override;
 147
 148     // PluginProxyDelegate implementation.
 149     virtual IPC::Sender* GetBrowserSender() override;
 150     virtual std::string GetUILanguage() override;
 151     virtual void PreCacheFont(const void* logfontw) override;
 152     virtual void SetActiveURL(const std::string& url) override;
 153     virtual PP_Resource CreateBrowserFont(
 154         Connection connection,
 155         PP_Instance instance,
 156         const PP_BrowserFont_Trusted_Description& desc,
 157         const Preferences& prefs) override;
 158
 159    private:
 160     base::MessageLoopProxy* ipc_message_loop_;  // Weak
 161     base::WaitableEvent* shutdown_event_;  // Weak
 162     std::set<PP_Instance> instance_id_set_;
 163     IPC::Sender* browser_sender_;
 164
 165     DISALLOW_COPY_AND_ASSIGN(PluginDelegateMock);
 166   };
 167
 168  private:
 169   void CreatePluginGlobals(
 170       const scoped_refptr<base::TaskRunner>& ipc_task_runner);
 171
 172   GlobalsConfiguration globals_config_;
 173   scoped_ptr<PluginGlobals> plugin_globals_;
 174
 175   scoped_ptr<PluginDispatcher> plugin_dispatcher_;
 176   PluginDelegateMock plugin_delegate_mock_;
 177 };
 178
 179 class PluginProxyTest : public PluginProxyTestHarness, public testing::Test {
 180  public:
 181   PluginProxyTest();
 182   virtual ~PluginProxyTest();
 183
 184   // testing::Test implementation.
 185   virtual void SetUp();
 186   virtual void TearDown();
 187  private:
 188   base::MessageLoop message_loop_;
 189 };
 190
 191 // This class provides support for multi-thread testing. A secondary thread is
 192 // created with a Pepper message loop.
 193 // Subclasses need to implement the two SetUpTestOn*Thread() methods to do the
 194 // actual testing work; and call both PostQuitFor*Thread() when testing is
 195 // done.
 196 class PluginProxyMultiThreadTest
 197     : public PluginProxyTest,
 198       public base::DelegateSimpleThread::Delegate {
 199  public:
 200   PluginProxyMultiThreadTest();
 201   virtual ~PluginProxyMultiThreadTest();
 202
 203   // Called before the secondary thread is started, but after all the member
 204   // variables, including |secondary_thread_| and
 205   // |secondary_thread_message_loop_|, are initialized.
 206   virtual void SetUpTestOnMainThread() = 0;
 207
 208   virtual void SetUpTestOnSecondaryThread() = 0;
 209
 210   // TEST_F() should call this method.
 211   void RunTest();
 212
 213   enum ThreadType {
 214     MAIN_THREAD,
 215     SECONDARY_THREAD
 216   };
 217   void CheckOnThread(ThreadType thread_type);
 218
 219   // These can be called on any thread.
 220   void PostQuitForMainThread();
 221   void PostQuitForSecondaryThread();
 222
 223  protected:
 224   scoped_refptr<MessageLoopResource> secondary_thread_message_loop_;
 225   scoped_refptr<base::MessageLoopProxy> main_thread_message_loop_proxy_;
 226
 227  private:
 228   // base::DelegateSimpleThread::Delegate implementation.
 229   virtual void Run() override;
 230
 231   void QuitNestedLoop();
 232
 233   static void InternalSetUpTestOnSecondaryThread(void* user_data,
 234                                                  int32_t result);
 235
 236   scoped_ptr<base::DelegateSimpleThread> secondary_thread_;
 237   scoped_ptr<base::RunLoop> nested_main_thread_message_loop_;
 238 };
 239
 240 class HostProxyTestHarness : public ProxyTestHarnessBase {
 241  public:
 242   explicit HostProxyTestHarness(GlobalsConfiguration globals_config);
 243   virtual ~HostProxyTestHarness();
 244
 245   HostDispatcher* host_dispatcher() { return host_dispatcher_.get(); }
 246   ResourceTracker& resource_tracker() {
 247     return *host_globals_->GetResourceTracker();
 248   }
 249   VarTracker& var_tracker() {
 250     return *host_globals_->GetVarTracker();
 251   }
 252
 253   // ProxyTestBase implementation.
 254   virtual PpapiGlobals* GetGlobals();
 255   virtual Dispatcher* GetDispatcher();
 256   virtual void SetUpHarness();
 257   virtual void SetUpHarnessWithChannel(const IPC::ChannelHandle& channel_handle,
 258                                        base::MessageLoopProxy* ipc_message_loop,
 259                                        base::WaitableEvent* shutdown_event,
 260                                        bool is_client);
 261   virtual void TearDownHarness();
 262
 263   class DelegateMock : public ProxyChannel::Delegate {
 264    public:
 265     DelegateMock() : ipc_message_loop_(NULL), shutdown_event_(NULL) {
 266     }
 267     virtual ~DelegateMock() {}
 268
 269     void Init(base::MessageLoopProxy* ipc_message_loop,
 270               base::WaitableEvent* shutdown_event) {
 271       ipc_message_loop_ = ipc_message_loop;
 272       shutdown_event_ = shutdown_event;
 273     }
 274
 275     // ProxyChannel::Delegate implementation.
 276     virtual base::MessageLoopProxy* GetIPCMessageLoop();
 277     virtual base::WaitableEvent* GetShutdownEvent();
 278     virtual IPC::PlatformFileForTransit ShareHandleWithRemote(
 279         base::PlatformFile handle,
 280         base::ProcessId remote_pid,
 281         bool should_close_source) override;
 282
 283    private:
 284     base::MessageLoopProxy* ipc_message_loop_;  // Weak
 285     base::WaitableEvent* shutdown_event_;  // Weak
 286
 287     DISALLOW_COPY_AND_ASSIGN(DelegateMock);
 288   };
 289
 290  private:
 291   void CreateHostGlobals();
 292
 293   GlobalsConfiguration globals_config_;
 294   scoped_ptr<ppapi::TestGlobals> host_globals_;
 295   scoped_ptr<HostDispatcher> host_dispatcher_;
 296   // The host side of the real proxy doesn't lock, so this disables locking for
 297   // the thread the host side of the test runs on.
 298   scoped_ptr<ProxyLock::LockingDisablerForTest> disable_locking_;
 299   DelegateMock delegate_mock_;
 300 };
 301
 302 class HostProxyTest : public HostProxyTestHarness, public testing::Test {
 303  public:
 304   HostProxyTest();
 305   virtual ~HostProxyTest();
 306
 307   // testing::Test implementation.
 308   virtual void SetUp();
 309   virtual void TearDown();
 310  private:
 311   base::MessageLoop message_loop_;
 312 };
 313
 314 // Use this base class to test both sides of a proxy.
 315 class TwoWayTest : public testing::Test {
 316  public:
 317   enum TwoWayTestMode {
 318     TEST_PPP_INTERFACE,
 319     TEST_PPB_INTERFACE
 320   };
 321   TwoWayTest(TwoWayTestMode test_mode);
 322   virtual ~TwoWayTest();
 323
 324   HostProxyTestHarness& host() { return host_; }
 325   PluginProxyTestHarness& plugin() { return plugin_; }
 326   PP_Module pp_module() const { return host_.pp_module(); }
 327   PP_Instance pp_instance() const { return host_.pp_instance(); }
 328   TwoWayTestMode test_mode() { return test_mode_; }
 329
 330   // testing::Test implementation.
 331   virtual void SetUp();
 332   virtual void TearDown();
 333
 334  protected:
 335   // Post a task to the thread where the remote harness lives. This
 336   // is typically used to test the state of the var tracker on the plugin
 337   // thread. This runs the task synchronously for convenience.
 338   void PostTaskOnRemoteHarness(const base::Closure& task);
 339
 340  private:
 341   TwoWayTestMode test_mode_;
 342   HostProxyTestHarness host_;
 343   PluginProxyTestHarness plugin_;
 344   // In order to use sync IPC, we need to have an IO thread.
 345   base::Thread io_thread_;
 346   // The plugin side of the proxy runs on its own thread.
 347   base::Thread plugin_thread_;
 348   // The message loop for the main (host) thread.
 349   base::MessageLoop message_loop_;
 350
 351   // Aliases for the host and plugin harnesses; if we're testing a PPP
 352   // interface, remote_harness will point to plugin_, and local_harness
 353   // will point to host_.  This makes it convenient when we're starting and
 354   // stopping the harnesses.
 355   ProxyTestHarnessBase* remote_harness_;
 356   ProxyTestHarnessBase* local_harness_;
 357
 358   base::WaitableEvent channel_created_;
 359   base::WaitableEvent shutdown_event_;
 360 };
 361
 362 // Used during Gtests when you have a PP_Var that you want to EXPECT is equal
 363 // to a certain constant string value:
 364 //
 365 //   EXPECT_VAR_IS_STRING("foo", my_var);
 366 #define EXPECT_VAR_IS_STRING(str, var) { \
 367   StringVar* sv = StringVar::FromPPVar(var); \
 368   EXPECT_TRUE(sv); \
 369   if (sv) \
 370     EXPECT_EQ(str, sv->value()); \
 371 }
 372
 373 }  // namespace proxy
 374 }  // namespace ppapi