1.0.2 • Published 5 years ago

gruetest v1.0.2

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

gruetest

A lightweight, minimalistic testing framework for Typescript.

Installation

npm i --save-dev gruetest
// package.json
{
  "scripts": {
    "test": "npm explore gruetest -- npm test -- path/to/test/folder"
  }
}

Usage

import describe from 'gruetest'

describe('Test Category', it => {
  it('should do something correctly', assert => {
    // If the two parameters are not equal, the test will fail.
    assert.equal(2+2, 4, 'optional message shown next to failed assertions')

    // Use this for testing random or inconsistent things.
    testConsistency(
      () => Math.random(), // A function to get the tested value.
      num => assert.inRange(num, 0, 1, 'Math.random range'),
      500 // The number of times to run the test (default: 10000)
    )
  })
})

Assert Methods

MethodDescription
truthAssert that the parameter is truthy.
equalAssert that two parameters are equal (==).
strictEqualAssert that two parameters are strictly equal (===).
notEqualAssert that two parameters are not equal (!=).
strictNotEqualAssert that two parameters are strictly not equal (!==).
inRangeAssert that two numeric parameters are within a range (inclusive).
greaterThanAssert that the first numeric parameter is greater than the second.
lessThanAssert that the first numeric parameter is less than the second.
greaterOrEqualAssert that the first numeric parameter is greater than or equal to the second.
lessOrEqualAssert that the first numeric parameter is less than or equal to the second.
inArrayAssert that the first parameter is contained in the array passed as the second.
matchPredAssert that the function passed as the second parameter returns true when passed the first.
throwsAssert that the function passed as the first parameter throws, and the exception matches the predicate passed as the second.