Modul:UnitTesztek

UnitTesztek[mi ez?] • [dokumentáció: mutat, szerkeszt] • [tesztek: létrehozás]

Az UnitTesztek modul tesztelési lehetőséget biztosít más , a require utasítást alkalmazó szkriptek számára. Lásd a részleteket itt: w:Wikipedia:Lua#Unit_testing. Nézzük pl. a Modul:Banánok/tesztdoboz modult:

-- Unit tesztelése a  [[Modul:Banánok]]on. Klikkelj a vitalapra, hogy elinduljon a teszt.
local p = require('Module:UnitTests')
 
function p:test_hello()
    self:preprocess_equals('{{#invoke:Banánok | hello}}', 'Hello, world!')
end
 
return p

A Modulvita:Banánok/tesztdoboz a következő kódot hajtja végre:

{{#invoke: Banánok/tesztdoboz| run_tests}}.

Minden egyes tesztelést szolgáló metódust, amelyet a "run_tests" végrehajtásra vár, kötelezően - mint a példabeli test_hello (lásd fent) a "test" sztringgel kell kezdenünk, mert erről ismeri fel a run_test metódus a tesztelni kívánt függvényt. Összetettebb példa: Modul:URLutil/teszt

Metódusok[szerkesztés]

run_tests[szerkesztés]

run_tests(differs_at): Minden tesztet végrehajt. Ha "differs_at=1" módon specifikáljuk, akkor kapunk egy újabb oszlopot, amelyben megtalálhatjuk az általunk elvárt és a teszttől kapott végeredmény közötti első eltérő karaktert. Szokásosan az egyes unit teszt modulok modulvita-lapján használjuk.

    {{#invoke:Banánok/tesztdoboz|run_tests(|opcionálisan megadhatod: differs_at=1)}}

preprocess_equals[szerkesztés]

preprocess_equals(szöveg, elvárt): Végrehajtja (preprocessing) azt a szöveget, amit az első argumentumában talál és összeveti azt a mi elvárt eredményünkkel. Szkripteket és sablonokat egyformán hívhatunk meg, ezek eredményei a lap tartalmába kerülnek majd.

    self:preprocess_equals('{{#invoke:Banánok | hello}}', 'Hello, világ!')

preprocess_equals_many[szerkesztés]

preprocess_equals_many(prefix, suffix, párok): Egy sorozat preprocess_equals() hívást valósít meg a megadott párokból álló halmazon. Automatikusan hozzáfűzi a megadott prefix és suffix-eket minden szöveghez.

   
    self:preprocess_equals_many('{{#invoke:BanánokArgumentumok | add |', '}}', {
        {'2|3', '5'},
        {'-2|2', '0'},
    })

preprocess_equals_preprocess[szerkesztés]

preprocess_equals_preprocess(text, elvárt): két wikitext végrehajtása (preprocessing) és az ezekből előálló eredmények azonosságának vizsgálatát végzi. Hasznos, ha szkripteket akarunk összevetni, hogy ugyanazt teljesítik-e, amit egy már ismert sablon.

    self:preprocess_equals_preprocess('{{#invoke:Banánok | hello}}', '{{Hello}}')

Vizsgálható, hogy az Helló, világ! a Sablon:Hello sablonnal azonos eredményt nyújtja-e.

preprocess_equals_preprocess_many[szerkesztés]

preprocess_equals_preprocess_many(prefix, suffix, párok)}}: Megvalósít egy sorozatot a preprocess_equals_preprocess() függvényhívásokból, "párok" ismét adott párokból álló halmaz. A prefix/suffix automatikusan hozzáadódik. Ha valamely páron belül nem adjuk meg a másodikat, akkor a pár második elemének is az elsőt tekinti.

    self:preprocess_equals_preprocess_many('{{#invoke:Foo | spellnum |', '}}', '{{spellnum', '}}', {
        {'2'}, -- equivalent to {'2','2'},
        {'-2', '-2.0'},
    })

equals[szerkesztés]

equals(név, aktuális, elvárt): Visszaad egy számított értéket, meg az elvárt értéket és ellenőrzi, hogy az egyenlőség (== operátor) fennáll-e. Olyankor hasznos, ha más modulokon belül felhasználni kívánt modulunkat kívánjuk tesztelni és nem kívánjuk az #invoke parser funkciót használni eközben.

    self:equals('Simple addition', 2 + 2, 4)

equals_deep[szerkesztés]

equals_deep(név, aktuális, elvárt): Mint előbb az equals, de táblákat kezel, mélységében végez összehasonlítást. Egyetlen értéknek sem szabad körbe mutató referenciákat tartalmaznia, mivel - egyrészt ezeket a jelenlegi változat nem interpretálja - másrészt végtelen ciklust hozhat ez létre.

    self:equals_deep('Tábla egybevetés', createRange(1,3), {1,2,3})

-- 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_header = "{|class=\"wikitable\"\n! !! Szöveg !! Elvárt !! Aktuális"
local result_table = ''
local num_failures = 0
 
function first_difference(s1, s2)
    if s1 == s2 then return '' end
    local max = math.min(#s1, #s2)
    for i = 1, max do
        if s1:sub(i,i) ~= s2:sub(i,i) then return i end
    end
    return max + 1
end
 
function UnitTester:preprocess_equals(text, expected, options)
    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
    local nowiki_open = (options and options.nowiki) and '<nowiki>' or ''
    local nowiki_close = (options and options.nowiki) and '</nowiki>' or ''
    local differs_at = self.differs_at and (' || ' .. first_difference(expected, actual)) or ''
    result_table = result_table .. ' || <nowiki>' .. text:gsub('%|', '&#124;') .. '</nowiki> || ' .. nowiki_open .. expected .. nowiki_close .. ' || ' .. nowiki_open .. actual .. nowiki_close .. differs_at .. "\n|-\n"
end
 
function UnitTester:preprocess_equals_many(prefix, suffix, cases, options)
    for _, case in ipairs(cases) do
        self:preprocess_equals(prefix .. case[1] .. suffix, case[2], options)
    end
end
 
function UnitTester:preprocess_equals_preprocess(text1, text2, options)
    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
    local nowiki_open = (options and options.nowiki) and '<nowiki>' or ''
    local nowiki_close = (options and options.nowiki) and '</nowiki>' or ''
    local differs_at = self.differs_at and (' || ' .. first_difference(expected, actual)) or ''
    result_table = result_table .. ' || <nowiki>' .. text1:gsub('%|', '&#124;') .. '</nowiki> || ' .. nowiki_open .. expected .. nowiki_close .. ' || ' .. nowiki_open .. actual .. nowiki_close .. differs_at .. "\n|-\n"
end
 
function UnitTester:preprocess_equals_preprocess_many(prefix1, suffix1, prefix2, suffix2, cases, options)
    for _, case in ipairs(cases) do
        self:preprocess_equals_preprocess(prefix1 .. case[1] .. suffix1, prefix2 .. (case[2] and case[2] or case[1]) .. suffix2, options)
    end
end
 
function UnitTester:equals(name, actual, expected, options)
    if actual == expected then
        result_table = result_table .. '| ' .. tick
    else
        result_table = result_table .. '| ' .. cross
        num_failures = num_failures + 1
    end
    local nowiki_open = (options and options.nowiki) and '<nowiki>' or ''
    local nowiki_close = (options and options.nowiki) and '</nowiki>' or ''
    local differs_at = self.differs_at and (' || ' .. first_difference(expected, actual)) or ''
    result_table = result_table .. ' || ' .. name .. ' || ' .. nowiki_open .. expected .. nowiki_close .. ' || ' .. nowiki_open .. actual .. nowiki_close .. differs_at .. "\n|-\n"
end
 
local function deep_compare(t1, t2, ignore_mt)
    local ty1 = type(t1)
    local ty2 = type(t2)
    if ty1 ~= ty2 then return false end
    if ty1 ~= 'table' and ty2 ~= 'table' then return t1 == t2 end
 
    local mt = getmetatable(t1)
    if not ignore_mt and mt and mt.__eq then return t1 == t2 end
 
    for k1, v1 in pairs(t1) do
        local v2 = t2[k1]
        if v2 == nil or not deep_compare(v1, v2) then return false end
    end
    for k2, v2 in pairs(t2) do
        local v1 = t1[k2]
        if v1 == nil or not deep_compare(v1, v2) then return false end
    end
 
    return true
end
 
function val_to_str(v)
    if type(v) == 'string' then
        v = mw.ustring.gsub(v, '\n', '\\n')
        if mw.ustring.match(mw.ustring.gsub(v, '[^\'"]', ''), '^"+$') then
            return "'" .. v .. "'"
        end
        return '"' .. mw.ustring.gsub(v, '"', '\\"' ) .. '"'
    else
        return type(v) == 'table' and table_to_str(v) or tostring(v)
    end
end
 
function table_key_to_str(k)
    if type(k) == 'string' and mw.ustring.match(k, '^[_%a][_%a%d]*$') then
        return k
    else
        return '[' .. val_to_str(k) .. ']'
    end
end
 
function table_to_str(tbl)
    local result, done = {}, {}
    for k, v in ipairs(tbl) do
        table.insert(result, val_to_str(v))
        done[k] = true
    end
    for k, v in pairs(tbl) do
        if not done[k] then
            table.insert(result, table_key_to_str(k) .. '=' .. val_to_str(v))
        end
    end
    return '{' .. table.concat(result, ',') .. '}'
end
 
function UnitTester:equals_deep(name, actual, expected, options)
    if deep_compare(actual, expected) then
        result_table = result_table .. '| ' .. tick
    else
        result_table = result_table .. '| ' .. cross
        num_failures = num_failures + 1
    end
    local nowiki_open = (options and options.nowiki) and '<nowiki>' or ''
    local nowiki_close = (options and options.nowiki) and '</nowiki>' or ''
    local actual_str = val_to_str(actual)
    local expected_str = val_to_str(expected)
    local differs_at = self.differs_at and (' || ' .. first_difference(expected_str, actual_str)) or ''
    result_table = result_table .. ' || ' .. name .. ' || ' .. nowiki_open .. expected_str .. nowiki_close .. ' || ' .. nowiki_open .. actual_str .. nowiki_close .. differs_at .. "\n|-\n"
end
 
function UnitTester:run(frame_arg)
    frame = frame_arg
    self.frame = frame
    self.differs_at = frame.args['differs_at']
    tick = frame:preprocess('{{zöldpipa}}')
    cross = frame:preprocess('{{pirosiksz}}')
 
    local table_header = result_table_header
    if self.differs_at then
        table_header = table_header .. ' !! Különbözik itt:'
    end
 
    for key,value in pairs(self) do
        if key:find('^test') then
            result_table = result_table .. "'''" .. key .. "''':\n" .. table_header .. "\n|-\n"
            value(self)-- ez és környezete már elavult
            result_table = result_table .. "|}\n\n"
        end
    end
 
    return (num_failures == 0 and "<font color=\"#008000\">'''Minden teszt sikeres.'''</font>" or "<font color=\"#800000\">'''" .. num_failures .. " sikertelen tesz.'''</font>") .. "\n\n" .. frame:preprocess(result_table)
end

function UnitTester:run(frame_arg) 
    frame = frame_arg 
    self.frame = frame
    self.differs_at = frame.args['differs_at']
    tick = frame:preprocess('{{zöldpipa}}')
    cross = frame:preprocess('{{pirosiksz}}')
 
    local table_header = result_table_header
    if self.differs_at then   
        table_header = table_header .. ' !! Különbözik ettől' 
    end
 
    -- Sort results into alphabetical order.
    local self_sorted = {}
    for key,value in pairs(self) do
        if key:find('^test') then  
            table.insert(self_sorted, key)
        end
    end
    table.sort(self_sorted)
    
    for i,value in ipairs(self_sorted) do 
        result_table = result_table .. "'''" .. value .. "''':\n" .. table_header .. "\n|-\n"
        self[value](self)
        result_table = result_table .. "|}\n\n"    
    end
    return (num_failures == 0 and "<font color=\"#008000\">'''Minden teszt sikeres.'''</font>" or "<font color=\"#800000\">'''ennyi hibás van:" .. num_failures .. " '''</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