https://github.com/webmatze/mickrigtest

a minimal testing framework for JavaScript written in CoffeeScript
https://github.com/webmatze/mickrigtest

coffeescript javascript npm-package test-framework testing testsuite

Last synced: about 1 month ago
JSON representation

a minimal testing framework for JavaScript written in CoffeeScript

• Host: GitHub
• URL: https://github.com/webmatze/mickrigtest
• Owner: webmatze
• Created: 2013-03-20T14:23:39.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2017-02-24T16:06:08.000Z (over 9 years ago)
• Last Synced: 2025-03-04T22:06:22.188Z (over 1 year ago)
• Topics: coffeescript, javascript, npm-package, test-framework, testing, testsuite
• Language: CoffeeScript
• Homepage:
• Size: 18.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
mickrigtest [![NPM version](https://img.shields.io/npm/v/mickrigtest.svg?style=flat)](https://npmjs.com/package/mickrigtest) [![NPM downloads](https://img.shields.io/npm/dm/mickrigtest.svg?style=flat)](https://npmjs.com/package/mickrigtest) [![Coverage Status](https://coveralls.io/repos/github/webmatze/mickrigtest/badge.svg?branch=master)](https://coveralls.io/github/webmatze/mickrigtest?branch=master)

==============

> a minimal testing framework for JavaScript written in CoffeeScript

Installing via npm

------------------

    npm install -g mickrigtest

Compiling the CoffeeScript

--------------------------

Using coffee cli:

    coffee -cb mickrigtest.coffee

Or using a npm task:

    npm run compile

Running Tests

-------------

    npm run test

Usage of mickrigtest

-----------------------

require expect from mickrigtest:

    var expect = require('mickrigtest').expect

Then you can test something to be true:

    expect(true).to().beTrue()

Or alternatively:

    expect(true).to().be(true)

You can also test something to be false:

    expect(false).to().beFalse()

Or alternatively:

    expect(false).to().be(false)

You can test something NOT to be something:

    expect(false).notTo().beTrue()

And you can also add a description to your test:

    expect(1 > 2, '1 > 2').to().beFalse()

    

You can test for exceptions. But you have to wrap your code into an anonymous function:

    expect(function() {

        throw "an exception"

    }).to().throwException()

    

Usage of MickrigTestCase

------------------------

You can also build test cases by using the **MickrigTestCase** class.

To use it you have to require it from *mickrigtest*, too.

    var MickrigTestCase = require('mickrigtest').MickrigTestCase

Then you can write your first test case:

    testcase = new MickrigTestCase("My first test");

    testcase.test("true should be true", function() {

        expect(true).to().beTrue();

    });

    testcase.test("true should not be false", function() {

        expect(true).notTo().be(false);

    });

    messages = testcase.run();

The *run()* function of **MickrigTestCase** returns an Array of all messages generated by the test case.

You can use this Array to display the messages on your page or displaying them using *console.log()*.

    

    messages.forEach(function(m){console.log(m)})

Copyright

---------

Copyright 2013-2017 by Mathias Karstädt