python+unittest+requests+HTMLTestRunner 框架通过读取excel测试用例实现接口自动化测试

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

文章目录

一、接口自动化框架目录二、读取相应配置文件testFile目录1.创建配置文件2.获取当前目录代码getpathinfo.py3.获取请求URL代码geturlParams.py4.读取配置文件readConfig.py5.读取excel表格readExcel.py 三、common目录介绍1.configDb.py连接数据库，具体代码如下2.configEmail.py发送邮件，代码如下：3.配置发送http请求configHttp.py4.日志文件Log.py5.HTMLTestRunner.py 四、testCase目录五、runAll.py运行代码如下：总结

一、接口自动化框架目录

目录介绍：

common目录：用来存放公共类，包含封装的数据库连接、邮件发送、http请求
result目录：用来存放运行结果以及日志
testCase目录：用来存放测试用例类
testFile目录：用来存放获取配置文件的类与执行测试的方法，case目录是用于存放excel测试用例

二、读取相应配置文件testFile目录

1.创建配置文件

第一步：在testFile目录下创建一个后缀为.txt文件
第二步：输入如下配置内容
第三步：将修改好的.txt文件改为config.ini文件

# coding: utf -8[HTTP]# 协议scheme = https# 待测接口所在的服务器地址baseurl =# 待测接口所在服务器上的端口号port = timeout = 10.0#配置邮箱，与后文相关，再次不必过度纠结[EMAIL]#发送邮箱开关是否打开，下文讲到邮件发送会有讲到on_off = onsubject = 接口自动化测试报告app = Outlook# 收件人addressee = 2417970@# 抄送人cc = 2417970@

2.获取当前目录代码getpathinfo.py

import os# 获取当前文件所在位置def get_Path():#path1 = os.path.split(os.path.realpath(__file__))[0]#path = os.path.split(path1)[0]path = os.path.split(os.path.realpath(__file__))[0]return pathif __name__ == '__main__': # 执行该文件，测试下是否OKprint('测试路径是否OK,路径为：', get_Path())

3.获取请求URL代码geturlParams.py

from testFile import readConfigfrom testFile import readExcel# 通过配置获取urlreadconfig = readConfig.ReadConfig()# 定义一个方法，将从配置文件中读取的进行拼接class geturlParams():def get_Url(self):#new_url = readconfig.get_http('scheme') + '://' + readconfig.get_http('baseurl') + ':'+readconfig.get_http('port')new_url = readconfig.get_http('scheme') + '://' + readconfig.get_http('baseurl')# logger.info('new_url'+new_url)return new_urlif __name__ == '__main__': # 验证拼接后的正确性print(geturlParams().get_Url())

4.读取配置文件readConfig.py

import osimport configparserfrom testFile import getpathinfopath = getpathinfo.get_Path() # 获取配置文件夹所在的位置config_path = os.path.join(path, 'config.ini') # 往上述返回的位置在添加一级config = configparser.ConfigParser() # 调取读取配置文件的方法config.read(config_path, encoding='utf-8') # 读配置文件print(path)class ReadConfig():# 获取HTTP方法def get_http(self, name):value = config.get('HTTP', name) # HTTP为配置文件中的HTTPreturn value# 获取Email的方法def get_email(self, name):value = config.get('EMAIL', name)return value# 获取sql的方法def get_mysql(self, name):value = config.get('DATABASE', name)return valueif __name__ == '__main__':print('HTTP中的baseurl值为:', ReadConfig().get_http('baseurl'))print('EMAIL中的开关on_off值为:', ReadConfig().get_email('on_off'))

5.读取excel表格readExcel.py

import osimport xlrd2from testFile import getpathinfofrom xlrd2 import open_workbookpath = getpathinfo.get_Path()print(path)# 定义一个类class readExcel():# 定义打开表格得到函数def get_xls(self, xls_name, sheet_name):cls = []# 获取Excel表格所在的路径xlsPath = os.path.join(path, 'case', xls_name)# 打开文件file = open_workbook(xlsPath)# 获取表格的sheet页sheet = file.sheet_by_name(sheet_name)# 获取当前sheet页面有多少行nrows = sheet.nrows#print(nrows)# 循环读取excel并写入cls数组中for i in range(nrows):if sheet.row_values(i)[0] != u'case_name':cls.append(sheet.row_values(i))#print(cls)return clsdef getLine_num(self,xls_name,sheet_name):# 读取表格行数# 获取Excel表格所在的路径xlsPath = os.path.join(path, 'case', xls_name)# 打开文件file = open_workbook(xlsPath)# 获取表格的sheet页sheet = file.sheet_by_name(sheet_name)# 获取当前sheet页面有多少行nrows = sheet.nrows#print(nrows)#return nrows# 类似c语言或者Java语言中的主方法执行窗口if __name__ == '__main__':print(readExcel().get_xls('文件名', 'sheet页名'))

