CN110297774B - 一种基于python的接口自动化测试方法 - Google Patents

Abstract

本发明公开了一种基于python的接口自动化测试方法，使用python脚本对excel进行操作读取数据和回写数据，将读取的测试数据与配置数据中的字段匹配替换，在执行接口请求的过程中，利用执行接口请求后返回的数据与配置数据匹配替换后再与后面所有即将进行接口请求的数据中的字段匹配替换，使得后面所有即将进行接口请求的数据中不带有参数，执行接口测试用例的过程中进行相应的响应数据回写和响应数据断言结果回写，测试人员可以直接从excel表中查看回写的数据。通过本发明的方法，测试人员只需维护excel表中的测试数据表和配置数据表无需编程，即可完成接口的自动化测试，并且可以查看表中的接口测试结果和断言结果，调整接口测试用例。

Description

一种基于python的接口自动化测试方法

技术领域

本发明涉及自动化测试技术领域，特别涉及一种基于python的接口自动化测试方法。

背景技术

接口测试是针对测试系统组件间接口的一种测试，主要用于检测外部系统与系统之间以及内部各子系统之间的交互点。测试的重点是要检查数据的交换，传递和控制管理过程，以及系统间的相互逻辑依赖关系等。目前的接口大多数都是使用的http协议，其测试的基本原理是模拟客户端向服务器发送数据，得到相应的响应数据，从而判断接口是否可以正常的进行数据交换。

手动针对每条测试用例修改接口参数对接口进行测试是一种测试的方式，调用接口后人工逐个对比返回的结果值与期望值是否一致，这其实是一项繁杂的工作，尤其当测试用例达到一定数量级，工作量更是成倍的增长，且测试效率低下，也不能完全保证质量。如何在保证测试质量的前提下提高测试效率，减少测试人员工作量，解放劳动力成了接口测试亟需解决的问题。

为解决上述问题，业界有接口测试工具诸如：

Postman：使用Postman生成各个语言的脚本，还可以抓包，认证，传输文件，利用脚本回放实现接口自动化测试，但缺点是脚本维护成本高，后台数据配置一旦变动，脚本又需重新录制；

JMeter：将一条条请求添加到测试计划下，一次性依次自动执行所有接口，编写脚本实现较复杂接口间数据传递，但是如果其中部分接口报错，则需要挨着翻看，相当繁琐；

RobotFramework：支持关键字驱动，相比前面两种工具做自动化会接触更多代码编写，对测试人员代码要求更高。

因此，如何不依赖诸如上述的现有自动化工具，同时又降低对测试人员代码要求，实现接口自动化测试，成了我们需要解决的问题。

发明内容

本发明的目的是克服上述背景技术中不足，提供一种基于python的接口自动化测试方法，可实现不依赖诸如技术背景所述的现有自动化工具，同时又降低对测试人员代码要求，实现接口自动化测试。

为了达到上述的技术效果，本发明采取以下技术方案：

一种基于python的接口自动化测试方法，包括以下步骤：

A.将自动化测试所需要使用到的测试数据表、配置数据表维护到excel表中；

B.执行自动化测试python脚本，python脚本从excel表里获取测试数据和配置数据，python脚本依据测试数据与配置数据的匹配规则，在自动化用例执行的过程中自动完善excel表里的配置数据及测试数据，完成接口自动化测试；

C.python脚本执行完毕后，即从excel表中查看接口自动化用例执行结果。

进一步地，所述步骤A中所述测试数据表中包括测试用例编号、请求方式、接口地址、接口请求参数、预期响应结果、实际请求结果、请求断言结果，所述配置数据表中包括测试数据表中用到的所有变化参数。

进一步地，所述接口请求参数的值为JSON格式，且在JSON数据里包含动态参数，所述动态参数为JSON数据里需要根据测试场景动态变化的字段。

进一步地，所述步骤A中，将测试数据表里的动态参数维护到excel表中时，具体是将测试数据表中的动态参数的值记为“${动态参数名称}”格式。

进一步地，所述步骤A中，将配置数据表维护到excel表中时是excel表中的配置数据表表头字段为所述动态参数的名称，第二行为其对应值，且若初始值没有，则填none。

进一步地，所述步骤B具体包括：

B1.利用python的openpyxl库从excel表读取配置数据表中的数据，存入python的字典类型conf_dict中，将配置数据表中的表头字段作为key，第二行对应数据作为value的键值对；

B2.利用python的openpyxl库从excel表循环逐行读取测试数据表中除接口数据列的表头之外的数据；

