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