topological-nodered-wdio 0.2.6

package/src/execute-script.html

@@ -0,0 +1,92 @@
+<script type="text/javascript">
+  RED.nodes.registerType('execute-script', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      locateUsing: { value: 'xpath' },
+      locateValue: { value: '' },
+      action: { value: 'sync' },
+      script: { value: '' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'execute script'
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="execute-script">
+  <div class="form-row">
+      <label for="node-input-locateUsing"><i class="fa fa-tasks"></i> Locate Method</label>
+      <select type="text" id="node-input-locateUsing" style="width:70%;">
+          <option value="id">id</option>
+          <option value="name">name</option>
+          <option value="css selector">CSS selector</option>
+          <option value="link text">Link text</option>
+          <option value="partial link text">Partial link text</option>
+          <option value="tag name">Tag name</option>
+          <option value="xpath" selected>XPath</option>
+      </select>
+  </div>
+  <div class="form-row">
+      <label for="node-input-locateValue"><i class="fa fa-tasks"></i> Selector</label>
+      <input id="node-input-locateValue" type="text">
+  </div>
+  <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%;">
+          <option value="sync">Sync</option>
+          <option value="aSync">Async</option>
+      </select>
+  </div>
+  <div class="form-row">
+      <label for="node-input-script"><i class="fa fa-tasks"></i> Script</label>
+      <input id="node-input-script" type="text" placeholder="javascript in string">
+  </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="execute-script">
+  <h3>Execute javascript commands on a target web element.</h3>
+  <h3>Inputs</h3>
+        <dl class="message-properties">
+
+          <dt><code>mgs.locateUsing</code>: <span class="property-type">string</span></dt>
+          <dd>specifies the type of web element identifier:
+            <ul>
+                <li>id</li>
+                <li>name</li>
+                <li>CSS selector</li>
+                <li>Link text</li>
+                <li>Partial link text</li>
+                <li>Tag name</li>
+                <li>XPath</li>
+            </ul>
+            <br>
+          </dd>
+          <dt><code>msg.locateValue</code><span class="property-type">string</span></dt>
+          <dd>value passed to the web element identifier (Locate Method)<br></dd>
+
+          <dt><code>msg.script</code><span class="property-type">string</span></dt>
+          <dd>This is the script that would run in the context frame; the selected web element(Selector) would be passed as an argument.</dd>
+        </dl>
+
+  <h3>Details</h3>
+   <p><b>Locate Method</b> specifies the method used to target the web element. This option can be selected manually from the Properties panel OR it can be received from <code>mgs.locateUsing</code><br></p>
+   <p><b>Selector</b> value used by the Locate Method to target the web element. This option can be selected manually from the Properties panel OR it can be received from <code>mgs.locateValue</code><br></p>
+   <p><b>Action</b>
+        <ul>
+            <li>Sync: executes a JavaScript function in the context of the current browsing context. Selector is passed in as an argument. <code>browser.executeScript(script, args)</code></li>
+            <li>Async: inject a snippet of JavaScript into the page for asynchronous execution in the context of the currently selected frame. Selector is passed in as argument/ <code>browser.executeAsyncScript(script, args)</code></li>
+        </ul>
+   </p>
+   <p><b>Script</b> The script that would would run in the context browser<br></p>
+</script>
+
+

package/src/execute-script.js

@@ -0,0 +1,39 @@
+const common = require('./wdio-common')
+
+module.exports = function(RED) {
+  function executeScript(config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+    common.clearStatus(node)
+
+    node.on('input', async (msg) => {
+      try {
+        let locateUsing = config.locateUsing || msg.locateUsing
+        let locateValue = config.locateValue || msg.locateValue
+
+        let browser = await common.getBrowser(node.context())
+        let element = await common.getElement(
+          browser,
+          locateUsing,
+          locateValue
+        )
+
+        let script = config.script || msg.script
+
+        if (config.action === 'sync') {
+          node.log = `Execute synchronous Javascript: "${script}"${element?` By passing the webelement identified using ${locateUsing}: "${locateValue}"`:''}.`
+          await browser.executeScript(script, Array.from(element))
+        } else if (config.action === 'aSync') {
+          node.log = `Execute the asynchronous Javascript: "${script}"${element?` By passing the webelement identified using ${locateUsing}: "${locateValue}"`:''}.`
+          await browser.executeAsyncScript(script, Array.from(element))
+        }
+        await common.log(node)
+        common.successStatus(node)
+        node.send(msg)
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('execute-script', executeScript)
+}

package/src/explicit-wait.html

@@ -0,0 +1,123 @@
+<script type="text/javascript">
+  function setExplicitAction() {
+    let action = $('#node-input-action').val()
+    $('#actionTime').show()
+    $('#actionReverse').show()
+    $('#actionError').show()
+    if (action === 'until') {
+      $('#actionTime').hide()
+      $('#actionReverse').hide()
+      $('#actionError').hide()
+    }
+  }
+
+  RED.nodes.registerType('explicit-wait', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      locateUsing: { value: 'xpath' },
+      locateValue: { value: '' },
+      action: { value: '' },
+      time: { value: '' },
+      reverse: { value: 'false' },
+      error: { value: '' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'explicit wait'
+    },
+    oneditprepare: function() {
+      setExplicitAction()
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="explicit-wait">
+  <div class="form-row">
+      <label for="node-input-locateUsing"><i class="fa fa-tasks"></i> Locate Method</label>
+      <select type="text" id="node-input-locateUsing" style="width:70%;">
+        <option value="id">id</option>
+        <option value="name">name</option>
+        <option value="className">Class Name</option>
+        <option value="selector">Jquery Selector</option>
+      </select>
+  </div>
+  <div class="form-row">
+      <label for="node-input-locateValue"><i class="fa fa-tasks"></i> Selector</label>
+      <input id="node-input-locateValue" type="text">
+  </div>
+  <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="setExplicitAction()">
+          <option value="displayed">Wait for Displayed</option>
+          <option value="enabled">Wait for Enabled</option>
+          <option value="exists">Wait for Exist</option>
+          <option value="until">Wait Until</option>
+      </select>
+  </div>
+  <div class="form-row" id="actionTime" >
+      <label for="node-input-time"><i class="fa fa-tasks"></i> Time to Wait</label>
+      <input id="node-input-time" type="text" placeholder="in ms">
+  </div>
+  <div class="form-row" id="actionReverse" >
+      <label for="node-input-reverse"><i class="fa fa-tasks"></i> Reverse</label>
+      <select type="text" id="node-input-reverse" style="width:70%;">
+          <option value="false">false</option>
+          <option value="true">true</option>
+      </select>
+  </div>
+  <div class="form-row" id="actionError" >
+      <label for="node-input-error"><i class="fa fa-tasks"></i> Error Message</label>
+      <input id="node-input-error" type="text" placeholder="error message">
+  </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="explicit-wait">
+  <h3>The Set Timeouts command sets timeout durations associated with the current session.</h3>
+  <h3>Inputs</h3>
+        <dl class="message-properties">
+        <dt><code>mgs.locateUsing</code>: <span class="property-type">string</span></dt>
+          <dd>specifies the type of web element identifier:
+            <ul>
+                <li>id</li>
+                <li>name</li>
+                <li>CSS selector</li>
+                <li>Link text</li>
+                <li>Partial link text</li>
+                <li>Tag name</li>
+                <li>XPath</li>
+            </ul>
+            <br>
+          </dd>
+          <dt><code>msg.locateValue</code><span class="property-type">string</span></dt>
+          <dd>value passed to the web element identifier (Locate Method)<br></dd>
+
+          <dt><code>msg.reverse</code><span class="property-type">boolean</span></dt>
+          <dd>If set to true, webdriver will wait for the <i>opposite</i> of the action selected<br></dd>
+        </dl>
+
+  <h3>Details</h3>
+    <p><b>Locate Method</b> specifies the method used to target the web element. This option can be selected manually from the Properties panel OR it can be received from <code>mgs.locateUsing</code><br></p>
+    <p><b>Selector</b> value used by the Locate Method to target the web element. This option can be selected manually from the Properties panel OR it can be received from <code>mgs.locateValue</code><br></p>
+    <p><b>Action</b> to perform on the pop-up alert/window:
+            <ul>
+                <li>Wait for Displayed</li>
+                <li>Wait for Enabled</li>
+                <li>Wait for Exist</li>
+                <li>Wait Until</li>
+            </ul>
+    </p>
+     <p><b>Time to Wait</b> Set time to wait in milliseconds. <br></p>
+     <p><b>Reverse</b> If set to true, webdriver will wait for the <i>opposite</i> of the action selected. <br></p>
+     <p><b>Error Message</b> If an error exists this error message overrides the default error message. <br></p>
+
+
+
+</script>

package/src/explicit-wait.js

@@ -0,0 +1,53 @@
+const common = require('./wdio-common')
+
+module.exports = function(RED) {
+  function explicitWait(config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+    common.clearStatus(node)
+
+    node.on('input', async (msg) => {
+      try {
+        let locateUsing = config.locateUsing || msg.locateUsing
+        let locateValue = config.locateValue || msg.locateValue
+
+        let browser = await common.getBrowser(node.context())
+        let element = await common.getElement(
+          browser,
+          locateUsing,
+          locateValue
+        )
+
+        let time = config.time || msg.time
+        let reverse = config.reverse || msg.reverse
+        let error = config.error || msg.error
+
+        let boolReverse = reverse === 'false' ? false : true
+
+        if (config.action === 'displayed') {
+          node.log = `Waiting for the element to be displayed for ${time}, identified using ${locateUsing}: "${locateValue}".`
+          await element.waitForDisplayed(time, boolReverse, error)
+        } else if (config.action === 'enabled') {
+          node.log = `Waiting for the element to be enabled for ${time}, identified using ${locateUsing}: "${locateValue}".`
+          await element.waitForEnabled(time, boolReverse, error)
+        } else if (config.action === 'exists') {
+          node.log = `Waiting for the element to be exists for ${time}, identified using ${locateUsing}: "${locateValue}".`
+          await element.waitForExist(time, boolReverse, error)
+        } else if (config.action === 'until') {
+          await element.waitUntil()
+        }
+
+        if (error) {
+          common.handleError(error, node, msg)
+        } else {
+          await common.log(node)
+          common.successStatus(node)
+          node.send(msg)
+        }
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('explicit-wait', explicitWait)
+}

package/src/frame-action.html

@@ -0,0 +1,67 @@
+<script type="text/javascript">
+  function setFrameAction() {
+    let action = $('#node-input-action').val()
+    $('#actionFrame').hide()
+    if (action === 'frame') {
+      $('#actionFrame').show()
+    }
+  }
+
+  RED.nodes.registerType('frame-action', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      action: { value: 'frame' },
+      frame: { value: '' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'frame action'
+    },
+    oneditprepare: function() {
+      setFrameAction()
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="frame-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="setFrameAction()">
+          <option value="frame">Switch to Frame</option>
+          <option value="parentFrame">Switch to Parent Frame</option>
+      </select>
+  </div>
+  <div class="form-row" id="actionFrame">
+      <label for="node-input-frame"><i class="fa fa-tasks"></i> Frame Name</label>
+      <input id="node-input-frame" 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="frame-action">
+  <h3>Select the current top-level browsing context or a child/parent browsing context of the current browsing context to use as the current browsing context for subsequent commands</h3>
+  <h3>Details</h3>
+      <dl class="message-properties">
+          <dt>Action: <span class="property-type">select</span></dt>
+          <dd>
+            <ul>
+                <li><b>Switch to Frame</b></li>
+                <ul>
+                    <li>The Switch To Frame command is used to select the current top-level browsing context or a child browsing context of the current browsing context to use as the current browsing context for subsequent commands.</li>
+                </ul>
+                <li><b>Switch to Parent Frame</b></li>
+                <ul>
+                    <li>The Switch to Parent Frame command sets the current browsing context for future commands to the parent of the current browsing context.</li>
+                </ul>
+            </ul>
+          </dd>
+      </dl>
+</script>
+

package/src/frame-action.js

@@ -0,0 +1,37 @@
+const common = require('./wdio-common')
+
+module.exports = function(RED) {
+  function frameAction(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 frame = config.frame || msg.value
+
+        if (config.action === 'frame') {
+          let checkNumber = Number(frame)
+          if (!Number.isNaN(checkNumber)) {
+            node.log = `Switch to frame/iFrame, identified using index: "${frame}".`
+            await browser.switchToFrame(parseInt(frame))
+          } else {
+            node.log = `Switch to frame/iFrame, identified using selector: "${frame}".`
+            //Need to fix this to find element
+            await browser.switchToFrame(frame)
+          }
+        } else if (config.action === 'parentFrame') {
+          await browser.switchToParentFrame()
+        }
+        await common.log(node)
+        common.successStatus(node)
+        node.send(msg)
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('frame-action', frameAction)
+}

package/src/implicit-wait-config.html

@@ -0,0 +1,85 @@
+<script type="text/javascript">
+  function setWaitAction() {
+    let action = $('#node-input-action').val()
+    $('#actionImplicit').show()
+    $('#actionPageLoad').show()
+    $('#actionScript').show()
+    if (action === 'get') {
+      $('#actionImplicit').hide()
+      $('#actionPageLoad').hide()
+      $('#actionScript').hide()
+    }
+  }
+
+  RED.nodes.registerType('implicit-wait-config', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      implicit: { value: '' },
+      pageload: { value: '' },
+      script: { value: '' },
+      action: { value: '' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'implicit-wait config'
+    },
+    oneditprepare: function() {
+      setWaitAction()
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="implicit-wait-config">
+
+  <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="setWaitAction()">
+          <option value="set">Set Timeouts</option>
+          <option value="get">Get Timeouts</option>
+      </select>
+  </div>
+  <div class="form-row" id="actionImplicit" >
+      <label for="node-input-implicit"><i class="fa fa-tasks"></i> Implicit Wait</label>
+      <input id="node-input-implicit" type="text" placeholder="in ms">
+  </div>
+  <div class="form-row" id="actionPageLoad" >
+      <label for="node-input-pageload"><i class="fa fa-tasks"></i> Page Load Timeout</label>
+      <input id="node-input-pageload" type="text" placeholder="in ms">
+  </div>
+  <div class="form-row" id="actionScript" >
+      <label for="node-input-script"><i class="fa fa-tasks"></i> Script Timeout</label>
+      <input id="node-input-script" type="text" placeholder="in ms">
+  </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="implicit-wait-config">
+  <h3>The Set Timeouts command sets timeout durations associated with the current session.</h3>
+  <h3>Inputs</h3>
+        <dl class="message-properties">
+          <dt><code>mgs.implicit</code>: <span class="property-type">int</span></dt>
+          <dd>Integer in ms for session implicit wait timeout</dd>
+          <dt><code>msg.pageload</code><span class="property-type">int</span></dt>
+          <dd>Integer in ms for session page load timeout<br></dd>
+          <dt><code>msg.script</code><span class="property-type">int</span></dt>
+          <dd>Integer in ms for session script timeout</dd>
+        </dl>
+
+  <h3>Details</h3>
+   <p><b>Action</b> specifies the action to be performed on the target web element. Actions includes:
+        <ul>
+            <li><b>Get Timeouts</b>: The Get Timeouts command gets timeout durations associated with the current session.</li>
+            <li><b>Set Timeouts</b>: The Set Timeouts command sets timeout durations associated with the current session. The timeouts that can be controlled are listed below.</li>
+        </ul>
+
+   <p><b>Implicit Wait</b> Integer in ms for session implicit wait timeout.<br></p>
+   <p><b>Page Load Timeout</b> Integer in ms for session page load timeout.<br></p>
+   <p><b>Script Timeout</b> Integer in ms for session script timeout.<br></p>
+</script>

package/src/implicit-wait-config.js

@@ -0,0 +1,40 @@
+const common = require('./wdio-common')
+
+module.exports = function(RED) {
+  function waitConfig(config) {
+    RED.nodes.createNode(this, config)
+    this.implicit = config.implicit
+    this.pageload = config.pageload
+    this.script = config.script
+    const node = this
+    common.clearStatus(node)
+
+    node.on('input', async (msg) => {
+      try {
+        let browser = await common.getBrowser(node.context())
+
+        let implicit = parseInt(node.implicit || msg.implicit)
+        let pageLoad = parseInt(node.pageload || msg.pageload)
+        let script = parseInt(node.script || msg.script)
+
+        if (config.action === 'set') {
+          var timeouts = {
+            implicit,
+            pageLoad,
+            script
+          }
+          node.log = `Setup the implicit wait timeouts as "${timeouts}".`
+          await browser.setTimeout(timeouts)
+        } else if (config.action === 'get') {
+          msg.payload = await browser.getTimeouts()
+        }
+        await common.log(node)
+        common.successStatus(node)
+        node.send(msg)
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('implicit-wait-config', waitConfig)
+}

package/src/new-session.html

@@ -0,0 +1,96 @@
+<script type="text/javascript">
+  function setValue() {
+    return $('#node-input-killSession').val()
+  }
+  //https://9bbb33aa-ac83-4087-9829-a264f90452fe@chrome.browserless.io:443/webdriver
+  function setProvider() {
+    if ($('#node-input-webdriverProvider').val() === 'browserless.io') {
+      $('#node-input-webdriverUri').attr(
+        'placeholder',
+        'https://<apikey>:chrome.browserless.io:443/webdriver'
+      )
+      $('#node-input-webdriverBrowser').val('chrome')
+      $('#row-browser').hide()
+    } else if ($('#node-input-webdriverProvider').val() === 'local') {
+      $('#row-browser').show()
+    }
+  }
+
+  RED.nodes.registerType('new-session', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      webdriverUri: { value: '' },
+      webdriverProvider: { value: '' },
+      webdriverBrowser: { value: '' },
+      logLevel: { value: 'error' },
+      killSession: { value: setValue() }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'new session'
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="new-session">
+  <div class="form-row">
+      <label for="node-input-webdriverProvider"><i class="fa fa-globe"></i> Webdriver Remote Provider</label>
+      <select type="text" id="node-input-webdriverProvider" style="width:70%;" onchange="setProvider()">
+          <option value="browserless.io">browserless.io</option>
+          <option value="local" selected>Local Webdriver</option>
+      </select>
+  </div>
+  <div class="form-row">
+      <label for="node-input-webdriverUri"><i class="fa fa-globe"></i> Webdriver Host URI</label>
+      <input id="node-input-webdriverUri" type="text" placeholder="https://host:port/path">
+  </div>
+  <div class="form-row" id="row-browser">
+      <label for="node-input-webdriverBrowser"><i class="fa fa-globe"></i> Browser</label>
+      <select type="text" id="node-input-webdriverBrowser" style="width:70%;">
+          <option value="chrome" selected>Chrome</option>
+          <option value="chromium">Chromium</option>
+      </select>
+  </div>
+  <div class="form-row">
+      <label for="node-input-logLevel"><i class="fa fa-tasks"></i> Log Level</label>
+      <select type="text" id="node-input-logLevel" style="width:70%;">
+          <option value="trace">Trace</option>
+          <option value="debug">Debug</option>
+          <option value="info">Info</option>
+          <option value="warn">Warn</option>
+          <option value="error" selected>Error</option>
+          <option value="silent">Silent</option>
+      </select>
+  </div>
+  <div class="form-row">
+      <label for="node-input-killSession"><i class="fa fa-tasks"></i> Kill existing session on flow deploy</label>
+      <input id="node-input-killSession" type="checkbox" onclick="setValue()" style="width:auto;">
+  </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="new-session">
+  <h3>Creates new session and also sets the "wdio_browser" global variable to the new session object.</h3>
+  <h3>Inputs</h3>
+      <dl class="message-properties">
+          <dt>webdriverProvider: <span class="property-type">string</span></dt>
+          <dd>Webdriver server name.</dd>
+          <dt>webdriverUri: <span class="property-type">string</span></dt>
+          <dd>The string format should be <protocal>://<hotsname>:<port number>/<path>, user 80/8080/443 if it is service based webdriver provider.</dd>
+          <dd><code>msg.webdriverUri</code> can be used by leaving the webdriverUri field blank.</dd>
+          <dt>Browser: <span class="property-type">string</span></dt>
+          <dd>Current configurations are only for chrome.</dd>
+          <dd><code>msg.webdriverBrowser</code> can be used by leaving the webdriverBrowser blank.</dd>
+          <dt>logLevel: <span class="property-type">string</span></dt>
+          <dd>Select the log level to display the logs on console during run.</dd>
+          <dt>killSession: <span class="property-type">Bool</span></dt>
+          <dd>Kill open session during deploy. This would be helpful to debug the changes by not closing the current browser.</dd>
+      </dl>
+</script>