B3.每读取一行测试数据表数据，则进行正则匹配查找读取的数据是否含有“${动态参数名称}”格式数据，有则取其中的动态参数名称与步骤B1中所述conf_dict数据的key做正则匹配，若一致则根据key取对应的value去替换“${动态参数名称}”，至此，读取的该行数据的动态参数替换完毕；

B4.利用python的request库结合步骤B3中替换后的数据，向服务器发送接口请求获取响应数据，利用python的openpyxl库，将响应数据回写至excel表的实际请求结果数据列。

进一步地，所述步骤B还包括步骤B5：

在执行一个接口测试后将conf_dict中的value和key依次与该接口调用返回的响应数据中字段做正则匹配，一致则将conf_dict中的对应key的value替换为该接口返回响应数据中对应字段值，再返回执行步骤B3、B4；实现下一接口的调用。

进一步地，所述步骤B5具体包括：

B5.1读取接口A测试数据和配置数据conf_dict；

B5.2根据conf_dict替换接口A中的动态参数；

B5.3调用接口数据A，返回接口响应，回写响应数据至excel表；

B5.4根据返回的A接口响应替换配置数据中值为none的数据；

B5.5读取接口B；

B5.6根据替换后的配置数据替换接口B中的动态参数；

B5.7调用接口B，返回接口响应，回写响应数据至excel表；

B5.8根据返回的B接口响应替换配置数据中值为none的数据；

B5.9读取下一接口，循环步骤B5.5至步骤B5.8，直至所有接口调用完毕。

进一步地，所述步骤B2中接口数据列的表头包括：数据请求方式、接口地址、接口请求参数、预期响应结果。

进一步地，所述步骤C具体包括：

C1.当所有行的接口测试均执行完毕，则再次利用python的openpyxl库和for循环逐行将excel表中的预期响应结果和实际请求结果作对比，一致则判断为接口测试通过，否则判断为接口测试不通过，并将通过或不通过的测试结果回写至excel表中的请求断言结果数据列；

C2.从excel表中即可查看相应的测试结果实际请求结果和请求断言结果。

本发明与现有技术相比，具有以下的有益效果：

本发明的基于python的接口自动化测试方法，使用python语言开发自动化测试脚本，将测试数据和配置数据以及响应结果、断言结果集中于一份excel文档，利用配置数据表和匹配替换规则，实现接口间参数传递，测试人员不需要考虑自动化代码实现只需在理解原理的基础上维护excel上的接口测试数据表和测试配置数据表，并能在执行完脚本后，从原有excel表里查看接口请求返回数据及断言结果，测试人员做接口自动化时不需对代码的要求，就能维护好测试数据及配置数据，复用性较高。

附图说明

图1是本发明的一个实施例中测试数据表设计示意图。

图2是本发明的一个实施例中配置数据表设计示意图。

图3是本发明的基于python的接口自动化测试方法中测试人员所需操作的流程示意图。

图4是本发明的基于python的接口自动化测试方法的流程示意图。

具体实施方式

下面结合本发明的实施例对本发明作进一步的阐述和说明。

实施例：

实施例一：

一种基于python的接口自动化测试方法，该方法是自行编写python代码实现对接口测试的自动执行，如图4所示，具体包括以下步骤：

步骤1：准备excel表中的测试数据。

其中，excel表中的测试数据表表头字段包括：测试用例编号(Case_Id)、请求方式(method)、接口地址(Url)、接口请求参数(Param)、预期响应结果(Excepted_Result)、实际请求结果(Actual_Result)、请求断言结果(Assert_Result)，后续每行维护的是对应字段的值，一行数据视为一条测试用例。

具体的，本实施例中，接口请求参数(Param)的值为JSON格式，JSON数据里部分字段是需要根据测试场景动态变化的，本方案中称之为动态参数，比如：某接口请求参数JSON中某字段值需要执行用例中前一接口后，从服务器返回的JSON数据的对应字段的值中获取，那么本方案将测试数据表中的动态参数的值记为“${动态参数名称}”，同理测试人员将诸如此类动态参数也维护至excel测试数据表中。同时，如接口ip地址等动态参数，当切换测试环境时域名往往会发生变化，测试人员将诸如此类动态参数也上述格式维护至测试数据表中。

步骤2：准备excel表中的配置数据表。

其中，excel表中的配置数据表表头字段为步骤1中所述的动态参数的名称，第二行维护其对应值，若初始值没有，则填none。

如本实施例中，以登录接口、充值接口为例，测试人员按照上述步骤1及步骤2所述相关测试数据和配置数据准备原则准备相应数据至excel表中，具体的测试数据表示意图及配置数据表示意图分别如图1及图2所示。

