Robotframework+python】实现http接口自动化测试

前言

下周即将展开一个http接口测试的需求，刚刚完成的java类接口测试工作中，由于之前犯懒，没有提前搭建好自动化回归测试框架，以至于后期rd每修改一个bug，经常导致之前没有问题的case又产生了bug，所以需要一遍遍回归case，过程一直手工去执行，苦不堪言。所以，对于即将开始的http接口测试需求，立马花了两天时间搭建了一个http接口自动化测试框架用于测试后期回归测试，实在是被大量的重复手工执行搞怕了。

基础框架选择

最方便的方法就是用python直接写代码，代码和测试数据分离，测试数据放在excel中保存。这种实现最快捷方便，但也有些缺点：
（1）用例管理不太方便，不直观；
（2）HTMLTestRunner输出报告做的比较烂。

相较而言，robot framework具有用例管理清晰，输出报告美观的特点。但robot的缺点就是编码起来不如python直接写代码方便。所以，为了快速搭建http接口自动化框架用于回归测试，我直接用python写了一个框架。为了后续长远考虑，便于用例管理，测试报告美观，且集成到测试平台工具化以及推广给rd和其他qa同学使用，又用robot搭建了一套框架。本文就详细说明该搭建过程。

搭建思路

框架采用robot和python实现，因为robot中的复杂逻辑实现起来比较繁琐，故选择用python实现，然后以外部库的形式导入robot中使用。测试用例数据保存在excel中。
使用过robot的人了解，robot中测试维度划分为测试套件（Test Suite）和测试用例（Test Case），一个Suite为一组Case的集合，每个Case对应为我们手工执行测试时的Case。

假设测试一个路径为/areaplug/showCityName的http接口，常规方法是在robot中新建一个showCityName的Suite，其下包含测试该http接口的用例集，如下图所示： 

showCityName Test Suite

倘若测试该接口有20个异常用例，则建立20条相应的test case。但是，对于测试http接口来讲，以上用例无非就是请求参数和响应不一样而已，发送请求的逻辑是一模一样的。所以，这20条test case其实用一条test case就能实现了，在这1条case中分别遍历读取20个异常用例的测试数据执行测试就ok了。所以最后构造的suite和case如下：

接口case

图中，batch_Request为测试套件，其下的每个robot的test case对应一个http接口测试场景，比如测试路径为/areaplug/showCityName的http接口，该接口的所有正向和异常用例均在test_showCityName中实现，在test_showCityName中读取测试数据文件，获取该接口的测试用例数目，遍历每一条测试用例数据，调用http_Request下的sendHttpRequest发送http请求。其实，这里的test_showCityName就相当于test suite了，而遍历测试数据文件中的每一行测试数据去调用sendHttpRequest时，就相当于生成了一条test case，这样就可以将一个接口的所有测试用例用robot的一条test case实现（实质是robot的一条test case相当于一个test suite，在这个robot的test case中动态生成n条test case）。整个流程如下图所示：

框架流程图

搭建

测试数据

测试数据保存在excel中，每一个sheet页对应一个测试场景，即一个http接口。该sheet也保存有测试该接口的所有测试用例数据以及接口路径和请求方法，如下图所示（这里仅仅是一个demo，实际回归测试时，会有大量的用例和数据）： 

测试数据

测试框架

整个工程目录如下：

1. E:\LLF_58TESTSUITES\JZ_WEBINTERGRATION\ROBOT_CODE

2. │ execPybot.bat

3. │

4. ├─pycode

5. │ │ Common_Excel.py

6. │ │ Common_Excel.pyc

7. │ │ Common_Exec.py

8. │ │ Common_Exec.pyc

9. │ │ testHTTP.py

10. │ │ __init__.py

11. │ │

12. │ ├─.idea

13. │ │ │ misc.xml

14. │ │ │ modules.xml

15. │ │ │ pycode.iml

16. │ │ │ workspace.xml

17. │ │ │

18. │ │ └─inspectionProfiles

19. │ └─__pycache__

20. │ Common_Excel.cpython-36.pyc

21. │ Common_Exec.cpython-36.pyc

22. │ __init__.cpython-36.pyc

23. │

24. ├─report

25. │ │ log.html

26. │ │ output.xml

27. │ │ report.html

28. │ │

29. │ └─TestCaseReport

30. │ ├─result_calendar

31. │ │ log_20180130195712.html

32. │ │ output_20180130195712.xml

33. │ │ report_20180130195712.html

34. │ │

35. │ ├─result_getScheduleFlags

