接口自动化框架(Pytest+request+Allure)

前言：

接口自动化是指模拟程序接口层面的自动化，由于接口不易变更，维护成本更小，所以深受各大公司的喜爱。
接口自动化包含2个部分，功能性的接口自动化测试和并发接口自动化测试。
本次文章着重介绍第一种，功能性的接口自动化框架。

一、简单介绍

环境：Mac、Python 3，Pytest，Allure，Request

1. pytest==3.6.0

2. pytest-allure-adaptor==1.7.10(弃用)

3. pytest-rerunfailures==5.0

4. configparser==3.5.0

5. PyYAML==3.12

6. requests==2.18.4

7. simplejson==3.16.0

8. ----------------------------------------

9. 2020-4-30更新

10. pytest==5.3.1

11. allure-pytest==2.8.6

12. allure-python-commons==2.8.6

13. ⚠️注：pytest-allure-adaptor已弃用，改为allure-pytest；

14. 安装allure-pytest时，需将pytest-allure-adaptor卸载

流程：读取Yaml测试数据-生成测试用例-执行测试用例-生成Allure报告
模块类的设计说明:

Request.py 封装request方法，可以支持多协议扩展（get\post\put）
Config.py读取配置文件，包括：不同环境的配置，email相关配置
Log.py 封装记录log方法，分为：debug、info、warning、error、critical
Email.py 封装smtplib方法，运行结果发送邮件通知
Assert.py 封装assert方法
run.py 核心代码。定义并执行用例集，生成报告

Yaml测试数据格式如下：

1. ---

2. Basic:

3. dec: "基础设置"

4. parameters:

5. -

6. url: /settings/basic.json

7. data: slug=da1677475c27

8. header: {

9. "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko)\

10. Chrome/67.0.3396.99 Safari/537.36",

11. "Content-Type": "keep-alive"

12. }

二、代码结构与框架流程

1、代码结构见下图：

代码结构.png

2、框架流程见下图：

框架流程.jpg 

三、详细功能和使用说明

1、定义配置文件config.ini

该文件中区分测试环境[private_debug]和正式环境[online_release]分别定义相关配置项，[mail]部分为邮件相关配置项

1. # http接口测试框架配置信息

3. [private_debug]

4. # debug测试服务

5. tester = your name

6. environment = debug

7. versionCode = your version

8. host = www.jianshu.com

9. loginHost = /Login

10. loginInfo = email=wang@user.com&password=123456

12. [online_release]

13. # release正式服务

14. tester = your name

15. environment = release

16. versionCode = v1.0

17. host = www.jianshu.com

18. loginHost = /Login

19. loginInfo = email=wang@user.com&password=123456

21. [mail]

22. #发送邮件信息

23. smtpserver = smtp.163.com

24. sender = test1@163.com

25. receiver = wang@user.com

26. username = wang@user.com

27. password = 123456

2、读取yaml测试数据后封装

yaml测试数据例子见第一节，一条接口可定义多条case数据，get_parameter为已封装好的读取yaml数据方法，循环读取后将多条case数据存在list中。

1. class Basic:

2. params = get_parameter('Basic')

3. url = []

4. data = []

5. header = []

6. for i in range(0, len(params)):

7. url.append(params[i]['url'])

8. data.append(params[i]['data'])

9. header.append(params[i]['header'])

 3、编写用例

1. class TestBasic:

2. @allure.feature('Home')

3. @allure.severity('blocker')

4. @allure.story('Basic')

5. def test_basic_01(self, action):

6. """

7. 用例描述：未登陆状态下查看基础设置

8. """

9. conf = Config()

10. data = Basic()

11. test = Assert.Assertions()

12. request = Request.Request(action)

14. host = conf.host_debug

15. req_url = 'http://' + host

16. urls = data.url

17. params = data.data

18. headers = data.header

20. api_url = req_url + urls[0]

21. response = request.get_request(api_url, params[0], headers[0])

23. assert test.assert_code(response['code'], 401)

24. assert test.assert_body(response['body'], 'error', u'继续操作前请注册或者登录.')

25. assert test.assert_time(response['time_consuming'], 400)

26. Consts.RESULT_LIST.append('True')

4、运行整个框架run.py

1. if __name__ == '__main__':

2. # 定义测试集

