Use correct WebView from TestRunner methods called via testRunner bindings.

components/test_runner/test_runner.h

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef COMPONENTS_TEST_RUNNER_TEST_RUNNER_H_
 #define COMPONENTS_TEST_RUNNER_TEST_RUNNER_H_
 
 #include <stdint.h>
 
 #include <deque>
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "components/test_runner/layout_test_runtime_flags.h"
 #include "components/test_runner/test_runner_export.h"
 #include "components/test_runner/web_test_runner.h"
 #include "third_party/WebKit/public/platform/WebImage.h"
 #include "v8/include/v8.h"
 
 class GURL;
 class SkBitmap;
 
 namespace blink {
 class WebContentSettingsClient;
 class WebFrame;
+class WebLocalFrame;
 class WebMediaStream;
 class WebString;
 class WebView;
 class WebURLResponse;
 }
 
 namespace gin {
 class ArrayBufferView;
 class Arguments;
 }
 
 namespace test_runner {
 
 class InvokeCallbackTask;
 class MockContentSettingsClient;
 class MockCredentialManagerClient;
 class MockScreenOrientationClient;
 class MockWebSpeechRecognizer;
 class MockWebUserMediaClient;
 class SpellCheckClient;
 class TestInterfaces;
+class TestRunnerForSpecificView;
 class WebTestDelegate;
 class WebTestProxyBase;
 
 class TestRunner : public WebTestRunner {
  public:
   explicit TestRunner(TestInterfaces*);
   virtual ~TestRunner();
 
-  void Install(blink::WebFrame* frame);
+  void Install(blink::WebLocalFrame* frame,
+               base::WeakPtr<TestRunnerForSpecificView> view_test_runner);
 
   void SetDelegate(WebTestDelegate*);
   void SetWebView(blink::WebView*);
 
   void Reset();
 
   void SetTestIsRunning(bool);
   bool TestIsRunning() const { return test_is_running_; }
 
   bool UseMockTheme() const { return use_mock_theme_; }
@@ skipping 76 matching lines @@
     virtual ~WorkItem() {}
 
     // Returns true if this started a load.
     virtual bool Run(WebTestDelegate*, blink::WebView*) = 0;
   };
 
  private:
   friend class TestRunnerBindings;
   friend class WorkQueue;
 
-  // Helpers for working with base and V8 callbacks.
+  // Helpers for posting base::Closure via |delegate_|.
   void PostTask(const base::Closure& callback);
   void PostDelayedTask(long long delay, const base::Closure& callback);
-  void PostV8Callback(const v8::Local<v8::Function>& callback);
-  void PostV8CallbackWithArgs(v8::UniquePersistent<v8::Function> callback,
-                              int argc,
-                              v8::Local<v8::Value> argv[]);
-  void InvokeV8Callback(const v8::UniquePersistent<v8::Function>& callback);
-  void InvokeV8CallbackWithArgs(
-      const v8::UniquePersistent<v8::Function>& callback,
-      const std::vector<v8::UniquePersistent<v8::Value>>& args);
-  base::Closure CreateClosureThatPostsV8Callback(
-      const v8::Local<v8::Function>& callback);
 
   // Helper class for managing events queued by methods like queueLoad or
   // queueScript.
   class WorkQueue {
    public:
     explicit WorkQueue(TestRunner* controller);
     virtual ~WorkQueue();
     void ProcessWorkSoon();
 
     // Reset the state of the class between tests.
@@ skipping 37 matching lines @@
   void SetCustomPolicyDelegate(gin::Arguments* args);
 
   // Delays completion of the test until the policy delegate runs.
   void WaitForPolicyDelegate();
 
   // Functions for dealing with windows. By default we block all new windows.
   int WindowCount();
   void SetCloseRemainingWindowsWhenComplete(bool close_remaining_windows);
   void ResetTestHelperControllers();
 
-  ///////////////////////////////////////////////////////////////////////////
-  // Methods implemented entirely in terms of chromium's public WebKit API
-
-  // Method that controls whether pressing Tab key cycles through page elements
-  // or inserts a '\t' char in text area
-  void SetTabKeyCyclesThroughElements(bool tab_key_cycles_through_elements);
-
-  // Executes an internal command (superset of document.execCommand() commands).
-  void ExecCommand(gin::Arguments* args);
-
-  // Checks if an internal command is currently available.
-  bool IsCommandEnabled(const std::string& command);
-
-  bool CallShouldCloseOnWebView();
-  void SetDomainRelaxationForbiddenForURLScheme(bool forbidden,
-                                                const std::string& scheme);
-  v8::Local<v8::Value> EvaluateScriptInIsolatedWorldAndReturnValue(
-      int world_id, const std::string& script);
-  void EvaluateScriptInIsolatedWorld(int world_id, const std::string& script);
-  void SetIsolatedWorldSecurityOrigin(int world_id,
-                                      v8::Local<v8::Value> origin);
-  void SetIsolatedWorldContentSecurityPolicy(int world_id,
-                                             const std::string& policy);
-
   // Allows layout tests to manage origins' whitelisting.
   void AddOriginAccessWhitelistEntry(const std::string& source_origin,
                                      const std::string& destination_protocol,
                                      const std::string& destination_host,
                                      bool allow_destination_subdomains);
   void RemoveOriginAccessWhitelistEntry(const std::string& source_origin,
                                         const std::string& destination_protocol,
                                         const std::string& destination_host,
                                         bool allow_destination_subdomains);
 
-  // Returns true if the current page box has custom page size style for
-  // printing.
-  bool HasCustomPageSizeStyle(int page_index);
-
-  // Forces the selection colors for testing under Linux.
-  void ForceRedSelectionColors();
-
   // Add |source_code| as an injected stylesheet to the active document of the
   // window of the current V8 context.
   void InsertStyleSheet(const std::string& source_code);
 
-  bool FindString(const std::string& search_text,
-                  const std::vector<std::string>& options_array);
-
-  std::string SelectionAsMarkup();
-
   // Enables or disables subpixel positioning (i.e. fractional X positions for
   // glyphs) in text rendering on Linux. Since this method changes global
   // settings, tests that call it must use their own custom font family for
   // all text that they render. If not, an already-cached style will be used,
   // resulting in the changed setting being ignored.
   void SetTextSubpixelPositioning(bool value);
 
-  // Switch the visibility of the page.
-  void SetPageVisibility(const std::string& new_visibility);
-
-  // Changes the direction of the focused element.
-  void SetTextDirection(const std::string& direction_name);
-
   // After this function is called, all window-sizing machinery is
   // short-circuited inside the renderer. This mode is necessary for
   // some tests that were written before browsers had multi-process architecture
   // and rely on window resizes to happen synchronously.
   // The function has "unfortunate" it its name because we must strive to remove
   // all tests that rely on this... well, unfortunate behavior. See
   // http://crbug.com/309760 for the plan.
   void UseUnfortunateSynchronousResizeMode();
 
   bool EnableAutoResizeMode(int min_width,
@@ skipping 185 matching lines @@
 
   // This function sets a flag to dump the drag image when the next drag&drop is
   // initiated. It is equivalent to DumpAsTextWithPixelResults but the pixel
   // results will be the drag image instead of a snapshot of the page.
   void DumpDragImage();
 
   // Sets a flag that tells the WebTestProxy to dump the default navigation
   // policy passed to the decidePolicyForNavigation callback.
   void DumpNavigationPolicy();
 
-  // Dump current PageImportanceSignals for the page.
-  void DumpPageImportanceSignals();
-
   ///////////////////////////////////////////////////////////////////////////
   // Methods interacting with the WebTestProxy
 
   ///////////////////////////////////////////////////////////////////////////
   // Methods forwarding to the WebTestDelegate
 
   // Shows DevTools window.
   void ShowWebInspector(const std::string& str,
                         const std::string& frontend_url);
   void CloseWebInspector();
@@ skipping 15 matching lines @@
 
   // Changes the cookie policy from the default to allow all cookies.
   void SetAlwaysAcceptCookies(bool accept);
 
   // Gives focus to the main test window.
   void SetWindowIsKey(bool value);
 
   // Converts a URL starting with file:///tmp/ to the local mapping.
   std::string PathToLocalResource(const std::string& path);
 
-  // Used to set the device scale factor.
-  void SetBackingScaleFactor(double value, v8::Local<v8::Function> callback);
-
-  // Enable zoom-for-dsf option.
-  // TODO(oshima): Remove this once all platforms migrated.
-  void EnableUseZoomForDSF(v8::Local<v8::Function> callback);
-
-  // Change the device color profile while running a layout test.
-  void SetColorProfile(const std::string& name,
-                       v8::Local<v8::Function> callback);
-
-  // Change the bluetooth test data while running a layout test.
-  void SetBluetoothFakeAdapter(const std::string& adapter_name,
-                               v8::Local<v8::Function> callback);
-
-  // If |enable| is true, makes the Bluetooth chooser record its input and wait
-  // for instructions from the test program on how to proceed. Otherwise falls
-  // back to the browser's default chooser.
-  void SetBluetoothManualChooser(bool enable);
-
-  // Calls |callback| with a DOMString[] representing the events recorded since
-  // the last call to this function.
-  void GetBluetoothManualChooserEvents(v8::Local<v8::Function> callback);
-
-  // Calls the BluetoothChooser::EventHandler with the arguments here. Valid
-  // event strings are:
-  //  * "cancel" - simulates the user canceling the chooser.
-  //  * "select" - simulates the user selecting a device whose device ID is in
-  //               |argument|.
-  void SendBluetoothManualChooserEvent(const std::string& event,
-                                       const std::string& argument);
-
   // Enables mock geofencing service while running a layout test.
   // |service_available| indicates if the mock service should mock geofencing
   // being available or not.
   void SetGeofencingMockProvider(bool service_available);
 
   // Disables mock geofencing service while running a layout test.
   void ClearGeofencingMockProvider();
 
   // Set the mock geofencing position while running a layout test.
   void SetGeofencingMockPosition(double latitude, double longitude);
 
   // Sets the permission's |name| to |value| for a given {origin, embedder}
   // tuple.
   void SetPermission(const std::string& name,
                      const std::string& value,
                      const GURL& origin,
                      const GURL& embedding_origin);
 
-  // Causes the beforeinstallprompt event to be sent to the renderer.
-  void DispatchBeforeInstallPromptEvent(
-      int request_id,
-      const std::vector<std::string>& event_platforms,
-      v8::Local<v8::Function> callback);
-
   // Resolve the beforeinstallprompt event with the matching request id.
   void ResolveBeforeInstallPromptPromise(int request_id,
                                          const std::string& platform);
 
-  // Immediately run all pending idle tasks, including all pending
-  // requestIdleCallback calls.  Invoke the callback when all
-  // idle tasks are complete.
-  void RunIdleTasks(v8::Local<v8::Function> callback);
-
   // Calls setlocale(LC_ALL, ...) for a specified locale.
   // Resets between tests.
   void SetPOSIXLocale(const std::string& locale);
 
   // MIDI function to control permission handling.
   void SetMIDIAccessorResult(bool result);
 
   // Simulates a click on a Web Notification.
   void SimulateWebNotificationClick(const std::string& title, int action_index);
 
   // Simulates closing a Web Notification.
   void SimulateWebNotificationClose(const std::string& title, bool by_user);
 
   // Speech recognition related functions.
   void AddMockSpeechRecognitionResult(const std::string& transcript,
                                       double confidence);
   void SetMockSpeechRecognitionError(const std::string& error,
                                      const std::string& message);
 
   // Credential Manager mock functions
   // TODO(mkwst): Support FederatedCredential.
   void AddMockCredentialManagerResponse(const std::string& id,
                                         const std::string& name,
                                         const std::string& avatar,
                                         const std::string& password);
   void AddMockCredentialManagerError(const std::string& error);
 
-  // WebPageOverlay related functions. Permits the adding and removing of only
-  // one opaque overlay.
-  void AddWebPageOverlay();
-  void RemoveWebPageOverlay();
-
-  void LayoutAndPaintAsync();
-  void LayoutAndPaintAsyncThen(v8::Local<v8::Function> callback);
-
-  // Similar to LayoutAndPaintAsyncThen(), but pass parameters of the captured
-  // snapshot (width, height, snapshot) to the callback. The snapshot is in
-  // uint8_t RGBA format.
-  void CapturePixelsAsyncThen(v8::Local<v8::Function> callback);
-  // Similar to CapturePixelsAsyncThen(). Copies to the clipboard the image
-  // located at a particular point in the WebView (if there is such an image),
-  // reads back its pixels, and provides the snapshot to the callback. If there
-  // is no image at that point, calls the callback with (0, 0, empty_snapshot).
-  void CopyImageAtAndCapturePixelsAsyncThen(
-      int x, int y, const v8::Local<v8::Function> callback);
-
-  void GetManifestThen(v8::Local<v8::Function> callback);
-
   // Takes care of notifying the delegate after a change to layout test runtime
   // flags.
   void OnLayoutTestRuntimeFlagsChanged();
 
   ///////////////////////////////////////////////////////////////////////////
   // Internal helpers
 
-  void GetManifestCallback(v8::UniquePersistent<v8::Function> callback,
-                           const blink::WebURLResponse& response,
-                           const std::string& data);
-  void CapturePixelsCallback(v8::UniquePersistent<v8::Function> callback,
-                             const SkBitmap& snapshot);
-  void DispatchBeforeInstallPromptCallback(
-      v8::UniquePersistent<v8::Function> callback,
-      bool canceled);
-  void GetBluetoothManualChooserEventsCallback(
-      v8::UniquePersistent<v8::Function> callback,
-      const std::vector<std::string>& events);
-
   void CheckResponseMimeType();
   void CompleteNotifyDone();
 
   void DidAcquirePointerLockInternal();
   void DidNotAcquirePointerLockInternal();
   void DidLosePointerLockInternal();
 
   // In the Mac code, this is called to trigger the end of a test after the
   // page has finished loading. From here, we can generate the dump for the
   // test.
   void LocationChangeDone();
 
-  // Sets a flag causing the next call to WebGLRenderingContext::create to fail.
-  void ForceNextWebGLContextCreationToFail();
-
-  // Sets a flag causing the next call to DrawingBuffer::create to fail.
-  void ForceNextDrawingBufferCreationToFail();
-
   bool test_is_running_;
 
   // When reset is called, go through and close all but the main test shell
   // window. By default, set to true but toggled to false using
   // setCloseRemainingWindowsWhenComplete().
   bool close_remaining_windows_;
 
   WorkQueue work_queue_;
 
   // Bound variable to return the name of this platform (chromium).
@@ skipping 85 matching lines @@
   // is ok, because this is taken care of in WebTestDelegate::SetFocus).
   blink::WebView* previously_focused_view_;
 
   std::set<blink::WebView*> views_with_scheduled_animations_;
 
   base::WeakPtrFactory<TestRunner> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(TestRunner);
 };
 
+// Wraps TestRunner's functionality that needs to work with a specific view
+// (that testRunner javascript bindings are exposed to;  as opposed to
+// working with the global main test window).
+class TestRunnerForSpecificView {

[Łukasz Anforowicz, 2016/04/21 23:41:01]

I don't like the name of the new class, but I couldn't think of a better
alternative... :-(

Notes:
- The bindings from TestRunner + TestRunnerForSpecificView are gathered together
and exposed through a single |window.testRunner| javascript object (i.e. they
are gathered together by TestRunnerBindings::GetObjectTemplateBuilder method).

- TestRunnerForSpecificView is owned by WebTestProxyBase in a similar way to
AccessbilityController, EventSender and TextInputController (all of which
provide javascript bindings that should act on the correct view [associated with
the bindings], not on the main test view).

- Maybe I should also rename TestRunner to something like TestRunnerGlobal? 
Bleh...

+ public:
+  TestRunnerForSpecificView(WebTestProxyBase* web_test_proxy_base);
+  ~TestRunnerForSpecificView();
+
+  // Installs view-specific bindings (handled by |this|) and *also* global
+  // TestRunner bindings (both kinds of bindings are exposed via a single
+  // |testRunner| object in javascript).
+  void Install(blink::WebLocalFrame* frame);
+
+ private:
+  friend class TestRunnerBindings;
+
+  // Helpers for working with base and V8 callbacks.
+  void PostTask(const base::Closure& callback);
+  void PostV8Callback(const v8::Local<v8::Function>& callback);
+  void PostV8CallbackWithArgs(v8::UniquePersistent<v8::Function> callback,
+                              int argc,
+                              v8::Local<v8::Value> argv[]);
+  void InvokeV8Callback(const v8::UniquePersistent<v8::Function>& callback);
+  void InvokeV8CallbackWithArgs(
+      const v8::UniquePersistent<v8::Function>& callback,
+      const std::vector<v8::UniquePersistent<v8::Value>>& args);
+  base::Closure CreateClosureThatPostsV8Callback(
+      const v8::Local<v8::Function>& callback);
+
+  void LayoutAndPaintAsync();
+  void LayoutAndPaintAsyncThen(v8::Local<v8::Function> callback);
+
+  // Similar to LayoutAndPaintAsyncThen(), but pass parameters of the captured
+  // snapshot (width, height, snapshot) to the callback. The snapshot is in
+  // uint8_t RGBA format.
+  void CapturePixelsAsyncThen(v8::Local<v8::Function> callback);
+  void CapturePixelsCallback(v8::UniquePersistent<v8::Function> callback,
+                             const SkBitmap& snapshot);
+
+  // Similar to CapturePixelsAsyncThen(). Copies to the clipboard the image
+  // located at a particular point in the WebView (if there is such an image),
+  // reads back its pixels, and provides the snapshot to the callback. If there
+  // is no image at that point, calls the callback with (0, 0, empty_snapshot).
+  void CopyImageAtAndCapturePixelsAsyncThen(
+      int x,
+      int y,
+      const v8::Local<v8::Function> callback);
+
+  void GetManifestThen(v8::Local<v8::Function> callback);
+  void GetManifestCallback(v8::UniquePersistent<v8::Function> callback,
+                           const blink::WebURLResponse& response,
+                           const std::string& data);
+
+  // Calls |callback| with a DOMString[] representing the events recorded since
+  // the last call to this function.
+  void GetBluetoothManualChooserEvents(v8::Local<v8::Function> callback);
+  void GetBluetoothManualChooserEventsCallback(
+      v8::UniquePersistent<v8::Function> callback,
+      const std::vector<std::string>& events);
+
+  // Change the bluetooth test data while running a layout test.
+  void SetBluetoothFakeAdapter(const std::string& adapter_name,
+                               v8::Local<v8::Function> callback);
+
+  // If |enable| is true, makes the Bluetooth chooser record its input and wait
+  // for instructions from the test program on how to proceed. Otherwise falls
+  // back to the browser's default chooser.
+  void SetBluetoothManualChooser(bool enable);
+
+  // Calls the BluetoothChooser::EventHandler with the arguments here. Valid
+  // event strings are:
+  //  * "cancel" - simulates the user canceling the chooser.
+  //  * "select" - simulates the user selecting a device whose device ID is in
+  //               |argument|.
+  void SendBluetoothManualChooserEvent(const std::string& event,
+                                       const std::string& argument);
+
+  // Used to set the device scale factor.
+  void SetBackingScaleFactor(double value, v8::Local<v8::Function> callback);
+
+  // Enable zoom-for-dsf option.
+  // TODO(oshima): Remove this once all platforms migrated.
+  void EnableUseZoomForDSF(v8::Local<v8::Function> callback);
+
+  // Change the device color profile while running a layout test.
+  void SetColorProfile(const std::string& name,
+                       v8::Local<v8::Function> callback);
+
+  // Causes the beforeinstallprompt event to be sent to the renderer.
+  void DispatchBeforeInstallPromptEvent(
+      int request_id,
+      const std::vector<std::string>& event_platforms,
+      v8::Local<v8::Function> callback);
+  void DispatchBeforeInstallPromptCallback(
+      v8::UniquePersistent<v8::Function> callback,
+      bool canceled);
+
+  // Immediately run all pending idle tasks, including all pending
+  // requestIdleCallback calls.  Invoke the callback when all
+  // idle tasks are complete.
+  void RunIdleTasks(v8::Local<v8::Function> callback);
+
+  // Method that controls whether pressing Tab key cycles through page elements
+  // or inserts a '\t' char in text area
+  void SetTabKeyCyclesThroughElements(bool tab_key_cycles_through_elements);
+
+  // Executes an internal command (superset of document.execCommand() commands).
+  void ExecCommand(gin::Arguments* args);
+
+  // Checks if an internal command is currently available.
+  bool IsCommandEnabled(const std::string& command);
+
+  // Returns true if the current page box has custom page size style for
+  // printing.
+  bool HasCustomPageSizeStyle(int page_index);
+
+  // Forces the selection colors for testing under Linux.
+  void ForceRedSelectionColors();
+
+  // Switch the visibility of the page.
+  void SetPageVisibility(const std::string& new_visibility);
+
+  // Changes the direction of the focused element.
+  void SetTextDirection(const std::string& direction_name);
+
+  // Dump current PageImportanceSignals for the page.
+  void DumpPageImportanceSignals();
+
+  // WebPageOverlay related functions. Permits the adding and removing of only
+  // one opaque overlay.
+  void AddWebPageOverlay();
+  void RemoveWebPageOverlay();
+
+  // Sets a flag causing the next call to WebGLRenderingContext::create to fail.
+  void ForceNextWebGLContextCreationToFail();
+
+  // Sets a flag causing the next call to DrawingBuffer::create to fail.
+  void ForceNextDrawingBufferCreationToFail();
+
+  bool CallShouldCloseOnWebView();
+  void SetDomainRelaxationForbiddenForURLScheme(bool forbidden,
+                                                const std::string& scheme);
+  v8::Local<v8::Value> EvaluateScriptInIsolatedWorldAndReturnValue(
+      int world_id,
+      const std::string& script);
+  void EvaluateScriptInIsolatedWorld(int world_id, const std::string& script);
+  void SetIsolatedWorldSecurityOrigin(int world_id,
+                                      v8::Local<v8::Value> origin);
+  void SetIsolatedWorldContentSecurityPolicy(int world_id,
+                                             const std::string& policy);
+  bool FindString(const std::string& search_text,
+                  const std::vector<std::string>& options_array);
+  std::string SelectionAsMarkup();
+  void SetViewSourceForFrame(const std::string& name, bool enabled);
+
+  // Helpers for accessing pointers exposed by |web_test_proxy_base_|.
+  blink::WebView* web_view();
+  WebTestDelegate* delegate();
+  WebTestProxyBase* web_test_proxy_base_;
+
+  base::WeakPtrFactory<TestRunnerForSpecificView> weak_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(TestRunnerForSpecificView);
+};
+
 }  // namespace test_runner
 
 #endif  // COMPONENTS_TEST_RUNNER_TEST_RUNNER_H_