Python unittest如何生成HTMLTestRunner模块

2023-07-17 02:01:03 310

生成HTMLTestRunner模块

unittest里面是不能生成html格式报告的，需要导入一个第三方的模块：HTMLTestRunner

方法1.这个模块下载不能通过pip安装了，只能下载后手动导入，下载地址：

http://tungwaiyip.info/software/HTMLTestRunner.html

方法2.在python安装文件的Lib目录下新增文件HTMLTestRunner.py

两种模板如下，建议使用第一种（第一种模板更加美观）

文件内容如下：

（1）第一种模板

#-*-coding:utf-8-*-
"""
ATestRunnerforusewiththePythonunittestingframework.It
generatesaHTMLreporttoshowtheresultataglance.
Thesimplestwaytousethisistoinvokeitsmainmethod.E.g.
importunittest
importHTMLTestRunner
...defineyourtests...
if__name__=='__main__':
HTMLTestRunner.main()
Formorecustomizationoptions,instantiatesaHTMLTestRunnerobject.
HTMLTestRunnerisacounterparttounittest'sTextTestRunner.E.g.
#outputtoafile
fp=file('my_report.html','wb')
runner=HTMLTestRunner.HTMLTestRunner(
stream=fp,
title='Myunittest',
description='ThisdemonstratesthereportoutputbyHTMLTestRunner.'
)
#Useanexternalstylesheet.
#SeetheTemplate_mixinclassformorecustomizableoptions
runner.STYLESHEET_TMPL=''
#runthetest
runner.run(my_test_suite)
------------------------------------------------------------------------
Copyright(c)2004-2007,WaiYipTung
Allrightsreserved.
Redistributionanduseinsourceandbinaryforms,withorwithout
modification,arepermittedprovidedthatthefollowingconditionsare
met:
*Redistributionsofsourcecodemustretaintheabovecopyrightnotice,
thislistofconditionsandthefollowingdisclaimer.
*Redistributionsinbinaryformmustreproducetheabovecopyright
notice,thislistofconditionsandthefollowingdisclaimerinthe
documentationand/orothermaterialsprovidedwiththedistribution.
*NeitherthenameWaiYipTungnorthenamesofitscontributorsmaybe
usedtoendorseorpromoteproductsderivedfromthissoftwarewithout
specificpriorwrittenpermission.
THISSOFTWAREISPROVIDEDBYTHECOPYRIGHTHOLDERSANDCONTRIBUTORS"AS
IS"ANDANYEXPRESSORIMPLIEDWARRANTIES,INCLUDING,BUTNOTLIMITED
TO,THEIMPLIEDWARRANTIESOFMERCHANTABILITYANDFITNESSFORA
PARTICULARPURPOSEAREDISCLAIMED.INNOEVENTSHALLTHECOPYRIGHTOWNER
ORCONTRIBUTORSBELIABLEFORANYDIRECT,INDIRECT,INCIDENTAL,SPECIAL,
EXEMPLARY,ORCONSEQUENTIALDAMAGES(INCLUDING,BUTNOTLIMITEDTO,
PROCUREMENTOFSUBSTITUTEGOODSORSERVICES;LOSSOFUSE,DATA,OR
PROFITS;ORBUSINESSINTERRUPTION)HOWEVERCAUSEDANDONANYTHEORYOF
LIABILITY,WHETHERINCONTRACT,STRICTLIABILITY,ORTORT(INCLUDING
NEGLIGENCEOROTHERWISE)ARISINGINANYWAYOUTOFTHEUSEOFTHIS
SOFTWARE,EVENIFADVISEDOFTHEPOSSIBILITYOFSUCHDAMAGE.
"""

#URL:http://tungwaiyip.info/software/HTMLTestRunner.html

__author__="WaiYipTung"
__version__="0.9.1"

