Bug 1408508 - Move Context to browser module. r=maja_zf

To avoid circular dependencies, where file A depends on B depending
on A, we should strive towards fewer inter-dependencies and more
autonomy between modules.

For example, if testing/marionette/browser.js needs access to
the Context enum it can currently only attain it by importing
testing/marionette/driver.js.  Because driver.js imports browser.js,
we create a circular dependency and Cu.import enters an infinite
import recursion.

MozReview-Commit-ID: LGiA9sy9xrd

--HG--
extra : rebase_source : f1748894c4309a5bc34b72acd4931d7937e8810e

testing/marionette/browser.js

@@ -16,13 +16,51 @@ const {
 Cu.import("chrome://marionette/content/frame.js");
 const {WindowState} = Cu.import("chrome://marionette/content/wm.js", {});
 
-this.EXPORTED_SYMBOLS = ["browser", "WindowState"];
+this.EXPORTED_SYMBOLS = ["browser", "Context", "WindowState"];
 
 /** @namespace */
 this.browser = {};
 
 const XUL_NS = "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
 
+/**
+ * Variations of Marionette contexts.
+ *
+ * Choosing a context through the <tt>Marionette:SetContext</tt>
+ * command directs all subsequent browsing context scoped commands
+ * to that context.
+ *
+ * @enum
+ */
+const Context = {
+  Chrome: "chrome",
+  Content: "content",
+};
+this.Context = Context;
+
+/**
+ * Gets the correct context from a string.
+ *
+ * @param {string} s
+ *     Context string serialisation.
+ *
+ * @return {Context}
+ *     Context.
+ *
+ * @throws {TypeError}
+ *     If <var>s</var> is not a context.
+ */
+Context.fromString = function(s) {
+  switch (s) {
+    case "chrome":
+      return Context.Chrome;
+    case "content":
+      return Context.Content;
+    default:
+      throw new TypeError(`Unknown context: ${s}`);
+  }
+};
+
 /**
  * Get the <code>&lt;xul:browser&gt;</code> for the specified tab.
  *

testing/marionette/driver.js

@@ -16,7 +16,10 @@ Cu.import("chrome://marionette/content/accessibility.js");
 Cu.import("chrome://marionette/content/addon.js");
 Cu.import("chrome://marionette/content/assert.js");
 Cu.import("chrome://marionette/content/atom.js");
-const {browser} = Cu.import("chrome://marionette/content/browser.js", {});
+const {
+  browser,
+  Context,
+} = Cu.import("chrome://marionette/content/browser.js", {});
 Cu.import("chrome://marionette/content/capture.js");
 Cu.import("chrome://marionette/content/cert.js");
 Cu.import("chrome://marionette/content/cookie.js");
@@ -52,7 +55,7 @@ const {WindowState} = Cu.import("chrome://marionette/content/wm.js", {});
 
 Cu.importGlobalProperties(["URL"]);
 
-this.EXPORTED_SYMBOLS = ["GeckoDriver", "Context"];
+this.EXPORTED_SYMBOLS = ["GeckoDriver"];
 
 const APP_ID_FIREFOX = "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}";
 
@@ -84,24 +87,6 @@ const globalMessageManager = Cc["@mozilla.org/globalmessagemanager;1"]
  * @namespace driver
  */
 
-/**
- * @enum
- * @memberof driver
- */
-this.Context = {
-  CHROME: "chrome",
-  CONTENT: "content",
-};
-
-/** @memberof driver */
-this.Context.fromString = function(s) {
-  s = s.toUpperCase();
-  if (s in this) {
-    return this[s];
-  }
-  return null;
-};
-
 /**
  * Helper function for converting a {@link nsISimpleEnumerator} to a
  * JavaScript iterator.
@@ -158,7 +143,7 @@ this.GeckoDriver = function(appId, server) {
 
   // The curent context decides if commands should affect chrome- or
   // content space.
-  this.context = Context.CONTENT;
+  this.context = Context.Content;
 
   this.sandboxes = new Sandboxes(() => this.getCurrentWindow());
   this.legacyactions = new legacyaction.Chain();
@@ -195,11 +180,11 @@ Object.defineProperty(GeckoDriver.prototype, "a11yChecks", {
 Object.defineProperty(GeckoDriver.prototype, "currentURL", {
   get() {
     switch (this.context) {
-      case Context.CHROME:
+      case Context.Chrome:
         let chromeWin = this.getCurrentWindow();
         return new URL(chromeWin.location.href);
 
-      case Context.CONTENT:
+      case Context.Content:
         return new URL(this.curBrowser.currentURI.spec);
 
       default:
@@ -211,11 +196,11 @@ Object.defineProperty(GeckoDriver.prototype, "currentURL", {
 Object.defineProperty(GeckoDriver.prototype, "title", {
   get() {
     switch (this.context) {
-      case Context.CHROME:
+      case Context.Chrome:
         let chromeWin = this.getCurrentWindow();
         return chromeWin.document.documentElement.getAttribute("title");
 
-      case Context.CONTENT:
+      case Context.Content:
         return this.curBrowser.currentTitle;
 
       default:
@@ -407,7 +392,7 @@ GeckoDriver.prototype.getCurrentWindow = function(forcedContext = undefined) {
   let win = null;
 
   switch (context) {
-    case Context.CHROME:
+    case Context.Chrome:
       if (this.curFrame !== null) {
         win = this.curFrame;
       } else if (this.curBrowser !== null) {
@@ -415,7 +400,7 @@ GeckoDriver.prototype.getCurrentWindow = function(forcedContext = undefined) {
       }
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       if (this.curFrame !== null) {
         win = this.curFrame;
       } else if (this.curBrowser !== null && this.curBrowser.contentBrowser) {
@@ -862,25 +847,39 @@ GeckoDriver.prototype.getSessionCapabilities = function(cmd, resp) {
 };
 
 /**
- * Sets the context of the subsequent commands to be either "chrome" or
- * "content".
+ * Sets the context of the subsequent commands.
+ *
+ * All subsequent requests to commands that in some way involve
+ * interaction with a browsing context will target the chosen browsing
+ * context.
  *
  * @param {string} value
  *     Name of the context to be switched to.  Must be one of "chrome" or
  *     "content".
+ *
+ * @throws {InvalidArgumentError}
+ *     If <var>value</var> is not a string.
+ * @throws {WebDriverError}
+ *     If <var>value</var> is not a valid browsing context.
  */
 GeckoDriver.prototype.setContext = function(cmd) {
-  let val = cmd.parameters.value;
-  let ctx = Context.fromString(val);
-  if (ctx === null) {
-    throw new WebDriverError(`Invalid context: ${val}`);
-  }
-  this.context = ctx;
+  let value = assert.string(cmd.parameters.value);
+  this.context = Context.fromString(value);
 };
 
-/** Gets the context of the server, either "chrome" or "content". */
-GeckoDriver.prototype.getContext = function(cmd, resp) {
-  resp.body.value = this.context.toString();
+/**
+ * Gets the context type that is Marionette's current target for
+ * browsing context scoped commands.
+ *
+ * You may choose a context through the {@link #setContext} command.
+ *
+ * The default browsing context is {@link Context.Content}.
+ *
+ * @return {Context}
+ *     Current context.
+ */
+GeckoDriver.prototype.getContext = function() {
+  return this.context;
 };
 
 /**
@@ -1033,7 +1032,7 @@ GeckoDriver.prototype.execute_ = async function(
   let res, els;
 
   switch (this.context) {
-    case Context.CONTENT:
+    case Context.Content:
       // evaluate in content with lasting side-effects
       if (!opts.sandboxName) {
         res = await this.listener.execute(script, args, timeout, opts);
@@ -1046,7 +1045,7 @@ GeckoDriver.prototype.execute_ = async function(
 
       break;
 
-    case Context.CHROME:
+    case Context.Chrome:
       let sb = this.sandboxes.get(opts.sandboxName, opts.newSandbox);
       opts.timeout = timeout;
       let wargs = evaluate.fromJSON(args, this.curBrowser.seenEls, sb.window);
@@ -1184,12 +1183,12 @@ GeckoDriver.prototype.getPageSource = async function(cmd, resp) {
   assert.noUserPrompt(this.dialog);
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let s = new win.XMLSerializer();
       resp.body.value = s.serializeToString(win.document);
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener.getPageSource();
       break;
   }
@@ -1398,7 +1397,7 @@ GeckoDriver.prototype.getWindowHandles = function() {
  *     Top-level browsing context has been discarded.
  */
 GeckoDriver.prototype.getChromeWindowHandle = function(cmd, resp) {
-  assert.window(this.getCurrentWindow(Context.CHROME));
+  assert.window(this.getCurrentWindow(Context.Chrome));
 
   for (let i in this.browsers) {
     if (this.curBrowser == this.browsers[i]) {
@@ -1675,7 +1674,7 @@ GeckoDriver.prototype.getActiveFrame = function(cmd, resp) {
   assert.window(this.getCurrentWindow());
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       // no frame means top-level
       resp.body.value = null;
       if (this.curFrame) {
@@ -1686,7 +1685,7 @@ GeckoDriver.prototype.getActiveFrame = function(cmd, resp) {
       }
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = null;
       if (this.currentFrameElement !== null) {
         let el = element.makeWebElement(this.currentFrameElement);
@@ -1754,7 +1753,7 @@ GeckoDriver.prototype.switchToFrame = async function(cmd) {
         checkLoad.bind(this), 100, Ci.nsITimer.TYPE_ONE_SHOT);
   };
 
-  if (this.context == Context.CHROME) {
+  if (this.context == Context.Chrome) {
     let foundFrame = null;
 
     // just focus
@@ -1871,7 +1870,7 @@ GeckoDriver.prototype.switchToFrame = async function(cmd) {
       throw new NoSuchFrameError(`Unable to locate frame: ${id}`);
     }
 
-  } else if (this.context == Context.CONTENT) {
+  } else if (this.context == Context.Content) {
     if (!id && !element &&
         this.curBrowser.frameManager.currentRemoteFrame !== null) {
       // We're currently using a ChromeMessageSender for a remote frame,
@@ -1928,11 +1927,11 @@ GeckoDriver.prototype.singleTap = async function(cmd) {
   let {id, x, y} = cmd.parameters;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       throw new UnsupportedOperationError(
           "Command 'singleTap' is not yet available in chrome context");
 
-    case Context.CONTENT:
+    case Context.Content:
       this.addFrameCloseListener("tap");
       await this.listener.singleTap(id, x, y);
       break;
@@ -2004,7 +2003,7 @@ GeckoDriver.prototype.actionChain = async function(cmd, resp) {
   let {chain, nextId} = cmd.parameters;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       // be conservative until this has a use case and is established
       // to work as expected in Fennec
       assert.firefox();
@@ -2013,7 +2012,7 @@ GeckoDriver.prototype.actionChain = async function(cmd, resp) {
           chain, nextId, {frame: win}, this.curBrowser.seenEls);
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       this.addFrameCloseListener("action chain");
       resp.body.value = await this.listener.actionChain(chain, nextId);
       break;
@@ -2072,7 +2071,7 @@ GeckoDriver.prototype.findElement = async function(cmd, resp) {
   };
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       if (!SUPPORTED_STRATEGIES.has(strategy)) {
         throw new InvalidSelectorError(`Strategy not supported: ${strategy}`);
       }
@@ -2088,7 +2087,7 @@ GeckoDriver.prototype.findElement = async function(cmd, resp) {
       resp.body.value = webEl;
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener.findElementContent(
           strategy,
           expr,
@@ -2117,7 +2116,7 @@ GeckoDriver.prototype.findElements = async function(cmd, resp) {
   };
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       if (!SUPPORTED_STRATEGIES.has(strategy)) {
         throw new InvalidSelectorError(`Strategy not supported: ${strategy}`);
       }
@@ -2133,7 +2132,7 @@ GeckoDriver.prototype.findElements = async function(cmd, resp) {
       resp.body = webEls;
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body = await this.listener.findElementsContent(
           cmd.parameters.using,
           cmd.parameters.value,
@@ -2181,12 +2180,12 @@ GeckoDriver.prototype.clickElement = async function(cmd) {
   let id = cmd.parameters.id;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let el = this.curBrowser.seenEls.get(id);
       await interaction.clickElement(el, this.a11yChecks);
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       // We need to protect against the click causing an OOP frame
       // to close.  This fires the mozbrowserclose event when it closes
       // so we need to listen for it and then just send an error back.
@@ -2240,12 +2239,12 @@ GeckoDriver.prototype.getElementAttribute = async function(cmd, resp) {
   let {id, name} = cmd.parameters;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let el = this.curBrowser.seenEls.get(id);
       resp.body.value = el.getAttribute(name);
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener.getElementAttribute(id, name);
       break;
   }
@@ -2274,12 +2273,12 @@ GeckoDriver.prototype.getElementProperty = async function(cmd, resp) {
   let {id, name} = cmd.parameters;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let el = this.curBrowser.seenEls.get(id);
       resp.body.value = el[name];
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener.getElementProperty(id, name);
       break;
   }
@@ -2307,7 +2306,7 @@ GeckoDriver.prototype.getElementText = async function(cmd, resp) {
   let id = cmd.parameters.id;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       // for chrome, we look at text nodes, and any node with a "label" field
       let el = this.curBrowser.seenEls.get(id);
       let lines = [];
@@ -2315,7 +2314,7 @@ GeckoDriver.prototype.getElementText = async function(cmd, resp) {
       resp.body.value = lines.join("\n");
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener.getElementText(id);
       break;
   }
@@ -2342,12 +2341,12 @@ GeckoDriver.prototype.getElementTagName = async function(cmd, resp) {
   let id = cmd.parameters.id;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let el = this.curBrowser.seenEls.get(id);
       resp.body.value = el.tagName.toLowerCase();
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener.getElementTagName(id);
       break;
   }
@@ -2374,13 +2373,13 @@ GeckoDriver.prototype.isElementDisplayed = async function(cmd, resp) {
   let id = cmd.parameters.id;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let el = this.curBrowser.seenEls.get(id);
       resp.body.value = await interaction.isElementDisplayed(
           el, this.a11yChecks);
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener.isElementDisplayed(id);
       break;
   }
@@ -2410,13 +2409,13 @@ GeckoDriver.prototype.getElementValueOfCssProperty = async function(
   let {id, propertyName: prop} = cmd.parameters;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let el = this.curBrowser.seenEls.get(id);
       let sty = win.document.defaultView.getComputedStyle(el);
       resp.body.value = sty.getPropertyValue(prop);
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener
           .getElementValueOfCssProperty(id, prop);
       break;
@@ -2444,14 +2443,14 @@ GeckoDriver.prototype.isElementEnabled = async function(cmd, resp) {
   let id = cmd.parameters.id;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       // Selenium atom doesn't quite work here
       let el = this.curBrowser.seenEls.get(id);
       resp.body.value = await interaction.isElementEnabled(
           el, this.a11yChecks);
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener.isElementEnabled(id);
       break;
   }
@@ -2478,14 +2477,14 @@ GeckoDriver.prototype.isElementSelected = async function(cmd, resp) {
   let id = cmd.parameters.id;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       // Selenium atom doesn't quite work here
       let el = this.curBrowser.seenEls.get(id);
       resp.body.value = await interaction.isElementSelected(
           el, this.a11yChecks);
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body.value = await this.listener.isElementSelected(id);
       break;
   }
@@ -2504,7 +2503,7 @@ GeckoDriver.prototype.getElementRect = async function(cmd, resp) {
   let id = cmd.parameters.id;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let el = this.curBrowser.seenEls.get(id);
       let rect = el.getBoundingClientRect();
       resp.body = {
@@ -2515,7 +2514,7 @@ GeckoDriver.prototype.getElementRect = async function(cmd, resp) {
       };
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       resp.body = await this.listener.getElementRect(id);
       break;
   }
@@ -2542,13 +2541,13 @@ GeckoDriver.prototype.sendKeysToElement = async function(cmd) {
   assert.string(text);
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let el = this.curBrowser.seenEls.get(id);
       await interaction.sendKeysToElement(
           el, text, true, this.a11yChecks);
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       await this.listener.sendKeysToElement(id, text);
       break;
   }
@@ -2572,7 +2571,7 @@ GeckoDriver.prototype.clearElement = async function(cmd) {
   let id = cmd.parameters.id;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       // the selenium atom doesn't work here
       let el = this.curBrowser.seenEls.get(id);
       if (el.nodeName == "textbox") {
@@ -2582,7 +2581,7 @@ GeckoDriver.prototype.clearElement = async function(cmd) {
       }
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       await this.listener.clearElement(id);
       break;
   }
@@ -2762,7 +2761,7 @@ GeckoDriver.prototype.close = async function() {
  */
 GeckoDriver.prototype.closeChromeWindow = async function() {
   assert.firefox();
-  assert.window(this.getCurrentWindow(Context.CHROME));
+  assert.window(this.getCurrentWindow(Context.Chrome));
 
   let nwins = 0;
 
@@ -2886,7 +2885,7 @@ GeckoDriver.prototype.takeScreenshot = function(cmd) {
   let format = hash ? capture.Format.Hash : capture.Format.Base64;
 
   switch (this.context) {
-    case Context.CHROME:
+    case Context.Chrome:
       let highlightEls = highlights.map(
           ref => this.curBrowser.seenEls.get(ref));
 
@@ -2916,7 +2915,7 @@ GeckoDriver.prototype.takeScreenshot = function(cmd) {
       }
       break;
 
-    case Context.CONTENT:
+    case Context.Content:
       return this.listener.takeScreenshot(format, cmd.parameters);
   }
 
@@ -3466,7 +3465,7 @@ GeckoDriver.prototype.setupReftest = async function(cmd) {
         "Called reftest:setup with a reftest session already active");
   }
 
-  if (this.context !== Context.CHROME) {
+  if (this.context !== Context.Chrome) {
     throw new UnsupportedOperationError(
         "Must set chrome context before running reftests");
   }
@@ -3515,7 +3514,6 @@ GeckoDriver.prototype.teardownReftest = function() {
   this._reftest = null;
 };
 
-
 GeckoDriver.prototype.commands = {
   // Marionette service
   "Marionette:SetContext": GeckoDriver.prototype.setContext,

testing/marionette/harness/marionette_harness/tests/unit/test_marionette.py

@@ -2,11 +2,9 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-import itertools
 import time
 
 from marionette_driver import errors
-
 from marionette_harness import MarionetteTestCase, run_if_manage_instance, skip_if_mobile
 
 
@@ -31,3 +29,34 @@ class TestMarionette(MarionetteTestCase):
         start_time = time.time()
         self.assertFalse(self.marionette.wait_for_port(timeout=5))
         self.assertLess(time.time() - start_time, 5)
+
+
+class TestContext(MarionetteTestCase):
+
+    def setUp(self):
+        MarionetteTestCase.setUp(self)
+        self.marionette.set_context(self.marionette.CONTEXT_CONTENT)
+
+    def get_context(self):
+        return self.marionette._send_message("getContext", key="value")
+
+    def set_context(self, value):
+        return self.marionette._send_message("setContext", {"value": value})
+
+    def test_set_context(self):
+        self.assertEqual(self.set_context("content"), {})
+        self.assertEqual(self.set_context("chrome"), {})
+
+        for typ in [True, 42, [], {}, None]:
+            with self.assertRaises(errors.InvalidArgumentException):
+                self.set_context(typ)
+
+        with self.assertRaises(errors.MarionetteException):
+            self.set_context("foo")
+
+    def test_get_context(self):
+        self.assertEqual(self.get_context(), "content")
+        self.set_context("chrome")
+        self.assertEqual(self.get_context(), "chrome")
+        self.set_context("content")
+        self.assertEqual(self.get_context(), "content")

testing/marionette/test_browser.js

@@ -0,0 +1,25 @@
+const {utils: Cu} = Components;
+
+const {Context} = Cu.import("chrome://marionette/content/browser.js", {});
+
+add_test(function test_Context() {
+  ok(Context.hasOwnProperty("Chrome"));
+  ok(Context.hasOwnProperty("Content"));
+  equal(typeof Context.Chrome, "string");
+  equal(typeof Context.Content, "string");
+  equal(Context.Chrome, "chrome");
+  equal(Context.Content, "content");
+
+  run_next_test();
+});
+
+add_test(function test_Context_fromString() {
+  equal(Context.fromString("chrome"), Context.Chrome);
+  equal(Context.fromString("content"), Context.Content);
+
+  for (let typ of ["", "foo", true, 42, [], {}, null, undefined]) {
+    Assert.throws(() => Context.fromString(typ), /TypeError/);
+  }
+
+  run_next_test();
+});

testing/marionette/unit.ini

@@ -9,6 +9,7 @@ skip-if = appname == "thunderbird"
 
 [test_action.js]
 [test_assert.js]
+[test_browser.js]
 [test_cookie.js]
 [test_dom.js]
 [test_element.js]