在本实施例中，准备测试数据和配置数据时：首先，系统会因为某些原因变更IP地址比如有两个系统生产和测试，所以为了便于本套方案可在多系统中使用，本实施例中，将excel表的测试数据表中接口请求地址的ip用${ip}替代，进行测试用例编写；其次，本实施例中，登录接口需要电话和密码，也是时常变更的数据，因此本实施例中放在配置数据表中，同时，充值接口需要参数token，而token需要从执行登录接口后返回参数中获取，则本实施例中，在测试数据表中token用${token}代替。

步骤3：利用python的openpyxl库从excel读取配置数据表中的数据，存入python的字典类型conf_dict中，表头字段作为key，第二行对应数据作为value的键值对。

步骤4：利用python的openpyxl库从excel循环逐行读取测试数据表中除接口数据列的表头之外数据(其中，接口数据列的表头为：数据请求方式(method)、接口地址(Url)、接口请求参数(Param)、预期响应结果(Excepted_Result))并进行如下操作：

步骤4.1：每读取一行测试数据表数据，则进行正则匹配查找读取的数据是否含有${动态参数名称}格式数据，有则取其中的动态参数名称与步骤3中所述conf_dict数据的key做正则匹配，若一致则根据key取对应的value替换为“${动态参数名称}”，至此，读取的该行数据的动态参数替换完毕；

步骤4.2：利用python的request库结合步骤4.1中替换后的数据，向服务器发送接口请求获取响应数据，响应数据也是JSON格式，利用python的openpyxl库，将响应数据回写至测试数据表的实际请求结果(Actual_Result)数据列。

其中，在本方案中，如果调用接口A后返回的响应数据中字段值是调用接口B所需的请求参数字段值，即如果接口B那行数据先于接口A被读取，在数据读取和替换后，B接口的请求参数中的动态参数值为none，调用接口B显然无法成功。为避免此种情况，本方案中在维护接口数据时需要将接口A放在接口B后面，并且在步骤4.2后，增加一个步骤4.3：

步骤4.3：执行接口A后，将conf_dict中value还是none的key依次与接口A调用返回的响应数据中字段做正则匹配，一致则将conf_dict中的对应key的value替换为接口A返回响应数据中对应字段值，再执行步骤4.1-4.2，即可实现接口B的调用，后续接口依次进行步骤4.1至步骤4.3的循环操作.

具体的，上述步骤4.3可细化为以下步骤：

S1.读取接口A测试数据和配置数据conf_dict；

S2.根据conf_dict替换接口A中的动态参数；

S3.调用接口数据A，返回接口响应，回写响应数据至excel表；

S4.根据返回的A接口响应替换配置数据中值为none的数据；

S5.读取接口B；

S6.根据替换后的配置数据替换接口B中的动态参数；

S7.调用接口B，返回接口响应，回写响应数据至excel表；

S8.根据返回的B接口响应替换配置数据中值为none的数据；

S9.读取接口C；

S10根据替换后的配置数据替换接口C中的动态参数……直至接口调用完毕为止。

步骤5：当所有行的接口测试均执行完毕，则再次利用python的openpyxl库和for循环逐行将excel测试数据表中的预期响应结果(Excepted_Result)和实际请求结果(Actual_Result)作对比，一致则判断为接口测试通过，不一致则判断为接口测试不通过，并将通过或不通过的测试结果回写至excel表中的请求断言结果(Assert_Result)数据列。

如本实施例中，利用python的request库和for循环逐条执行测试数据中的测试用例时，首先，程序将配置数据字段ip、mobliephone、pwd、token与测试数据中的字段${ip}、${mobliephone}、${pwd}、${token}匹配，将配置数据中字段的值与测试数据中的${变化参数名称}替换，然后再执行第1条测试用例登录，然后再回写登录响应数据和断言结果数据至excel测试数据表中的Actual_Result、Assert_Result，其中，在数据列中，断言是比较响应结果和excel表中的Excepted_Result列值是否一致，一致则断言为测试通过；然后，响应数据中有字段token与配置数据字段token匹配，则将响应数据中字段的值与对应配置数据字段值替换后，再判断配置数据中的token与测试数据表中的${token}相匹配，将token值与${token}替换，再继续执行下一条用例充值接口。

步骤6：测试人员直接在excel测试数据表中即可查看相应的测试结果实际请求结果(Actual_Result)和请求断言结果(Assert_Result)。

