Module:UnitTests

Documentation for this module may be created at Module:UnitTests/doc

-- UnitTester provides unit testing for other Lua scripts. For details see [[Wikipedia:Lua#Unit_testing]].
-- For user documentation see talk page.
local UnitTester = {}

local frame, tick, cross
local result_table = "{|class=\"wikitable\"\n! !! Text !! Expected !! Actual\n|-\n"
local num_failures = 0

function UnitTester:preprocess_equals(text, expected)
    local actual = frame:preprocess(text)
    if actual == expected then
        result_table = result_table .. '| ' .. tick
    else
        result_table = result_table .. '| ' .. cross
        num_failures = num_failures + 1
    end
    result_table = result_table .. ' || <nowiki>' .. text:gsub('%|', '&#124;') .. '</nowiki> || ' .. expected .. ' || ' .. actual .. "\n|-\n"
end

function UnitTester:preprocess_equals_preprocess(text1, text2)
    local actual = frame:preprocess(text1)
    local expected = frame:preprocess(text2)
    if actual == expected then
        result_table = result_table .. '| ' .. tick
    else
        result_table = result_table .. '| ' .. cross
        num_failures = num_failures + 1
    end
    result_table = result_table .. ' || <nowiki>' .. text:gsub('%|', '&#124;') .. '</nowiki> || ' .. expected .. ' || ' .. actual .. "\n|-\n"
end

function UnitTester:run(frame_arg)
    frame = frame_arg
    tick = frame:preprocess('{{Tick}}')
    cross = frame:preprocess('{{Cross}}')
    
    for key,value in pairs(self) do
        if key:find('^test') then value(self) end
    end

    result_table = result_table .. "|}"
    return (num_failures == 0 and "<font color=\"#008000\">'''All tests passed.'''</font>" or "<font color=\"#800000\">'''" .. num_failures .. " tests failed.'''</font>") .. "\n\n" .. frame:preprocess(result_table)
end

function UnitTester:new()
    local o = {}
    setmetatable(o, self)
    self.__index = self
    return o
end

local p = UnitTester:new()
function p.run_tests(frame) return p:run(frame) end
return p