testium-driver-wd/lib/element.js

Testium backend powered by wd

/*
 * Copyright (c) 2015, Groupon, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of GROUPON nor the names of its contributors may be
 * used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

'use strict';

/**
 * @param {string} name
 * @return {Promise<any>}
 *
 * @example element.get('alt')
 */
function get(name) {
  return this.getAttribute(name);
}

/**
 * @param {Element[]} elements
 * @return {Element|null}
 * @private
 */
function firstOrNull(elements) {
  return elements[0] || null;
}

/**
 * @param {string} selector
 * @return {Promise<Element>}
 *
 * @example element.getElement('.cols')
 */
async function getElement(selector) {
  const elements = await this.elementsByCssSelector(selector);

  if (elements.length === 0) {
    throw new Error(
      `Element ${selector} not found, use getElementOrNull if that's expected`
    );
  }
  return elements[0];
}

/**
 * @param {string} selector
 * @return {Promise<Element[]>}
 *
 * @example element.getElements('.cols')
 */
function getElements(selector) {
  return this.elementsByCssSelector(selector);
}

/**
 * @param {string} selector
 * @return {Promise<Element[]|null>}
 *
 * @example element.getElementOrNull('.cols')
 */
function getElementOrNull(selector) {
  return this.elementsByCssSelector(selector).then(firstOrNull);
}

module.exports = {
  get,
  getElement,
  getElements,
  getElementOrNull,
};