36. │ │ log_20180130195710.html

37. │ │ output_20180130195710.xml

38. │ │ report_20180130195710.html

39. │ │

40. │ └─result_showCityName

41. │ log_20180130195707.html

42. │ output_20180130195707.xml

43. │ report_20180130195707.html

44. │

45. ├─rfcode

46. │ │ batch_Request.txt

47. │ │ http_Request.txt

48. │ │ __init__.robot

49. │ │

50. │ ├─关键字

51. │ │ 关键字index.txt

52. │ │ 自定义关键字.txt

53. │ │

54. │ └─配置信息

55. │ config.txt

56. │ configIndex.txt

57. │ RequestHeaders.txt

58. │

59. └─testData

60. testData.xlsx

工程有4部分构成：

• pycode
  由于robot中复杂逻辑的实现比较繁琐，所以将一些复杂逻辑直接用python代码实现，然后以外部库的形式导入robot中调用。共有2个文件:

Common_Excel.py
主要负责对测试数据excel文件的读取操作。

1. # coding: utf-8

2. import xlrd

3. def getTestData(testDataFile, testScene, host, caseNo):

4. '''

5. 从excel中获取测试数据

6. :param testDataFile: 测试数据文件

7. :param testScene: 测试场景

8. :param host: 服务器主机

9. :param caseNo: 用例No

10. :param method: 请求方法

11. :return: url，用例No，用例名称，请求参数，预期返回码，预期响应内容

12. '''

13. caseNo = int(caseNo)

14. data = xlrd.open_workbook(testDataFile)

15. table = data.sheet_by_name(testScene)

16. cols = table.ncols

18. resource_path = table.cell(0, 1).value # 文件路径

19. url = "http://" + host + resource_path # 访问的url

20. method = table.cell(1, 1).value # 请求方法

22. dict_params = {}

23. for i in range(cols):

24. dict_params[table.cell(2, i).value] = table.cell(caseNo+2, i).value

26. caseNo = dict_params.pop("caseNo")

27. caseName = dict_params.pop("caseName")

28. expectCode = dict_params.pop("expect_code")

29. expectCotent = dict_params.pop("expect_content")

30. testName = "TestCase" + caseNo + "_" + caseName

32. return method, url, caseNo, testName, dict_params, expectCode, expectCotent

34. def getTestCaseNum(testDataFile, testScene):

35. '''

36. 获取testScene测试场景中的测试用例数

37. :param testDataFile: 测试数据文件

38. :param testScene: 测试场景

39. :return: 测试用例数

40. '''

41. data = xlrd.open_workbook(testDataFile)

42. table = data.sheet_by_name(testScene)

43. rows = table.nrows

44. return rows-3

46. def getTestHttpMethod(testDataFile, testScene):

47. '''

48. 获取testScene测试场景的请求方法

49. :param testDataFile: 测试数据文件

50. :param testScene: 测试场景

51. :return: 请求方法

52. '''

53. data = xlrd.open_workbook(testDataFile)

54. table = data.sheet_by_name(testScene)

55. method = table.cell(1, 1).value # 请求方法

56. return method

Common_Exec.py
主要负责根据测试数据批量构造pybot命令来调用robot执行测试。

1. # coding: utf-8

2. import requests

3. import os

4. import time

6. def batch_Call(robot_testSuite, robot_testCase, testScene, caseNum, testCaseReportPath, execTime):

7. '''

8. 批量执行testScene测试场景下的用例

9. :param robot_testSuite: robot testSuite路径

10. :param robot_testCase: robot testCase路径

11. :param testScene: 测试场景

12. :param caseNum: 用例数

13. :param testCaseReportPath: 业务用例测试报告路径

14. :param execTime: 执行时间

15. :return:

16. '''

17. try:

18. for caseNo in range(caseNum):

19. testCase = ""

20. caseNo = caseNo + 1

21. testName = "testcase" + "_" + str(caseNo)

22. output_dir = "-d " + testCaseReportPath + "/result_{0}".format(testScene) # 输出目录

23. output_xml = "-o output_{0}_{1}.xml".format(testName, execTime)

24. output_log = "-l log_{0}_{1}.html".format(testName, execTime)

25. output_report = "-r report_{0}_{1}.html".format(testName, execTime)

26. variable = "-v caseNo:" + str(caseNo) + " -v testScene:" + testScene

27. testCase = "--test " + robot_testCase

28. pybot_cmd = "pybot " + output_dir + " " + output_xml + " " + output_log + " " + output_report + " " + variable + " " + " " + testCase + " " + robot_testSuite

