„Wikipedia:Lua/Modul/UnitTests/en“ – Versionsunterschied
Erscheinungsbild
Inhalt gelöscht Inhalt hinzugefügt
Erste Anpassung dewiki |
Anpassung dewiki |
||
Zeile 1: | Zeile 1: | ||
{{LuaModuleDoc}} |
{{LuaModuleDoc}} |
||
'''<code>UnitTests</code>''' provides a unit test facility that can be used by other scripts using |
'''<code>UnitTests</code>''' provides a unit test facility that can be used by other scripts using ''require()''. |
||
Following is a sample from [[Module:Hello/test]]: |
|||
<syntaxhighlight lang="lua"> |
<syntaxhighlight lang="lua"> |
||
-- Unit tests for [[Module: |
-- Unit tests for [[Module:Hello]]. Click test page to run tests. |
||
local p = require('Module:UnitTests') |
local p = require('Module:UnitTests') |
||
function p:test_hello() |
function p:test_hello() |
||
self:preprocess_equals('{{#invoke: |
self:preprocess_equals('{{#invoke:Hello | hello}}', 'Hello, world!') |
||
end |
end |
||
Zeile 13: | Zeile 14: | ||
</syntaxhighlight> |
</syntaxhighlight> |
||
The |
The test page [[Wikipedia:Lua/Modul/UnitTests/test]] executes it with: |
||
<nowiki>{{#invoke: Bananas/test | run_tests}}</nowiki> |
|||
Test methods like test_hello above must begin with "test". |
|||
== Methods == |
== Methods == |
||
=== run_tests === |
=== run_tests === |
||
; <code>run_tests(differs_at)</code> |
|||
: 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> |
<pre> |
||
{{#invoke: |
{{#invoke:Hello/test|run_tests}} |
||
</pre> |
</pre> |
||
=== preprocess_equals === |
=== preprocess_equals === |
||
; <code>preprocess_equals(text, expected)</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"> |
<syntaxhighlight lang="lua"> |
||
self:preprocess_equals('{{#invoke: |
self:preprocess_equals('{{#invoke:Hello | hello}}', 'Hello, world!') |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
=== preprocess_equals_many === |
=== preprocess_equals_many === |
||
; <code>preprocess_equals_many(prefix, suffix, cases)</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"> |
<syntaxhighlight lang="lua"> |
||
self:preprocess_equals_many('{{#invoke: |
self:preprocess_equals_many('{{#invoke:DemoArgs | add |', '}}', { |
||
{'2|3', '5'}, |
{'2|3', '5'}, |
||
{'-2|2', '0'}, |
{'-2|2', '0'}, |
||
Zeile 35: | Zeile 40: | ||
</syntaxhighlight> |
</syntaxhighlight> |
||
=== preprocess_equals_preprocess === |
=== preprocess_equals_preprocess === |
||
; <code>preprocess_equals_preprocess(text, expected)</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"> |
<syntaxhighlight lang="lua"> |
||
self:preprocess_equals_preprocess('{{#invoke: |
self:preprocess_equals_preprocess('{{#invoke:Hello | hello}}', '{{Hello}}') |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
=== preprocess_equals_preprocess_many === |
=== preprocess_equals_preprocess_many === |
||
; <code>preprocess_equals_preprocess_many(prefix, suffix, cases)</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"> |
<syntaxhighlight lang="lua"> |
||
self:preprocess_equals_preprocess_many('{{#invoke:Foo | spellnum |', '}}', '{{spellnum', '}}', { |
self:preprocess_equals_preprocess_many('{{#invoke:Foo | spellnum |', '}}', '{{spellnum', '}}', { |
||
Zeile 49: | Zeile 56: | ||
=== equals === |
=== equals === |
||
; <code>equals(name, actual, expected)</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"> |
<syntaxhighlight lang="lua"> |
||
self:equals('Simple addition', 2 + 2, 4) |
self:equals('Simple addition', 2 + 2, 4) |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
=== equals_deep === |
=== equals_deep === |
||
; <code>equals_deep(name, actual, expected)</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"> |
<syntaxhighlight lang="lua"> |
||
self:equals_deep('Table comparison', createRange(1,3), {1,2,3}) |
self:equals_deep('Table comparison', createRange(1,3), {1,2,3}) |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
== Origin == |
|||
[[:en:Module:UnitTests]] 2013-05-18 |
|||
[[Kategorie:Wikipedia:Lua/Modul/Dokumentation|UnitTests]] |
[[Kategorie:Wikipedia:Lua/Modul/Dokumentation|UnitTests]] |
Version vom 18. Mai 2013, 21:27 Uhr
Vorlagenprogrammierung | Diskussionen | Lua | Unterseiten | |||
Modul | Deutsch | English
|
Modul: | Dokumentation |
UnitTests
provides a unit test facility that can be used by other scripts using require().
Following is a sample from Module:Hello/test:
-- Unit tests for [[Module:Hello]]. Click test page to run tests.
local p = require('Module:UnitTests')
function p:test_hello()
self:preprocess_equals('{{#invoke:Hello | hello}}', 'Hello, world!')
end
return p
The test page Wikipedia:Lua/Modul/UnitTests/test executes it with:
{{#invoke: Bananas/test | run_tests}}
Test methods like test_hello above must begin with "test".
Methods
run_tests
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.
{{#invoke:Hello/test|run_tests}}
preprocess_equals
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.
self:preprocess_equals('{{#invoke:Hello | hello}}', 'Hello, world!')
preprocess_equals_many
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.
self:preprocess_equals_many('{{#invoke:DemoArgs | add |', '}}', {
{'2|3', '5'},
{'-2|2', '0'},
})
preprocess_equals_preprocess
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.
self:preprocess_equals_preprocess('{{#invoke:Hello | hello}}', '{{Hello}}')
preprocess_equals_preprocess_many
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.
self:preprocess_equals_preprocess_many('{{#invoke:Foo | spellnum |', '}}', '{{spellnum', '}}', {
{'2'}, -- equivalent to {'2','2'},
{'-2', '-2.0'},
})
equals
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.
self:equals('Simple addition', 2 + 2, 4)
equals_deep
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.
self:equals_deep('Table comparison', createRange(1,3), {1,2,3})
Origin
en:Module:UnitTests 2013-05-18