content/public/test/mock_render_thread.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_THREAD_H_
   6 #define CONTENT_PUBLIC_TEST_MOCK_RENDER_THREAD_H_
   7
   8 #include "base/memory/shared_memory.h"
   9 #include "base/observer_list.h"
  10 #include "base/strings/string16.h"
  11 #include "cc/test/test_shared_bitmap_manager.h"
  12 #include "content/public/renderer/render_thread.h"
  13 #include "ipc/ipc_test_sink.h"
  14 #include "ipc/message_filter.h"
  15 #include "third_party/WebKit/public/web/WebPopupType.h"
  16
  17 struct ViewHostMsg_CreateWindow_Params;
  18
  19 namespace IPC {
  20 class MessageFilter;
  21 class MessageReplyDeserializer;
  22 }
  23
  24 namespace content {
  25
  26 // This class is a very simple mock of RenderThread. It simulates an IPC channel
  27 // which supports only three messages:
  28 // ViewHostMsg_CreateWidget : sync message sent by the Widget.
  29 // ViewHostMsg_CreateWindow : sync message sent by the Widget.
  30 // ViewMsg_Close : async, send to the Widget.
  31 class MockRenderThread : public RenderThread {
  32  public:
  33   MockRenderThread();
  34   ~MockRenderThread() override;
  35
  36   // Provides access to the messages that have been received by this thread.
  37   IPC::TestSink& sink() { return sink_; }
  38
  39   // RenderThread implementation:
  40   bool Send(IPC::Message* msg) override;
  41   scoped_refptr<base::SingleThreadTaskRunner> GetTaskRunner() override;
  42   IPC::SyncChannel* GetChannel() override;
  43   std::string GetLocale() override;
  44   IPC::SyncMessageFilter* GetSyncMessageFilter() override;
  45   scoped_refptr<base::MessageLoopProxy> GetIOMessageLoopProxy() override;
  46   void AddRoute(int32 routing_id, IPC::Listener* listener) override;
  47   void RemoveRoute(int32 routing_id) override;
  48   int GenerateRoutingID() override;
  49   void AddFilter(IPC::MessageFilter* filter) override;
  50   void RemoveFilter(IPC::MessageFilter* filter) override;
  51   void AddObserver(RenderProcessObserver* observer) override;
  52   void RemoveObserver(RenderProcessObserver* observer) override;
  53   void SetResourceDispatcherDelegate(
  54       ResourceDispatcherDelegate* delegate) override;
  55   void EnsureWebKitInitialized() override;
  56   void RecordAction(const base::UserMetricsAction& action) override;
  57   void RecordComputedAction(const std::string& action) override;
  58   scoped_ptr<base::SharedMemory> HostAllocateSharedMemoryBuffer(
  59       size_t buffer_size) override;
  60   cc::SharedBitmapManager* GetSharedBitmapManager() override;
  61   void RegisterExtension(v8::Extension* extension) override;
  62   void ScheduleIdleHandler(int64 initial_delay_ms) override;
  63   void IdleHandler() override;
  64   int64 GetIdleNotificationDelayInMs() const override;
  65   void SetIdleNotificationDelayInMs(
  66       int64 idle_notification_delay_in_ms) override;
  67   void UpdateHistograms(int sequence_number) override;
  68   int PostTaskToAllWebWorkers(const base::Closure& closure) override;
  69   bool ResolveProxy(const GURL& url, std::string* proxy_list) override;
  70   base::WaitableEvent* GetShutdownEvent() override;
  71 #if defined(OS_WIN)
  72   virtual void PreCacheFont(const LOGFONT& log_font) override;
  73   virtual void ReleaseCachedFonts() override;
  74 #endif
  75   ServiceRegistry* GetServiceRegistry() override;
  76
  77   //////////////////////////////////////////////////////////////////////////
  78   // The following functions are called by the test itself.
  79
  80   void set_routing_id(int32 id) {
  81     routing_id_ = id;
  82   }
  83
  84   void set_surface_id(int32 id) {
  85     surface_id_ = id;
  86   }
  87
  88   int32 opener_id() const {
  89     return opener_id_;
  90   }
  91
  92   void set_new_window_routing_id(int32 id) {
  93     new_window_routing_id_ = id;
  94   }
  95
  96   void set_new_frame_routing_id(int32 id) {
  97     new_frame_routing_id_ = id;
  98   }
  99
 100   // Simulates the Widget receiving a close message. This should result
 101   // on releasing the internal reference counts and destroying the internal
 102   // state.
 103   void SendCloseMessage();
 104
 105   // Dispatches control messages to observers.
 106   bool OnControlMessageReceived(const IPC::Message& msg);
 107
 108   ObserverList<RenderProcessObserver>& observers() {
 109     return observers_;
 110   }
 111
 112  protected:
 113   // This function operates as a regular IPC listener. Subclasses
 114   // overriding this should first delegate to this implementation.
 115   virtual bool OnMessageReceived(const IPC::Message& msg);
 116
 117   // The Widget expects to be returned valid route_id.
 118   void OnCreateWidget(int opener_id,
 119                       blink::WebPopupType popup_type,
 120                       int* route_id,
 121                       int* surface_id);
 122
 123   // The View expects to be returned a valid route_id different from its own.
 124   // We do not keep track of the newly created widget in MockRenderThread,
 125   // so it must be cleaned up on its own.
 126   void OnCreateWindow(
 127     const ViewHostMsg_CreateWindow_Params& params,
 128     int* route_id,
 129     int* main_frame_route_id,
 130     int* surface_id,
 131     int64* cloned_session_storage_namespace_id);
 132
 133   // The Frame expects to be returned a valid route_id different from its own.
 134   void OnCreateChildFrame(int new_frame_routing_id,
 135                           const std::string& frame_name,
 136                           int* new_render_frame_id);
 137
 138 #if defined(OS_WIN)
 139   void OnDuplicateSection(base::SharedMemoryHandle renderer_handle,
 140                           base::SharedMemoryHandle* browser_handle);
 141 #endif
 142
 143   IPC::TestSink sink_;
 144
 145   // Routing id what will be assigned to the Widget.
 146   int32 routing_id_;
 147
 148   // Surface id what will be assigned to the Widget.
 149   int32 surface_id_;
 150
 151   // Opener id reported by the Widget.
 152   int32 opener_id_;
 153
 154   // Routing id that will be assigned to a CreateWindow Widget.
 155   int32 new_window_routing_id_;
 156   int32 new_window_main_frame_routing_id_;
 157   int32 new_frame_routing_id_;
 158
 159   // The last known good deserializer for sync messages.
 160   scoped_ptr<IPC::MessageReplyDeserializer> reply_deserializer_;
 161
 162   // A list of message filters added to this thread.
 163   std::vector<scoped_refptr<IPC::MessageFilter> > filters_;
 164
 165   // Observers to notify.
 166   ObserverList<RenderProcessObserver> observers_;
 167
 168   cc::TestSharedBitmapManager shared_bitmap_manager_;
 169 };
 170
 171 }  // namespace content
 172
 173 #endif  // CONTENT_PUBLIC_TEST_MOCK_RENDER_THREAD_H_