CN110287119A - 一种基于python的接口自动化测试方法及装置 - Google Patents

Abstract

本发明公开了一种基于python的接口自动化测试方法及装置，其中方法包括：从excel中循环读取所有的接口数据；判断当前状态读取到的接口是否需要运行；若是，则判断接口是否存在关联依赖；若否，则调用接口类；根据接口类中不同的接口请求方式调用请求类；请求类封装不同的请求接口，并返回响应数据至接口类；通过正则表达式设置检查点与接口内得到的响应数据进行对比；将对比结果和响应数据写入测试报告中。本发明降低了接口测试门槛，提高测试效率，而且可以将log同时写入文件和输出到控制台，方便实时查看信息和跟踪定位问题，而且还解决了接口之间有关联依赖的场景难题。

Description

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

技术领域

本发明涉及接口测试，更具体地说是一种基于python的接口自动化测试方法及装置。

背景技术

目前目前传统的接口测试主要采用soapui、postman、jmeter等工具来进行纯手工的接口测试。对每一个接口进行测试时都需要新建线程组、添加http信息头管理器、各类sample，接口名称、接口地址、请求方式、数据传输类型、请求参数、检查点等，人为输入工作量较大，导致测试人员工作量增大，测试效率低。也有使用python自带的request库进行接口测试，但是代码编写工作量大，增大了接口测试门槛，这样就给接口测试带来一定的隐患性和繁琐性，也不方便维护，无法实现数据和代码进行分离，同时也无法实现邮件通知功能。

发明内容

本发明的目的在于克服现有技术的不足，提供一种基于python的接口自动化测试方法及装置。

为实现上述目的，本发明采用以下技术方案：一种基于python的接口自动化测试方法，所述方法包括以下步骤：

从excel中循环读取所有的接口数据；

判断当前状态读取到的接口是否需要运行；

若是，则判断接口是否存在关联依赖；

若否，则调用接口类；

根据接口类中不同的接口请求方式调用请求类；

请求类封装不同的请求接口，并返回响应数据至接口类；

通过正则表达式设置检查点与接口内得到的响应数据进行对比；

将对比结果和响应数据写入测试报告中。

其进一步技术方案为：所述判断接口是否存在关联依赖的步骤之后，还包括以下步骤：

若是，则进行关联参数拆分；

将拆分的关联参数替换请求参数。

其进一步技术方案为：所述从excel中循环读取所有的接口数据的步骤之后，还包括以下步骤：

对需要加密的接口数据采用des进行对称加密。

其进一步技术方案为：所述调用接口类的步骤之后，还包括以下步骤：

调用日志类log；

向日志文件和控制台输出相应日志信息。

一种基于python的接口自动化测试装置，所述装置包括读取单元、第一判断单元、第二判断单元、第一调用单元、第二调用单元、封装单元、对比单元以及存储单元；

所述读取单元，用于从excel中循环读取所有的接口数据；

所述第一判断单元，用于判断当前状态读取到的接口是否需要运行；

所述第二判断单元，用于判断接口是否存在关联依赖；

所述第一调用单元，用于调用接口类；

所述第二调用单元，用于根据接口类中不同的接口请求方式调用请求类；

所述封装单元，用于请求类封装不同的请求接口，并返回响应数据至接口类；

所述对比单元，用于通过正则表达式设置检查点与接口内得到的响应数据进行对比；

所述存储单元，将对比结果和响应数据写入测试报告中。

其进一步技术方案为：所述装置还包括拆分单元以及替换单元；

所述拆分单元，用于进行关联参数拆分；

所述替换单元，用于将拆分的关联参数替换请求参数。

其进一步技术方案为：所述装置还包括加密单元；

所述加密单元，用于对需要加密的接口数据采用des进行对称加密。

其进一步技术方案为：所述装置还包括第三调用单元以及发送单元；

所述第三调用单元，用于调用日志类log；

所述发送单元，用于向日志文件和控制台输出相应日志信息。

本发明与现有技术相比的有益效果是：本发明提供的一种基于python的接口自动化测试方法及装置，通过excel一次性读取所有的接口数据，自动运行脚本进行接口测试，并将测试结果自动填写到测试报告中，还可以给相应人员发送邮件通知测试结果。测试人员只需在excel中填写少量的数据即可进行接口测试，降低接口测试门槛，提高测试效率，而且可以将log同时写入文件和输出到控制台，方便实时查看信息和跟踪定位问题。另外，当判断出接口之间有关联依赖(即B接口的入参依赖A接口的出参)，只需要对关联参数进行拆分，然后将拆分的关联参数替换为请求参数，解决了接口之间有关联依赖的场景难题。

