nightwatch/lib/api/assertions/hasAttribute.js

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

/**
 * Checks if the given element contains the specified DOM attribute.
 *
 * Equivalent of: https://developer.mozilla.org/en-US/docs/Web/API/Element/hasAttribute
 *
 * @example
 * this.demoTest = function (browser) {
 *   browser.assert.hasAttribute('#main', 'data-track');
 * };
 *
 * @method assert.hasAttribute
 * @param {string|object} definition The selector (CSS/Xpath) used to locate the element. Can either be a string or an object which specifies [element properties](https://nightwatchjs.org/guide/writing-tests/finding-interacting-with-dom-elements.html#postdoc-element-properties).
 * @param {string} expectedAttribute The DOM attribute to look for.
 * @param {string} [msg] Optional log message to display in the output. If missing, one is displayed by default.
 * @api assertions
 */

const {setElementSelectorProps, isString} = require('../../utils');

exports.assertion = function(definition, expectedAttribute, msg) {
  this.options = {
    elementSelector: true
  };

  this.expected = function() {
    return this.negate ? `has not ${expectedAttribute}` : `has ${expectedAttribute}`;
  };


  this.formatMessage = function() {
    if (!isString(expectedAttribute)) {
      throw new Error('Expected attribute must be a string');
    }

    const message = msg || `Testing if element %s ${this.negate ? 'doesn\'t have attribute %s' : 'has attribute %s'}`;

    return {
      message,
      args: [this.elementSelector, `'${expectedAttribute}'`]
    };
  };

  this.evaluate = function() {
    const {result} = this;

    if (!result || !result.value) {
      return false;
    }

    return true;
  };

  this.command = function(callback) {
    this.api.getAttribute(setElementSelectorProps(definition, {
      suppressNotFoundErrors: true
    }), expectedAttribute, callback);
  };
};