基于Pytest+Requests+Allure实现接口自动化测试

一、整体结构

框架组成：pytest+requests+allure

设计模式：

关键字驱动

项目结构：

1. 工具层：api_keyword/

2. 参数层：params/

3. 用例层：case/

4. 数据驱动：data_driver/

5. 数据层：data/

6. 逻辑层：logic/

二、具体步骤及代码

1、工具层

将get、post等常用行为进行二次封装。

代码（api_key.py）如下：

1. import allure

2. import json

3. import jsonpath

4. import requests

6. # 定义一个关键字类

7. class ApiKey:

8. # 将get请求行为进行封装

9. @allure.step("发送get请求")

10. def get(self, url, params=None, **kwargs):

11. return requests.get(url=url, params=params, **kwargs)

13. # 将post请求行为进行封装

14. @allure.step("发送post请求")

15. def post(self, url, data=None, **kwargs):

16. return requests.post(url=url, data=data, **kwargs)

18. # 由于接口之间可能相互关联，因此下一个接口需要上一个接口的某个返回值，此处采用jsonpath对上一个接口返回的值进行定位并取值

19. @allure.step("获取返回结果字典值")

20. def get_text(self, data, key):

21. # json数据转换为字典

22. json_data = json.loads(data)

23. # jsonpath取值

24. value = jsonpath.jsonpath(json_data, '$..{0}'.format(key))

25. return value[0]

其中引用allure.step()装饰器进行步骤详细描述，使测试报告更加详细。

使用jsonpath对接口的返回值进行取值。

2、数据层

数据采用yaml文件。

代码（user.yaml）如下：

1. -

2. user:

3. username: admin

4. password: '123456'

5. msg: success

6. title: 输入正确账号、密码，登录成功

7. -

8. user:

9. username: admin1

10. password: '1234561'

11. msg: 用户名或密码错误

12. title: 输入错误账号1、密码1，登录失败

13. -

14. user:

15. username: admin2

16. password: '1234562'

17. msg: 用户名或密码错误

18. title: 输入错误账号2、密码2，登录失败

其中title是为了在用例进行时动态获取参数生成标题。

3、数据驱动层

对数据进行读写。

代码（yaml.driver.py）如下:

1. import yaml

4. def load_yaml(path):

5. file = open(path, 'r', encoding='utf-8')

6. data = yaml.load(file, Loader=yaml.FullLoader)

7. return data

4、参数层

参数层存放公共使用的参数，在使用时对其进行调用。

代码（allParams.py）如下：

1. '''python

2. 规则：

3. 全局变量使用大写字母表示

4. '''

6. # 地址

7. URL = 'http://39.98.138.157:'

9. # 端口

10. PORT = '5000'

5、逻辑层

用例一：进行登录的接口请求，此处登录请求在yaml文件里设置了三组不同的数据进行请求。

用例二：进行个人查询的接口请求，此处需要用到登录接口返回的token值。

用例三、进行添加商品到购物车的接口请求，此处需要用到登录接口返回的token值以及个人查询接口返回的openid、userid值

用例四、进行下单的接口请求，此处需要用到登录接口返回的token值以及个人查询接口返回的openid、userid、cartid值

注意：由于多数接口需要用到登录接口返回的token值，因此封装一个conftest.py定义项目级前置fixture，在整个项目只执行一次，可以在各个用例中进行调用（其他共用参数也可以采取类似前置定义）。同时由于此处定义的项目级fixture，因此可以将初始化工具类ak = ApiKey()也放入其中。
代码（conftest.py）如下：

1. from random import random

3. import allure

4. import pytest

6. from pytest_demo_2.api_keyword.api_key import ApiKey

7. from pytest_demo_2.params.allParams import *

10. def pytest_collection_modifyitems(items):

11. """

12. 测试用例收集完成时，将收集到的item的name和nodeid的中文显示在控制台上

13. """

14. for item in items:

15. item.name = item.name.encode("utf-8").decode("unicode_escape")

16. item._nodeid = item.nodeid.encode("utf-8").decode("unicode_escape")

19. # 项目级fix，整个项目只初始化一次

20. @pytest.fixture(scope='session')

21. def token_fix():

22. # 初始化工具类`在这里插入代码片`

23. ak = ApiKey()

24. with allure.step("发送登录接口请求，并获取token，整个项目只生成一次"):

25. # 请求接口

26. # url = 'http://39.98.138.157:5000/api/login'

27. url = URL + PORT + '/api/login'

28. # 请求参数

29. userInfo = {

30. 'username': 'admin',

31. 'password': '123456'

32. }

33. # post请求

34. res = ak.post(url=url, json=userInfo)

35. # 获取token

36. token = ak.get_text(res.text, 'token')

37. # 验证代码，验证token只生成一次

38. token_random = random()

39. return ak, token, res, token_random

其中也包含了防止中文乱码，加入了pytest_collection_modifyitems（函数）。

设置好conftest后，就可以应用在逻辑层里面了。

代码（shopingApi.py）如下：

1. import pytest

2. import allure

3. from pytest_demo_2.api_keyword.api_key import ApiKey

4. from pytest_demo_2.params.allParams import *

7. class ApiCase():

8. # 登录逻辑

9. def params_login(self, userdata):

10. # 动态获取参数生成标题

