All files / lib assert.js

67.12% Statements 49/73
34% Branches 17/50
35.71% Functions 10/28
67.12% Lines 49/73

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151                                        4x 4x 4x       4x 89x 89x     4x       4x       4x             4x           4x   4x     4x     4x     4x     4x 12x     4x 2x     4x       4x       4x   4x       4x       4x   4x   4x     4x     4x             4x 184x   4x 191x   4x 39x   4x     4x     4x     4x     4x 1x   4x     4x 429x   4x 517x   4x         4x 51x    
// assert.js -- extended asserts
//
// Copyright 2016 fuzzy.ai <evan@fuzzy.ai>
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
/* jshint esversion: 6 */
 
'use strict'
 
const assert = require('assert')
const debug = require('debug')('vows:assert')
const _ = require('lodash')
 
// This can't be an arrow function because of some weird stuff with `this`.
// If it is, then plain `assert()` doesn't work and you have to `assert.ok()`
const me = function () {
  debug(arguments)
  assert.apply(this, arguments)
}
 
module.exports = me
 
// Copy everything from assert module to this module
 
_.assign(me, assert)
 
// Extend this module with some extra utilities
 
me.epsilon = function (eps, actual, expected, message) {
  me.isNumber(eps)
  me.isNumber(actual)
  me.isNumber(expected)
  return me.lesser(Math.abs(actual - expected), eps)
}
 
me.match = function (actual, expected, message) {
  assert(_.isRegExp(expected), `${expected} must be a regular expression`)
  return assert(expected.test(actual),
    message || `${actual} does not match ${expected}`)
}
 
me.matches = me.match
 
me.isTrue = (actual, message) =>
  assert(actual === true, message || 'Argument must be true')
 
me.isFalse = (actual, message) =>
  assert(actual === false, message || 'Argument must be false')
 
me.isZero = (actual, message) =>
  assert.equal(actual, 0, message || 'Argument must be zero')
 
me.isNotZero = (actual, message) =>
  assert.notEqual(actual, 0, message || 'Argument must not be zero')
 
me.greater = (actual, expected, message) =>
  assert(actual > expected,
    message || `${actual} is not greater than ${expected}`)
 
me.lesser = (actual, expected, message) =>
  assert(actual < expected,
    message || `${actual} is not less than ${expected}`)
 
me.inDelta = (actual, expected, delta, message) =>
  assert(Math.abs(actual - expected) <= delta,
    message || `${actual} is not greater than ${expected}`)
 
me.include = (actual, expected, message) =>
  assert(_.hasIn(actual, expected),
    message || `${actual} does not contain ${expected}`)
 
me.includes = me.include
 
me.notInclude = (actual, expected, message) =>
  assert(!_.hasIn(actual, expected),
    message || `${actual} contains ${expected}`)
 
me.notIncludes = me.notInclude
 
// FIXME: figure out include/deepInclude
 
me.deepInclude = me.include
 
me.deepIncludes = me.deepInclude
 
me.isEmpty = (actual, message) =>
  assert(_.isEmpty(actual), message || `${actual} is not empty`)
 
me.isNotEmpty = (actual, message) =>
  assert(!_.isEmpty(actual), message || `${actual} is empty`)
 
me.lengthOf = function (actual, expected, message) {
  assert(actual !== null)
  me.include(actual, 'length')
  return assert.equal(actual.length, expected,
    `Length is ${actual.length} not ${expected}`)
}
 
me.isArray = (actual, message) =>
  assert(_.isArray(actual), message || 'Argument is not an array')
 
me.isObject = (actual, message) =>
  assert(_.isObject(actual), message || 'Argument must be an object')
 
me.isNumber = (actual, message) =>
  assert(_.isNumber(actual), message || 'Argument must be a number')
 
me.isBoolean = (actual, message) =>
  assert(_.isBoolean(actual), message || 'Argument must be a boolean')
 
me.isNaN = (actual, message) =>
  assert(_.isNaN(actual), message || 'Argument must be NaN')
 
me.isNull = (actual, message) =>
  assert(_.isNull(actual), message || 'Argument must be null')
 
me.isNotNull = (actual, message) =>
  assert(!_.isNull(actual), message || 'Argument must not be null')
 
me.isUndefined = (actual, message) =>
  assert(_.isUndefined(actual), message || 'Argument must be undefined')
 
me.isDefined = (actual, message) =>
  assert(!_.isUndefined(actual), message || 'Argument must be defined')
 
me.isString = (actual, message) =>
  assert(_.isString(actual), message || 'Argument must be a string')
 
me.isFunction = (actual, message) =>
  assert(_.isFunction(actual), message || 'Argument must be a function')
 
me.typeOf = (actual, expected, message) =>
  // eslint-disable-next-line valid-typeof
  assert(typeof (actual) === expected,
    message || `Argument is not of type ${expected}`)
 
me.instanceOf = (actual, expected, message) =>
  assert(actual instanceof expected,
    message || `Argument is not an instance of ${expected}`)