三、common目录介绍

1.configDb.py连接数据库，具体代码如下

import pymysqlclass ClientSql():def __init__(self, host, port, user, passwd, db, charset):self.host = hostself.port = portself.user = userself.passwd = passwdself.db = dbself.charset = charsetdef client_mysql(self):return pymysql.connect(host=self.host, port=self.port, user=self.user,passwd=self.passwd, db=self.db, charset=self.charset)if __name__ == '__main__':res = ClientSql(host='127.0.0.1', # mysql服务器地址port=3306, # mysql服务器端口号user='hhh', # 用户名passwd='111111',# 密码db='Student', # 数据库名称charset='utf8')test = res.client_mysql()cursor = test.cursor() #使用cursor方法创建一个游标cursor.execute("select version()") #查询数据库版本data = cursor.fetchone()print(" Database Version:%s" % data)test.close()

2.configEmail.py发送邮件，代码如下：

import osimport smtplibimport base64from email.mime.text import MIMETextfrom email.mime.multipart import MIMEMultipartclass SendEmail(object):def __init__(self, username, passwd, recv, title, content,file=None, ssl=False,email_host='', port=25, ssl_port=465):self.username = username # 发送者用户名self.passwd = passwd # 发送者密码self.recv = recv # 收件人，多个要传list ['a@','b@']self.title = title # 邮件标题self.content = content # 邮件正文self.file = file # 附件路径，如果不在当前目录下，要写绝对路径self.email_host = email_host # smtp服务器地址self.port = port # 普通端口self.ssl = ssl # 是否安全链接self.ssl_port = ssl_port # 安全链接端口def send_email(self):msg = MIMEMultipart()# 发送内容的对象if self.file: # 处理附件的file_name = os.path.split(self.file)[-1] # 只取文件名，不取路径try:f = open(self.file, 'rb').read()except Exception as e:raise Exception('附件打不开！！！！')else:att = MIMEText(f, "base64", "utf-8")att["Content-Type"] = 'application/octet-stream'# base64.b64encode(file_name.encode()).decode()new_file_name = '=?utf-8?b?' + base64.b64encode(file_name.encode()).decode() + '?='# 这里是处理文件名为中文名的，必须这么写att["Content-Disposition"] = 'attachment; filename="%s"' % (new_file_name)msg.attach(att)msg.attach(MIMEText(self.content)) # 邮件正文的内容msg['Subject'] = self.title # 邮件主题msg['From'] = self.username # 发送者账号msg['To'] = ','.join(self.recv) # 接收者账号列表if self.ssl:self.smtp = smtplib.SMTP_SSL(self.email_host, port=self.ssl_port)else:self.smtp = smtplib.SMTP(self.email_host, port=self.port)# 发送邮件服务器的对象self.smtp.login(user=self.username, password=self.passwd)try:self.smtp.sendmail(self.username, self.recv, msg.as_string())passexcept Exception as e:print('出错了。。', e)else:print('发送成功！')self.smtp.quit()if __name__ == '__main__':m = SendEmail(#发送者username='165879@',# 需要去163邮箱设置 163邮箱POP3/SMTP/IMAP 服务，需要开启密码为授权密码，而不是登录密码passwd='开通POP3/SMTP/IMAP 服务之后生成的密码',#接收者recv=['2410@'],title='ceshi',content='测试发送邮件',file=r'..\result\report.html',ssl=True,)m.send_email()

3.配置发送http请求configHttp.py

import requestsimport jsonclass RunMain():header = {# 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36','Content-Type': 'application/json; charset=UTF-8'}# 定义一个方法，传入需要的参数url和datadef send_post(self, url, data):# 参数必须按照url、data顺序传入header = self.headerresult = requests.post(url=url, data=data, headers=header).json() # 因为这里要封装post方法，所以这里的url和data值不能写死res = json.dumps(result, ensure_ascii=False, sort_keys=True, indent=2)return resdef send_get(self, url, data):header = self.headerresult = requests.get(url=url, params=data, headers=header).json()res = json.dumps(result, ensure_ascii=False, sort_keys=True, indent=2)return resdef run_main(self, method=None, url=None, data=None): # 定义一个run_main函数，通过传过来的method来进行不同的get或post请求result = Noneif method == 'post':result = self.send_post(url, data)elif method == 'get':result = self.send_get(url, data)else:print("method值错误！！！")return result

4.日志文件Log.py

import osimport loggingfrom logging.handlers import TimedRotatingFileHandlerfrom testFile import getpathinfopath1 = getpathinfo.get_Path()path = os.path.split(path1)[0]print(path)log_path = os.path.join(path, 'result') # 存放log文件的路径print(log_path)class Logger(object):def __init__(self, logger_name='logs…'):self.logger = logging.getLogger(logger_name)logging.root.setLevel(logging.NOTSET)self.log_file_name = 'logs' # 日志文件的名称self.backup_count = 5 # 最多存放日志的数量# 日志输出级别self.console_output_level = 'WARNING'self.file_output_level = 'DEBUG'# 日志输出格式self.formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')def get_logger(self):"""在logger中添加日志句柄并返回，如果logger已有句柄，则直接返回"""if not self.logger.handlers: # 避免重复日志console_handler = logging.StreamHandler()console_handler.setFormatter(self.formatter)console_handler.setLevel(self.console_output_level)self.logger.addHandler(console_handler)# 每天重新创建一个日志文件，最多保留backup_count份file_handler = TimedRotatingFileHandler(filename=os.path.join(log_path, self.log_file_name), when='D',interval=1, backupCount=self.backup_count, delay=True,encoding='utf-8')file_handler.setFormatter(self.formatter)file_handler.setLevel(self.file_output_level)self.logger.addHandler(file_handler)return self.loggerlogger = Logger().get_logger()

5.HTMLTestRunner.py

# -*- coding: utf-8 -*-"""A TestRunner for use with the Python unit testing framework. Itgenerates a HTML report to show the result at a glance.The simplest way to use this is to invoke its main method. E.g.import unittestimport HTMLTestRunner... define your tests ...if __name__ == '__main__':HTMLTestRunner.main()For more customization options, instantiates a HTMLTestRunner object.HTMLTestRunner is a counterpart to unittest's TextTestRunner. E.g.# output to a filefp = file('my_report.html', 'wb')runner = HTMLTestRunner.HTMLTestRunner(stream=fp,title='My unit test',description='This demonstrates the report output by HTMLTestRunner.')# Use an external stylesheet.# See the Template_mixin class for more customizable optionsrunner.STYLESHEET_TMPL = '<link rel="stylesheet" href="my_stylesheet.css" type="text/css">'# run the testrunner.run(my_test_suite)------------------------------------------------------------------------Copyright (c) -, Wai Yip TungAll rights reserved.Redistribution and use in source and binary forms, with or withoutmodification, are permitted provided that the following conditions aremet:* Redistributions of source code must retain the above copyright notice,this list of conditions and the following disclaimer.* Redistributions in binary form must reproduce the above copyrightnotice, this list of conditions and the following disclaimer in thedocumentation and/or other materials provided with the distribution.* Neither the name Wai Yip Tung nor the names of its contributors may beused to endorse or promote products derived from this software withoutspecific prior written permission.THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "ASIS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITEDTO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR APARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNEROR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, ORPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OFLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDINGNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THISSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."""# URL: http://tungwaiyip.info/software/HTMLTestRunner.html# __author__ = "Wai Yip Tung"__version__ = "0.9.1""""Change HistoryVersion 0.9.1* 用Echarts添加执行情况统计图 (灰蓝)Version 0.9.0* 改成Python 3.x (灰蓝)Version 0.8.3* 使用 Bootstrap稍加美化 (灰蓝)* 改为中文 (灰蓝)Version 0.8.2* Show output inline instead of popup window (Viorel Lupu).Version in 0.8.1* Validated XHTML (Wolfgang Borgert).* Added description of test classes and test cases.Version in 0.8.0* Define Template_mixin class for customization.* Workaround a IE 6 bug that it does not treat <script> block as CDATA.Version in 0.7.1* Back port to Python 2.3 (Frank Horowitz).* Fix missing scroll bars in detail log (Podi)."""# TODO: color stderr# TODO: simplify javascript using ,ore than 1 class in the class attribute?import datetimeimport sysimport ioimport timeimport unittestfrom xml.sax import saxutils# ------------------------------------------------------------------------# The redirectors below are used to capture output during testing. Output# sent to sys.stdout and sys.stderr are automatically captured. However# in some cases sys.stdout is already cached before HTMLTestRunner is# invoked (e.g. calling logging.basicConfig). In order to capture those# output, use the redirectors for the cached stream.## e.g.# >>> logging.basicConfig(stream=HTMLTestRunner.stdout_redirector)# >>>class OutputRedirector(object):""" Wrapper to redirect stdout or stderr """def __init__(self, fp):self.fp = fpdef write(self, s):self.fp.write(s)def writelines(self, lines):self.fp.writelines(lines)def flush(self):self.fp.flush()stdout_redirector = OutputRedirector(sys.stdout)stderr_redirector = OutputRedirector(sys.stderr)# ----------------------------------------------------------------------# Templateclass Template_mixin(object):"""Define a HTML template for report customerization and generation.Overall structure of an HTML reportHTML+------------------------+|<html> || <head>|| || STYLESHEET || +----------------+ || || || +----------------+ || || </head>|| || <body>|| || HEADING || +----------------+ || || || +----------------+ || || REPORT|| +----------------+ || || || +----------------+ || || ENDING|| +----------------+ || || || +----------------+ || || </body>||</html> |+------------------------+"""STATUS = {0: u'通过',1: u'失败',2: u'错误',}DEFAULT_TITLE = 'Unit Test Report'DEFAULT_DESCRIPTION = ''# ------------------------------------------------------------------------# HTML TemplateHTML_TMPL = r"""<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="/1999/xhtml"><head><title>%(title)s</title><meta name="generator" content="%(generator)s"/><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><link href="/bootstrap/3.3.0/css/bootstrap.min.css" rel="stylesheet"><script src="/echarts/3.8.5/mon.min.js"></script>%(stylesheet)s</head><body><script language="javascript" type="text/javascript"></script><div id="div_base">%(heading)s%(report)s%(ending)s%(chart_script)s</div></body></html>""" # variables: (title, generator, stylesheet, heading, report, ending, chart_script)ECHARTS_SCRIPT = """<script type="text/javascript">// 基于准备好的dom，初始化echarts实例var myChart = echarts.init(document.getElementById('chart'));// 指定图表的配置项和数据var option = {title : {text: '测试执行情况',x:'center'},tooltip : {trigger: 'item',formatter: "{a} <br/>{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);</script>""" # variables: (Pass, fail, error)# ------------------------------------------------------------------------# Stylesheet## alternatively use a <link> for external style sheet, e.g.# <link rel="stylesheet" href="$url" type="text/css">STYLESHEET_TMPL = """<style type="text/css" media="screen">body { font-family: Microsoft YaHei,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;}/* -- css div popup ------------------------------------------------------------------------ */a.popup_link {}a.popup_link:hover {color: red;}.popup_window {display: none;position: relative;left: 0px;top: 0px;/*border: solid #627173 1px; */padding: 10px;/*background-color: #E6E6D6; */font-family: "Lucida Console", "Courier New", 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: -15px 0 0 0;}</style>"""# ------------------------------------------------------------------------# Heading#HEADING_TMPL = """<div class='page-header'><h1>%(title)s</h1>%(parameters)s</div><div style="float: left;width:50%%;"><p class='description'>%(description)s</p></div><div id="chart" style="width:50%%;height:400px;float:left;"></div>""" # variables: (title, parameters, description)HEADING_ATTRIBUTE_TMPL = """<p class='attribute'><strong>%(name)s:</strong> %(value)s</p>""" # variables: (name, value)# ------------------------------------------------------------------------# Report#REPORT_TMPL = u"""<div class="btn-group btn-group-sm"><button class="btn btn-default" οnclick='javascript:showCase(0)'>总结</button><button class="btn btn-default" οnclick='javascript:showCase(1)'>失败</button><button class="btn btn-default" οnclick='javascript:showCase(2)'>全部</button></div><p></p><table id='result_table' class="table table-bordered"><colgroup><col align='left' /><col align='right' /><col align='right' /><col align='right' /><col align='right' /><col align='right' /></colgroup><tr id='header_row'><td>测试用例</td><td>总数</td><td>通过</td><td>失败</td><td>错误</td><td>查看</td></tr>%(test_list)s<tr id='total_row'><td>总计</td><td>%(count)s</td><td>%(Pass)s</td><td>%(fail)s</td><td>%(error)s</td><td> </td></tr></table>""" # variables: (test_list, count, Pass, fail, error)REPORT_CLASS_TMPL = u"""<tr class='%(style)s'><td>%(desc)s</td><td>%(count)s</td><td>%(Pass)s</td><td>%(fail)s</td><td>%(error)s</td><td><a href="javascript:showClassDetail('%(cid)s',%(count)s)">详情</a></td></tr>""" # variables: (style, desc, count, Pass, fail, error, cid)REPORT_TEST_WITH_OUTPUT_TMPL = r"""<tr id='%(tid)s' class='%(Class)s'><td class='%(style)s'><div class='testcase'>%(desc)s</div></td><td colspan='5' align='center'><a class="popup_link" οnfοcus='this.blur();' href="javascript:showTestDetail('div_%(tid)s')" >%(status)s</a><div id='div_%(tid)s' class="popup_window"><pre>%(script)s</pre></div></td></tr>""" # variables: (tid, Class, style, desc, status)REPORT_TEST_NO_OUTPUT_TMPL = r"""<tr id='%(tid)s' class='%(Class)s'><td class='%(style)s'><div class='testcase'>%(desc)s</div></td><td colspan='5' align='center'>%(status)s</td></tr>""" # variables: (tid, Class, style, desc, status)REPORT_TEST_OUTPUT_TMPL = r"""%(id)s: %(output)s""" # variables: (id, output)# ------------------------------------------------------------------------# ENDING#ENDING_TMPL = """<div id='ending'> </div>"""# -------------------- The end of the Template class -------------------TestResult = unittest.TestResultclass _TestResult(TestResult):# note: _TestResult is a pure representation of results.# It lacks the output and reporting ability compares to unittest._TextTestResult.def __init__(self, verbosity=1):TestResult.__init__(self)self.stdout0 = Noneself.stderr0 = Noneself.success_count = 0self.failure_count = 0self.error_count = 0self.verbosity = verbosity# result is a list of result in 4 tuple# (# result code (0: success; 1: fail; 2: error),# TestCase object,# Test output (byte string),# stack trace,# )self.result = []self.subtestlist = []def startTest(self, test):TestResult.startTest(self, test)# just one buffer for both stdout and stderrself.outputBuffer = io.StringIO()stdout_redirector.fp = self.outputBufferstderr_redirector.fp = self.outputBufferself.stdout0 = sys.stdoutself.stderr0 = sys.stderrsys.stdout = stdout_redirectorsys.stderr = stderr_redirectordef complete_output(self):"""Disconnect output redirection and return buffer.Safe to call multiple times."""if self.stdout0:sys.stdout = self.stdout0sys.stderr = self.stderr0self.stdout0 = Noneself.stderr0 = Nonereturn self.outputBuffer.getvalue()def stopTest(self, test):# Usually one of addSuccess, addError or addFailure would have been called.# But there are some path in unittest that would bypass this.# We must disconnect stdout in stopTest(), which is guaranteed to be plete_output()def addSuccess(self, test):if test not in self.subtestlist:self.success_count += 1TestResult.addSuccess(self, test)output = plete_output()self.result.append((0, test, output, ''))if self.verbosity > 1:sys.stderr.write('ok ')sys.stderr.write(str(test))sys.stderr.write('\n')else:sys.stderr.write('.')def addError(self, test, err):self.error_count += 1TestResult.addError(self, test, err)_, _exc_str = self.errors[-1]output = plete_output()self.result.append((2, test, output, _exc_str))if self.verbosity > 1:sys.stderr.write('E ')sys.stderr.write(str(test))sys.stderr.write('\n')else:sys.stderr.write('E')def addFailure(self, test, err):self.failure_count += 1TestResult.addFailure(self, test, err)_, _exc_str = self.failures[-1]output = plete_output()self.result.append((1, test, output, _exc_str))if self.verbosity > 1:sys.stderr.write('F ')sys.stderr.write(str(test))sys.stderr.write('\n')else:sys.stderr.write('F')def addSubTest(self, test, subtest, err):if err is not None:if getattr(self, 'failfast', False):self.stop()if issubclass(err[0], test.failureException):self.failure_count += 1errors = self.failureserrors.append((subtest, self._exc_info_to_string(err, subtest)))output = plete_output()self.result.append((1, test, output + '\nSubTestCase Failed:\n' + str(subtest),self._exc_info_to_string(err, subtest)))if self.verbosity > 1:sys.stderr.write('F ')sys.stderr.write(str(subtest))sys.stderr.write('\n')else:sys.stderr.write('F')else:self.error_count += 1errors = self.errorserrors.append((subtest, self._exc_info_to_string(err, subtest)))output = plete_output()self.result.append((2, test, output + '\nSubTestCase Error:\n' + str(subtest), self._exc_info_to_string(err, subtest)))if self.verbosity > 1:sys.stderr.write('E ')sys.stderr.write(str(subtest))sys.stderr.write('\n')else:sys.stderr.write('E')self._mirrorOutput = Trueelse:self.subtestlist.append(subtest)self.subtestlist.append(test)self.success_count += 1output = plete_output()self.result.append((0, test, output + '\nSubTestCase Pass:\n' + str(subtest), ''))if self.verbosity > 1:sys.stderr.write('ok ')sys.stderr.write(str(subtest))sys.stderr.write('\n')else:sys.stderr.write('.')class HTMLTestRunner(Template_mixin):def __init__(self, stream=sys.stdout, verbosity=1, title=None, description=None):self.stream = streamself.verbosity = verbosityif title is None:self.title = self.DEFAULT_TITLEelse:self.title = titleif description is None:self.description = self.DEFAULT_DESCRIPTIONelse:self.description = descriptionself.startTime = datetime.datetime.now()def run(self, test):"Run the given test case or test suite."result = _TestResult(self.verbosity)test(result)self.stopTime = datetime.datetime.now()self.generateReport(test, result)print('\nTime Elapsed: %s' % (self.stopTime - self.startTime), file=sys.stderr)return resultdef sortResult(self, result_list):# unittest does not seems to run in any particular order.# Here at least we want to group them together by class.rmap = {}classes = []for n, t, o, e in result_list:cls = t.__class__if cls not in rmap:rmap[cls] = []classes.append(cls)rmap[cls].append((n, t, o, e))r = [(cls, rmap[cls]) for cls in classes]return rdef getReportAttributes(self, result):"""Return report attributes as a list of (name, value).Override this to add custom attributes."""startTime = str(self.startTime)[:19]duration = str(self.stopTime - self.startTime)status = []if result.success_count: status.append(u'通过 %s' % result.success_count)if result.failure_count: status.append(u'失败 %s' % result.failure_count)if result.error_count: status.append(u'错误 %s' % result.error_count)if status:status = ' '.join(status)else:status = 'none'return [(u'开始时间', startTime),(u'运行时长', duration),(u'状态', status),]def generateReport(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()chart = self._generate_chart(result)output = self.HTML_TMPL % dict(title=saxutils.escape(self.title),generator=generator,stylesheet=stylesheet,heading=heading,report=report,ending=ending,chart_script=chart)self.stream.write(output.encode('utf8'))def _generate_stylesheet(self):return self.STYLESHEET_TMPLdef _generate_heading(self, report_attrs):a_lines = []for name, value in report_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),)return headingdef _generate_report(self, result):rows = []sortedResult = self.sortResult(result.result)for cid, (cls, cls_results) in enumerate(sortedResult):# subtotal for a classnp = nf = ne = 0for n, t, o, e in cls_results:if n == 0:np += 1elif n == 1:nf += 1else:ne += 1# format class descriptionif cls.__module__ == "__main__":name = cls.__name__else:name = "%s.%s" % (cls.__module__, cls.__name__)doc = cls.__doc__ and cls.__doc__.split("\n")[0] or ""desc = doc and '%s: %s' % (name, doc) or namerow = self.REPORT_CLASS_TMPL % dict(style=ne > 0 and 'errorClass' or nf > 0 and 'failClass' or 'passClass',desc=desc,count=np + nf + ne,Pass=np,fail=nf,error=ne,cid='c%s' % (cid + 1),)rows.append(row)for tid, (n, t, o, e) in enumerate(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),)return reportdef _generate_chart(self, result):chart = self.ECHARTS_SCRIPT % dict(Pass=str(result.success_count),fail=str(result.failure_count),error=str(result.error_count),)return chartdef _generate_report_test(self, rows, cid, tid, n, t, o, e):# e.g. 'pt1.1', 'ft1.1', etchas_output = bool(o or e)tid = (n == 0 and 'p' or 'f') + 't%s.%s' % (cid + 1, tid + 1)name = t.id().split('.')[-1]doc = t.shortDescription() or ""desc = doc and ('%s: %s' % (name, doc)) or nametmpl = has_output and self.REPORT_TEST_WITH_OUTPUT_TMPL or self.REPORT_TEST_NO_OUTPUT_TMPLscript = self.REPORT_TEST_OUTPUT_TMPL % dict(id=tid,output=saxutils.escape(o + e),)row = tmpl % dict(tid=tid,Class=(n == 0 and 'hiddenRow' or 'none'),style=(n == 2 and 'errorCase' or (n == 1 and 'failCase' or 'none')),desc=desc,script=script,status=self.STATUS[n],)rows.append(row)if not has_output:returndef _generate_ending(self):return self.ENDING_TMPL############################################################################### Facilities for running tests from the command line############################################################################### Note: Reuse unittest.TestProgram to launch test. In the future we may# build our own launcher to support more specific command line# parameters like test title, CSS, etc.class TestProgram(unittest.TestProgram):"""A variation of the unittest.TestProgram. Please refer to the baseclass for command line parameters."""def runTests(self):# Pick HTMLTestRunner as the default test runner.# base class's testRunner parameter is not useful because it means# we have to instantiate HTMLTestRunner before we know self.verbosity.if self.testRunner is None:self.testRunner = HTMLTestRunner(verbosity=self.verbosity)unittest.TestProgram.runTests(self)main = TestProgram############################################################################### Executing this module from the command line##############################################################################if __name__ == "__main__":main(module=None)

四、testCase目录

测试用例代码举例：

import jsonimport unittestimport requestsfrom common.configHttp import RunMain#import paramunittest #如果需要解决用例执行顺序，需要在common目录下创建paramunittest.py文件，下面讲到from common import paramunittestfrom testFile import geturlParamsimport urllib.parse# import pythoncomfrom testFile import readExcel# pythoncom.CoInitialize()login_xls1 = readExcel.readExcel().get_xls('文件名', 'sheet页名')@paramunittest.parametrized(*login_xls1)class testUserApi(unittest.TestCase):def setParameters(self, case_name, path, query, method, export):"""set params:param case_name:param path:param query:param method:param export:return:"""self.case_name = str(case_name)self.path = str(path)self.query = str(query)self.method = str(method)self.export = str(export)print(self.query)def description(self):"""test report description:return:"""self.case_namedef setUp(self):""":return:"""print("测试用例名称：" + self.case_name)def test001case(self):self.checkResult()def tearDown(self):print("测试结束，输出log完结\n\n")def checkResult(self): # 断言"""check test result:return:"""url = geturlParams.geturlParams().get_Url() + self.pathprint("接口请求地址：" + str(url))if self.method == 'post':print("接口请求头：" + str(RunMain.header))#api_res = RunMain().run_main(self.method, url, self.query)api_res = RunMain().run_main(self.method, url, json.dumps(json.loads(self.query)))result_res = json.loads(api_res)print("请求响应：" + str(result_res))elif self.method == 'get':print("接口请求头：" + str(RunMain.header))api_res = RunMain().run_main(self.method, url, self.query)result_res = json.loads(api_res) # 将响应转换为字典格式print("请求响应：" + str(result_res))if result_res['code'] == 'SUCCESS':self.assertEqual(str(result_res['code']), self.export)else:self.assertEqual(str(result_res['code']), self.export)print("响应描述：" + result_res['message'])

EXCEL表格数据样式举例如下：

五、runAll.py运行代码如下：

import osimport sys#下面两行代码，解决的是Jenkins持续集成时找不到文件问题object_path = os.path.join(os.path.abspath(os.path.dirname(os.path.dirname(__file__))))sys.path.append(object_path)from common import HTMLTestRunnerfrom common.configEmail import SendEmailimport common.Logfrom testFile import getpathinfoimport unittestfrom testFile import readConfigpath1 = getpathinfo.get_Path()path = os.path.split(path1)[0]report_path = os.path.join(path, 'result')#print('文件父级地址'+report_path)report_file = os.path.join(report_path, 'report.html')#print('文件地址'+report_file)send_mail = SendEmail(username='60@',# 需要去163邮箱设置 163邮箱POP3/SMTP/IMAP 服务，需要开启密码为授权密码，而不是登录密码passwd='VL',recv=['247970@'],title='接口测试',content='测试发送邮件',file=report_file,ssl=True)on_off = readConfig.ReadConfig().get_email('on_off')log = common.Log.loggerclass AllTest: # 定义一个类AllTestdef __init__(self): # 初始化一些参数和数据global resultPath#print(report_path)resultPath = os.path.join(report_path, "report.html") # result/report.htmlself.caseListFile = os.path.join(path1, "caselist") # 配置执行哪些测试文件的配置文件路径self.caseFile = os.path.join(path, "testCase") # 真正的测试断言文件路径self.caseList = []log.info('resultPath: %s', resultPath)log.info('caseListFile: %s', self.caseListFile)log.info('caseFile: %s', self.caseFile)def set_case_list(self):"""读取caselist.txt文件中的用例名称，并添加到caselist元素组:return:"""fb = open(self.caseListFile)for value in fb.readlines():data = str(value)if data != '' and not data.startswith("#"): # 如果data非空且不以#开头self.caseList.append(data.replace("\n", "")) # 读取每行数据会将换行转换为\n，去掉每行数据中的\n#print(data)fb.close()def set_case_suite(self):""":return:"""self.set_case_list() # 通过set_case_list()拿到caselist元素组test_suite = unittest.TestSuite()suite_module = []for case in self.caseList: # 从caselist元素组中循环取出casecase_name = case.split("/")[-1] # 通过split函数来将aaa/bbb分割字符串，-1取后面，0取前面print(case_name + ".py") # 打印出取出来的名称# 批量加载用例，第一个参数为用例存放路径，第一个参数为路径文件名discover = unittest.defaultTestLoader.discover(self.caseFile, pattern=case_name + '.py', top_level_dir=None)suite_module.append(discover) # 将discover存入suite_module元素组#print('suite_module:' + str(suite_module))if len(suite_module) > 0: # 判断suite_module元素组是否存在元素for suite in suite_module: # 如果存在，循环取出元素组内容，命名为suitefor test_name in suite: # 从discover中取出test_name，使用addTest添加到测试集test_suite.addTest(test_name)else:print('else:')return Nonereturn test_suite # 返回测试集def run(self):"""run test:return:"""try:suit = self.set_case_suite() # 调用set_case_suite获取test_suiteprint('try')#print(str(suit))if suit is not None: # 判断test_suite是否为空print('if-suit')fp = open(resultPath, 'wb') # 打开result/1108/report.html测试报告文件，如果不存在就创建# 调用HTMLTestRunnerrunner = HTMLTestRunner.HTMLTestRunner(stream=fp, title='Test Report', description='Test Description')runner.run(suit)else:print("Have no case to test.")except Exception as ex:print(str(ex))log.info(str(ex))finally:print("*********TEST END*********")log.info("*********TEST END*********")fp.close()# 判断邮件发送的开关if on_off == 'on':send_mail.send_email()else:print("邮件发送开关配置关闭，请打开开关后可正常自动发送测试报告")#pythoncom.CoInitialize()#scheduler = BlockingScheduler()#scheduler.add_job(AllTest().run, 'cron', day_of_week='1-5', hour=14, minute=59)#scheduler.start()if __name__ == '__main__':AllTest().run()

注：本文在运行时会发现，测试用例执行顺序并非按照读取excel表格顺序进行执行，主要原因在于unittest框架中testCase执行顺序如下：

用例必须以"test"开头，后面可以接数字、字母、下划线等等，其实，"test"后面可以接的内容除了上面提到的3种外，其他的也可以，执行的优先级按照ASCII表从前到后的排序。
用例执行优先级关系如下:
数字>大写字母>小写字母
数字之间的优先级：0-9
大写字母之间的优先级：A-Z
小写字母之间的优先级：a-z

如果想要用例执行是按照读取excel顺序执行，那么paramunittest文件需要做一些调整，调整之后的代码入下：

import copyimport unittestimport collectionsimport importlibfrom unittest.util import strclass__all__ = ['parametrized','ParametrizedTestCase',]def _process_parameters(parameters_seq):processed_parameters_seq = []for parameters in parameters_seq:if isinstance(parameters, collections.Mapping):processed_parameters_seq.append((tuple(),dict(parameters)))elif (len(parameters) == 2and isinstance(parameters[0], collections.Sequence)and isinstance(parameters[1], collections.Mapping)):processed_parameters_seq.append((tuple(parameters[0]),dict(parameters[1])))else:processed_parameters_seq.append((tuple(parameters),dict()))return processed_parameters_seq# 给用例编号def _build_name(name, index):if index <= 9:index = '00' + str(index)elif index >9 and index <100:index = '0' +str(index)return '%s_%s' % (name, index)# 新增获取序号def num(index):if index < 9:index = '00' + str(index)elif index >=9 and index <100:index = '0' +str(index)return '%s' % (index)class ParametrizedTestCase(unittest.TestCase):def setParameters(self, *args, **kwargs):raise NotImplementedError(('setParameters must be implemented ''because it receives the parameters.'))def getParameters(self):"""Return the parameters with which this test case was instantiated."""raise NotImplementedError('getParameters should have been patched by parametrized.')def getFullParametersSequence(self):raise NotImplementedError('getFullParametersSequence should have been patched by parametrized.')def getTestCaseIndex(self):"""Return the index of the current test case according to the list ofparametes passed to parametrized."""raise NotImplementedError('getTestCaseIndex should have been patched by parametrized.')def getFullParametersSequence(self):"""Return the full normalized list of parameters passed to parametrized."""raise NotImplementedError('getFullParametersSequence should have been patched by parametrized.')def __str__(self):return "%s[%d](%s) (%s)" % (self._testMethodName,self.getTestCaseIndex(),self.getParameters(),strclass(self.__class__))def __repr__(self):return "<%s[%d](%s) testMethod=%s>" % (strclass(self.__class__),self.getTestCaseIndex(),self.getParameters(),self._testMethodName)def parametrized(*parameters_seq):parameters_seq = _process_parameters(parameters_seq)# print(parameters_seq)def magic_module_set_test_case(cls):if not hasattr(cls, 'setParameters'):raise TypeError('%s does not have a setParameters method.' % (cls.__name__, ))module = importlib.import_module(cls.__module__)for index, parameters in enumerate(parameters_seq):name = _build_name(cls.__name__, index)def closing_over(parameters=parameters, index=index):def setUp(self):self.setParameters(*parameters[0], **parameters[1])cls.setUp(self)def getParameters(self):"""Return the parameters with which this test case was instantiated."""return parametersdef getTestCaseIndex(self):"""Return the index of the current test case according to the list ofparametes passed to parametrized."""return indexdef getFullParametersSequence(self):"""Return the full normalized list of parameters passed to parametrized."""return copy.copy(parameters_seq)return setUp, getParameters, getTestCaseIndex, getFullParametersSequence(set_up, get_parameters,get_test_case_index,get_full_parameters_sequence) = closing_over()new_class = type(name, (cls, ),{'setUp': set_up,'getParameters': get_parameters,'getTestCaseIndex': get_test_case_index,'getFullParametersSequence': get_full_parameters_sequence})#print(name,"=============")setattr(module, name, new_class)return None # this is explicit!return magic_module_set_test_case

调整执行顺序前后执行结果对比：

调整前：

调整后：

总结

接口自动化测试over,后续更新一下怎么持续集成并定时执行吧！