上述说明仅是本发明技术方案的概述，为了能够更清楚了解本发明技术手段，可依照说明书的内容予以实施，并且为了让本发明的上述和其它目的、特征及优点能够更明显易懂，以下特举较佳实施例，详细说明如下。

附图说明

图1为本发明一种基于python的接口自动化测试方法具体实施例的流程图；

图2为本发明一种基于python的接口自动化测试装置具体实施例结构图。

具体实施方式

为了更充分理解本发明的技术内容，下面结合具体实施例对本发明的技术方案进一步介绍和说明，但不局限于此。

应当理解，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体/操作/对象与另一个实体/操作/对象区分开来，而不一定要求或者暗示这些实体/操作/对象之间存在任何这种实际的关系或者顺序。

还应当理解，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者系统不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者系统所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括该要素的过程、方法、物品或者系统中还存在另外的相同要素。

如图1所示，本发明提供了一种基于python的接口自动化测试方法，该方法包括以下步骤：

S10、从excel中循环读取所有的接口数据；

S20、对需要加密的接口数据采用des进行对称加密；

S30、判断当前状态读取到的接口是否需要运行，若是，进入步骤S301，若否，则返回步骤S10；

S301、判断接口是否存在关联依赖，若是，则进入步骤S302，若否，S40、则调用接口类；

S50、根据接口类中不同的接口请求方式调用请求类；

S60、请求类封装不同的请求接口，并返回响应数据至接口类；

S70、通过正则表达式设置检查点与接口内得到的响应数据进行对比；

S80、将对比结果和响应数据写入测试报告中；

S302、进行关联参数拆分；

S3021、将拆分的关联参数替换请求参数。

进一步的，步骤S40之后，还包括以下步骤：

S401、调用日志类log；

S402、向日志文件和控制台输出相应日志信息。

在从excel中读取接口数据之前，需建立相关文件，具体的：新建interface_automation工程，下载相关依赖包，其中，依赖包包括setuptool、openpyxl、re、time、requests、json、logging、smtplib、email以及pyDes。

新建commons、log、report、src、testcase模块和主入口文件run.py，其中，commons模块存放mylog.py、requestclass.py、sendmail.py，分别用于记录日志及处理异常、封装request库里面的各类请求、发送和接收邮件；log模块存放log.txt，用于保存框架运行时产生的log；report模块存放result.xlsx，用于保存接口运行结果；src模块保存interfaceclass.py、traversal_testcase.py，其中interfaceclass.py主要完成调用请求类并接收响应然后对结果进行对比，对结果和响应的写入，traversal_testcase.py主要用于遍历case，每次遍历一条case,就要调用一次接口类，testcase模块用于读取所有的接口case；run.py用于框架的主入口，调用遍历case类，并传递相关参数，读取case，将结果回填到report；调用发送邮件的类，并传递相关参数，包括发件人，收件人，标题，附件等。

新建excel文件，配置excel文件路径，按接口格式新增Summary和TestCase两个sheet页。Summary中记录接口版本、执行总数、通过总数、失败总数、成功率、失败率等信息；TestCase中第一行新建编号、接口名称、地址前缀、请求地址、请求方法、请求数据类型、请求数据、检查点、关联参数、是否运行、测试结果、响应数据12个字段，同时存储接口信息和接口用例。其中，TestCase sheet页中接口名称、地址前缀、请求地址、请求方法、请求数据类型、请求数据、检查点、关联参数字段存放接口相关数据，读取数据后拼接成各种类型的request调用service，然后将接口的response写入result中TeseCase sheet页中测试结果、响应数据字段中。若读取的接口信息中有需要加密的数据则采用des对称加密，保证数据的安全性。

对于步骤S10-S40，通过主入口run.py调用遍历case类，读取excel中TestCase这个sheet页中的数据。通过for循环遍历case读取数据，每遍历一条case就请求一次接口类InterfaceTest。判断接口是否需要运行，再判断是否存在关联依赖：对没有关联依赖的接口直接调用接口类InterfaceTest；若存在关联依赖的接口，则需要先在文件中按照固定格式填写参数变量名和json层级，然后多次for循环进行关联参数的拆分，再用关联参数替换请求参数，再调用接口类InterfaceTest。通过主入口调用邮件类SendMail中的send_mail方法，可发送和接收包含正文、excel附件、图片附件的邮件，邮件可设置发送给多人。