11. allure.dynamic.title(userdata['title'])

12. # 初始化工具类

13. ak = ApiKey()

14. # 请求接口

15. url = URL + PORT + '/api/login'

16. # 请求参数

17. userInfo = {

18. 'username': userdata['user']['username'],

19. 'password': userdata['user']['password']

20. }

21. res = ak.post(url=url, json=userInfo)

22. with allure.step("接口返回信息校验及打印"):

23. print("/api/login登录接口请求响应信息")

24. print(res.text)

25. # 获取响应结果

26. msg = ak.get_text(res.text, 'msg')

27. print(msg)

28. # 断言

29. assert msg == userdata['msg']

31. def params_getuserinfo(self, token_fix):

32. # 从fix中获取预置的工具类和token,所有返回值都需要接收

33. ak, token, res, token_random01 = token_fix

34. with allure.step("发送个人查询接口请求"):

35. url = URL + PORT + '/api/getuserinfo'

36. headers = {

37. 'token': token

38. }

39. res1 = ak.get(url=url, headers=headers)

40. with allure.step("接口返回信息校验及打印"):

41. print("/api/getuserinfo个人用户查询接口请求响应信息")

42. print(res1.text)

43. # print("验证的random值，测试用")

44. # print(token_random01)

45. name = ak.get_text(res1.text, 'nikename')

46. # 断言

47. assert "风清扬" == name

48. return res1

50. def params_addcart(self, token_fix):

51. # 从fix中获取预置的工具类和token

52. # 所有返回都要获取，不然会报错

53. ak, token, res, token_random01 = token_fix

54. with allure.step("调用getuserinfo接口获取返回信息"):

55. res1 = self.params_getuserinfo(token_fix)

56. with allure.step("发送添加商品到购物车请求"):

57. # 添加商品到购物车,基于token、userid、openid、productid

58. url = URL + PORT + '/api/addcart'

59. hd = {

60. "token": token

61. }

62. data = {

63. "userid": ak.get_text(res1.text, 'userid'),

64. "openid": ak.get_text(res1.text, 'openid'),

65. "productid": 8888

66. }

67. # 发送请求

68. res2 = ak.post(url=url, headers=hd, json=data)

69. with allure.step("接口返回信息校验及打印"):

70. print("/api/addcart添加商品到购物车请求响应信息")

71. print(res2.text)

72. # print("验证的random值，测试用")

73. # print(token_random01)

74. result = ak.get_text(res2.text, 'result')

75. assert 'success' == result

76. return res2

78. def params_createorder(self, token_fix):

79. ak, token, res, token_random01 = token_fix

80. with allure.step("调用addcart接口获取返回信息"):

81. res1 = self.params_addcart(token_fix)

82. with allure.step("发送下单请求"):

83. url = URL + PORT + '/api/createorder'

84. # 从项目级fix中获取token

85. hd = {

86. "token": token

87. }

88. # 从添加商品到购物车接口中获取userid,openid,cartid

89. data = {

90. "userid": ak.get_text(res1.text, 'userid'),

91. "openid": ak.get_text(res1.text, 'openid'),

92. "productid": 8888,

93. "cartid": ak.get_text(res1.text, 'cartid')

94. }

95. res2 = ak.post(url=url, headers=hd, json=data)

96. with allure.step("接口返回信息校验及打印"):

97. print("/api/createorder下单请求响应信息")

98. print(res2.text)

99. # print("验证的random值，测试用")

100. # print(token_random01)

101. result = ak.get_text(res1.text, 'result')

102. assert 'success' == result

6、用例层

调用逻辑层进行用例管理和数据传输。

代码（test_Tree.py）如下：

1. import allure

2. import pytest

3. from pytest_demo_2.data_driver import yaml_driver

4. from pytest_demo_2.logic.shopingApi import ApiCase

7. @allure.epic("shopXo电商平台接口-接口测试")

8. class TestTree():

9. # 初始化用例库

10. actions1 = ApiCase()

12. @allure.feature("01.登陆")

13. @allure.story("02.一般场景")

14. @pytest.mark.parametrize('userdata', yaml_driver.load_yaml('./data/user.yaml'))

15. def test_case01(self, userdata):

16. self.actions1.params_login(userdata)

18. @allure.feature("02.个人查询")

19. @allure.story("01.典型场景")

20. @allure.title("个人查询")

21. def test_case02(self, token_fix):

22. self.actions1.params_getuserinfo(token_fix)

24. @allure.feature("03.添加商品到购物车")

25. @allure.story("01.典型场景")

26. @allure.title("添加商品到购物车")

27. def test_case03(self, token_fix):

28. self.actions1.params_addcart(token_fix)

30. @allure.feature("04.下单")

31. @allure.story("01.典型场景")

32. @allure.title("下单")

33. def test_case04(self, token_fix):

34. self.actions1.params_createorder(token_fix)

7、运行

代码（main_run.py）如下：

1. import os

2. import pytest

5. def run():

6. pytest.main(['-v', './case/test_Tree.py',

7. '--alluredir', './result', '--clean-alluredir'])

8. os.system('allure serve result')

9. # os.system('allure generate ./result/ -o ./report_allure/ --clean')

11. if __name__ == '__main__':

12. run()

8、结果

感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你!有需要的小伙伴可以点击下方小卡片领取