3. args = ['-s', '-q', '--alluredir', xml_report_path]

4. self_args = sys.argv[1:]

5. pytest.main(args)

6. cmd = 'allure generate %s -o %s' % (xml_report_path, html_report_path)

8. try:

9. shell.invoke(cmd)

10. except:

11. log.error('执行用例失败，请检查环境配置')

12. raise

14. try:

15. mail = Email.SendMail()

16. mail.sendMail()

17. except:

18. log.error('发送邮件失败，请检查邮件配置')

19. raise

5、err.log实例

1. [ERROR 2018-08-24 09:55:37]Response body != expected_msg, expected_msg is {"error":"继续操作前请注册或者登录9."}, body is {"error":"继续操作前请注册或者登录."}

2. [ERROR 2018-08-24 10:00:11]Response time > expected_time, expected_time is 400, time is 482.745

3. [ERROR 2018-08-25 21:49:41]statusCode error, expected_code is 208, statusCode is 200

6、Assert部分代码

1. def assert_body(self, body, body_msg, expected_msg):

2. """

3. 验证response body中任意属性的值

4. :param body:

5. :param body_msg:

6. :param expected_msg:

7. :return:

8. """

9. try:

10. msg = body[body_msg]

11. assert msg == expected_msg

12. return True

14. except:

15. self.log.error("Response body msg != expected_msg, expected_msg is %s, body_msg is %s" % (expected_msg, body_msg))

16. Consts.RESULT_LIST.append('fail')

18. raise

20. def assert_in_text(self, body, expected_msg):

21. """

22. 验证response body中是否包含预期字符串

23. :param body:

24. :param expected_msg:

25. :return:

26. """

27. try:

28. text = json.dumps(body, ensure_ascii=False)

29. # print(text)

30. assert expected_msg in text

31. return True

33. except:

34. self.log.error("Response body Does not contain expected_msg, expected_msg is %s" % expected_msg)

35. Consts.RESULT_LIST.append('fail')

37. raise

7、Request部分代码

1. def post_request(self, url, data, header):

2. """

3. Post请求

4. :param url:

5. :param data:

6. :param header:

7. :return:

8. """

9. if not url.startswith('http://'):

10. url = '%s%s' % ('http://', url)

11. print(url)

12. try:

13. if data is None:

14. response = self.get_session.post(url=url, headers=header)

15. else:

16. response = self.get_session.post(url=url, params=data, headers=header)

18. except requests.RequestException as e:

19. print('%s%s' % ('RequestException url: ', url))

20. print(e)

21. return ()

23. except Exception as e:

24. print('%s%s' % ('Exception url: ', url))

25. print(e)

26. return ()

28. # time_consuming为响应时间，单位为毫秒

29. time_consuming = response.elapsed.microseconds/1000

30. # time_total为响应时间，单位为秒

31. time_total = response.elapsed.total_seconds()

33. Common.Consts.STRESS_LIST.append(time_consuming)

35. response_dicts = dict()

36. response_dicts['code'] = response.status_code

37. try:

38. response_dicts['body'] = response.json()

39. except Exception as e:

40. print(e)

41. response_dicts['body'] = ''

43. response_dicts['text'] = response.text

44. response_dicts['time_consuming'] = time_consuming

45. response_dicts['time_total'] = time_total

47. return response_dicts

四、Allure报告及Email

1、Allure报告总览，见下图：

Allure报告.png

2、Email见下图：

五、后续优化

1、集成Jenkins，使用Jenkins插件生成Allure报告
2、多线程并发接口自动化测试
3、接口加密，参数加密

总结：

感谢每一个认真阅读我文章的人！！！

作为一位过来人也是希望大家少走一些弯路，如果你不想再体验一次学习时找不到资料，没人解答问题，坚持几天便放弃的感受的话，在这里我给大家分享一些自动化测试的学习资源，希望能给你前进的路上带来帮助。

软件测试面试文档

我们学习必然是为了找到高薪的工作，下面这些面试题是来自阿里、腾讯、字节等一线互联网大厂最新的面试资料，并且有字节大佬给出了权威的解答，刷完这一套面试资料相信大家都能找到满意的工作。

 

          视频文档获取方式：
这份文档和视频资料，对于想从事【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！以上均可以分享，点下方小卡片即可自行领取。