具体的，通过接口类run_case完成接口请求调用并接受响应，然后对结果进行对比，对结果和响应写入报告中。从TestCase sheet页中第2行开始读取数据，通过for循环遍历case取数据，每遍历一条case就请求一次接口类InterfaceTest，一直读到该sheet页sheet.max_row+1行。读取的数据都通过replace("\n","").replace("\r","")进行过滤，如果读取到TestCase sheet页中是否运行字段的值不为YES，则通过continue跳出for循环，不执行调用接口类InterfaceTest，读取到TestCase sheet页中不同的types来自动选择不同的接口请求headers。判断接口是否存在关联依赖，当遇到有关联依赖的接口时：需要在TestCase sheet页中关联参数字段的值中填写参数变量名和json层级：以等号为界限，左侧是存放关联参数的变量名，格式${变量名}，右侧是关联参数的json层级，格式类似于[data][id]。如果有多个关联参数，则用分号进行分割。对关联参数进行拆分，先通过replace函数将\n和\r替换为空字符串，然后通过3次for循环进行关联参数的拆分。第1次根据；进行拆分，第2次根据＝进行拆分，第3次根据][进行拆分，最终分隔为list形式。提取响应内容result、关联参数对应的值赋给temp临时变量，将temp的值付给res，通过代码corr_dict[param[0]]＝res可获得字典里面第一个key的对应的value。传入result时打印结果为请求返回内容；传入关联参数时打印的是关联参数对应的值。定义一个空字典corr_dict把对应的值放进去。然后关联参数去替换请求中的参数，通过for循环去遍历字典中的key，如果找到相应的key就替换为key对应的value，replace(keyword,str(corr_dict[keyword]))。然后调用接口类InterfaceTest。若接口不存在关联依赖，则直接调用接口类InterfaceTest。

主入口也调用邮件类SendMail中的send_mail方法，发送和接收邮件，通过email.mime.multipart.MIMEMultipart()生成包含多个邮件体的对象msg，定义邮件sendperson、receiverperson、titie及content，也对excel附件和图片附件做了封装，可发送和接收包含正文、excel附件、图片附件的邮件，邮件可设置发送给多人。

对于步骤S50-S80，接口类InterfaceTest完成调用接口请求并接收响应并对结果进行对比。封装接口方法，传递参数，根据不同的接口请求方式调用不同的方法，然后将响应结果和检查点进行对比，通过正则表达式re.search不管是否匹配成功，都将测试结果和响应数据写入测试报告中。

请求类中封装request库各类请求方法，如果是post_json类型的接口，还需要通过json.dumps(data)将python数据类型转化为json数据类型，所有接口返回的response是一个json体，还需要通过r.json将json类型转化成python数据类型，以供接口类InterfaceTest调用，将数据写入到测试报告中TestCase sheet页测试结果和响应数据字段中。

日志类里面创建2个handler，一个是FileHandler，一个是StreamHandler，设置输出格式和日志级别，使用addHandler方法把handler添加到logger，将log同时写入文件和输出到控制台，方便实时查看信息和跟踪定位问题。

通过正则表达式re.search将检查点和响应结果作对比得知测试结果，统计数据回填到测试报告中测试结果和响应数据字段。通过调用多个函数自动统计接口执行总数、通过总数、失败总数、通过率、失败率回填到测试报告中的Summary。

应理解，上述实施例中各步骤的序号的大小并不意味着执行顺序的先后，各过程的执行顺序应以其功能和内在逻辑确定，而不应对本发明实施例的实施过程构成任何限定

对应于上述实施例的一种基于python的接口自动化测试方法，本发明还提供了一种基于python的接口自动化测试装置，如图2所示，本装置包括读取单元1、第一判断单元2、第二判断单元3、第一调用单元4、第二调用单元5、封装单元6、对比单元7以及存储单元8；

读取单元1，用于从excel中循环读取所有的接口数据；

第一判断单元2，用于判断当前状态读取到的接口是否需要运行；

第二判断单元3，用于判断接口是否存在关联依赖；

第一调用单元4，用于调用接口类；

第二调用单元5，用于根据接口类中不同的接口请求方式调用请求类；

封装单元6，用于请求类封装不同的请求接口，并返回响应数据至接口类；

对比单元7，用于通过正则表达式设置检查点与接口内得到的响应数据进行对比；

存储单元8，将对比结果和响应数据写入测试报告中。

进一步的，本装置还包括拆分单元9以及替换单元10；

拆分单元9，用于进行关联参数拆分；

替换单元10，用于将拆分的关联参数替换请求参数。

进一步的，本装置还包括加密单元11；

加密单元11，用于对需要加密的接口数据采用des进行对称加密。

进一步的，本装置还包括第三调用单元12以及发送单元13；

第三调用单元12，用于调用日志类log；

发送单元13，用于向日志文件和控制台输出相应日志信息。

所述集成的单元如果以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本发明实施例的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的全部或部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)或处理器(processor)执行本发明中各个实施例所述方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(ROM，Read-Only Memory)、随机存取存储器(RAM，Random Access Memory)、磁碟或者光盘等各种可以存储程序代码的介质。

