bahmutov/qunit-once

Adds one time module setup and teardown support to QUnit

qunit-once

QUnit plugin that adds setupOne and teardownOnce to modules

Test page

Available through bower and npm as qunit-once.

Tested in the browser by QUnit and under nodejs by qunit-node. Safe to use with gt, which includes setupOnce and teardownOnce already.

API

QUnit.module('Example', {
  setupOnce: function () {
    // runs once before anything else in the module
  },
  setup: function () {
    // runs before each unit test
  },
  teardown: function () {
    // runs after EACH unit test in this module
  },
  teardownOnce: function () {
    // runs once after all unit tests finished (including teardown)
  }
});

Use

install

Include qunit-once.js after qunit.js in HTML

<script src="http://code.jquery.com/qunit/qunit-1.12.0.js"></script>
<script src="qunit-once.js"></script>
<script src="tests.js"></script>

Or install qunit-once via npm install qunit-once --save-dev under node.

Write unit tests

  // tests.js
  var counter = 0;

  QUnit.module('Example', {
    setupOnce: function () {
      counter = 1;
    },
    setup: function () {
      counter += 1;
    }
  });

  QUnit.test('first', function () {
    QUnit.equal(counter, 2, 'setupOnce followed by setup');
    counter = 0;
  });

  QUnit.test('second', function () {
    QUnit.equal(counter, 1, 'first test followed by setup');
  });

Run under node using node-qunit or gt

npm install -g qunit
qunit -d qunit-once.js -c tests.js -t tests.js

You don't need to include this module when running with gt, it already supports setupOnce and teardownOnce methods.

Related

Run QUnit module setup once, Testing code with async setup, qunit-promises

Small print

Author: Gleb Bahmutov © 2013 @bahmutov

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

qunit-once's Issues

Crash if module has no config parameter

  QUnit.module('no module config');

  QUnit.test('basic', 1, function () {
    QUnit.ok(true, 'everything is fine');
  });

Describe usage

• when used from QUnit test page
• when using with node-qunit
• when using with gt

Add gt support and tests

Split testing into parallel tracks for qunit / node-qunit / gt

using grunt-parallel or similar plugin

Module names are not shown anymore

...when including qunit-once.

Status:
Testscript with 4 modules a,b,c,d.

Problems:
1.) Not Module names are added
2.) Some tests are not executed

In this example I included "qunit-once" inline, cause I din't find it on cdn
http://jsfiddle.net/legends77/wv6tb/4/

Check is setupOnce has been already initialized

To prevent multiple hooks

Add QUnit testing through Karma

teardownOnce is not once per module

Created a simple test and noticed that teardownOnce does not occur at the end of each QUnit module, instead only occurs when QUnit is finished. Sample code:

    QUnit.module("Module A", {
        setupOnce: function onSetupOnce() {
            console.log("Module A setupOnce");
        },
        teardownOnce: function onTeardownOnce() {
            console.log("Module A teardownOnce");
        }
    });

    QUnit.test("Module A Test 1", function () {
        QUnit.ok(true, "Assertion for Test 1");
    });

    QUnit.test("Module A Test 2", function () {
        QUnit.ok(true, "Assertion for Test 2");
    });

    QUnit.module("Module B", {
        setupOnce: function onSetupOnce() {
            console.log("Module B setupOnce");
        },
        teardownOnce: function onTeardownOnce() {
            console.log("Module B teardownOnce");
        }
    });

    QUnit.test("Module B Test 1", function () {
        QUnit.ok(true, "Assertion for Test 1");
    });

    QUnit.test("Module B Test 2", function () {
        QUnit.ok(true, "Assertion for Test 2");
    });

Console output:
Module A setupOnce
Module B setupOnce
Module B teardownOnce

I would expect Console output to be:
Module A setupOnce
Module A teardownOnce
Module B setupOnce
Module B teardownOnce

I am very interested in the concept and use of qunit-once if it works the way I thought and expected it to work. Please let me know if my thoughts are incorrect or if there is something that I am doing wrong that is preventing my expected output from happening. Thanks!