参考网址：https://blog.csdn.net/songlh1234/article/details/84317617
Python+unittest+requests+HTMLTestRunner 完整的接口自动化测试框架搭建
一、00——框架结构简解
大家可以先简单了解下该项目的目录结构介绍，后面会针对每个文件有详细注解和代码。
common：
——configDb.py：这个文件主要编写数据库连接池的相关内容，本项目暂未考虑使用数据库来存储读取数据，此文件可忽略，或者不创建。本人是留着以后如果有相关操作时，方便使用。
——configEmail.py：这个文件主要是配置发送邮件的主题、正文等，将测试报告发送并抄送到相关人邮箱的逻辑。
——configHttp.py：这个文件主要来通过get、post、put、delete等方法来进行http请求，并拿到请求响应。
——HTMLTestRunner.py：主要是生成测试报告相关
——Log.py：调用该类的方法，用来打印生成日志
result:
——logs：生成的日志文件
——report.html：生成的测试报告
testCase:
——test01case.py：读取userCase.xlsx中的用例，使用unittest来进行断言校验
testFile/case:
——userCase.xlsx：对下面test_api.py接口服务里的接口，设计了三条简单的测试用例，如参数为null，参数不正确等
caselist.txt：配置将要执行testCase目录下的哪些用例文件，前加#代表不进行执行。当项目过于庞大，用例足够多的时候，我们可以通过这个开关，来确定本次执行哪些接口的哪些用例。
config.ini：数据库、邮箱、接口等的配置项，用于方便的调用读取。
getpathInfo.py：获取项目绝对路径
geturlParams.py：获取接口的URL、参数、method等
readConfig.py：读取配置文件的方法，并返回文件中内容
readExcel.py：读取Excel的方法
runAll.py：开始执行接口自动化，项目工程部署完毕后直接运行该文件即可
test_api.py：自己写的提供本地测试的接口服务
test_sql.py：测试数据库连接池的文件，本次项目未用到数据库，可以忽略
二、01——测试接口服务
模拟一个简单的接口（安装库，cmd窗口输入命令，pip install flask）
按第一讲的目录创建好文件，打开test_api.py，写入如下代码
import flask
import json
from flask import request
'''
flask： web框架，通过flask提供的装饰器@server.route()将普通函数转换为服
'''
# 创建一个服务，把当前这个python文件当做一个服务
server = flask.Flask(__name__)
# @server.route()可以将普通函数转变为服务 登录接口的路径、请求方式
@server.route('/login', methods=['get', 'post'])
def login():
# 获取通过url请求传参的数据
username = request.values.get('name')
# 获取url请求传的密码，明文
pwd = request.values.get('pwd')
# 判断用户名、密码都不为空
if username and pwd:
if username == 'xiaoming' and pwd == '111':
resu = {'code': 200, 'message': '登录成功'}
return json.dumps(resu, ensure_ascii=False) # 将字典转换字符串
else:
resu = {'code': -1, 'message': '账号密码错误'}
return json.dumps(resu, ensure_ascii=False)
else:
resu = {'code': 10001, 'message': '参数不能为空！'}
return json.dumps(resu, ensure_ascii=False)
if __name__ == '__main__':
server.run(debug=True, port=8888, host='127.0.0.1')
执行test_api.py，在浏览器中输入http://127.0.0.1:8888/login?name=xiaoming&pwd=11199回车，验证我们的接口服务是否正常~
变更我们的参数，查看不同的响应结果确认接口服务一切正常
三、02——配置文件读取
在我们第二讲中，我们已经通过flask这个web框架创建好了我们用于测试的接口服务，因此我们可以把这个接口抽出来一些参数放到配置文件，然后通过一个读取配置文件的方法，方便后续的使用。同样还有邮件的相关配置~
（1）config.ini
按第一讲的目录创建好config.ini文件，打开该文件写入如下：
# -*- coding: utf-8 -*-
[HTTP]
scheme = http
baseurl = 127.0.0.1
port = 8888
timeout = 10.0
[EMAIL]
on_off = on;
subject = 接口自动化测试报告
app = Outlook
addressee = [email protected]
cc = [email protected]
在HTTP中，协议http，baseURL，端口，超时时间。
在EMAIL中on_off是设置的一个开关，=on打开，发送邮件，=其他不发送邮件。subject邮件主题，addressee收件人，cc抄送人。
（2）getpathInfo.py
在我们编写readConfig.py文件前，我们先写一个获取项目某路径下某文件绝对路径的一个方法。按第一讲的目录结构创建好getpathInfo.py，打开该文件
import os
def get_Path():
#方法一：
# path = os.path.split(os.path.realpath(__file__))[0] # 获取当前执行脚本的绝对路径（去掉文件名，只返回目录 ）
# [0]#path = os.path.realpath(__file__) #获取当前执行脚本的绝对路径
# path = os.path.split(os.path.realpath(__file__)) # os.path.split()用法：按照路径将文件名和路径分割开
#方法二：
path = os.path.dirname(__file__) # 获取当前执行脚本的绝对路径（去掉文件名，只返回目录 ）
return path
if __name__ == '__main__': # 执行该文件，测试下是否OK
print('测试路径是否OK,路径为：', get_Path())
（3）readConfig.py
继续往下走，同理，按第一讲目录创建好readConfig.py文件，打开该文件，以后的章节不在累赘
import os
import configparser
import getpathInfo # 引入我们自己的写的获取路径的类
path = getpathInfo.get_Path() # 调用实例化，还记得这个类返回的路径为*（当前执行脚本的绝对路径)*
config_path = os.path.join(path, 'config.ini')#这句话是在path路径下再加一级，最后变成C:\Users\songlihui\PycharmProjects\dkxinterfaceTest\config.ini
config = configparser.ConfigParser()#调用外部的读取配置文件的方法
config.read(config_path, encoding='utf-8')
class ReadConfig():
def get_http(self, name):
value = config.get('HTTP', name)
return value
def get_email(self, name):
value = config.get('EMAIL', name)
return value
def get_mysql(self, name):#写好，留以后备用。但是因为我们没有对数据库的操作，所以这个可以屏蔽掉
value = config.get('DATABASE', name)
return value
if __name__ == '__main__':#测试一下，我们读取配置文件的方法是否可用
print('HTTP中的baseurl值为：', ReadConfig().get_http('baseurl'))
print('EMAIL中的开关on_off值为：', ReadConfig().get_email('on_off'))
执行下readConfig.py，查看数据是否正确
HTTP中的baseurl值为： 127.0.0.1
EMAIL中的开关on_off值为： on;
四、03——读取Excel中的case
配置文件写好了，接口我们也有了，然后我们来根据我们的接口设计我们简单的几条用例。将对这个接口的用例写在一个对应的单独文件中testFile\case\userCase.xlsx ，userCase.xlsx内容如下：
1.png
（1）readExcel.py
紧接着，我们有了用例设计的Excel了，我们要对这个Excel进行数据的读取操作，继续往下，我们创建readExcel.py文件
# -*- coding:utf-8 -*-
import os
import getpathInfo # 自己定义的内部类，该类返回项目的绝对路径
# 调用读Excel的第三方库xlrd
from xlrd import open_workbook
# 拿到该项目所在的绝对路径
path = getpathInfo.get_Path()
class readExcel():
def get_xls(self, xls_name, sheet_name): # xls_name填写用例的Excel名称 sheet_name该Excel的sheet名称
cls = []
# 获取用例文件路径
xlsPath = os.path.join(path, 'testfile',xls_name)
#得到的路径应该是这样的：E:/untitled/apiautomation/testfile/usercase.xlsx
print('用例的路径为: %s'%(xlsPath))
file = open_workbook(xlsPath) # 打开excel文件
sheet = file.sheet_by_name(sheet_name) # 这里的sheet_name是表格名，获得打开Excel的表格
# 获取这个表格的内容行数
nrows = sheet.nrows
print('%s表的行数为: %s'%(sheet_name,nrows))
'''
row_values()用法
print(sheet.row_values(0)) # 表格第一行的数据为一个列表
print(sheet.row_values(0)[0]) # 列表的第一个，则是表格第一行的第一列数据
'''
for i in range(nrows): # 根据行数做循环，for i in range()用法，这里行数是4的话，就是i依次输出为0 1 2 3
if sheet.row_values(i)[0] != 'case_name': # 如果这个Excel的这个sheet的第i行的第一列不等于case_name那么我们把这行的数据添加到cls[]
cls.append(sheet.row_values(i)) #append用法，就是在cls列表插入
return cls
if __name__ == '__main__': # 我们执行该文件测试一下是否可以正确获取Excel中的值
cls = readExcel().get_xls('usercase.xlsx', 'Sheet1') #参数传入文件名和表格名
print('cls数组为：')
for i in cls:
print(i)
print(cls[0][1]) #表格中第1行，第2列
print(cls[2][3]) #表格中第3行，第4列
执行结果
用例的路径为: E:\untitled\apiautomation\testfile\usercase.xlsx
Sheet1表的行数为: 4
cls数组为：
['登录', '/login', 'name=xiaoming&pwd=111', 'post']
['login_error', '/login', 'name=xiaoming&pwd=111222', 'post']
['login_null', '/login', 'name=xiaoming&pwd=', 'post']
/login
post
五、04——requests请求
（1）configHttp.py
配置文件有了，读取配置文件有了，用例有了，读取用例有了，我们的接口服务有了，我们是不是该写对某个接口进行http请求了，这时候我们需要使用pip install requests来安装第三方库，在common下configHttp.py，configHttp.py的内容如下：
import requests
import json
class RunMain():
def send_post(self, url, data): # 定义一个方法，传入需要的参数url和data
# 参数必须按照url、data顺序传入
result = requests.post(url=url, data=data).json() # 因为这里要封装post方法，所以这里的url和data值不能写死
res = json.dumps(result, ensure_ascii=False, sort_keys=True, indent=2)
return res
def send_get(self, url, data):
result = requests.get(url=url, params=data).json()
res = json.dumps(result, ensure_ascii=False, sort_keys=True, indent=2)
return res
def run_main(self, method, url=None, data=None): # 定义一个run_main函数，通过传过来的method来进行不同的get或post请求
result = None
if method == 'post':
result = self.send_post(url, data)
elif method == 'get':
result = self.send_get(url, data)
else:
print("method值错误！！！")
return result
if __name__ == '__main__': # 通过写死参数，来验证我们写的请求是否正确
result1 = RunMain().run_main('post', 'http://127.0.0.1:8888/login', {'name': 'xiaoming', 'pwd': '111'})
result2 = RunMain().run_main('get', 'http://127.0.0.1:8888/login', 'name=xiaoming&pwd=111')
result3 = RunMain().run_main('get', 'http://127.0.0.1:8888/login')
print(result1)
print(result2)
print(result3)
执行结果
{
"code": 200,
"message": "登录成功"
}
{
"code": 200,
"message": "登录成功"
}
{
"code": 10001,
"message": "参数不能为空！"
}
相关知识点：
Skipkeys：默认值是False，如果dict的keys内的数据不是python的基本类型(str,unicode,int,long,float,bool,None)，设置为False时，就会报TypeError的错误。此时设置成True，则会跳过这类key
ensure_ascii：默认值True，如果dict内含有non-ASCII的字符，则会类似\uXXXX的显示数据，设置成False后，就能正常显示
indent：应该是一个非负的整型，如果是0，或者为空，则一行显示数据，否则会换行且按照indent的数量显示前面的空白，这样打印出来的json数据也叫pretty-printed json
separators：分隔符，实际上是(item_separator, dict_separator)的一个元组，默认的就是(‘,’,’:’)；这表示dictionary内keys之间用“,”隔开，而KEY和value之间用“：”隔开。
encoding：默认是UTF-8，设置json数据的编码方式。
sort_keys：将数据根据keys的值进行排序。
六、05——参数动态化
（1）geturlParams.py
在上一讲中，我们写了针对我们的接口服务，设计的三种测试用例，使用写死的参数（result = RunMain().run_main('post', 'http://127.0.0.1:8888/login', 'name=xiaoming&pwd=')）来进行requests请求。本讲中我们写一个类，来用于分别获取这些参数，来第一讲的目录创建geturlParams.py，geturlParams.py文件中的内容如下：
import readConfig as readConfig
readconfig = readConfig.ReadConfig()
class geturlParams(): # 定义一个方法，将从配置文件中读取的进行拼接
def get_Url(self):
new_url = readconfig.get_http('scheme') + '://' + readconfig.get_http('baseurl') + ':' + readconfig.get_http('port') + '/login' + '?'
# logger.info('new_url'+new_url)
return new_url
if __name__ == '__main__': # 验证拼接后的正确性
print(geturlParams().get_Url())
执行结果
http://127.0.0.1:8888/login?
七、06——unittest断言
（1）test01case.py
以上的我们都准备好了，剩下的该写我们的unittest断言测试case了，在testCase下创建test01case.py文件，文件中内容如下：
import json
import unittest
from common.configHttp import RunMain
import paramunittest
import geturlParams
import urllib.parse
# import pythoncom
import readExcel
# pythoncom.CoInitialize()
url = geturlParams.geturlParams().get_Url()# 调用我们的geturlParams获取我们拼接的URL
login_xls = readExcel.readExcel().get_xls('userCase.xlsx', 'login')
@paramunittest.parametrized(*login_xls)
class testUserLogin(unittest.TestCase):
def setParameters(self, case_name, path, query, method):
"""
set params
:param case_name:
:param path
:param query
:param method
:return:
"""
self.case_name = str(case_name)
self.path = str(path)
self.query = str(query)
self.method = str(method)
def description(self):
"""
test report description
:return:
"""
self.case_name
def setUp(self):
"""
:return:
"""
print(self.case_name+"测试开始前准备")
def test01case(self):
self.checkResult()
def tearDown(self):
print("测试结束，输出log完结\n\n")
def checkResult(self):# 断言
"""
check test result
:return:
"""
url1 = "http://www.xxx.com/login?"
new_url = url1 + self.query
data1 = dict(urllib.parse.parse_qsl(urllib.parse.urlsplit(new_url).query))# 将一个完整的URL中的name=&pwd=转换为{'name':'xxx','pwd':'bbb'}
info = RunMain().run_main(self.method, url, data1)# 根据Excel中的method调用run_main来进行requests请求，并拿到响应
ss = json.loads(info)# 将响应转换为字典格式
if self.case_name == 'login':# 如果case_name是login，说明合法，返回的code应该为200
self.assertEqual(ss['code'], 200)
if self.case_name == 'login_error':# 同上
self.assertEqual(ss['code'], -1)
if self.case_name == 'login_null':# 同上
self.assertEqual(ss['code'], 10001)
八、07——HTMLTestRunner
（1）HTMLTestRunner.py
按我的目录结构，在common下创建HTMLTestRunner.py文件，内容如下：
"""
A TestRunner for use with the Python unit testing framework. It
generates 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 unittest
import 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 file
fp = 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 options
runner.STYLESHEET_TMPL = ''
# run the test
runner.run(my_test_suite)
------------------------------------------------------------------------
Copyright (c) 2004-2007, Wai Yip Tung
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* 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 copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name Wai Yip Tung nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
OR 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, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
# URL: http://tungwaiyip.info/software/HTMLTestRunner.html
__author__ = "Wai Yip Tung"
__version__ = "0.8.2"
"""
Change History
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
%(heading)s
%(report)s
%(ending)s