所属领域的技术人员可以清楚地了解到，为了描述的方便和简洁，仅以上述各功能单元、模块的划分进行举例说明，实际应用中，可以根据需要而将上述功能分配由不同的功能单元、模块完成，即将所述装置的内部结构划分成不同的功能单元，以完成以上描述的全部或者部分功能。实施例中的各功能单元、模块可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中，上述集成的单元既可以采用硬件的形式实现，也可以采用软件功能单元的形式实现。另外，各功能单元、模块的具体名称也只是为了便于相互区分，并不用于限制本申请的保护范围。上述装置中单元的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。

本领域普通技术人员可以意识到，结合本文中所公开的实施例描述的各示例的单元及算法步骤，能够以电子硬件、或者计算机软件和电子硬件的结合来实现。这些功能究竟以硬件还是软件方式来执行，取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能，但是这种实现不应认为超出本发明的范围。

在本发明所提供的实施例中，应该理解到，所揭露的装置和方法，可以通过其它的方式实现。例如，以上所描述的装置实施例仅仅是示意性的，例如，所述模块或单元的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，例如多个单元或组件可以结合或者可以集成到另一个装置，或一些特征可以忽略，或不执行。另一点，所显示或讨论的相互之间的耦合或直接耦合或通讯连接可以是通过一些接口，装置或单元的间接耦合或通讯连接，可以是电性，机械或其它的形式。

所述作为分离部件说明的单元可以是或者也可以不是物理上分开的，作为单元显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例方案的目的。

另外，在本发明各个实施例中的各功能单元可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中。上述集成的单元既可以采用硬件的形式实现，也可以采用软件功能单元的形式实现。

上述仅以实施例来进一步说明本发明的技术内容，以便于读者更容易理解，但不代表本发明的实施方式仅限于此，任何依本发明所做的技术延伸或再创造，均受本发明的保护。本发明的保护范围以权利要求书为准。

Claims (8)

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

从excel中循环读取所有的接口数据；

判断当前状态读取到的接口是否需要运行；

若是，则判断接口是否存在关联依赖；

若否，则调用接口类；

根据接口类中不同的接口请求方式调用请求类；

请求类封装不同的请求接口，并返回响应数据至接口类；

通过正则表达式设置检查点与接口内得到的响应数据进行对比；

将对比结果和响应数据写入测试报告中。

2.根据权利要求1所述的一种基于python的接口自动化测试方法，其特征在于，所述判断接口是否存在关联依赖的步骤之后，还包括以下步骤：

若是，则进行关联参数拆分；

将拆分的关联参数替换请求参数。

3.根据权利要求1所述的一种基于python的接口自动化测试方法，其特征在于，所述从excel中循环读取所有的接口数据的步骤之后，还包括以下步骤：

对需要加密的接口数据采用des进行对称加密。

4.根据权利要求1所述的一种基于python的接口自动化测试方法，其特征在于，所述调用接口类的步骤之后，还包括以下步骤：

调用日志类log；

向日志文件和控制台输出相应日志信息。

5.一种基于python的接口自动化测试装置，其特征在于，所述装置包括读取单元、第一判断单元、第二判断单元、第一调用单元、第二调用单元、封装单元、对比单元以及存储单元；

所述读取单元，用于从excel中循环读取所有的接口数据；

所述第一判断单元，用于判断当前状态读取到的接口是否需要运行；

所述第二判断单元，用于判断接口是否存在关联依赖；

所述第一调用单元，用于调用接口类；

所述第二调用单元，用于根据接口类中不同的接口请求方式调用请求类；

所述封装单元，用于请求类封装不同的请求接口，并返回响应数据至接口类；

所述对比单元，用于通过正则表达式设置检查点与接口内得到的响应数据进行对比；

所述存储单元，将对比结果和响应数据写入测试报告中。

6.根据权利要求5所述的一种基于python的接口自动化测试装置，其特征在于，所述装置还包括拆分单元以及替换单元；

所述拆分单元，用于进行关联参数拆分；

所述替换单元，用于将拆分的关联参数替换请求参数。

7.根据权利要求5所述的一种基于python的接口自动化测试装置，其特征在于，所述装置还包括加密单元；

所述加密单元，用于对需要加密的接口数据采用des进行对称加密。

8.根据权利要求5所述的一种基于python的接口自动化测试装置，其特征在于，所述装置还包括第三调用单元以及发送单元；

所述第三调用单元，用于调用日志类log；

所述发送单元，用于向日志文件和控制台输出相应日志信息。