在本实施例中，测试人员所需操作的流程步骤如图3所示，通过上述步骤，测试人员只需维护excel表中的测试数据表和配置数据表无需编程，即可完成接口的自动化测试，并且可以查看表中的接口测试结果和断言结果，调整接口测试用例。

可以理解的是，以上实施方式仅仅是为了说明本发明的原理而采用的示例性实施方式，然而本发明并不局限于此。对于本领域内的普通技术人员而言，在不脱离本发明的精神和实质的情况下，可以做出各种变型和改进，这些变型和改进也视为本发明的保护范围。

Claims (7)

1.一种基于python的接口自动化测试方法，其特征在于，包括以下步骤：

A.将自动化测试所需要使用到的测试数据表、配置数据表维护到excel表中；

B.执行自动化测试python脚本，python脚本从excel表里获取测试数据和配置数据，python脚本依据测试数据与配置数据的匹配规则，在自动化用例执行的过程中自动完善excel表里的配置数据及测试数据，完成接口自动化测试；所述步骤B具体包括：

B1.利用python的openpyxl库从excel表读取配置数据表中的数据，存入python的字典类型conf_dict中，将配置数据表中的表头字段作为key，第二行对应数据作为value的键值对；

B2.利用python的openpyxl库从excel表循环逐行读取测试数据表中除接口数据列的表头之外的数据；

B3.每读取一行测试数据表数据，则进行正则匹配查找读取的数据是否含有“${动态参数名称}”格式数据，有则取其中的动态参数名称与步骤B1中所述conf_dict数据的key做正则匹配，若一致则根据key取对应的value去替换“${动态参数名称}”，至此，读取的该行数据的动态参数替换完毕；

B4.利用python的request库结合步骤B3中替换后的数据，向服务器发送接口请求获取响应数据，利用python的openpyxl库，将响应数据回写至excel表的实际请求结果数据列；所述步骤B还包括步骤B5：

在执行一个接口测试后将conf_dict中的value和key依次与该接口调用返回的响应数据中字段做正则匹配，一致则将conf_dict中的对应key的value替换为该接口返回响应数据中对应字段值，再返回执行步骤B3、B4；实现下一接口的调用；

所述步骤B5具体包括：

B5.1读取接口A测试数据和配置数据conf_dict；

B5.2根据conf_dict替换接口A中的动态参数；

B5.3调用接口数据A，返回接口响应，回写响应数据至excel表；

B5.4根据返回的A接口响应替换配置数据中值为none的数据；

B5.5读取接口B；

B5.6根据替换后的配置数据替换接口B中的动态参数；

B5.7调用接口B，返回接口响应，回写响应数据至excel表；

B5.8根据返回的B接口响应替换配置数据中值为none的数据；

B5.9读取下一接口，循环步骤B5.5至步骤B5.8，直至所有接口调用完毕；

C.python脚本执行完毕后，即从excel表中查看接口自动化用例执行结果。

2.根据权利要求 1所述的一种基于python的接口自动化测试方法，其特征在于，所述步骤A中所述测试数据表中包括测试用例编号、请求方式、接口地址、接口请求参数、预期响应结果、实际请求结果、请求断言结果，所述配置数据表中包括测试数据表中用到的所有变化参数。

3.根据权利要求 2所述的一种基于python的接口自动化测试方法，其特征在于，所述接口请求参数的值为JSON格式，且在JSON数据里包含动态参数，所述动态参数为JSON数据里需要根据测试场景动态变化的字段。

4.根据权利要求 3所述的一种基于python的接口自动化测试方法，其特征在于，所述步骤A中，将测试数据表里的动态参数维护到excel表中时，具体是将测试数据表中的动态参数的值记为“${动态参数名称}”格式。

5.根据权利要求 4所述的一种基于python的接口自动化测试方法，其特征在于，所述步骤A中，将配置数据表维护到excel表中时是excel表中的配置数据表表头字段为所述动态参数的名称，第二行为其对应值，且若初始值没有，则填none。

6.根据权利要求 1所述的一种基于python的接口自动化测试方法，其特征在于，所述步骤B2中接口数据列的表头包括：数据请求方式、接口地址、接口请求参数、预期响应结果。

7.根据权利要求 1所述的一种基于python的接口自动化测试方法，其特征在于，所述步骤C具体包括：

C1.当所有行的接口测试均执行完毕，则再次利用python的openpyxl库和for循环逐行将excel表中的预期响应结果和实际请求结果作对比，一致则判断为接口测试通过，否则判断为接口测试不通过，并将通过或不通过的测试结果回写至excel表中的请求断言结果数据列；

C2.从excel表中即可查看相应的测试结果实际请求结果和请求断言结果。

Images