Module:UnitTests/doc

UnitTests provides a unit test facility that can be used by other scripts using require. See Lua for details. Following is a sample from Module:Example/testcases:

The talk page Module talk:Example/testcases executes it with. Test methods like test_hello above must begin with "test".

run_tests

 * run_tests: Runs all tests. Normally used on talk page of unit tests.
 * If differs_at=1 is specified, a column will be added showing the first character position where the expected and actual results differ.
 * If is specified, the header will show the columns "Test", "Live", "Sandbox", "Expected"

preprocess_equals

 * preprocess_equals(text, expected, options): Gives a piece of wikitext to preprocess and an expected resulting value. Scripts and templates can be invoked in the same manner they would be in a page.

preprocess_equals_many

 * preprocess_equals_many(prefix, suffix, cases, options): Performs a series of preprocess_equals calls on a set of given pairs. Automatically adds the given prefix and suffix to each text.

preprocess_equals_preprocess

 * preprocess_equals_preprocess(text, expected, options): Gives two pieces of wikitext to preprocess and determines if they produce the same value. Useful for comparing scripts to existing templates.

preprocess_equals_preprocess_many

 * preprocess_equals_preprocess_many(prefix1, suffix1, prefix2, suffix2, cases, options): Performs a series of preprocess_equals_preprocess calls on a set of given pairs. The prefix/suffix supplied for both arguments is added automatically. If in any case the second part is not specified, the first part will be used.

preprocess_equals_sandbox_many

 * preprocess_equals_sandbox_many(module, function, cases, options): Performs a series of preprocess_equals_compare calls on a set of given pairs. The test compares the live version of the module vs the /sandbox version and vs an expected result.

equals

 * equals(name, actual, expected, options): Gives a computed value and the expected value, and checks if they are equal according to the == operator. Useful for testing modules that are designed to be used by other modules rather than using #invoke.

equals_deep

 * equals_deep(name, actual, expected, options): Like equals, but handles tables by doing a deep comparison. Neither value should contain circular references, as they are not handled by the current implementation and may result in an infinite loop.