"""
ChangeHistory
Version0.9.1
*用Echarts添加执行情况统计图(灰蓝)
Version0.9.0
*改成Python3.x(灰蓝)
Version0.8.3
*使用Bootstrap稍加美化(灰蓝)
*改为中文(灰蓝)
Version0.8.2
*Showoutputinlineinsteadofpopupwindow(ViorelLupu).
Versionin0.8.1
*ValidatedXHTML(WolfgangBorgert).
*Addeddescriptionoftestclassesandtestcases.
Versionin0.8.0
*DefineTemplate_mixinclassforcustomization.
*WorkaroundaIE6bugthatitdoesnottreat


%(stylesheet)s





%(heading)s
%(report)s
%(ending)s
%(chart_script)s

"""#variables:(title,generator,stylesheet,heading,report,ending,chart_script) ECHARTS_SCRIPT=""" //基于准备好的dom，初始化echarts实例 varmyChart=echarts.init(document.getElementById('chart')); //指定图表的配置项和数据 varoption={ title:{ text:'测试执行情况', x:'center' }, tooltip:{ trigger:'item', formatter:"{a}
{b}:{c}({d}%%)" }, color:['#95b75d','grey','#b64645'], legend:{ orient:'vertical', left:'left', data:['通过','失败','错误'] }, series:[ { name:'测试执行情况', type:'pie', radius:'60%%', center:['50%%','60%%'], data:[ {value:%(Pass)s,name:'通过'}, {value:%(fail)s,name:'失败'}, {value:%(error)s,name:'错误'} ], itemStyle:{ emphasis:{ shadowBlur:10, shadowOffsetX:0, shadowColor:'rgba(0,0,0,0.5)' } } } ] }; //使用刚指定的配置项和数据显示图表。 myChart.setOption(option); """#variables:(Pass,fail,error) #------------------------------------------------------------------------ #Stylesheet # #alternativelyuseaforexternalstylesheet,e.g. # STYLESHEET_TMPL=""" body{font-family:MicrosoftYaHei,Consolas,arial,sans-serif;font-size:80%;} table{font-size:100%;} pre{white-space:pre-wrap;word-wrap:break-word;} /*--heading----------------------------------------------------------------------*/ h1{ font-size:16pt; color:gray; } .heading{ margin-top:0ex; margin-bottom:1ex; } .heading.attribute{ margin-top:1ex; margin-bottom:0; } .heading.description{ margin-top:2ex; margin-bottom:3ex; } /*--cssdivpopup------------------------------------------------------------------------*/ a.popup_link{ } a.popup_link:hover{ color:red; } .popup_window{ display:none; position:relative; left:0px; top:0px; /*border:solid#6271731px;*/ padding:10px; /*background-color:#E6E6D6;*/ font-family:"LucidaConsole","CourierNew",Courier,monospace; text-align:left; font-size:8pt; /*width:500px;*/ } } /*--report------------------------------------------------------------------------*/ #show_detail_line{ margin-top:3ex; margin-bottom:1ex; } #result_table{ width:99%; } #header_row{ font-weight:bold; color:#303641; background-color:#ebebeb; } #total_row{font-weight:bold;} .passClass{background-color:#bdedbc;} .failClass{background-color:#ffefa4;} .errorClass{background-color:#ffc9c9;} .passCase{color:#6c6;} .failCase{color:#FF6600;font-weight:bold;} .errorCase{color:#c00;font-weight:bold;} .hiddenRow{display:none;} .testcase{margin-left:2em;} /*--ending----------------------------------------------------------------------*/ #ending{ } #div_base{ position:absolute; top:0%; left:5%; right:5%; width:auto; height:auto; margin:-15px000; } """ #------------------------------------------------------------------------ #Heading # HEADING_TMPL="""

%(title)s

%(parameters)s

%(description)s