29. os.system(pybot_cmd) # 执行pybot命令

30. return "done"

31. except Exception as e:

32. return "Error: " + str(e)

34. def send_HttpRequest(url, data=None, headers=None, method=None):

35. '''

36. 发送http请求

37. :param url: 请求的url

38. :param data: 请求数据

39. :param headers: 请求头

40. :param method: 请求方法

41. :return: 响应码，响应内容

42. '''

43. if method == "get":

44. response = requests.get(url, data, headers=headers)

45. if method == "post":

46. response = requests.post(url, data, headers=headers)

47. code = str(response.status_code)

48. content = response.content.decode("utf-8") # 转码

49. return code, content

51. def cleanLogs(testScene, testCaseReportPath):

52. '''

53. 删除硬盘中合并前的测试报告

54. :param testScene: 测试场景

55. :param testCaseReportPath: 业务用例测试报告路径

56. :return:

57. '''

58. testCaseReportPath = testCaseReportPath + "/result_{0}".format(testScene)

59. report_files = testCaseReportPath + "/report_testcase*"

60. xml_files = testCaseReportPath + "/output_testcase*"

61. log_files = testCaseReportPath + "/log_testcase*"

62. cmd = "del " + report_files + " " + xml_files + " " + log_files # windows

63. cmd = cmd.replace("/", "\\")

64. print(cmd)

65. os.system(cmd)

67. def getCurtime():

68. '''

69. 获取当前时间

70. :return: 当前时间

71. '''

72. return time.strftime("%Y%m%d%H%M%S", time.localtime(time.time()))

74. def mergeReport(testScene, testCaseReportPath, execTime):

75. '''

76. # 合并报告

77. :param testScene: 测试场景

78. :param testCaseReportPath: 业务用例测试报告路径

79. :param execTime: 执行时间

80. :return:

81. '''

82. try:

83. output_dir = "-d " + testCaseReportPath + "/result_{0}".format(testScene) # 输出目录

84. output_xml = "-o output_{0}.xml".format(execTime)

85. output_log = "-l log_{0}.html".format(execTime)

86. output_report = "-r report_{0}.html".format(execTime)

87. # 被合并的报告

88. merge_report = testCaseReportPath + "/result_{0}".format(testScene) + "/output_testcase_*.xml"

89. name = "--name " + testScene

90. rebot_cmd = r"rebot " + output_dir + " " + output_xml + " " + output_log + " " + output_report + " " + name + " " + merge_report

91. os.system(rebot_cmd) # 执行rebot命令

92. return "done"

93. except Exception as e:

94. return "Error: " + str(e)

• report
  该目录用于存放测试报告。其中report目录下的robot测试报告为测试Suite的测试报告，而TestCaseReport下会根据不同的测试场景生成对应该场景名称的测试报告文件夹，其下会包含该测试场景下所有用例的合并报告（即excel中的每一条case会生成一个报告，最后会将这些cases的报告合并为一个报告，作为该测试场景即该http接口的测试报告）。

• rfcode
  该目录下为robot的代码。

batch_Request.txt
batch_Request下包含要测试的各http接口对应的测试场景（即robot的测试用例）。在各测试场景中会设置${testScene}变量，通过该变量去excel文件中对应的sheet页获取相应的测试数据。

1. *** Settings ***

2. Library ../pycode/Common_Exec.py

3. Resource 关键字/关键字index.txt

4. Resource 配置信息/configIndex.txt

5. Library ../pycode/Common_Excel.py

7. *** Test Cases ***

8. test_showCityName

9. [Documentation] /areaplug/showCityName

10. # 测试场景

11. ${testScene} Set Variable showCityName

12. # 请求方法

13. ${method} getTestHttpMethod ${testDataFile} ${testScene}

14. 执行测试 ${testScene} ${method}

16. test_getScheduleFlags

17. [Documentation] /ManageSchedule/getScheduleFlags

18. # 测试场景

19. ${testScene} Set Variable getScheduleFlags

20. # 请求方法

21. ${method} getTestHttpMethod ${testDataFile} ${testScene}

22. 执行测试 ${testScene} ${method}

24. test_calendar

25. # 测试场景

26. ${testScene} Set Variable calendar

27. # 请求方法

28. ${method} getTestHttpMethod ${testDataFile} ${testScene}

29. 执行测试 ${testScene} ${method}

http_Request.txt
在各测试场景中会根据excel中的测试用例记录数目去批量调用http_Request下的sendHttpRequest执行http接口测试。在sendHttpRequest中会根据caseNo去excel中查询相应测试数据，并发送对应的http请求到相应http接口中。收到响应后，与excel中的预期响应码和响应内容做比对。

