Module:UnitTests/doc: Difference between revisions

Content deleted Content added
trim some whitespace; no change to actual content
No edit summary
Line 21:
</pre>
=== preprocess_equals ===
* {{code|1=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.
<syntaxhighlight lang="lua">
self:preprocess_equals('{{#invoke:Bananas | hello}}', 'Hello, world!',{nowiki=1})
</syntaxhighlight>
=== preprocess_equals_many ===
* {{code|1=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.
<syntaxhighlight lang="lua">
self:preprocess_equals_many('{{#invoke:BananasArgs | add |', '}}', {
Line 34:
</syntaxhighlight>
=== preprocess_equals_preprocess ===
* {{code|1=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.
<syntaxhighlight lang="lua">
self:preprocess_equals_preprocess('{{#invoke:Bananas | hello}}', '{{Hello}}',{nowiki=1})
</syntaxhighlight>
=== preprocess_equals_preprocess_many ===
* {{code|1=preprocess_equals_preprocess_many(prefix, suffix, 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.
<syntaxhighlight lang="lua">
self:preprocess_equals_preprocess_many('{{#invoke:Foo | spellnum |', '}}', '{{spellnum', '}}', {
{'2'}, -- equivalent to {'2','2'},
{'-2', '-2.0'},
},{nowiki=1})
</syntaxhighlight>
 
=== equals ===
* {{code|1=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.
<syntaxhighlight lang="lua">
self:equals('Simple addition', 2 + 2, 4,{nowiki=1})
</syntaxhighlight>
=== equals_deep ===
* {{code|1=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.
<syntaxhighlight lang="lua">
self:equals_deep('Table comparison', createRange(1,3), {1,2,3},{nowiki=1})
</syntaxhighlight>