content/public/test/render_view_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 #ifndef CONTENT_PUBLIC_TEST_RENDER_VIEW_TEST_H_
   6 #define CONTENT_PUBLIC_TEST_RENDER_VIEW_TEST_H_
   7
   8 #include <string>
   9
  10 #include "base/command_line.h"
  11 #include "base/memory/scoped_ptr.h"
  12 #include "base/message_loop/message_loop.h"
  13 #include "base/strings/string16.h"
  14 #include "content/public/browser/native_web_keyboard_event.h"
  15 #include "content/public/common/main_function_params.h"
  16 #include "content/public/test/mock_render_thread.h"
  17 #include "testing/gtest/include/gtest/gtest.h"
  18 #include "third_party/WebKit/public/platform/Platform.h"
  19 #include "third_party/WebKit/public/web/WebFrame.h"
  20
  21 namespace blink {
  22 class WebWidget;
  23 }
  24
  25 namespace gfx {
  26 class Rect;
  27 }
  28
  29 namespace content {
  30 class ContentBrowserClient;
  31 class ContentClient;
  32 class ContentRendererClient;
  33 class MockRenderProcess;
  34 class PageState;
  35 class RendererMainPlatformDelegate;
  36 class RendererWebKitPlatformSupportImplNoSandboxImpl;
  37 class RenderView;
  38
  39 class RenderViewTest : public testing::Test {
  40  public:
  41   // A special WebKitPlatformSupportImpl class for getting rid off the
  42   // dependency to the sandbox, which is not available in RenderViewTest.
  43   class RendererWebKitPlatformSupportImplNoSandbox {
  44    public:
  45     RendererWebKitPlatformSupportImplNoSandbox();
  46     ~RendererWebKitPlatformSupportImplNoSandbox();
  47     blink::Platform* Get();
  48
  49    private:
  50     scoped_ptr<RendererWebKitPlatformSupportImplNoSandboxImpl>
  51         webkit_platform_support_;
  52   };
  53
  54   RenderViewTest();
  55   virtual ~RenderViewTest();
  56
  57  protected:
  58   // Spins the message loop to process all messages that are currently pending.
  59   void ProcessPendingMessages();
  60
  61   // Returns a pointer to the main frame.
  62   blink::WebLocalFrame* GetMainFrame();
  63
  64   // Executes the given JavaScript in the context of the main frame. The input
  65   // is a NULL-terminated UTF-8 string.
  66   void ExecuteJavaScript(const char* js);
  67
  68   // Executes the given JavaScript and sets the int value it evaluates to in
  69   // |result|.
  70   // Returns true if the JavaScript was evaluated correctly to an int value,
  71   // false otherwise.
  72   bool ExecuteJavaScriptAndReturnIntValue(const base::string16& script,
  73                                           int* result);
  74
  75   // Loads the given HTML into the main frame as a data: URL and blocks until
  76   // the navigation is committed.
  77   void LoadHTML(const char* html);
  78
  79   // Navigates the main frame back or forward in session history and commits.
  80   // The caller must capture a PageState for the target page.
  81   void GoBack(const PageState& state);
  82   void GoForward(const PageState& state);
  83
  84   // Navigates the main frame back to whatever is considered the previous
  85   // history entry internally.
  86   void GoBackToPrevious();
  87
  88   // Sends one native key event over IPC.
  89   void SendNativeKeyEvent(const NativeWebKeyboardEvent& key_event);
  90
  91   // Send a raw keyboard event to the renderer.
  92   void SendWebKeyboardEvent(const blink::WebKeyboardEvent& key_event);
  93
  94   // Send a raw mouse event to the renderer.
  95   void SendWebMouseEvent(const blink::WebMouseEvent& key_event);
  96
  97   // Returns the bounds (coordinates and size) of the element with id
  98   // |element_id|.  Returns an empty rect if such an element was not found.
  99   gfx::Rect GetElementBounds(const std::string& element_id);
 100
 101   // Sends a left mouse click in the middle of the element with id |element_id|.
 102   // Returns true if the event was sent, false otherwise (typically because
 103   // the element was not found).
 104   bool SimulateElementClick(const std::string& element_id);
 105
 106   // Simulates |node| being focused.
 107   void SetFocused(const blink::WebNode& node);
 108
 109   // Clears anything associated with the browsing history.
 110   void ClearHistory();
 111
 112   // Simulates a navigation with a type of reload to the given url.
 113   void Reload(const GURL& url);
 114
 115   // Returns the IPC message ID of the navigation message.
 116   uint32 GetNavigationIPCType();
 117
 118   // Resize the view.
 119   void Resize(gfx::Size new_size,
 120               gfx::Rect resizer_rect,
 121               bool is_fullscreen);
 122
 123   // These are all methods from RenderViewImpl that we expose to testing code.
 124   bool OnMessageReceived(const IPC::Message& msg);
 125   void DidNavigateWithinPage(blink::WebLocalFrame* frame,
 126                              bool is_new_navigation);
 127   void SendContentStateImmediately();
 128   blink::WebWidget* GetWebWidget();
 129
 130   // Allows a subclass to override the various content client implementations.
 131   virtual ContentClient* CreateContentClient();
 132   virtual ContentBrowserClient* CreateContentBrowserClient();
 133   virtual ContentRendererClient* CreateContentRendererClient();
 134
 135   // testing::Test
 136   virtual void SetUp() OVERRIDE;
 137
 138   virtual void TearDown() OVERRIDE;
 139
 140   base::MessageLoop msg_loop_;
 141   scoped_ptr<MockRenderProcess> mock_process_;
 142   // We use a naked pointer because we don't want to expose RenderViewImpl in
 143   // the embedder's namespace.
 144   RenderView* view_;
 145   RendererWebKitPlatformSupportImplNoSandbox webkit_platform_support_;
 146   scoped_ptr<ContentClient> content_client_;
 147   scoped_ptr<ContentBrowserClient> content_browser_client_;
 148   scoped_ptr<ContentRendererClient> content_renderer_client_;
 149   scoped_ptr<MockRenderThread> render_thread_;
 150
 151   // Used to setup the process so renderers can run.
 152   scoped_ptr<RendererMainPlatformDelegate> platform_;
 153   scoped_ptr<MainFunctionParams> params_;
 154   scoped_ptr<base::CommandLine> command_line_;
 155
 156 #if defined(OS_MACOSX)
 157   scoped_ptr<base::mac::ScopedNSAutoreleasePool> autorelease_pool_;
 158 #endif
 159
 160  private:
 161   void GoToOffset(int offset, const PageState& state);
 162 };
 163
 164 }  // namespace content
 165
 166 #endif  // CONTENT_PUBLIC_TEST_RENDER_VIEW_TEST_H_