content/public/test/mock_render_process_host.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 #ifndef CONTENT_PUBLIC_TEST_MOCK_RENDER_PROCESS_HOST_H_
   6 #define CONTENT_PUBLIC_TEST_MOCK_RENDER_PROCESS_HOST_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/scoped_vector.h"
  10 #include "base/observer_list.h"
  11 #include "content/public/browser/render_process_host.h"
  12 #include "content/public/browser/render_process_host_factory.h"
  13 #include "ipc/ipc_test_sink.h"
  14
  15 class StoragePartition;
  16 class TransportDIB;
  17
  18 namespace content {
  19
  20 class MockRenderProcessHostFactory;
  21
  22 // A mock render process host that has no corresponding renderer process.  All
  23 // IPC messages are sent into the message sink for inspection by tests.
  24 class MockRenderProcessHost : public RenderProcessHost {
  25  public:
  26   explicit MockRenderProcessHost(BrowserContext* browser_context);
  27   virtual ~MockRenderProcessHost();
  28
  29   // Provides access to all IPC messages that would have been sent to the
  30   // renderer via this RenderProcessHost.
  31   IPC::TestSink& sink() { return sink_; }
  32
  33   // Provides test access to how many times a bad message has been received.
  34   int bad_msg_count() const { return bad_msg_count_; }
  35
  36   // RenderProcessHost implementation (public portion).
  37   virtual void EnableSendQueue() OVERRIDE;
  38   virtual bool Init() OVERRIDE;
  39   virtual int GetNextRoutingID() OVERRIDE;
  40   virtual void AddRoute(int32 routing_id, IPC::Listener* listener) OVERRIDE;
  41   virtual void RemoveRoute(int32 routing_id) OVERRIDE;
  42   virtual void AddObserver(RenderProcessHostObserver* observer) OVERRIDE;
  43   virtual void RemoveObserver(RenderProcessHostObserver* observer) OVERRIDE;
  44   virtual bool WaitForBackingStoreMsg(int render_widget_id,
  45                                       const base::TimeDelta& max_delay,
  46                                       IPC::Message* msg) OVERRIDE;
  47   virtual void ReceivedBadMessage() OVERRIDE;
  48   virtual void WidgetRestored() OVERRIDE;
  49   virtual void WidgetHidden() OVERRIDE;
  50   virtual int VisibleWidgetCount() const OVERRIDE;
  51   virtual bool IsGuest() const OVERRIDE;
  52   virtual StoragePartition* GetStoragePartition() const OVERRIDE;
  53   virtual void AddWord(const base::string16& word);
  54   virtual bool FastShutdownIfPossible() OVERRIDE;
  55   virtual bool FastShutdownStarted() const OVERRIDE;
  56   virtual void DumpHandles() OVERRIDE;
  57   virtual base::ProcessHandle GetHandle() const OVERRIDE;
  58   virtual TransportDIB* MapTransportDIB(TransportDIB::Id dib_id) OVERRIDE;
  59   virtual TransportDIB* GetTransportDIB(TransportDIB::Id dib_id) OVERRIDE;
  60   virtual int GetID() const OVERRIDE;
  61   virtual bool HasConnection() const OVERRIDE;
  62   virtual void SetIgnoreInputEvents(bool ignore_input_events) OVERRIDE;
  63   virtual bool IgnoreInputEvents() const OVERRIDE;
  64   virtual void Cleanup() OVERRIDE;
  65   virtual void AddPendingView() OVERRIDE;
  66   virtual void RemovePendingView() OVERRIDE;
  67   virtual void SetSuddenTerminationAllowed(bool allowed) OVERRIDE;
  68   virtual bool SuddenTerminationAllowed() const OVERRIDE;
  69   virtual BrowserContext* GetBrowserContext() const OVERRIDE;
  70   virtual bool InSameStoragePartition(
  71       StoragePartition* partition) const OVERRIDE;
  72   virtual IPC::ChannelProxy* GetChannel() OVERRIDE;
  73   virtual void AddFilter(BrowserMessageFilter* filter) OVERRIDE;
  74   virtual bool FastShutdownForPageCount(size_t count) OVERRIDE;
  75   virtual base::TimeDelta GetChildProcessIdleTime() const OVERRIDE;
  76   virtual void SurfaceUpdated(int32 surface_id) OVERRIDE;
  77   virtual void ResumeRequestsForView(int route_id) OVERRIDE;
  78   virtual void FilterURL(bool empty_allowed, GURL* url) OVERRIDE;
  79 #if defined(ENABLE_WEBRTC)
  80   virtual void EnableAecDump(const base::FilePath& file) OVERRIDE;
  81   virtual void DisableAecDump() OVERRIDE;
  82 #endif
  83
  84   // IPC::Sender via RenderProcessHost.
  85   virtual bool Send(IPC::Message* msg) OVERRIDE;
  86
  87   // IPC::Listener via RenderProcessHost.
  88   virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
  89   virtual void OnChannelConnected(int32 peer_pid) OVERRIDE;
  90
  91   // Attaches the factory object so we can remove this object in its destructor
  92   // and prevent MockRenderProcessHostFacotry from deleting it.
  93   void SetFactory(const MockRenderProcessHostFactory* factory) {
  94     factory_ = factory;
  95   }
  96
  97   int GetActiveViewCount();
  98
  99   void SetIsGuest(bool is_guest) {
 100     is_guest_ = is_guest;
 101   }
 102
 103  private:
 104   // Stores IPC messages that would have been sent to the renderer.
 105   IPC::TestSink sink_;
 106   TransportDIB* transport_dib_;
 107   int bad_msg_count_;
 108   const MockRenderProcessHostFactory* factory_;
 109   int id_;
 110   BrowserContext* browser_context_;
 111   ObserverList<RenderProcessHostObserver> observers_;
 112
 113   IDMap<RenderWidgetHost> render_widget_hosts_;
 114   int prev_routing_id_;
 115   IDMap<IPC::Listener> listeners_;
 116   bool fast_shutdown_started_;
 117   bool deletion_callback_called_;
 118   bool is_guest_;
 119
 120   DISALLOW_COPY_AND_ASSIGN(MockRenderProcessHost);
 121 };
 122
 123 class MockRenderProcessHostFactory : public RenderProcessHostFactory {
 124  public:
 125   MockRenderProcessHostFactory();
 126   virtual ~MockRenderProcessHostFactory();
 127
 128   virtual RenderProcessHost* CreateRenderProcessHost(
 129       BrowserContext* browser_context,
 130       SiteInstance* site_instance) const OVERRIDE;
 131
 132   // Removes the given MockRenderProcessHost from the MockRenderProcessHost list
 133   // without deleting it. When a test deletes a MockRenderProcessHost, we need
 134   // to remove it from |processes_| to prevent it from being deleted twice.
 135   void Remove(MockRenderProcessHost* host) const;
 136
 137  private:
 138   // A list of MockRenderProcessHosts created by this object. This list is used
 139   // for deleting all MockRenderProcessHosts that have not deleted by a test in
 140   // the destructor and prevent them from being leaked.
 141   mutable ScopedVector<MockRenderProcessHost> processes_;
 142
 143   DISALLOW_COPY_AND_ASSIGN(MockRenderProcessHostFactory);
 144 };
 145
 146 }  // namespace content
 147
 148 #endif  // CONTENT_PUBLIC_TEST_MOCK_RENDER_PROCESS_HOST_H_