1. *** Settings ***

2. Library ../pycode/Common_Exec.py

3. Library ../pycode/Common_Excel.py

4. Resource 关键字/关键字index.txt

6. *** Test Cases ***

7. sendHttpRequest

8. # 获取测试用例数据

9. ${method} ${url} ${caseNo} ${testName} ${dict_params} ${expectCode} ${expectCotent}

10. ... getTestData ${testDataFile} ${testScene} ${Host} ${caseNo}

11. # 设置用例说明

12. Set Test Documentation ${testName}

13. # 请求头

14. ${headers} 获取请求头

15. #根据method发送对应的http请求

16. ${actualCode} ${actualContent} send_HttpRequest ${url} ${dict_params} ${headers} ${method}

17. # 响应码比对

18. Should Be Equal ${actualCode} ${expectCode}

19. # 响应内容比对

20. Should Be Equal ${actualContent} ${expectCotent}

关键字
关键字模块主要是对一些复用逻辑的封装。

1. *** Settings ***

2. Resource ../配置信息/configIndex.txt

3. Library ../../pycode/Common_Excel.py

4. Library ../../pycode/Common_Exec.py

6. *** Keywords ***

7. 获取请求头

8. ${dict_headers} Create Dictionary Host=${Host} User-Agent=${User-Agent} Accept=${Accept} Accept-Language=${Accept-Language} Accept-Encoding=${Accept-Encoding}

9. ... Cookie=${Cookie} Connection=${Connection} Cache-Control=${Cache-Control}

10. Return From Keyword ${dict_headers}

12. 执行测试

13. [Arguments] ${testScene} ${method} # 测试场景|请求方法

14. # 获取用例数目

15. ${case_num} getTestCaseNum ${testDataFile} ${testScene}

16. # 获取当前时间

17. ${execTime} getCurtime

18. #批量执行testScene测试场景下的用例

19. ${status} batch_Call ${httpTestSuite} ${httpRequestTestCase} ${testScene} ${case_num} ${testCaseReportPath}

20. ... ${execTime}

21. log ${status}

22. # 合并报告

23. ${status} mergeReport ${testScene} ${testCaseReportPath} ${execTime}

24. log ${status}

25. # 清理合并前的报告

26. cleanLogs ${testScene} ${testCaseReportPath}

配置信息
配置信息中存储配置信息以及通讯头的信息。通讯头中有cookie，保存有登录信息，通讯头的部分涉及隐私，故这部分数据不放出来了。
config.txt

1. *** Settings ***

3. *** Variables ***

4. ${testDataFile} E:/llf_58TestSuites/jz_webIntergration/robot_code/testData/testData.xlsx # 测试数据

5. ${httpRequestTestCase} sendHttpRequest # http请求用例模板

6. ${httpTestSuite} E:/llf_58TestSuites/jz_webIntergration/robot_code/rfcode/http_Request.txt # http请求测试套件

7. ${testCaseReportPath} E:/llf_58TestSuites/jz_webIntergration/robot_code/report/TestCaseReport # 业务用例测试报告路径

RequestHeaders.txt

1. *** Settings ***

2. Documentation 请求头信息

4. *** Variables ***

5. ${Host} ******* # 服务器主机

6. ${User-Agent} Mozilla/5.0 (Windows NT 6.1; WOW64; rv:56.0) Gecko/20100101 Firefox/56.0 # 浏览器代理

7. ${Accept} text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

8. ${Accept-Language} en-US,en;q=0.5

9. ${Accept-Encoding} gzip, deflate

10. ${Cookie} ************

11. ${Connection} keep-alive

12. ${Cache-Control} max-age=0

13. ${Upgrade-Insecure-Requests} ***

• testData
  该目录下存放测试数据excel文件。

执行测试

pybot -d E:/llf_58TestSuites/jz_webIntergration/robot_code/report -o output.xml -l log.html -r report.html E:\llf_58TestSuites\jz_webIntergration\robot_code\rfcode\batch_Request.txt

执行测试

可见，showCityName测试场景已根据excel中的用例条数批量执行了测试。

进入TestCaseReport目录，可以看到已根据测试场景分别生成了对应目录的测试报告： 

各测试场景的报告存在相应目录中

进入showCityName目录，打开最新生成的该场景测试报告：

showCityName场景测试报告

根据说明列辨别是哪条用例的报告数据

sendHttpRequest被批量调用

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

 

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