Module:UnitTests

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

 localframe,tick,cross
 localresult_table_header="{|class=\"wikitable\"\n! !! Text !! Expected !! Actual"
 localresult_table=''
 localnum_tests=0;
 localnum_failures=0

 functionfirst_difference(s1,s2)
 ifs1==s2thenreturn''end
 localmax=math.min(#s1,#s2)
 fori=1,maxdo
 ifs1:sub(i,i)~=s2:sub(i,i)thenreturniend
 end
 returnmax+1
 end

 functionUnitTester:preprocess_equals(text,expected,options)
 num_tests=num_tests+1;
 localactual=frame:preprocess(text)
 ifactual==expectedthen
 result_table=result_table..'| '..tick
 else
 result_table=result_table..'| '..cross
 num_failures=num_failures+1
 end
 localmaybe_nowiki=(optionsandoptions.nowiki)andmw.text.nowikiorfunction(...)return...end
 localdiffers_at=self.differs_atand(' \n| '..first_difference(expected,actual))or''
 result_table=result_table..' \n| '..mw.text.nowiki(text)..' \n| '..maybe_nowiki(expected)..' \n| '..maybe_nowiki(actual)..differs_at.."\n|-\n"
 end

 functionUnitTester:preprocess_expect_error(text,options)
 num_tests=num_tests+1;
 localactual=frame:preprocess(text)
 localmaybe_nowiki=(optionsandoptions.nowiki)andmw.text.nowikiorfunction(...)return...end

 localcaught=frame:preprocess("{{#iferror:"..actual.."|ok|fail}}")
 ifcaught=="ok"then
 actual="Caught expected error: "..maybe_nowiki(actual)
 result_table=result_table..'| '..tick
 else
 result_table=result_table..'| '..cross
 num_failures=num_failures+1
 end

 localdiffers_at=self.differs_atand' \n| 'or''
 result_table=result_table..' \n| '..mw.text.nowiki(text)..' \n| '.."An error"..' \n| '..actual..differs_at.."\n|-\n"
 end

 functionUnitTester:preprocess_equals_many(prefix,suffix,cases,options)
 for_,caseinipairs(cases)do
 localtext=prefix..case[1]..suffix
 if(notcase.error)then
 self:preprocess_equals(text,case[2],options)
 else
 self:preprocess_expect_error(text,options)
 end
 end
 end

 functionUnitTester:preprocess_equals_preprocess(text1,text2,options)
 num_tests=num_tests+1;
 localactual=frame:preprocess(text1)
 localexpected=frame:preprocess(text2)
 ifactual==expectedthen
 result_table=result_table..'| '..tick
 else
 result_table=result_table..'| '..cross
 num_failures=num_failures+1
 end
 localmaybe_nowiki=(optionsandoptions.nowiki)andmw.text.nowikiorfunction(...)return...end
 localdiffers_at=self.differs_atand(' \n| '..first_difference(expected,actual))or''
 result_table=result_table..' \n| '..mw.text.nowiki(text1)..' \n| '..maybe_nowiki(expected)..' \n| '..maybe_nowiki(actual)..differs_at.."\n|-\n"
 end

 functionUnitTester:preprocess_equals_preprocess_many(prefix1,suffix1,prefix2,suffix2,cases,options)
 for_,caseinipairs(cases)do
 localtext1=prefix1..case[1]..suffix1
 if(notcase.error)then
 localtext2=prefix2..(case[2]andcase[2]orcase[1])..suffix2
 self:preprocess_equals_preprocess(text1,text2,options)
 else
 self:preprocess_expect_error(text1,options)
 end
 end
 end

 functionUnitTester:equals(name,actual,expected,options)
 num_tests=num_tests+1;
 ifactual==expectedthen
 result_table=result_table..'| '..tick
 else
 result_table=result_table..'| '..cross
 num_failures=num_failures+1
 end
 localmaybe_nowiki=(optionsandoptions.nowiki)andmw.text.nowikiorfunction(...)return...end
 localdiffers_at=self.differs_atand(' \n| '..first_difference(expected,actual))or''
 result_table=result_table..' \n| '..name..' \n| '..maybe_nowiki(tostring(expected))..' \n| '..maybe_nowiki(tostring(actual))..differs_at.."\n|-\n"
 end

 localfunctiondeep_compare(t1,t2,ignore_mt)
 localty1=type(t1)
 localty2=type(t2)
 ifty1~=ty2thenreturnfalseend
 ifty1~='table'andty2~='table'thenreturnt1==t2end

 localmt=getmetatable(t1)
 ifnotignore_mtandmtandmt.__eqthenreturnt1==t2end

 fork1,v1inpairs(t1)do
 localv2=t2[k1]
 ifv2==nilornotdeep_compare(v1,v2)thenreturnfalseend
 end
 fork2,v2inpairs(t2)do
 localv1=t1[k2]
 ifv1==nilornotdeep_compare(v1,v2)thenreturnfalseend
 end

 returntrue
 end

 functionval_to_str(v)
 iftype(v)=='string'then
 v=mw.ustring.gsub(v,'\n','\\n')
 ifmw.ustring.match(mw.ustring.gsub(v,'[^\'"]',''),'^"+$')then
 return"'"..v.."'"
 end
 return'"'..mw.ustring.gsub(v,'"','\\"')..'"'
 else
 returntype(v)=='table'andtable_to_str(v)ortostring(v)
 end
 end

 functiontable_key_to_str(k)
 iftype(k)=='string'andmw.ustring.match(k,'^[_%a][_%a%d]*$')then
 returnk
 else
 return'['..val_to_str(k)..']'
 end
 end

 functiontable_to_str(tbl)
 localresult,done={},{}
 fork,vinipairs(tbl)do
 table.insert(result,val_to_str(v))
 done[k]=true
 end
 fork,vinpairs(tbl)do
 ifnotdone[k]then
 table.insert(result,table_key_to_str(k)..'='..val_to_str(v))
 end
 end
 return'{'..table.concat(result,',')..'}'
 end

 functionUnitTester:equals_deep(name,actual,expected,options)
 num_tests=num_tests+1;
 ifdeep_compare(actual,expected)then
 result_table=result_table..'| '..tick
 else
 result_table=result_table..'| '..cross
 num_failures=num_failures+1
 end
 localmaybe_nowiki=(optionsandoptions.nowiki)andmw.text.nowikiorfunction(...)return...end
 localactual_str=val_to_str(actual)
 localexpected_str=val_to_str(expected)
 localdiffers_at=self.differs_atand(' \n| '..first_difference(expected_str,actual_str))or''
 result_table=result_table..' \n| '..name..' \n| '..maybe_nowiki(expected_str)..' \n| '..maybe_nowiki(actual_str)..differs_at.."\n|-\n"
 end

 functionUnitTester:run(frame_arg)
 frame=frame_arg
 self.frame=frame
 self.differs_at=frame.args['differs_at']
 localdisplayMode=frame.args.displayModeor'table';
 tick=frame:preprocess('{{Tick}}')
 cross=frame:preprocess('{{Cross}}')

 localtable_header=result_table_header
 ifself.differs_atthen
 table_header=table_header..' !! Differs at'
 end

 -- Sort results into alphabetical order.
 localself_sorted={}
 forkey,valueinpairs(self)do
 ifkey:find('^test')then
 table.insert(self_sorted,key)
 end
 end
 table.sort(self_sorted)
 -- Add results to the results table.
 fori,valueinipairs(self_sorted)do
 result_table=result_table.."\n\n'''"..value.."''':\n"..table_header.."\n|-\n"
 self[value](self)
 result_table=result_table.."|}"
 end

 if(displayMode=='short')then
 localresult_text=string.format(
 "success: %d, error: %d",
 num_tests-num_failures,
 num_failures
 );
 if(num_failures>0)then
 result_text='<span class="error">'..result_text.."</span>";
 end
 returnresult_text;
 end

 return(num_failures==0and'<strong style="color:#008000;">All tests passed.</strong>'or'<strong class="error" style="font-size:100%;">'..num_failures..' tests failed.</strong>')..frame:preprocess(result_table)
 end

 functionUnitTester:new()
 localo={}
 setmetatable(o,self)
 self.__index=self
 returno
 end

 localp=UnitTester:new()
 functionp.run_tests(frame)returnp:run(frame)end
 returnp