topological-nodered-wdio 0.2.6

package/src/browser-action.js

@@ -0,0 +1,69 @@
+const common = require('./wdio-common')
+
+module.exports = function(RED) {
+  function browserAction(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 url = config.url || msg.url
+        let height = config.height || msg.height
+        let width = config.width || msg.width
+        let keys = config.keysArr || msg.keysArr
+
+        if (config.action === 'getUrl') {
+          node.log = 'Get the url of the web page.'
+          msg.payload = await browser.getUrl()
+        } else if (config.action === 'navigateTo') {
+          node.log = `Navigate to the "${url}".`
+          await browser.navigateTo(url)
+        } else if (config.action === 'back') {
+          node.log = 'Go to previous page (browser back feature).'
+          await browser.back()
+        } else if (config.action === 'forward') {
+          node.log = 'Go for next page (browser forward feature).'
+          await browser.forward()
+        } else if (config.action === 'refresh') {
+          node.log = 'Refresh the web page.'
+          await browser.refresh()
+        } else if (config.action === 'getTitle') {
+          node.log = 'Get the title of the browser window.'
+          msg.payload = await browser.getTitle()
+        } else if (config.action === 'setSize') {
+          node.log = `Set the Size of browser window to Width: ${width}, Height: ${height}.`
+          await browser.setWindowSize(parseInt(width), parseInt(height))
+        } else if (config.action === 'maximize') {
+          node.log = 'Maximize the browser window.'
+          await browser.maximizeWindow()
+        } else if (config.action === 'takeScreenShot') {
+          node.log = 'Take the screenshot of the browser window.'
+          msg.payload = await browser.takeScreenshot()
+        } else if (config.action === 'pageSource') {
+          node.log = 'Get the Page sorce (Source code of the web page).'
+          msg.payload = await browser.getPageSource()
+        } else if (config.action === 'getCookies') {
+          node.log = 'Get the cookies stored.'
+          msg.payload = await browser.getAllCookies()
+        } else if (config.action === 'print') {
+          node.log = 'Print the page.'
+          await browser.execute('setTimeout(()=> {window.print()}, 2000)')
+        } else if (config.action === 'keyStrokes') {
+          node.log = `Enter the provide keystrokes: ${key}.`
+          let arr = keys.split(',')
+          let keyValues = arr.map((item) => item.trim())
+          await browser.keys(Array.from(keyValues))
+        }
+        await common.log(node)
+        common.successStatus(node)
+        node.send(msg)
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('browser-action', browserAction)
+}

package/src/delete-session.html

@@ -0,0 +1,26 @@
+<script type="text/javascript">
+  RED.nodes.registerType('delete-session', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'delete session'
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="delete-session">
+  <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="delete-session">
+  <h3><br><br>Deletes the session and also sets the "wdio_browser" global variable to \'\'.</h3>
+</script>

package/src/delete-session.js

@@ -0,0 +1,28 @@
+const common = require('./wdio-common')
+
+module.exports = function(RED) {
+  function deleteSession(config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+    common.clearStatus(node)
+
+    node.on('input', async (msg) => {
+      try {
+        let browser = await common.deleteSession(node.context())
+        if (browser && browser.sessionId) {
+          node.log = 'Close the browser.'
+          msg.payload = browser.sessionId
+        } else {
+          node.log = 'No active browser detected to Close.'
+          msg.payload = 'no open session'
+        }
+        await common.log(node)
+        common.successStatus(node)
+        node.send(msg)
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('delete-session', deleteSession)
+}

package/src/dropdown-action.html

@@ -0,0 +1,121 @@
+<script type="text/javascript">
+  function setDropdownAction() {
+    let action = $('#node-input-action').val()
+    $('#actionText').hide()
+    $('#actionAttr').hide()
+    $('#actionIndex').hide()
+    $('#actionValue').hide()
+    if (action == 'selectByAttr') {
+      $('#actionAttr').show()
+      $('#actionValue').show()
+    }
+    if (action == 'selectByIndex') {
+      $('#actionIndex').show()
+    }
+    if (action == 'selectByText') {
+      $('#actionText').show()
+    }
+  }
+
+  RED.nodes.registerType('dropdown-action', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      locateUsing: { value: 'xpath' },
+      locateValue: { value: '' },
+      action: { value: 'selectByAttr' },
+      text: { value: '' },
+      attribute: { value: '' },
+      index: { value: '' },
+      value: { value: '' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'dropdown action'
+    },
+    oneditprepare: function() {
+      setDropdownAction()
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="dropdown-action">
+  <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="setDropdownAction()">
+          <option value="selectByAttr">Select by Attribute</option>
+          <option value="selectByIndex">Select by Index</option>
+          <option value="selectByText">Select by Visual text</option>
+          <option value="getValue">Get Value</option>
+      </select>
+  </div>
+  <div class="form-row" id="actionText">
+      <label for="node-input-text"><i class="fa fa-tasks"></i> Text to Select</label>
+      <input id="node-input-text" type="text">
+  </div>
+  <div class="form-row" id="actionAttr">
+      <label for="node-input-attribute"><i class="fa fa-tasks"></i> Attribute Name</label>
+      <input id="node-input-attribute" type="text">
+  </div>
+  <div class="form-row" id="actionValue">
+      <label for="node-input-value"><i class="fa fa-tasks"></i> Value</label>
+      <input id="node-input-value" type="text">
+  </div>
+  <div class="form-row" id="actionIndex">
+      <label for="node-input-index"><i class="fa fa-tasks"></i> Index</label>
+      <input id="node-input-index" 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="dropdown-action">
+  <h3>Perform action on a dropdown  selector</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>Class Name</li>
+                <li>Jquery selector</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>
+        </dl>
+
+  <h3>Details</h3>
+   <p><b>Locate Method</b> specifies the method used to target the web element/dropdown. 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> specifies the action to be performed on the target dropdown. Actions includes:
+        <ul>
+            <li>Select By Attribute</li>
+            <li>Select By Index</li>
+            <li>Select by Visual text</li>
+            <li>Get Value</li>
+        </ul>
+   </p>
+</script>

package/src/dropdown-action.js

@@ -0,0 +1,48 @@
+const common = require('./wdio-common')
+
+module.exports = function(RED) {
+  function dropdownAction(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 text = config.text || msg.text
+        let attribute = config.attribute || msg.attribute
+        let index = config.index || msg.index
+        let value = config.value || msg.value
+
+        if (config.action === 'selectByAttr') {
+          node.log = `Select the dropdown value using Attribute: ${attribute} with Value: ${value}.`
+          await element.selectByAttribute(attribute, value)
+        } else if (config.action === 'selectByIndex') {
+          node.log = `Select the dropdown value using Index: ${index}.`
+          await element.selectByIndex(parseInt(index))
+        } else if (config.action === 'selectByText') {
+          node.log = `Select the dropdown value using Visible text: ${text}.`
+          await element.selectByVisibleText(text)
+        } else if (config.action === 'getValue') {
+          node.log = 'Get selected drop down value.'
+          msg.payload = await element.getValue()
+        }
+        await common.log(node)
+        common.successStatus(node)
+        node.send(msg)
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('dropdown-action', dropdownAction)
+}

package/src/element-action.html

@@ -0,0 +1,133 @@
+<script type="text/javascript">
+  function setAction() {
+    let action = $('#node-input-action').val()
+    $('#actionSendKeys').hide()
+    $('#getAttribute').hide()
+    if (action == 'sendKeys') {
+      $('#actionSendKeys').show()
+    }
+    if (action == 'getAttribute') {
+      $('#getAttribute').show()
+    }
+  }
+
+  RED.nodes.registerType('element-action', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      locateUsing: { value: 'xpath' },
+      locateValue: { value: '' },
+      action: { value: 'click' },
+      sendKeys: {
+        value: '',
+        validate: RED.validators.typedInput('object')
+      },
+      object: { value: '' },
+      attribute: { value: '' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'element action'
+    },
+    oneditprepare: function() {
+      setAction()
+      $('#node-input-sendKeys').typedInput({
+        default: 'str',
+        typeField: $('#node-input-object'),
+        types: ['msg', 'flow', 'global', 'str']
+      })
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="element-action">
+  <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%;" onchange="setAction()">
+          <option value="click">Click</option>
+          <option value="clear">Clear</option>
+          <option value="sendKeys">Send Keys</option>
+          <option value="getValue">Get Value</option>
+          <option value="getText">Get Text</option>
+          <option value="getAttribute">Get Attribute</option>
+          <option value="takeScreenShot">Element Screenshot</option>
+          <option value="hover">Hover</option>
+      </select>
+  </div>
+  <div class="form-row" id="actionSendKeys">
+      <label for="node-input-sendKeys"><i class="fa fa-tasks"></i> Text to Send</label>
+      <input type="text" id="node-input-sendKeys" style="width:70%">
+      <input type="hidden" id="node-input-object">
+  </div>
+  <div class="form-row" id="getAttribute">
+      <label for="node-input-attribute"><i class="fa fa-tasks"></i>Attribute Name</label>
+      <input id="node-input-attribute" 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="element-action">
+  <h3>Perform a list of actions 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.value</code><span class="property-type">string</span></dt>
+          <dd>If you elect to SendKeys to the web element, this is the value that would be sent</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> specifies the action to be performed on the target web element. Actions includes:
+        <ul>
+            <li>Click</li>
+            <li>Clear</li>
+            <li>Send Keys</li>
+            <li>Get Value</li>
+            <li>Get Text</li>
+            <li>Get Attribute</li>
+            <li>Element Screenshot</li>
+            <li>Hover</li>
+        </ul>
+   </p>
+   <p><b>Text to Send</b> if the Send Keys action is selected, this value would send the text to the selected web element.<br></p>
+</script>

package/src/element-action.js

@@ -0,0 +1,104 @@
+const common = require('./wdio-common')
+
+module.exports = function(RED) {
+  function elementAction(config) {
+    RED.nodes.createNode(this, config)
+    const node = this
+    const context = node.context()
+    common.clearStatus(node)
+
+    var getTypeInputValue = async (msg, type, value) => {
+      var r = ''
+      switch (type) {
+        case 'msg':
+          r = RED.util.getMessageProperty(msg, value)
+          break
+        case 'flow':
+          r = context.flow.get(value)
+          break
+        case 'global':
+          r = context.global.get(value)
+          break
+        case 'str':
+          try {
+            r = unescape(JSON.parse('"' + value + '"'))
+          } catch (e) {
+            r = value
+          }
+          break
+        case 'num':
+          r = parseFloat(value)
+          break
+        case 'json':
+          if (value !== '') {
+            r = JSON.parse(value)
+          } else {
+            r = undefined
+          }
+      }
+      return r
+    }
+
+    node.on('input', async (msg) => {
+      try {
+        let locateUsing = config.locateUsing || msg.locateUsing
+        let locateValue = config.locateValue || msg.locateValue
+
+        let browser = await common.getBrowser(context)
+        let capabilities = browser.capabilities
+        let elementId = await common.getElementId(
+          browser,
+          locateUsing,
+          locateValue
+        )
+
+        let attribute = config.attribute || msg.attribute
+
+        if (config.action === 'click') {
+          node.log = `Click on the webelement identified using ${locateUsing}: "${locateValue}".`
+          await browser.elementClick(elementId)
+        } else if (config.action === 'clear') {
+          node.log = `Clear the Value of the webelement identified using ${locateUsing}: "${locateValue}".`
+          await browser.elementClear(elementId)
+        } else if (config.action === 'sendKeys') {
+          let value = await getTypeInputValue(
+            msg,
+            config.object,
+            config.sendKeys
+          )
+          node.log = `Enter the Value: "${value}" to the webelement identified using ${locateUsing}: "${locateValue}".`
+          await browser.elementSendKeys(
+            elementId,
+            capabilities.version ? Array.from(value) : value
+          )
+        } else if (config.action === 'getValue') {
+          node.log = `Get the Value of webelement identified using ${locateUsing}: "${locateValue}".`
+          msg.payload = await browser.getElementAttribute(elementId, 'value')
+        } else if (config.action === 'getText') {
+          node.log = `Get the Text of webelement identified using ${locateUsing}: "${locateValue}".`
+          msg.payload = await browser.getElementText(elementId)
+        } else if (config.action === 'getAttribute') {
+          node.log = `Get the Attribute: "${attribute}" of webelement identified using ${locateUsing}: "${locateValue}".`
+          msg.payload = await browser.getElementAttribute(elementId, attribute)
+        } else if (config.action === 'takeScreenShot') {
+          node.log = 'Take the screenshot of the webelement.'
+          msg.payload = await browser.takeElementScreenshot(elementId)
+        } else if (config.action === 'hover') {
+          let element = await common.getElement(
+            browser,
+            locateUsing,
+            locateValue
+          )
+          node.log = `Hover on the webelement identified using ${locateUsing}: "${locateValue}".`
+          msg.payload = await element.moveTo()
+        }
+        await common.log(node)
+        common.successStatus(node)
+        node.send(msg)
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('element-action', elementAction)
+}

package/src/element-check.html

@@ -0,0 +1,87 @@
+<script type="text/javascript">
+  RED.nodes.registerType('element-check', {
+    category: 'Webdriver IO',
+    color: '#a6bbcf',
+    defaults: {
+      name: { value: '' },
+      locateUsing: { value: 'xpath' },
+      locateValue: { value: '' },
+      check: { value: 'selected' }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'white-globe.png',
+    label: function() {
+      return this.name || 'element check'
+    }
+  })
+</script>
+
+<script type="text/x-red" data-template-name="element-check">
+  <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-check"><i class="fa fa-tasks"></i> Check</label>
+      <select type="text" id="node-input-check" style="width:70%;">
+          <option value="selected">Is Element Selected</option>
+          <option value="enabled">Is Element Enabled</option>
+          <option value="displayed">Is Element Displayed</option>
+      </select>
+  </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="element-check">
+  <h3>Selected action of the node performs a target web element inside the browser.</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>
+
+        </dl>
+
+  <h3>Details</h3>
+  <dl class="message-properties">
+   <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>Check</b> specifies the action to be performed on the target web element. Actions includes:
+        <ul>
+            <li>Is Element Selected</li>
+            <li>Is Element Enabled</li>
+            <li>Is Element Displayed</li>
+        </ul>
+   </p>
+   </dl>
+</script>

package/src/element-check.js

@@ -0,0 +1,46 @@
+const common = require('./wdio-common')
+
+module.exports = function (RED) {
+  function elementCheck(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 elementId = await common.getElementId(
+          browser,
+          locateUsing,
+          locateValue
+        )
+
+        if (config.check === 'selected') {
+          node.log = `Check the webelement is selected, identified using ${locateUsing}: "${locateValue}".`
+          msg.payload = await browser.isElementSelected(elementId)
+        } else if (config.check === 'enabled') {
+          node.log = `Check the webelement is enabled, identified using ${locateUsing}: "${locateValue}".`
+          msg.payload = await browser.isElementEnabled(elementId)
+        } else if (config.check === 'displayed') {
+          let element = await common.getElement(
+            browser,
+            locateUsing,
+            locateValue
+          )
+          node.log = `Check the webelement is displayed, identified using ${locateUsing}: "${locateValue}".`
+          msg.payload = await browser.isElementDisplayed(element.elementId)
+        }
+        await common.log(node)
+        common.successStatus(node)
+        node.send(msg)
+      } catch (e) {
+        common.handleError(e, node, msg)
+      }
+    })
+  }
+  RED.nodes.registerType('element-check', elementCheck)
+}