Manual:JavaScript unit testing

From MediaWiki.org
(Redirected from QUnit)
Jump to navigation Jump to search
MediaWiki's QUnit test suite running in Chrome.

MediaWiki uses QUnit to unit test its JavaScript code base.

Run from a browser[edit]

  1. Set $wgEnableJavaScriptTest to true. (This is already set if you use MediaWiki-Docker-Dev or MediaWiki-Vagrant.)
  2. Visit Special:JavaScriptTest in a browser to run the tests.

Run from the command line[edit]

Getting started[edit]

One-time setup:

  1. Ensure environment variables MW_SERVER and MW_SCRIPT_PATH are set. Either manually each time, or from ~/.bash_profile to have them automatically set in the future:
    export MW_SERVER=http://default.web.mw.localhost:8080
    export MW_SCRIPT_PATH=/mediawiki
    
  2. Enter an isolated environment where you have Node.js and npm installed. Why?
    • If using MediaWiki-Vagrant, simply ssh to your Vagrant VM.
    • If using MDD or other, consider Fresh. Run fresh-node -net -env from the MediaWiki directory.
  3. Once inside your isolated shell, run npm ci.

Run[edit]

This runs the QUnit tests in Headless Chrome and prints the results.

$ npm run qunit

Running "karma:main" (karma) task
START:
INFO [launcher]: Starting browser ChromeHeadless
…
mediawiki.util
    ✔ escapeRegExp
    ✔ debounce
…
Finished in 5.659 secs / 5.442 secs

SUMMARY:
✔ 440 tests completed

Done.

How to help?[edit]

Run tests before committing[edit]

Make it a habit to run unit tests before committing and submitting your changes to Gerrit.

Write unit tests[edit]

Always write unit tests for new functionality. We're also looking to expand our unit test coverage of already existing modules in the MediaWiki JavaScript library.

Write a test[edit]

It is the convention to name the test suite file after the module it covers. For example, mediawiki.user.test.js covers the mediawiki.user module.

Inside the test suite should be one, and only one, call to QUnit.module with the module name.

The unit tests for MediaWiki core are located in the tests/qunit/suites directory.

Register a test[edit]

MediaWiki core[edit]

Test suites are added to the registration of the mediawiki.tests.qunit.suites module in /tests/qunit/QUnitTestResources.php.

Tests are organised into a directory structure that matches the directory structure of the code being tested. For example: The unit test for resources/mediawiki.util/mediawiki.util.js can be found at tests/qunit/suites/resources/mediawiki.util/mediawiki.util.test.js.

Example:

 'mediawiki.tests.qunit.suites' => array(
 	'scripts' => array(
 		'tests/qunit/suites/resources/mediawiki/mediawiki.test.js',
+		'tests/qunit/suites/resources/mediawiki/mediawiki.example.test.js',
 		'tests/qunit/suites/resources/mediawiki/mediawiki.user.test.js',
 		'tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js',
 	),
 	'dependencies' => array(
 		'mediawiki',
+		'mediawiki.example',
 		'mediawiki.user',
 		'mediawiki.util',

Extensions[edit]

Extensions register their QUnit tests via the ResourceLoaderTestModules hook.

See also[edit]