testium-driver-wd/lib/browser/form.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} selector
 *
 * @example browser.clear('#foo')
 */
function clear(selector) {
  return this.getElement(selector).clear();
}

/**
 * @param {string} selector
 * @param {any} value
 *
 * @example browser.type('#foo', 'bar')
 */
function type(selector, value) {
  return this.getElement(selector).type(value);
}

/**
 * @param {string} selector
 * @param {any} value
 *
 * @example browser.clearAndType('#foo', 'bar')
 */
function clearAndType(selector, value) {
  return this.getElement(selector).clear().type(value);
}

/**
 * @param {Record<string, any>} fields
 * @returns {Promise<void>}
 *
 * @example browser.fillFields({ '#foo': 'bar', '.test': 'just a test' })
 */
async function fillFields(fields) {
  for (const [selector, value] of Object.entries(fields)) {
    await this.clearAndType(selector, value);
  }
}

module.exports = {
  clear,
  type,
  clearAndType,
  setValue: clearAndType,
  fillFields,
};