topological-nodered-wdio 0.2.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Ruud Senden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# node-red-topological-wdio
+
+Node Red nodes for [Webdriver IO](https://webdriver.io) test framework. The nodes are similar to nodes (https://flows.nodered.org/node/node-red-contrib-wdio). We created a new project as we are planning to customize needed for our organization.
+
+## Usage
+
+The "new session" node creates a Selenium Webdriver session with the configured provider, or local Webdriver server. The session is stored at the Flow level, so can be reused by downstream webdriverIO nodes in the same flow.
+
+If any nodes encounter an error, for example unable to locate a given element on a page, an error will be thrown. This can be caught by a global catch node and actioned appropriately.
+
+After a flow completes, close the Selenium session using the "delete session" node. Alternatively, when Node Red exits, any open Selenium sessions will be closed.
+
+## Contributing
+
+Pull requests are welcomed for bug fixes, new nodes, and new features. Please push your changes in a branch and initiate a Pull Request against master.

package/examples/basic.json

@@ -0,0 +1,332 @@
+[
+  {
+    "id": "b333aac5.8be6a8",
+    "type": "tab",
+    "label": "Flow 1",
+    "disabled": false,
+    "info": ""
+  },
+  {
+    "id": "2ae2052c84670f7b",
+    "type": "group",
+    "z": "b333aac5.8be6a8",
+    "name": "Not an example",
+    "style": { "fill": "#bfbfbf", "label": true },
+    "nodes": [
+      "80d7692a0b0a5dae",
+      "dbe5078787689019",
+      "3d557240da278749",
+      "6ca4cf3b1e3156c8",
+      "acc978488aa9fd9e",
+      "206a1838d1053cc6",
+      "21510f1cf2dc4e22",
+      "8f550411f523be8d",
+      "efe81da4597b7c90"
+    ],
+    "x": 74,
+    "y": 739,
+    "w": 792,
+    "h": 402
+  },
+  {
+    "id": "3a964070.37941",
+    "type": "inject",
+    "z": "b333aac5.8be6a8",
+    "name": "",
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "x": 100,
+    "y": 60,
+    "wires": [["2017a5a9.9aa3da"]]
+  },
+  {
+    "id": "e95ea90a.a813d8",
+    "type": "debug",
+    "z": "b333aac5.8be6a8",
+    "name": "",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "false",
+    "x": 430,
+    "y": 260,
+    "wires": []
+  },
+  {
+    "id": "b670d9f3.134eb8",
+    "type": "delete-session",
+    "z": "b333aac5.8be6a8",
+    "name": "",
+    "x": 260,
+    "y": 440,
+    "wires": [[]]
+  },
+  {
+    "id": "19944fc9.c9237",
+    "type": "catch",
+    "z": "b333aac5.8be6a8",
+    "name": "",
+    "scope": null,
+    "uncaught": false,
+    "x": 240,
+    "y": 580,
+    "wires": [["3a338a9f.17c156"]]
+  },
+  {
+    "id": "3a338a9f.17c156",
+    "type": "debug",
+    "z": "b333aac5.8be6a8",
+    "name": "",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "error",
+    "targetType": "msg",
+    "x": 400,
+    "y": 580,
+    "wires": []
+  },
+  {
+    "id": "54afd8dd.3df5a8",
+    "type": "debug",
+    "z": "b333aac5.8be6a8",
+    "name": "",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "false",
+    "x": 790,
+    "y": 340,
+    "wires": []
+  },
+  {
+    "id": "5f57519b.33bc9",
+    "type": "element-action",
+    "z": "b333aac5.8be6a8",
+    "name": "click go",
+    "locateUsing": "css selector",
+    "locateValue": "#search_button_homepage",
+    "action": "click",
+    "sendKeys": "",
+    "attribute": "",
+    "x": 400,
+    "y": 340,
+    "wires": [["6a3b88d8.2791a"]]
+  },
+  {
+    "id": "a5053d5f.b6a638",
+    "type": "browser-action",
+    "z": "b333aac5.8be6a8",
+    "name": "navigate to",
+    "action": "navigateTo",
+    "url": "https://duckduckgo.com",
+    "width": "",
+    "height": "",
+    "keysArr": "",
+    "x": 431.5,
+    "y": 181,
+    "wires": [["7e7366f3.e7b74"]]
+  },
+  {
+    "id": "7e7366f3.e7b74",
+    "type": "browser-action",
+    "z": "b333aac5.8be6a8",
+    "name": "get title",
+    "action": "getTitle",
+    "url": "",
+    "width": "",
+    "height": "",
+    "keysArr": "",
+    "x": 234.5,
+    "y": 260,
+    "wires": [["e95ea90a.a813d8", "1e414894.80c9f7"]]
+  },
+  {
+    "id": "6a3b88d8.2791a",
+    "type": "browser-action",
+    "z": "b333aac5.8be6a8",
+    "name": "get title",
+    "action": "getTitle",
+    "url": "",
+    "width": "",
+    "height": "",
+    "keysArr": "",
+    "x": 570.5,
+    "y": 339,
+    "wires": [["54afd8dd.3df5a8", "b670d9f3.134eb8"]]
+  },
+  {
+    "id": "1e414894.80c9f7",
+    "type": "element-action",
+    "z": "b333aac5.8be6a8",
+    "name": "send keys",
+    "locateUsing": "css selector",
+    "locateValue": "#search_form_input_homepage",
+    "action": "sendKeys",
+    "sendKeys": "hi",
+    "object": "str",
+    "attribute": "",
+    "x": 233,
+    "y": 340,
+    "wires": [["5f57519b.33bc9"]]
+  },
+  {
+    "id": "2017a5a9.9aa3da",
+    "type": "new-session",
+    "z": "b333aac5.8be6a8",
+    "name": "",
+    "webdriverUri": "",
+    "webdriverProvider": "",
+    "webdriverBrowser": "",
+    "logLevel": "error",
+    "x": 238,
+    "y": 181,
+    "wires": [["a5053d5f.b6a638"]]
+  },
+  {
+    "id": "80d7692a0b0a5dae",
+    "type": "element-check",
+    "z": "b333aac5.8be6a8",
+    "d": true,
+    "g": "2ae2052c84670f7b",
+    "name": "",
+    "locateUsing": "xpath",
+    "locateValue": "",
+    "check": "selected",
+    "x": 400,
+    "y": 780,
+    "wires": [["3d557240da278749"]]
+  },
+  {
+    "id": "dbe5078787689019",
+    "type": "inject",
+    "z": "b333aac5.8be6a8",
+    "d": true,
+    "g": "2ae2052c84670f7b",
+    "name": "",
+    "props": [{ "p": "payload" }, { "p": "topic", "vt": "str" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "x": 180,
+    "y": 780,
+    "wires": [["80d7692a0b0a5dae"]]
+  },
+  {
+    "id": "3d557240da278749",
+    "type": "alert-action",
+    "z": "b333aac5.8be6a8",
+    "d": true,
+    "g": "2ae2052c84670f7b",
+    "name": "",
+    "action": "accept",
+    "sendText": "",
+    "x": 610,
+    "y": 800,
+    "wires": [["6ca4cf3b1e3156c8"]]
+  },
+  {
+    "id": "6ca4cf3b1e3156c8",
+    "type": "dropdown-action",
+    "z": "b333aac5.8be6a8",
+    "d": true,
+    "g": "2ae2052c84670f7b",
+    "name": "",
+    "locateUsing": "xpath",
+    "locateValue": "",
+    "action": "selectByAttr",
+    "text": "",
+    "attribute": "",
+    "index": "",
+    "value": "",
+    "x": 520,
+    "y": 900,
+    "wires": [["efe81da4597b7c90"]]
+  },
+  {
+    "id": "acc978488aa9fd9e",
+    "type": "window-action",
+    "z": "b333aac5.8be6a8",
+    "d": true,
+    "g": "2ae2052c84670f7b",
+    "name": "",
+    "action": "byName",
+    "value": "",
+    "index": "",
+    "x": 400,
+    "y": 1040,
+    "wires": [["206a1838d1053cc6"]]
+  },
+  {
+    "id": "206a1838d1053cc6",
+    "type": "frame-action",
+    "z": "b333aac5.8be6a8",
+    "d": true,
+    "g": "2ae2052c84670f7b",
+    "name": "",
+    "action": "frame",
+    "frame": "",
+    "x": 370,
+    "y": 1100,
+    "wires": [["21510f1cf2dc4e22"]]
+  },
+  {
+    "id": "21510f1cf2dc4e22",
+    "type": "execute-script",
+    "z": "b333aac5.8be6a8",
+    "d": true,
+    "g": "2ae2052c84670f7b",
+    "name": "",
+    "locateUsing": "xpath",
+    "locateValue": "",
+    "action": "sync",
+    "script": "",
+    "x": 600,
+    "y": 1100,
+    "wires": [[]]
+  },
+  {
+    "id": "8f550411f523be8d",
+    "type": "explicit-wait",
+    "z": "b333aac5.8be6a8",
+    "d": true,
+    "g": "2ae2052c84670f7b",
+    "name": "",
+    "locateUsing": "xpath",
+    "locateValue": "",
+    "action": "",
+    "time": "",
+    "reverse": "false",
+    "error": "",
+    "x": 630,
+    "y": 1000,
+    "wires": [["acc978488aa9fd9e"]]
+  },
+  {
+    "id": "efe81da4597b7c90",
+    "type": "implicit-wait-config",
+    "z": "b333aac5.8be6a8",
+    "d": true,
+    "g": "2ae2052c84670f7b",
+    "name": "",
+    "implicit": "",
+    "pageload": "",
+    "script": "",
+    "action": "",
+    "x": 750,
+    "y": 920,
+    "wires": [["8f550411f523be8d"]]
+  }
+]

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "topological-nodered-wdio",
+  "description": "Open source WebdriverIO nodes for Node-RED",
+  "version": "0.2.6",
+  "author": "topological",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Topological-dev/topological-nodered-wdio.git"
+  },
+  "keywords": [
+    "node-red",
+    "topological"
+  ],
+  "node-red": {
+    "version": ">=2.0.0",
+    "nodes": {
+      "delete-session": "src/delete-session.js",
+      "element-action": "src/element-action.js",
+      "new-session": "src/new-session.js",
+      "browser-action": "src/browser-action.js",
+      "element-check": "src/element-check.js",
+      "alert-action": "src/alert-action.js",
+      "dropdown-action": "src/dropdown-action.js",
+      "window-action": "src/window-action.js",
+      "frame-action": "src/frame-action.js",
+      "execute-script": "src/execute-script.js",
+      "explicit-wait": "src/explicit-wait.js",
+      "implicit-wait-config": "src/implicit-wait-config.js"
+    }
+  },
+  "dependencies": {
+    "@wdio/allure-reporter": "^7.19.7",
+    "@wdio/cli": "^7.19.7",
+    "webdriverio": "^7.19.7"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  }
+}

package/src/alert-action.html

@@ -0,0 +1,79 @@
+<script type="text/javascript">
+  function setAlertAction() {
+    let action = $('#node-input-action').val()
+    $('#actionSendText').hide()
+    if (action === 'sendAlertText') {
+      $('#actionSendText').show()
+    }
+  }
+
+  RED.nodes.registerType('alert-action', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      action: { value: 'accept' },
+      sendText: { value: '' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'alert action'
+    },
+    oneditprepare: function() {
+      setAlertAction()
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="alert-action">
+
+  <div class="form-row">
+      <label for="node-input-action"><i class="fa fa-tasks"></i> Action</label>
+      <select type="text" id="node-input-action" style="width:70%;" onchange="setAlertAction()">
+          <option value="dismiss">Dismiss Alert</option>
+          <option value="accept">Accept Alert</option>
+          <option value="getAlertText">Get Alert Text</option>
+          <option value="isPresent">Is Alert Present</option>
+      </select>
+  </div>
+
+
+  <div class="form-row" id="actionSendText">
+      <label for="node-input-sendText"><i class="fa fa-tasks"></i> Text to Send</label>
+      <input id="node-input-sendText" type="text">
+  </div>
+
+
+  <div class="form-row">
+      <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+      <input id="node-input-name" type="text">
+  </div>
+</script>
+
+
+
+<script type="text/x-red" data-help-name="alert-action">
+  <h3>Selected action of the node performs on pop-up alerts/windows.</h3>
+  <h3>Details</h3>
+      <dl class="message-properties">
+          <dt>Action: <span class="property-type">select</span></dt>
+          <dd>Action to perform on the pop-up alert/window:
+            <ul>
+                <li>Dismiss Alert</li>
+                <li>Accept Alert</li>
+                <li>Get Alert Text</li>
+                <li>Is Alert Present</li>
+            </ul>
+          </dd>
+      </dl>
+
+  <h3>Outputs</h3>
+      <dl class="message-properties">
+          <dt>msg.payload: <span class="property-type">string/bool</span></dt>
+          <dd>If the <b>Get Alert Text</b> action is selected, the <code>ms.payload</code> will return the text on the alert message<br></dd>
+          <dd>If the <b>Is Alert Present</b> action is selected, <code>ms.payload</code> will return a true/false <code>boolean</code></dd>
+      </dl>
+
+</script>

package/src/alert-action.js

@@ -0,0 +1,51 @@
+const common = require('./wdio-common')
+
+const isAlertPresent = async (browser) => {
+  try {
+    await browser.getAlertText()
+    return true
+  } catch (e) {
+    return false
+  }
+}
+
+module.exports = function(RED) {
+  function alertAction(config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+    common.clearStatus(node)
+
+    node.on('input', async (msg) => {
+      try {
+        let browser = await common.getBrowser(node.context())
+
+        let value = msg.value || config.sendText 
+
+        if (config.action === 'dismiss') {
+          node.log = 'Dismiss the alert.'
+          await browser.dismissAlert()
+        } else if (config.action === 'accept') {
+          node.log = 'Accept the alert displayed.'
+          await browser.acceptAlert()
+        } else if (config.action === 'getAlertText') {
+          node.log = 'Get the alert text.'
+          msg.payload = await browser.getAlertText()
+        } else if (config.action === 'sendAlertText') {
+          if (await isAlertPresent()) {
+            node.log = `Send "${value}" to alert.`
+            await browser.sendAlertText(value)
+          }
+        } else if (config.action === 'isPresent') {
+          node.log = 'Verify for an alert.'
+          msg.payload = await isAlertPresent(browser)
+        }
+        await common.log(node)
+        common.successStatus(node)
+        node.send(msg)
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('alert-action', alertAction)
+}

package/src/browser-action.html

@@ -0,0 +1,114 @@
+<script type="text/javascript">
+  function setBrowserAction() {
+    let action = $('#node-input-action').val()
+    $('#actionURL').hide()
+    $('#actionWidth').hide()
+    $('#actionHeight').hide()
+    $('#actionValue').hide()
+    if (action === 'setSize') {
+      $('#actionWidth').show()
+      $('#actionHeight').show()
+    }
+    if (action === 'navigateTo') {
+      $('#actionURL').show()
+    }
+    if (action === 'keyStorkes') {
+      $('#actionValue').show()
+    }
+  }
+
+  RED.nodes.registerType('browser-action', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      action: { value: 'navigateTo' },
+      url: { value: '' },
+      width: { value: '' },
+      height: { value: '' },
+      keysArr: { value: '' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'browser action'
+    },
+    oneditprepare: function() {
+      setBrowserAction()
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="browser-action">
+  <div class="form-row">
+      <label for="node-input-action"><i class="fa fa-tasks"></i> Action</label>
+      <select type="text" id="node-input-action" style="width:70%;" onchange="setBrowserAction()">
+          <option value="getUrl">Get URL</option>
+          <option value="navigateTo">Navigate To</option>
+          <option value="back">Back</option>
+          <option value="forward">Forward</option>
+          <option value="refresh">Refresh</option>
+          <option value="getTitle">Get Title</option>
+          <option value="setSize">Set window Size</option>
+          <option value="maximize">Maximize Window</option>
+          <option value="takeScreenShot">Screenshot</option>
+          <option value="pageSource">Get Page Source</option>
+          <option value="print">Print</option>
+          <option value="keyStrokes">Key Strokes</option>
+          <option value="getCookies">Get All Cookies</option>
+      </select>
+  </div>
+  <div class="form-row" id="actionURL">
+      <label for="node-input-url"><i class="fa fa-tasks"></i> URL</label>
+      <input id="node-input-url" type="text">
+  </div>
+  <div class="form-row" id="actionWidth">
+      <label for="node-input-width"><i class="fa fa-tasks"></i>Width</label>
+      <input id="node-input-width" type="text">
+  </div>
+  <div class="form-row" id="actionHeight">
+      <label for="node-input-height"><i class="fa fa-tasks"></i>Height</label>
+      <input id="node-input-height" type="text">
+  </div>
+  <div class="form-row" id="actionValue">
+    <label for="node-input-keysArr"><i class="fa fa-tasks"></i> Key Values</label>
+    <input id="node-input-keysArr" type="text">
+  </div>
+  <div class="form-row">
+      <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+      <input id="node-input-name" type="text">
+  </div>
+</script>
+
+<script type="text/x-red" data-help-name="browser-action">
+  <h3>Performs from a list of standard browser actions on the current instance of the browser.</h3>
+  <h3>Inputs</h3>
+      <dl class="message-properties">
+          <dt>action: <span class="property-type">string</span></dt>
+          <dd>All the browser actions. Selected action will be performed on the browser.</dd>
+          <dt>url: <span class="property-type">string</span></dt>
+          <dd>Browser navigates to the provide url when we select the action as "navigateTo"</dd>
+          <dd>Can be parameterized using <code>msg.url</code>, by leaving the URL empty on node configuration.</dd>
+          <dt>width: <span class="property-type">string</span></dt>
+          <dd>Browser window will be adjusted to specified width.</dd>
+          <dd>Can be parameterized using <code>msg.width</code>, by leaving the Width empty on node configuration.</dd>
+          <dt>height: <span class="property-type">string</span></dt>
+          <dd>Browser window will be adjusted to specified height.</dd>
+          <dd>Can be parameterized using <code>msg.height</code>, by leaving the Height empty on node configuration.</dd>
+          <dt>Key Values: <span class="property-type">string</span></dt>
+          <dd>See the list of values as keys. click <a href="https://w3c.github.io/webdriver/#keyboard-actions">here</a>.</dd>
+          <dd>A string with , separated key values, which will be converted to an array of strings.</dd>
+          <dd>Can be parameterized using <code>msg.keysArr</code>, by leaving the Key Values empty on node configuration.</dd>
+      </dl>
+
+  <h3>Outputs</h3>
+      <dl class="message-properties">
+          <dt>msg.payload: <span class="property-type">string/Object</span></dt>
+          <dd><b>Get URL</b> returns url of the current browser tab<br></dd>
+          <dd><b>Get Title</b> returns title of the current browser tab<br></dd>
+          <dd><b>Screenshot</b> returns Base64 encode string value of screenshot of open window<br></dd>
+          <dd><b>Get Page Source</b> returns entire page source of the document<br></dd>
+          <dd><b>Get All Cookies</b> returns all cookies stored at the moment inside of an Object<br></dd>
+      </dl>
+</script>