""" ATestRunnerforusewiththePythonunittestingframework.It generatesaHTMLreporttoshowtheresultataglance. Thesimplestwaytousethisistoinvokeitsmainmethod.E.g. importunittest importHTMLTestRunner ...defineyourtests... if__name__=='__main__': HTMLTestRunner.main() Formorecustomizationoptions,instantiatesaHTMLTestRunnerobject. HTMLTestRunnerisacounterparttounittest'sTextTestRunner.E.g. #outputtoafile fp=file('my_report.html','wb') runner=HTMLTestRunner.HTMLTestRunner( stream=fp, title='Myunittest', description='ThisdemonstratesthereportoutputbyHTMLTestRunner.' ) #Useanexternalstylesheet. #SeetheTemplate_mixinclassformorecustomizableoptions runner.STYLESHEET_TMPL='' #runthetest runner.run(my_test_suite) ------------------------------------------------------------------------ Copyright(c)2004-2007,WaiYipTung Allrightsreserved. Redistributionanduseinsourceandbinaryforms,withorwithout modification,arepermittedprovidedthatthefollowingconditionsare met: *Redistributionsofsourcecodemustretaintheabovecopyrightnotice, thislistofconditionsandthefollowingdisclaimer. *Redistributionsinbinaryformmustreproducetheabovecopyright notice,thislistofconditionsandthefollowingdisclaimerinthe documentationand/orothermaterialsprovidedwiththedistribution. *NeitherthenameWaiYipTungnorthenamesofitscontributorsmaybe usedtoendorseorpromoteproductsderivedfromthissoftwarewithout specificpriorwrittenpermission. THISSOFTWAREISPROVIDEDBYTHECOPYRIGHTHOLDERSANDCONTRIBUTORS"AS IS"ANDANYEXPRESSORIMPLIEDWARRANTIES,INCLUDING,BUTNOTLIMITED TO,THEIMPLIEDWARRANTIESOFMERCHANTABILITYANDFITNESSFORA PARTICULARPURPOSEAREDISCLAIMED.INNOEVENTSHALLTHECOPYRIGHTOWNER ORCONTRIBUTORSBELIABLEFORANYDIRECT,INDIRECT,INCIDENTAL,SPECIAL, EXEMPLARY,ORCONSEQUENTIALDAMAGES(INCLUDING,BUTNOTLIMITEDTO, PROCUREMENTOFSUBSTITUTEGOODSORSERVICES;LOSSOFUSE,DATA,OR PROFITS;ORBUSINESSINTERRUPTION)HOWEVERCAUSEDANDONANYTHEORYOF LIABILITY,WHETHERINCONTRACT,STRICTLIABILITY,ORTORT(INCLUDING NEGLIGENCEOROTHERWISE)ARISINGINANYWAYOUTOFTHEUSEOFTHIS SOFTWARE,EVENIFADVISEDOFTHEPOSSIBILITYOFSUCHDAMAGE. """ #URL:http://tungwaiyip.info/software/HTMLTestRunner.html __author__="WaiYipTung" __version__="0.8.2" """ ChangeHistory Version0.8.2 *Showoutputinlineinsteadofpopupwindow(ViorelLupu). Versionin0.8.1 *ValidatedXHTML(WolfgangBorgert). *Addeddescriptionoftestclassesandtestcases. Versionin0.8.0 *DefineTemplate_mixinclassforcustomization. *WorkaroundaIE6bugthatitdoesnottreat %(heading)s %(report)s %(ending)s """ #variables:(title,generator,stylesheet,heading,report,ending) #------------------------------------------------------------------------ #Stylesheet # #alternativelyuseaforexternalstylesheet,e.g. # STYLESHEET_TMPL=""" body{font-family:verdana,arial,helvetica,sans-serif;font-size:80%;} table{font-size:100%;} pre{} /*--heading----------------------------------------------------------------------*/ h1{ font-size:16pt; color:gray; } .heading{ margin-top:0ex; margin-bottom:1ex; } .heading.attribute{ margin-top:1ex; margin-bottom:0; } .heading.description{ margin-top:4ex; margin-bottom:6ex; } /*--cssdivpopup------------------------------------------------------------------------*/ a.popup_link{ } a.popup_link:hover{ color:red; } .popup_window{ display:none; position:relative; left:0px; top:0px; /*border:solid#6271731px;*/ padding:10px; background-color:#E6E6D6; font-family:"LucidaConsole","CourierNew",Courier,monospace; text-align:left; font-size:8pt; width:500px; } } /*--report------------------------------------------------------------------------*/ #show_detail_line{ margin-top:3ex; margin-bottom:1ex; } #result_table{ width:80%; border-collapse:collapse; border:1pxsolid#777; } #header_row{ font-weight:bold; color:white; background-color:#777; } #result_tabletd{ border:1pxsolid#777; padding:2px; } #total_row{font-weight:bold;} .passClass{background-color:#6c6;} .failClass{background-color:#c60;} .errorClass{background-color:#c00;} .passCase{color:#6c6;} .failCase{color:#c60;font-weight:bold;} .errorCase{color:#c00;font-weight:bold;} .hiddenRow{display:none;} .testcase{margin-left:2em;} /*--ending----------------------------------------------------------------------*/ #ending{ } """ #------------------------------------------------------------------------ #Heading # HEADING_TMPL="""

%(title)s

%(parameters)s %(description)s

"""#variables:(title,parameters,description) HEADING_ATTRIBUTE_TMPL="""%(name)s:%(value)s

"""#variables:(name,value) #------------------------------------------------------------------------ #Report # REPORT_TMPL=""" Show Summary Failed All

TestGroup/Testcase Count Pass Fail Error View %(test_list)s Total %(count)s %(Pass)s %(fail)s %(error)s """#variables:(test_list,count,Pass,fail,error) REPORT_CLASS_TMPL=r""" %(desc)s %(count)s %(Pass)s %(fail)s %(error)s Detail """#variables:(style,desc,count,Pass,fail,error,cid) REPORT_TEST_WITH_OUTPUT_TMPL=r""" %(desc)s %(status)s

[x]

%(script)s

