QUnit: A JavaScript Unit Testing framework.


What is QUnit?

QUnit is a powerful, easy-to-use JavaScript unit testing framework. It's used by the jQuery, jQuery UI and jQuery Mobile projects and is capable of testing any generic JavaScript code, including itself!

Getting Started

In The Browser

A minimal QUnit test setup:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>QUnit Example</title>
<link rel="stylesheet" href="https://code.jquery.com/qunit/qunit-2.3.3.css">
</head>
<body>
<div id="qunit"></div>
<div id="qunit-fixture"></div>
<script src="https://code.jquery.com/qunit/qunit-2.3.3.js"></script>
<script src="tests.js"></script>
</body>
</html>

The contents of tests.js:

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

The result:


In Node

Install QUnit globally so you can use the CLI:

1
$ npm install -g qunitjs

Create test files in a test directory and then simply run:

1
$ qunit

And you should see some output like:

1
2
3
4
5
6
7
8
TAP version 13
ok 1 Module > Test #1
ok 2 Module > Test #2
1..2
# pass 2
# skip 0
# todo 0
# fail 0

And that is it! While QUnit defaults to looking for test files in test, you can also put them anywhere and then specify file paths or glob expressions:

1
$ qunit 'tests/*-test.js'

To view the additional supported options, simply run:

1
$ qunit --help

Download

QUnit is available from the jQuery CDN hosted by MaxCDN.

Current Release - v2.3.3

To test the latest features and bug fixes to QUnit, a version automatically generated from the latest commit to the QUnit Git repository is also available for use.

Browser Support

QUnit currently supports the same browsers as jQuery 3.x.

For legacy browser support, including Internet Explorer versions lower than IE9, please use the 1.x series of QUnit.

Node Support

QUnit follows the Node Long-term Support (LTS) Schedule. Support is provided for Current, Active, and Maintenance releases.

Learn More

Get Involved

History

QUnit was originally developed by John Resig as part of jQuery. In 2008 it got its own home, name and API documentation, allowing others to use it for their unit testing as well. At the time it still depended on jQuery. A rewrite in 2009 fixed that, and now QUnit runs completely standalone.

QUnit's assertion methods follow the CommonJS Unit Testing specification, which was to some degree influenced by QUnit.