@instructure/ui-testbed/lib/chaiWrapper.js

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 - present Instructure, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
const runAxeCheck = require('@instructure/ui-axe-check').default
const chai = require('chai')

module.exports = function () {
  chai.should()
  chai.use(require('sinon-chai'))
  chai.use(require('chai-string'))
  chai.use(require('chai-enzyme')())

  chai.use(function (chai, utils) {
    utils.addMethod(chai.Assertion.prototype, 'accessible', function (done, options = {}) {
      const obj = utils.flag(this, 'object')
      let element = obj
      if (typeof obj.getA11yViolations === 'function') {
        obj.getA11yViolations(done, options)
      } else if (obj instanceof Element) {
        runAxeCheck(element, options).then((result) => {
          if (result instanceof Error) {
            done(result)
          } else {
            done()
          }
        }, done)
      } else {
        done(new Error('[ui-testbed] accessibility check can only run on a single DOM Element!'))
      }
    })
  })

  chai.use(require('dirty-chai'))

  return chai
}()