"""#variables:(tid,Class,style,desc,status) REPORT_TEST_NO_OUTPUT_TMPL=r""" %(desc)s %(status)s """#variables:(tid,Class,style,desc,status) REPORT_TEST_OUTPUT_TMPL=r""" %(id)s:%(output)s """#variables:(id,output) #------------------------------------------------------------------------ #ENDING # ENDING_TMPL=""" """ #--------------------TheendoftheTemplateclass------------------- TestResult=unittest.TestResult class_TestResult(TestResult): #note:_TestResultisapurerepresentationofresults. #Itlackstheoutputandreportingabilitycomparestounittest._TextTestResult. def__init__(self,verbosity=1): TestResult.__init__(self) self.stdout0=None self.stderr0=None self.success_count=0 self.failure_count=0 self.error_count=0 self.verbosity=verbosity #resultisalistofresultin4tuple #( #resultcode(0:success;1:fail;2:error), #TestCaseobject, #Testoutput(bytestring), #stacktrace, #) self.result=[] defstartTest(self,test): TestResult.startTest(self,test) #justonebufferforbothstdoutandstderr self.outputBuffer=io.StringIO() stdout_redirector.fp=self.outputBuffer stderr_redirector.fp=self.outputBuffer self.stdout0=sys.stdout self.stderr0=sys.stderr sys.stdout=stdout_redirector sys.stderr=stderr_redirector defcomplete_output(self): """ Disconnectoutputredirectionandreturnbuffer. Safetocallmultipletimes. """ ifself.stdout0: sys.stdout=self.stdout0 sys.stderr=self.stderr0 self.stdout0=None self.stderr0=None returnself.outputBuffer.getvalue() defstopTest(self,test): #UsuallyoneofaddSuccess,addErrororaddFailurewouldhavebeencalled. #Buttherearesomepathinunittestthatwouldbypassthis. #WemustdisconnectstdoutinstopTest(),whichisguaranteedtobecalled. self.complete_output() defaddSuccess(self,test): self.success_count+=1 TestResult.addSuccess(self,test) output=self.complete_output() self.result.append((0,test,output,'')) ifself.verbosity>1: sys.stderr.write('ok') sys.stderr.write(str(test)) sys.stderr.write('\n') else: sys.stderr.write('.') defaddError(self,test,err): self.error_count+=1 TestResult.addError(self,test,err) _,_exc_str=self.errors[-1] output=self.complete_output() self.result.append((2,test,output,_exc_str)) ifself.verbosity>1: sys.stderr.write('E') sys.stderr.write(str(test)) sys.stderr.write('\n') else: sys.stderr.write('E') defaddFailure(self,test,err): self.failure_count+=1 TestResult.addFailure(self,test,err) _,_exc_str=self.failures[-1] output=self.complete_output() self.result.append((1,test,output,_exc_str)) ifself.verbosity>1: sys.stderr.write('F') sys.stderr.write(str(test)) sys.stderr.write('\n') else: sys.stderr.write('F') classHTMLTestRunner(Template_mixin): """ """ def__init__(self,stream=sys.stdout,verbosity=1,title=None,description=None): self.stream=stream self.verbosity=verbosity iftitleisNone: self.title=self.DEFAULT_TITLE else: self.title=title ifdescriptionisNone: self.description=self.DEFAULT_DESCRIPTION else: self.description=description self.startTime=datetime.datetime.now() defrun(self,test): "Runthegiventestcaseortestsuite." result=_TestResult(self.verbosity) test(result) self.stopTime=datetime.datetime.now() self.generateReport(test,result) #print(sys.stderr,"\nTimeElapsed:%s"%(self.stopTime-self.startTime)) sys.stderr.write('\nTimeElapsed:%s\n'%(self.stopTime-self.startTime)) returnresult defsortResult(self,result_list): #unittestdoesnotseemstoruninanyparticularorder. #Hereatleastwewanttogroupthemtogetherbyclass. rmap={} classes=[] forn,t,o,einresult_list: cls=t.__class__ ifnotclsinrmap: rmap[cls]=[] classes.append(cls) rmap[cls].append((n,t,o,e)) r=[(cls,rmap[cls])forclsinclasses] returnr defgetReportAttributes(self,result): """ Returnreportattributesasalistof(name,value). Overridethistoaddcustomattributes. """ startTime=str(self.startTime)[:19] duration=str(self.stopTime-self.startTime) status=[] ifresult.success_count:status.append('Pass%s'%result.success_count) ifresult.failure_count:status.append('Failure%s'%result.failure_count) ifresult.error_count:status.append('Error%s'%result.error_count) ifstatus: status=''.join(status) else: status='none' return[ ('StartTime',startTime), ('Duration',duration), ('Status',status), ] defgenerateReport(self,test,result): report_attrs=self.getReportAttributes(result) generator='HTMLTestRunner%s'%__version__ stylesheet=self._generate_stylesheet() heading=self._generate_heading(report_attrs) report=self._generate_report(result) ending=self._generate_ending() output=self.HTML_TMPL%dict( title=saxutils.escape(self.title), generator=generator, stylesheet=stylesheet, heading=heading, report=report, ending=ending, ) self.stream.write(output.encode('utf8')) def_generate_stylesheet(self): returnself.STYLESHEET_TMPL def_generate_heading(self,report_attrs): a_lines=[] forname,valueinreport_attrs: line=self.HEADING_ATTRIBUTE_TMPL%dict( name=saxutils.escape(name), value=saxutils.escape(value), ) a_lines.append(line) heading=self.HEADING_TMPL%dict( title=saxutils.escape(self.title), parameters=''.join(a_lines), description=saxutils.escape(self.description), ) returnheading def_generate_report(self,result): rows=[] sortedResult=self.sortResult(result.result) forcid,(cls,cls_results)inenumerate(sortedResult): #subtotalforaclass np=nf=ne=0 forn,t,o,eincls_results: ifn==0:np+=1 elifn==1:nf+=1 else:ne+=1 #formatclassdescription ifcls.__module__=="__main__": name=cls.__name__ else: name="%s.%s"%(cls.__module__,cls.__name__) doc=cls.__doc__andcls.__doc__.split("\n")[0]or"" desc=docand'%s:%s'%(name,doc)orname row=self.REPORT_CLASS_TMPL%dict( style=ne>0and'errorClass'ornf>0and'failClass'or'passClass', desc=desc, count=np+nf+ne, Pass=np, fail=nf, error=ne, cid='c%s'%(cid+1), ) rows.append(row) fortid,(n,t,o,e)inenumerate(cls_results): self._generate_report_test(rows,cid,tid,n,t,o,e) report=self.REPORT_TMPL%dict( test_list=''.join(rows), count=str(result.success_count+result.failure_count+result.error_count), Pass=str(result.success_count), fail=str(result.failure_count), error=str(result.error_count), ) returnreport def_generate_report_test(self,rows,cid,tid,n,t,o,e): #e.g.'pt1.1','ft1.1',etc has_output=bool(oore) tid=(n==0and'p'or'f')+'t%s.%s'%(cid+1,tid+1) name=t.id().split('.')[-1] doc=t.shortDescription()or"" desc=docand('%s:%s'%(name,doc))orname tmpl=has_outputandself.REPORT_TEST_WITH_OUTPUT_TMPLorself.REPORT_TEST_NO_OUTPUT_TMPL #oandeshouldbebytestringbecausetheyarecollectedfromstdoutandstderr? ifisinstance(o,str): #TODO:someproblemwith'string_escape':itescape\nandmessupformating #uo=unicode(o.encode('string_escape')) uo=o else: uo=o ifisinstance(e,str): #TODO:someproblemwith'string_escape':itescape\nandmessupformating #ue=unicode(e.encode('string_escape')) ue=e else: ue=e script=self.REPORT_TEST_OUTPUT_TMPL%dict( id=tid, output=saxutils.escape(uo+ue), ) row=tmpl%dict( tid=tid, Class=(n==0and'hiddenRow'or'none'), style=n==2and'errorCase'or(n==1and'failCase'or'none'), desc=desc, script=script, status=self.STATUS[n], ) rows.append(row) ifnothas_output: return def_generate_ending(self): returnself.ENDING_TMPL ############################################################################## #Facilitiesforrunningtestsfromthecommandline ############################################################################## #Note:Reuseunittest.TestProgramtolaunchtest.Inthefuturewemay #buildourownlaunchertosupportmorespecificcommandline #parametersliketesttitle,CSS,etc. classTestProgram(unittest.TestProgram): """ Avariationoftheunittest.TestProgram.Pleaserefertothebase classforcommandlineparameters. """ defrunTests(self): #PickHTMLTestRunnerasthedefaulttestrunner. #baseclass'stestRunnerparameterisnotusefulbecauseitmeans #wehavetoinstantiateHTMLTestRunnerbeforeweknowself.verbosity. ifself.testRunnerisNone: self.testRunner=HTMLTestRunner(verbosity=self.verbosity) unittest.TestProgram.runTests(self) main=TestProgram ############################################################################## #Executingthismodulefromthecommandline ############################################################################## if__name__=="__main__": main(module=None)

Python unittest如何生成HTMLTestRunner模块

%(title)s

%(title)s

热门推荐

随机推荐