python restful api测试框架_Python搭建接口自动化测试框架

环境准备Python 3.6 + pycharm用到的库：requests，HTMLTestRunner，unittestrequests：HTTP for Humans，官网(http://docs.python-requests.org/en/master/)解释就是牛掰，就是处理http请求的，关于http请求，可以看文章：http://www.jianshu.com/p/b8f9f89d8

weixin_39760433

748人浏览 · 2020-12-17 22:26:30

weixin_39760433 · 2020-12-17 22:26:30 发布

环境准备

Python 3.6 + pycharm

用到的库：requests，HTMLTestRunner，unittest

requests：HTTP for Humans，官网(http://docs.python-requests.org/en/master/)解释就是牛掰，就是处理http请求的，关于http请求，可以看文章：http://www.jianshu.com/p/b8f9f89d8869；HTMLTestRunner运行测试集用例并生成html测试报告；unittest Python单元测试框架。

开始搭框架

image.png

整个框架的结构是这样的，很简单但是够清晰：

api_call：里面的文件是对服务端提供的接口进行封装，至于为什么中间多出两级distribute>vo2是为了对版本进行很好的标志和控制，v02代表我们项目现在是2.0.X 的版本，下面是获取用户token的接口封装例子：

class GetAccessToken(Http):

def getAdminToken(self, username):

body = {

}

response = self.post("/api/v1/oauth/token", body)

return response

def getUserToken(self, phone):

body = {

}

response = self.post("/api/v1/oauth/token", body)

return response

该类继承自Http,Http类的封装见下文

cof:对公用类的封装，host文件主要是配置host和port，http是对http常用方法及返回结果的处理，restful文件是对restful接口返回结果的处理。

(1)Http.py下面是对post方法的封装

class Http():

"""

对http的常用请求方法进行封装

"""

def init(self):

self.host = ""

self.port = ""

# 默认的header，内容遵循restful接口规范要求

self.header = {

"Accept": "application/json",

"Content-Type": "application/json"

}

def post(self, url, dictData):

response = requests.post(self.host+url, data=json.dumps(dictData), headers=self.header)

res = dict()

res["request"] = "methon=post" + " " + self.host + ":" + self.port + url + " " + "body = " + json.dumps(dictData)

res["code"] = response.status_code

res["data"] = response.text

return res

init ：host和port应是从host文件取得，设置请求头

post：传的参数为url和请求体，请求体的数字格式为字典，使用requests库的post方法，将返回的数据作简单分离处理res["request"]请求的基本信息， res["code"] = response.status_code请求返回的状态吗，res["data"] = response.text响应数据。将这些分离放入一个字典里并返回字典。这一步的处理是为了断言和出错处理，尤为重要。

(2)restful.py:restful风格接口的返回值处理方法。对返回的状态码和期望的状态码作比较，如果不一致，给出错误信息(其实这部是对撞他码的断言)如果一致，返回正确的数据，以供数据断言，在github的代码中注释地很详细，文末有地址。

runner：下面的HTMLTestRunner是Python的一个测试报告生成库，格式为html文档，这里是Python3的版本，runnerTest.py是测试类：

suite = unittest.TestSuite()

suite.addTest(unittest.makeSuite(rides.rideTest))

fp = open(filename, 'wb')

runner = HTMLTestRunner.HTMLTestRunner(

stream = fp,

title ='顺道嘉接口测试报告',

description = '顺道嘉接口测试报告')

runner.run(suite)#执行测试

fp.close()#关闭文件，否则会无法生成文件

简单解释一下：第一步创建测试套，往测试套里添加测试集，运行。生成测试文件，详细代码见github，里边运行完后可以发送测试邮件给相关人员。

testcase：测试用例，直接粘代码，因为我写代码真的很爱注释(菜鸟)

class rideTest(unittest.TestCase):

def setUp(self):

"""

测试类的构造方法

该方法会在每个case运行前被调用一次

"""

# 实例化接口调用对象

self.rides = rides.Rides()

self.carpool = carpool.Carpool()

# 随机数对象

self.rnd = CoRandM.CoRand()

self.rf = CoRestful.Restful()

self.nowTime = datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S")

# 记录创建资源的标志

self.flag = 0

response_createOrder = self.rides.postPassengerOrder("88881713123", 4, 16, self.nowTime)

message = "创建订单失败"

code = 201

data_dict = self.rf.parse_response(response_createOrder, code, message)

self.ret_id = data_dict['id']

self.set_create_flag()

def set_create_flag(self):

"""

将资源创建标志设置为1，表示有创建过资源

"""

self.flag = 1

print("创建资源 %s 成功" % str(self.ret_id))

def tearDown(self):

"""

测试类的析构方法

该方法会在每个case运行后被调用一次

"""

# 删除服务，回收数据

if self.flag != 0:

response_del = self.rides.deleteRide(self.ret_id)

message = "删除订单失败"

code = 204

data_dec_del = self.rf.parse_response(response_del, code, message)

self.flag = 0

print("删除资源 %s 成功" % str(self.ret_id))

def test_fromPendingToRate_ok(self):

driverPhone = "88889876123"

driverID = 185

routeID = 16

#这里是调用api_call里面的相应方法

driverInlineResponse = self.carpool.makeDriverOnline(driverPhone, routeID)

# 给出错误信息和期望的状态码，若返回的状态码不合预期，则测试失败，返回错误信息，若合，则返回响应数据

message = "司机出车失败"

code = 201

response_dict = self.rf.parse_response(driverInlineResponse, code, message)

# 返回数据完整性断言

assert_that(response_dict, has_key('id'))

assert_that(response_dict, has_key('route_id'))

assert_that(response_dict, has_key('status'))

assert_that(response_dict, has_key('passengers'))

assert_that(response_dict, has_key('fee'))

assert_that(response_dict, has_key('route_direction'))

# 返回数据正确性断言

assert_that(response_dict['id'], equal_to(self.ret_id))

assert_that(response_dict['route_id'], equal_to(routeID))

assert_that(response_dict['status'], equal_to("accepted"))

def test_fromPendingToRate_ok(self):是一个测试用例，我这里是一个订单从创建到完成的用例，创建放在setup方法里实现，因为涉及到数据的销货，放在测试用例里数据里，当多个用例一起执行时，资源没法唯一正确标识。 def setUp(self):每个用例执行前都会执行该方法，可以把一些常量在该方法中初始化。def tearDown(self):每个用例执行后都会执行该方法，可作数据销毁操作。

后面的ini文件是环境配置文件，可在此文件中选择运行环境。

github地址https://github.com/sunsy22/apiTest

又到了搬砖的时间，点点点不易