Merge branch 'master' into rewrite-targetselector-class

Author: manoj9788

packages/selenium-ide/src/content/locatorBuilders.js

@@ -16,7 +16,7 @@
 
 import { MozillaBrowserBot } from "./selenium-browserbot";
 import { core } from "./closure-polyfill";
-const exactMatchPattern = window.global.exactMatchPattern;
+import { exactMatchPattern } from "./targetSelector";
 
 export default function LocatorBuilders(window) {
   this.window = window;
@@ -290,11 +290,6 @@ LocatorBuilders.prototype.preciseXPath = function(xpath, e) {
  * ===== builders =====
  */
 
-LocatorBuilders.add("ui", function(pageElement) {
-  return UIMap.getInstance().getUISpecifierString(pageElement,
-    this.window.document);
-});
-
 LocatorBuilders.add("id", function(e) {
   if (e.id) {
     return "id=" + e.id;
@@ -329,58 +324,6 @@ LocatorBuilders.add("css", function(e) {
   return "css=" + sub_path;
 });
 
-/*
- * This function is called from DOM locatorBuilders
- */
-LocatorBuilders.prototype.findDomFormLocator = function(form) {
-  if (form.hasAttribute("name")) {
-    let name = form.getAttribute("name");
-    let locator = "document." + name;
-    if (this.findElement(locator) == form) {
-      return locator;
-    }
-    locator = "document.forms['" + name + "']";
-    if (this.findElement(locator) == form) {
-      return locator;
-    }
-  }
-  let forms = this.window.document.forms;
-  for (let i = 0; i < forms.length; i++) {
-    if (form == forms[i]) {
-      return "document.forms[" + i + "]";
-    }
-  }
-  return null;
-};
-
-LocatorBuilders.add("dom:name", function(e) {
-  if (e.form && e.name) {
-    let formLocator = this.findDomFormLocator(e.form);
-    if (formLocator) {
-      let candidates = [formLocator + "." + e.name,
-        formLocator + ".elements['" + e.name + "']"
-      ];
-      for (let c = 0; c < candidates.length; c++) {
-        let locator = candidates[c];
-        let found = this.findElement(locator);
-        if (found) {
-          if (found == e) {
-            return locator;
-          } else if (found instanceof NodeList) {
-            // multiple elements with same name
-            for (let i = 0; i < found.length; i++) {
-              if (found[i] == e) {
-                return locator + "[" + i + "]";
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-  return null;
-});
-
 LocatorBuilders.add("xpath:link", function(e) {
   if (e.nodeName == "A") {
     let text = e.textContent;
@@ -477,21 +420,6 @@ LocatorBuilders.add("xpath:href", function(e) {
   return null;
 });
 
-LocatorBuilders.add("dom:index", function(e) {
-  if (e.form) {
-    let formLocator = this.findDomFormLocator(e.form);
-    if (formLocator) {
-      let elements = e.form.elements;
-      for (let i = 0; i < elements.length; i++) {
-        if (elements[i] == e) {
-          return formLocator + ".elements[" + i + "]";
-        }
-      }
-    }
-  }
-  return null;
-});
-
 LocatorBuilders.add("xpath:position", function(e, opt_contextNode) {
   //this.log.debug("positionXPath: e=" + e);
   let path = "";
@@ -515,4 +443,4 @@ LocatorBuilders.add("xpath:position", function(e, opt_contextNode) {
 });
 // Samit: Warning: The old method of setting the order using LocatorBuilders.order is now deprecated
 // You can change the priority of builders by setting LocatorBuilders.order.
-//LocatorBuilders.order = ['ui', 'id', 'link', 'name', 'css', 'dom:name', 'xpath:link', 'xpath:img', 'xpath:attributes', 'xpath:idRelative', 'xpath:href', 'dom:index', 'xpath:position'];
+//LocatorBuilders.order = ['id', 'link', 'name', 'css', 'xpath:link', 'xpath:img', 'xpath:attributes', 'xpath:idRelative', 'xpath:href', 'xpath:position'];

packages/selenium-ide/src/content/prompt-injector.js

@@ -40,9 +40,9 @@ if (window === window.top) {
             }
             record("assertPrompt", [[event.data.recordedMessage]], "", false, event.data.frameLocation);
             if (event.data.recordedResult != null) {
-              record("webdriverAnswerOnNextPrompt", [[event.data.recordedResult]], "", false, event.data.frameLocation);
+              record("webdriverAnswerOnVisiblePrompt", [[event.data.recordedResult]], "", false, event.data.frameLocation);
             } else {
-              record("webdriverChooseCancelOnNextPrompt", [[""]], "", false, event.data.frameLocation);
+              record("webdriverChooseCancelOnVisiblePrompt", [[""]], "", false, event.data.frameLocation);
             }
             break;
           case "confirm":
@@ -53,9 +53,9 @@ if (window === window.top) {
             }
             record("assertConfirmation", [[event.data.recordedMessage]], "", false, event.data.frameLocation);
             if (event.data.recordedResult == true) {
-              record("webdriverChooseOkOnNextConfirmation", [[""]], "", false, event.data.frameLocation);
+              record("webdriverChooseOkOnVisibleConfirmation", [[""]], "", false, event.data.frameLocation);
             } else {
-              record("webdriverChooseCancelOnNextConfirmation", [[""]], "", false, event.data.frameLocation);
+              record("webdriverChooseCancelOnVisibleConfirmation", [[""]], "", false, event.data.frameLocation);
             }
             break;
           case "alert":

packages/selenium-ide/src/content/targetSelector.js

@@ -17,11 +17,18 @@
 
 // Modified in tools.js from selenium-IDE
 
+export function exactMatchPattern(string) {
+  if (string != null && (string.match(/^\w*:/) || string.indexOf("?") >= 0 || string.indexOf("*") >= 0)) {
+    return "exact:" + string;
+  } else {
+    return string;
+  }
+}
+
 class TargetSelector {
   constructor(callback, cleanupCallback) {
     this.callback = callback;
     this.cleanupCallback = cleanupCallback;
-
     // This is for XPCOM/XUL addon and can't be used
     //var wm = Components.classes["@mozilla.org/appshell/window-mediator;1"].getService(Components.interfaces.nsIWindowMediator);
     //this.win = wm.getMostRecentWindow('navigator:browser').getBrowser().contentWindow;

packages/selenium-ide/src/neo/IO/SideeX/ext-command.js

@@ -212,7 +212,7 @@ export default class ExtCommand {
     });
   }
 
-  doPause(ignored, milliseconds) {
+  doPause(milliseconds) {
     return new Promise(function(resolve) {
       setTimeout(resolve, milliseconds);
     });

packages/selenium-ide/src/neo/IO/SideeX/playback.js

@@ -288,6 +288,7 @@ function doSeleniumCommand(id, command, target, value, implicitTime, implicitCou
 function doPluginCommand(id, command, target, value, implicitTime, implicitCount) {
   return executeCommand(command, target, value, {
     commandId: id,
+    isNested: !!PlaybackState.callstack.length,
     runId: PlaybackState.runId,
     testId: PlaybackState.currentRunningTest.id,
     frameId: extCommand.getCurrentPlayingFrameId(),

packages/selenium-ide/src/neo/models/Command.js

@@ -218,7 +218,7 @@ class CommandList {
       name: "answer on next prompt",
       description: "Affects the next alert prompt. This command will send \
                     the specified answer string to it. If the alert is already \
-                    present, then use \"webdriver answer on next prompt\" instead.",
+                    present, then use \"webdriver answer on visible prompt\" instead.",
       target: ArgTypes.answer
     }],
     [ "assertAlert", {
@@ -327,19 +327,19 @@ class CommandList {
       name: "choose cancel on next confirmation",
       description: "Affects the next confirmation alert. This command will \
                     cancel it. If the alert is already present, then use \
-                    \"webdriver choose cancel on next confirmation\" instead."
+                    \"webdriver choose cancel on visible confirmation\" instead."
     }],
     [ "chooseCancelOnNextPrompt", {
       name: "choose cancel on next prompt",
       description: "Affects the next alert prompt. This command will cancel \
                     it. If the alert is already present, then use \"webdriver \
-                    choose cancel on next prompt\" instead."
+                    choose cancel on visible prompt\" instead."
     }],
     [ "chooseOkOnNextConfirmation", {
       name: "choose ok on next confirmation",
       description: "Affects the next confirmation alert. This command will accept \
                     it. If the alert is already present, then use \"webdriver \
-                    choose ok on next confirmation\" instead."
+                    choose ok on visible confirmation\" instead."
     }],
     [ "click", {
       name: "click",
@@ -687,30 +687,30 @@ class CommandList {
       target: ArgTypes.selectLocator,
       value: ArgTypes.pattern
     }],
-    [ "webdriverAnswerOnNextPrompt", {
-      name: "webdriver answer on next prompt",
+    [ "webdriverAnswerOnVisiblePrompt", {
+      name: "webdriver answer on visible prompt",
       description: "Affects a currently showing alert prompt. This command \
                     instructs Selenium to provide the specified answer to it. \
                     If the alert has not appeared yet then use \"answer on next \
                     prompt\" instead.",
       target: ArgTypes.answer
     }],
-    [ "webdriverChooseCancelOnNextConfirmation", {
-      name: "webdriver choose cancel on next confirmation",
+    [ "webdriverChooseCancelOnVisibleConfirmation", {
+      name: "webdriver choose cancel on visible confirmation",
       description: "Affects a currently showing confirmation alert. This command \
                     instructs Selenium to cancel it. If the alert has not \
                     appeared yet then use \"choose cancel on next confirmation\" \
                     instead."
     }],
-    [ "webdriverChooseCancelOnNextPrompt", {
-      name: "webdriver choose cancel on next prompt",
+    [ "webdriverChooseCancelOnVisiblePrompt", {
+      name: "webdriver choose cancel on visible prompt",
       description: "Affects a currently showing alert prompt. This command \
                     instructs Selenium to cancel it. If the alert has not \
                     appeared yet then use \"choose cancel on next prompt\" \
                     instead."
     }],
-    [ "webdriverChooseOkOnNextConfirmation", {
-      name: "webdriver choose ok on next confirmation",
+    [ "webdriverChooseOkOnVisibleConfirmation", {
+      name: "webdriver choose ok on visible confirmation",
       description: "Affects a currently showing confirmation alert. This command \
                     instructs Selenium to accept it. If the alert has not \
                     appeared yet then use \"choose ok on next confirmation\" \

packages/selenium-side-runner/README.md

@@ -49,3 +49,14 @@ Running tests faster through the use of multiple workers
 The runner will automatically set the number of workers to the amount of cores available, for most cases this is the best result.  
 **Note:** unless you specified that a suite is parallel, it will still run the contained tests sequentially, though the runner will run suites in parallel by default.  
 To mark a suite's tests as parallel, set that in the suite's settings in the IDE.
+
+### FAQ
+
+#### I'm getting an error similar to `Unknown locator ${vars.something}`
+When running your projects make sure that the command is aware of the locator strategy **before** variables are evaluated.  
+For example `click | id=${myButton}` vs `click | ${idOfMyButton}`.  
+Always use the first one, since the strategy is hardcoded in the command, the second would yield an error.  
+
+>But it works in the IDE.  
+
+That is because the IDE calculates locator strategies differently than the runner, it is a known current issue.

packages/selianize/__tests__/command.spec.js

@@ -137,7 +137,7 @@ describe("command code emitter", () => {
       target: "some test case",
       value: ""
     };
-    return expect(CommandEmitter.emit(command)).resolves.toBe("await tests.some_test_case(driver, vars);");
+    return expect(CommandEmitter.emit(command)).resolves.toBe("await tests.some_test_case(driver, vars, { isNested: true });");
   });
   it("should emit `run script` command", () => {
     const command = {
@@ -166,10 +166,10 @@ describe("command code emitter", () => {
   it("should emit `pause` command", () => {
     const command = {
       command: "pause",
-      target: "",
-      value: "300"
+      target: "300",
+      value: ""
     };
-    return expect(CommandEmitter.emit(command)).resolves.toBe(`await driver.sleep(${command.value});`);
+    return expect(CommandEmitter.emit(command)).resolves.toBe(`await driver.sleep(${command.target});`);
   });
   it("should emit `verify checked` command", () => {
     const command = {
@@ -571,33 +571,33 @@ describe("command code emitter", () => {
     };
     return expect(CommandEmitter.emit(command)).resolves.toBe(`await driver.switchTo().alert().then(alert => {alert.getText().then(text => {expect(text).toBe(\`${command.target}\`);});});`);
   });
-  it("should emit `choose ok on next confirmation` command", () => {
+  it("should emit `choose ok on visible confirmation` command", () => {
     const command = {
-      command: "webdriverChooseOkOnNextConfirmation",
+      command: "webdriverChooseOkOnVisibleConfirmation",
       target: "",
       value: ""
     };
     return expect(CommandEmitter.emit(command)).resolves.toBe("await driver.switchTo().alert().then(alert => {alert.accept();});");
   });
-  it("should emit `choose cancel on next confirmation` command", () => {
+  it("should emit `choose cancel on visible confirmation` command", () => {
     const command = {
-      command: "webdriverChooseCancelOnNextConfirmation",
+      command: "webdriverChooseCancelOnVisibleConfirmation",
       target: "",
       value: ""
     };
     return expect(CommandEmitter.emit(command)).resolves.toBe("await driver.switchTo().alert().then(alert => {alert.dismiss();});");
   });
-  it("should emit `answer on next prompt` command", () => {
+  it("should emit `answer on visible prompt` command", () => {
     const command = {
-      command: "webdriverAnswerOnNextPrompt",
+      command: "webdriverAnswerOnVisiblePrompt",
       target: "an answer",
       value: ""
     };
     return expect(CommandEmitter.emit(command)).resolves.toBe(`await driver.switchTo().alert().then(alert => {alert.sendKeys(\`${command.target}\`).then(() => {alert.accept();});});`);
   });
-  it("should emit `choose cancel on next prompt` command", () => {
+  it("should emit `choose cancel on visible prompt` command", () => {
     const command = {
-      command: "webdriverChooseCancelOnNextPrompt",
+      command: "webdriverChooseCancelOnVisiblePrompt",
       target: "",
       value: ""
     };

packages/selianize/__tests__/selection.spec.js

@@ -21,6 +21,9 @@ describe("selection location code emitter", () => {
   it("should fail to emit unknown selection locator", () => {
     return expect(SelectionEmitter.emit("notExists=element")).rejects.toThrow("Unknown selection locator notExists");
   });
+  it("should assume when no selector is given that it is the label locator", () => {
+    return expect(SelectionEmitter.emit("label")).resolves.toBe("By.xpath(`//option[. = 'label']`)");
+  });
   it("should emit label locator", () => {
     const type = "label";
     const selector = "a label";

packages/selianize/__tests__/testcase.spec.js

@@ -27,7 +27,7 @@ describe("test case code emitter", () => {
     return expect(TestCaseEmitter.emit(test)).resolves.toEqual({
       name: "example test case",
       test: `it("${test.name}", async () => {await tests.example_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});`,
-      function: "tests.example_test_case = async function example_test_case(driver, vars) {}"
+      function: "tests.example_test_case = async function example_test_case(driver, vars, opts) {}"
     });
   });
   it("should emit a test with a single command", () => {
@@ -43,7 +43,7 @@ describe("test case code emitter", () => {
     return expect(TestCaseEmitter.emit(test)).resolves.toEqual({
       name: "example test case",
       test: `it("${test.name}", async () => {await tests.example_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});`,
-      function: `tests.example_test_case = async function example_test_case(driver, vars) {await driver.get(BASE_URL + "${test.commands[0].target}");}`
+      function: `tests.example_test_case = async function example_test_case(driver, vars, opts) {await driver.get(BASE_URL + "${test.commands[0].target}");}`
     });
   });
   it("should emit a test with multiple commands", () => {
@@ -71,7 +71,7 @@ describe("test case code emitter", () => {
     return expect(TestCaseEmitter.emit(test)).resolves.toEqual({
       name: "example test case",
       test: `it("${test.name}", async () => {await tests.example_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});`,
-      function: `tests.example_test_case = async function example_test_case(driver, vars) {await driver.get(BASE_URL + "${test.commands[0].target}");await driver.get(BASE_URL + "${test.commands[1].target}");await driver.get(BASE_URL + "${test.commands[2].target}");}`
+      function: `tests.example_test_case = async function example_test_case(driver, vars, opts) {await driver.get(BASE_URL + "${test.commands[0].target}");await driver.get(BASE_URL + "${test.commands[1].target}");await driver.get(BASE_URL + "${test.commands[2].target}");}`
     });
   });
   it("should reject a test with failed commands", () => {
@@ -133,7 +133,7 @@ describe("test case code emitter", () => {
     return expect(TestCaseEmitter.emit(test, { silenceErrors: true })).resolves.toEqual({
       name: "silence",
       test: "it(\"silence\", async () => {await tests.silence(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});",
-      function: "tests.silence = async function silence(driver, vars) {throw new Error(\"Unknown command doesntExist\");}"
+      function: "tests.silence = async function silence(driver, vars, opts) {throw new Error(\"Unknown command doesntExist\");}"
     });
   });
 });