Module:UnitTests/doc

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

<syntaxhighlight lang="lua"> -- Unit tests for Module:Example. Click talk page to run tests. local p = require('Module:UnitTests')

function p:test_hello()

   self:preprocess_equals('Hello World!', 'Hello World!')

end

return p </syntaxhighlight>

The talk page Module talk:Example/testcases executes it with {{#invoke: Example/testcases | run_tests}}. Test methods like test_hello above must begin with "test".

Methods

run_tests

• Template:Code: Runs all tests. Normally used on talk page of unit tests.

    {{#invoke:Example/testcases|run_tests}}

• If Template:Code is specified, a column will be added showing the first character position where the expected and actual results differ.

    {{#invoke:Example/testcases|run_tests|differs_at=1}}

preprocess_equals

• Template:Code: 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.

<syntaxhighlight lang="lua">

   self:preprocess_equals('Hello World!', 'Hello, world!',{nowiki=1})

</syntaxhighlight>

preprocess_equals_many

• Template:Code: Performs a series of preprocess_equals() calls on a set of given pairs. Automatically adds the given prefix and suffix to each text.

<syntaxhighlight lang="lua">

   self:preprocess_equals_many('Hello, ', '!', {
       {'John', 'Hello, John!'},
       {'Jane', 'Hello, Jane!'},
   },{nowiki=1})

</syntaxhighlight>

preprocess_equals_preprocess

• Template:Code: Gives two pieces of wikitext to preprocess and determines if they produce the same value. Useful for comparing scripts to existing templates.

<syntaxhighlight lang="lua">

   self:preprocess_equals_preprocess('Hello World!', 'Template:Hello',{nowiki=1})

</syntaxhighlight>

preprocess_equals_preprocess_many

• Template:Code: 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.

<syntaxhighlight lang="lua">

   self:preprocess_equals_preprocess_many('', 'Template:Spellnum', '', {
       {'2'}, -- equivalent to {'2','2'},
       {'-2', '-2.0'},
   },{nowiki=1})

</syntaxhighlight>

equals

• Template:Code: 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.

<syntaxhighlight lang="lua">

   self:equals('Simple addition', 2 + 2, 4,{nowiki=1})

</syntaxhighlight>

equals_deep

• Template:Code: 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.

<syntaxhighlight lang="lua">

   self:equals_deep('Table comparison', createRange(1,3), {1,2,3},{nowiki=1})

</syntaxhighlight>

See also

• Module:ScribuntoUnit – alternative unit test module