qunit

What is qunit?

QUnit is a powerful, easy-to-use JavaScript unit testing framework. It is used to test any generic JavaScript code, including code running in the browser or in Node.js. QUnit is especially useful for testing jQuery projects.

What are qunit's main functionalities?

Basic Test

This feature allows you to write a basic test case. The `QUnit.test` function defines a test with a name and a callback function. The `assert.ok` method checks if the given expression is true.

QUnit.test('hello test', function(assert) {
  assert.ok(1 == '1', 'Passed!');
});

Asynchronous Testing

QUnit supports asynchronous testing. You can use async/await to handle asynchronous operations within your tests. The test will wait for the promise to resolve before making assertions.

QUnit.test('asynchronous test: async and await', async function(assert) {
  const result = await new Promise(resolve => setTimeout(() => resolve('done'), 1000));
  assert.equal(result, 'done', 'Passed!');
});

Module Grouping

QUnit allows you to group related tests using `QUnit.module`. You can also define setup and teardown logic using hooks like `beforeEach` and `afterEach`.

QUnit.module('group a', function(hooks) {
  hooks.beforeEach(function(assert) {
    assert.ok(true, 'beforeEach called');
  });
  QUnit.test('a basic test example', function(assert) {
    assert.ok(true, 'this test is fine');
  });
});

Other packages similar to qunit

mocha

Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun. Mocha tests run serially, allowing for flexible and accurate reporting, while mapping uncaught exceptions to the correct test cases. Compared to QUnit, Mocha is more flexible and can be paired with various assertion libraries like Chai.

jest

Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It works out of the box for most JavaScript projects and provides a rich API for writing tests. Jest includes built-in assertion libraries and mocking capabilities, making it a more integrated solution compared to QUnit.

jasmine

Jasmine is a behavior-driven development framework for testing JavaScript code. It does not depend on any other JavaScript frameworks and does not require a DOM. Jasmine is known for its easy-to-read syntax and is often compared to QUnit for its simplicity and ease of use.

README

QUnit - A JavaScript Unit Testing Framework.

QUnit is a powerful, easy-to-use, JavaScript unit testing framework. It's used by the jQuery project to test its code and plugins but is capable of testing any generic JavaScript code (and even capable of testing JavaScript code on the server-side).

QUnit is especially useful for regression testing: Whenever a bug is reported, write a test that asserts the existence of that particular bug. Then fix it and commit both. Every time you work on the code again, run the tests. If the bug comes up again - a regression - you'll spot it immediately and know how to fix it, because you know what code you just changed.

Having good unit test coverage makes safe refactoring easy and cheap. You can run the tests after each small refactoring step and always know what change broke something.

QUnit is similar to other unit testing frameworks like JUnit, but makes use of the features JavaScript provides and helps with testing code in the browser, such as built in support for asynchronicity and exception handling.

Support

If you need help using QUnit, chat with us on Gitter.

To report a bug or request a new feature, open an issue.

Contribute

If you are interested in helping develop QUnit, check out our contributing guide.