Shawndouglas: Created as needed.

2013-10-31T15:54:18Z

Created as needed.

New page

UnitTests provides a unit test facility that can be used by other scripts using '''require'''. Following is a sample from [[Module:Bananas/testcases]]:

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

function p:test_hello()
self:preprocess_equals('{{#invoke:Bananas | hello}}', 'Hello, world!')
end

return p
</syntaxhighlight>

The talk page [[Module talk:Bananas/testcases]] executes it with <code><nowiki>{{#invoke: Bananas/testcases | run_tests}}</nowiki></code>. Test methods like test_hello above must begin with "test".

== Methods ==
=== run_tests ===
* {{code|1=run_tests(differs_at)}}: Runs all tests. If "differs_at=1" is specified, a column will be added showing the first character position where the expected and actual results differ. Normally used on talk page of unit tests.
<pre>
{{#invoke:Bananas/testcases|run_tests}}
</pre>
=== preprocess_equals ===
* {{code|1=preprocess_equals(text, expected)}}: 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('{{#invoke:Bananas | hello}}', 'Hello, world!')
</syntaxhighlight>
=== preprocess_equals_many ===
* {{code|1=preprocess_equals_many(prefix, suffix, cases)}}: 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('{{#invoke:BananasArgs | add |', '}}', {
{'2|3', '5'},
{'-2|2', '0'},
})
</syntaxhighlight>
=== preprocess_equals_preprocess ===
* {{code|1=preprocess_equals_preprocess(text, expected)}}: 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('{{#invoke:Bananas | hello}}', '{{Hello}}')
</syntaxhighlight>
=== preprocess_equals_preprocess_many ===
* {{code|1=preprocess_equals_preprocess_many(prefix, suffix, cases)}}: 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('{{#invoke:Foo | spellnum |', '}}', '{{spellnum', '}}', {
{'2'}, -- equivalent to {'2','2'},
{'-2', '-2.0'},
})
</syntaxhighlight>

=== equals ===
* {{code|1=equals(name, actual, expected)}}: 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)
</syntaxhighlight>
=== equals_deep ===
* {{code|1=equals_deep(name, actual, expected)}}: 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})
</syntaxhighlight>

Module:UnitTests/doc - Revision history

Shawndouglas: Created as needed.