conssert v19.3.1

Conssert

A zero-config testing framework that runs in your browser.

Conssert aims to:

• Provide a clean, simple interface for writing tests around client-side facing code.
• Allow for tested code to use new, browser-supported JS syntax without needing to transpile for testing (as with node-based testing frameworks).

• Make setting up a testing environment as simple and painless as possible with zero configuration necessary.

Conssert is not suited for projects that are transpiled due to its utilization of the native ES Module standard found in the browser.

Installation

Install with npm:

npm install -D conssert

or with yarn:

yarn add -D conssert

Usage: Writing a Test

Once you've installed conssert you can start creating your first test module to be run:

// translators.test.js

import { isValidCamelCase, camel2Kabob } from './translators.js'

new Suite('isValidCamelCase')
  .tests([
    ['Should return false for invalid camel cased inputs', assert => {
      assert(isValidCamelCase('Invalid-')).equalTo(false)
      assert(isValidCamelCase('invalid-camel-')).equalTo(false)
    }],
    ['Should return true for valid camel cased inputs', assert => {
      assert(isValidCamelCase('isValid')).equalTo(true)
      assert(isValidCamelCase('isValidAgain')).equalTo(true)
    }]
  ])

new Suite('camel2Kabob')
  .tests([
    ['Should return identity of value passed in if not camel case', assert => {
      assert(camel2Kabob('is_value')).equalTo('is_value')
      assert(camel2Kabob('is-value')).equalTo('is-value')
    }],
    ['Should return value translated to kabob case', assert => {
      assert(camel2Kabob('isValue')).equalTo('is-value')
      assert(camel2Kabob('isValueAgain')).equalTo('is-value-again')
    }]
  ])

As you can see above first we create a file with a .test.js extension.

We then import the code we'd like to test from ./translators.js and create instances of the Suite object (available globally), providing it with a list of test cases to run.

Each test case should first include a description of the test itself followed by the function which, provided with an assert function, will do any assetions necessary.

You can find more detailed documentation around the assertion methods available and other testing interfaces below.

Usage: Running the Test Harness

To get conssert up and running simply run:

$ conssert

This will spin up an HTTP server that runs on http://localhost:3000.

When you navigate to the page conssert will sift through the files in your project and serve up all the ones ending with a .test.js extension.

You will see the test results output in both the browser console:

placeholder image of browser console

As well as in the rendered HTML page:

placeholder image of HTML output

At any point you can click Re-run or simply refresh the page to run the tests again.

A watch mode is supported as well in which the tests will automatically re-run when changes are detected. See section below.

CLI Options

Listed below are the options you can provide conssert from the terminal:

conssert [options]

  -h, --help         Will print out this message and list out
                     CLI options available.

  -i, --ignore       JS structured regex to ignore.
                     Multiple can be set by separating with a space.
                     Use single quotes to prevent shell expansion.

  -l, --local-dev    Allows for local development of conssert
                     by properly configuring directory.

  -p, --port         Port conssert will run on and serve
                     files from. - default: 3000

  -q, --quiet        Report errors only rather than standard output
                     of tests and assets being served. - default: false

  -v, --version      Output the version number of conssert being used.

  -w, --watch        Will automatically re-run tests when file
                     modifications are detected. If --ignore option is
                     used, the files matching given pattern(s) will not
                     be watched.

If you wish to run conssert on a sub-directory of your project you simply cd into that directory and run conssert from there.

Conssert API Examples

Below you can find an example usage of the API provided by conssert followed by a breakdown of each key component:

new Suite('TestSuiteName')
  .before(fn)
  .beforeEach(fn)
  .tests([
    ['isTrue / isFalse Test Case', assert => {
      assert(true).isTrue()
      assert(true).not.isFalse()

      assert(false).not.isFalse()
      assert(false).not.isTrue()
    }],
    ['equalTo Test Case', assert => {
      assert('abc').equalTo('abc')
      assert('abc').not.equalTo('ABC')

      assert([1, 2]).equalTo([1, 2])
      assert([1, 2]).not.equalTo([2, 1])

      assert({x: 1, y: {z: 2}}).equalTo({x: 1, y: {z: 2}})
      assert({x: 1, y: {z: 2}}).not.equalTo({x: 1, y: 2})
    }],
    ['sameAs Test Case', assert => {
      const x = [1, 2, 3]
      assert(x).sameAs(x)
      assert(x).not.sameAs([1, 2, 3])
    }],
    ['instanceOf Test Case', assert => {
      function A() {}
      assert(new A()).instanceOf(A)
      function B() {}
      assert(new A()).not.instanceOf(B)
    }]
  ])
  .afterEach(fn)
  .after(fn)