nightwatch/lib/api/expect/assertions/element/type.js

Easy to use Node.js based end-to-end testing solution for web applications using the W3C WebDriver API.

/**
 * Checks if the type (i.e. tag name) of a specified element is of an expected value.
 *
 * @example
 * this.demoTest = function (browser) {
 *   browser.expect.element('#q').to.be.an('input');
 *   browser.expect.element('#q').to.be.an('input', 'Testing if #q is an input');
 *   browser.expect.element('#w').to.be.a('span');
 * }
 *
 * @method a
 * @display .a(type)
 * @alias an
 * @since v0.7
 * @param {string} type The expected type
 * @param {string} [message] Optional log message to display in the output. If missing, one is displayed by default.
 * @api expect.element
 */
const BaseAssertion = require('./_element-assertion.js');

class TypeAssertion extends BaseAssertion {
  static get assertionName() {
    return ['a', 'an'];
  }

  static get assertionType() {
    return BaseAssertion.AssertionType.METHOD;
  }

  init(type, msg) {
    super.init();

    this.type = type;
    this.article = ['a', 'e', 'i', 'o'].indexOf(type.toString().substring(0, 1)) > -1 ? 'an' : 'a';
    this.hasCustomMessage = typeof msg != 'undefined';
    this.flag('typeFlag', true);
    this.message = msg || 'Expected element %s to ' + (this.negate ? 'not be' : 'be') + ' ' + this.article + ' ' + type;

    this.start();
  }

  executeCommand() {
    return this.executeProtocolAction('getElementTagName');
  }

  onResultSuccess() {
    if (this.retries > 0 && this.negate) {
      return;
    }

    if (this.type instanceof RegExp) {
      const result = this.type.test(this.resultValue);
      this.passed = this.negate ? !result : result;
    } else {
      this.type = this.type.toLowerCase();
      this.resultValue = this.resultValue.toLowerCase();
      this.passed = this.negate ? (this.resultValue !== this.type) : (this.resultValue === this.type);
    }

    this.expected = this.negate ? 'not be ' + this.article + ' ' + this.type : 'be ' + this.article + ' ' + this.type;
    this.actual = this.resultValue;

    this.addExpectedInMessagePart();
  }

  onResultFailed() {
    this.passed = false;
  }
}



module.exports = TypeAssertion;