CN112131131A - 一种预构造域名及请求体的接口自动化测试框架系统 - Google Patents

Abstract

本发明涉及软件测试领域，公开了一种预构造域名及请求体的接口自动化测试框架系统，用以减少手工设置测试数据的操作，从而达到降低测试数据错误率的目的。本发明包括：文件存储层，用于构造并存储接口测试用例；读取数据层，用于读取文件存储层中电子表格数据，并预构造请求地址和请求体的数据，并将构造的数据作为提供的请求数据之一；发送数据层，用于发送请求数据供服务器测试；处理比较层，通过比较服务器返回的测试结果和文件存储层中电子表格中的期望结果，得出最终测试结论，并将最终测试结论发送至文件存储层中的电子表格保存；发送服务层，用于将经过处理比较层处理后的数据进行展示并发送至指定人员。本发明适用于接口测试。

Description

一种预构造域名及请求体的接口自动化测试框架系统

技术领域

本发明涉及软件测试领域，特别涉及一种预构造域名及请求体的接口自动化测试框架系统。

背景技术

目前大部分依赖excel测试用例的接口自动化测试的框架系统，都是通过读取每一行excel表格的测试用例数据，通过自动化测试脚本让每一条测试用例自动执行并输出测试结果从而完成接口自动化的测试。通过此种方法得到的测试结果，需要完全依赖于excel表格预先设置的数据。由于excel表格的测试用例数据都是手动填写，难免存在填写的数据出错的情况。而其中最容易出现设置错误的数据，莫过于接口请求的地址和请求体；同时，一部分测试用例的请求体中的部分参数需要代入到请求地址后构成新的请求地址和新的请求体来执行测试操作，此类需要二者进行部分替换的测试用例手工进行设置极其容易出现数据设置错误的情况。倘若接口的请求地址和请求体数据手动预先设置错误，导致错误的测试用例被执行，那么所得到的测试结果必然是错误的，接口自动化测试也就失去了其意义。

针对上述手动设置的请求地址和请求体测试数据容易出错的问题，本发明将设计一种预构造域名及请求体的接口自动化测试框架系统，自动预构造域名及请求体的部分参数。对于请求地址而言，无需在excel表格中手动重复输入域名；对于请求体的参数而言，无需手动设置需要与域名替换的请求体参数。通过预构造的方式，减少手工设置请求地址和请求体两个主要数据的操作，从而大大降低了请求地址和请求体两个重要测试数据的错误率。

发明内容

本发明要解决的技术问题是：提供一种预构造域名及请求体的接口自动化测试框架系统，用以减少手工设置测试数据的操作，从而达到降低测试数据错误率的目的，提高了接口自动化测试结果的正确性。

为解决上述问题，本发明采用的技术方案是：一种预构造域名及请求体的接口自动化测试框架系统，包括：

文件存储层，文件存储层作为最基本的数据提供，用于整合接口测试用例，按照电子模板方式构造存储接口测试用例，并存储测试用例测试完成后的最终测试结果；

读取数据层，读取数据层在读取电子表格模板数据前，会预先设置请求域名，再对读取到的电子表单中需要进行预构造的请求地址和请求体的数据，进行拼接或者替换操作，从而构造出的新内容作为测试的请求数据；

发送数据的发送数据层，该层用于发送请求数据供服务器测试；

接收返回数据的处理比较层，该层通过比较服务器返回的测试结果和电子表格中的期望结果，得出最终测试结论；

邮件发送功能的发送服务层，经过数据处理比较层处理后的数据最终在此层以特定格式展示并发送至指定人员，该层的发件人、签名、发送内容实现可配置。

优选地，所述文件存储层设置的电子表格模板，主要模板要素(字段)主要包括：用例编号、用例名称、Header、cookie、请求URL、请求数据、期望结果、实际结果及测试最终结果，要素之间无优先级；

其中，存储模板要素Header，cookie为非必需条件，Header在特定请求方式设置时提供，cookie在测试用例存在依赖关系时提供；

请求URL，无需手动设置域名，只需手动设置请求接口即可；

模板文件存储层数据行数支持999行，单个表单每行的数据内容按照序列号正序依次被读取数据的应用程序所获取。

优选地，读取数据层需要依赖特定的处理电子表格库或者模块，用于处理电子表格，处理电子表格的库来源python模块所特有的xlrd模块，模块工作用于读取电子数据并提供给发送数据层，经过读取数据应用程序层处理过的数据格式为列表类型，通过遍历方式依次将数据提供给发送数据层；

读取数据层若遇到空数据，即电子表格中单元格为空的数据会自动处理为“”,不会出现错误信息，使得该层更加人性化；

读取数据层适用于文件存储层的特定模板，非该特定模板的数据不会读取成功，返回出现错误提示信息；

通过在读取数据层预先设置请求域名，在其读取到电子表格的请求URL地址时，会自动将预先设置的请求域名与读取到的请求URL地址拼接，形成最终完整的请求地址；

为了易于发现错误，读取数据层每执行一条测试用例，会打印出当前请求的完整地址，以便执行测试时查看请求地址是否正确；

针对需要将请求地址和请求体的部分参数替换的测试数据，读取数据层通过特定的正则表达式自动进行替换，构成新的请求地址和请求参数作为测试数据。

优选地，发送数据层依赖特定发送消息的方法来发送数据消息到请求服务器，发送方式支持当前软件行业主流测试请求方式，请求方式包括GET，POST，DELETE,PUT，PATCH等；

发送数据层发送的数据包含从读取数据层获取的数据以及读取数据层构造的数据，将这些数据处理成服务端可识别的数据形式；

根据读取数据层读取到的请求方式不同，发送数据层会自动选择不同的请求方式，自动带上请求所必需的参数或者不发送请求参数进行数据的传递；

发送数据层发送的数据，如果发送失败，该层的处理异常程序会再次尝试进行数据发送，但发送次数有限制，例如最多重发五次，五次之后，不再进行该条数据发送，而开始进行下一条数据发送。

具体地，处理比较层获取服务器测试返回的响应数据，响应数据包含响应状态码，及响应的json数据；

处理比较层会将响应的json数据和从读取数据层获取到的对应项数据进行比较断言，比较断言方式可通过如下自定义方式实行；

断言判断返回json数据是否包含读取的电子表格数据的预定json数据，返回的响应状态码是否等于读取的电子表格数据的预定状态码；

断言判断返回json数据是否与读取的电子表格数据的预定json数据完全一致，返回的状态响应码是否等于读取的电子表格数据的预定状态码；

该层的判断方式会通过自定义的断言方式对返回结果和预定结果进行比较，将比较结果记录并存储，比较出所有数据结果后，通过字典进行数据统计，之后存放结果数据；

结果数据可通过使用python编程语言的xlwt模块相应的写入数据到excel列表的方法将数据写入到文件存储层的excel表格，会在表格测试最终结果列增加最终对比数据。

优选地，发送服务层会接收到处理比较层汇总的对比结果数据，并将该数据通过邮件形式发送，除了该对比结果数据外，邮件的其他内容可通过配置的方式进行发送，邮件发送过程会以日志形式展示，展示邮件发送成功与否；

该邮件发送应用服务层配置邮件包括接收邮箱、邮件接收人、发送内容、邮件签名配置；

接收邮箱支持多种流行邮箱，邮箱通过配置常量字符串代码进行配置，支持163邮箱，QQ邮箱，特定企业邮箱等邮箱形式；

邮件接收人通过配置常量字符串代码进行配置，代码为收件人邮箱账号，邮箱账号设置错误发送邮件将失败，但不会出现错误提示，需要手动检查邮箱账号配置正确与否；

邮件发送内容为可编辑，在邮件发送应用服务层提供了编辑邮件发送的具体内容和邮件签名；邮件签名为邮件提供了固定发送内容；

在上述技术方案中，接收返回数据应用层采用记录作为数据组织形式，每条记录对应一个请求发送后，服务器端返回的数据，数据类型为json类型，会通过特定程序转换为字符串类型，所有返回数据的集合均采用字符串类型存储。实际应用时，再根据邮件发送应用服务层的需要进行数据类型的转换。

本发明的有益效果如下：

由于本发明能够与构造电子表格中的请求地址和请求体两大重要参数，需要手动设置的内容相对传统设置内容大幅度减少，数据出错的情况也随之减少；

对于该系统框架的后期维护工作，无需投入过多的编码人员，只需投入到文件存储层和读取数据层。

针对文件存储层而言，只需对电子表格数据除请求地址和请求体外的其他数据进行仔细设计，此两项已经通过本发明预构造的数据，其人工的投入工作量相对传统的方式大幅度降低，正确性显著提高；

针对读取数据层而言，该层预构造了请求地址和请求体中的参数，无需手动构造详细参数，而造成难以避免的错误。

综上，本发明在保证代码质量的前提下，代码的开发与维护获得更大的灵活度和适应性，整体代码的安全及质量可以得到有效保障。

附图说明

图1为本发明提供的一种预构造域名及请求体的接口自动化测试框架系统的测试流程图；

图2为本发明提供的一种预构造域名及请求体的自动化测试框架系统文件存储层excel表头结构图；

图3为本发明提供的一种预构造域名及请求体的自动化测试框架系统发送服务层的邮件配置结构图。

具体实施方式

本发明设计思想中最核心的目标是降低接口自动化测试数据的错误率，通过减少手工设置测试数据的方法，减少手工设置数据时的错误，从而保证接口自动化测试结果的质量。

为实现上述目标，本发明对接口测试的请求地址及请求体参数预先自动进行设置，并通过不同层级之间的协同作用来进行自动化测试，得到更加准确的测试结果。

下面结合说明书附图和具体实施方式对本发明做出详细的说明。

如图1所示为本发明提供的一种通用型接口自动化测试框架系统的测试流程图，通过几个具有不同功能的处理层对excel的测试用例数据进行解析，对解析数据进行处理发送，对发送后收到的返回数据与预期结果进行对比分析，得出最终测试结果并将最终结果通过发送服务进行发送。所划分的不同功能数据处理层包括：

1、文件存储层,该层作为整个系统最基本的应用层，用于提供请求所需要的数据。

该层的使用者既可以是主要进行手工测试的测试人员，也可以是该系统的主要功能代码编写人员，因为作为最基本层，手工测试人员要保证测试用例的覆盖度，系统代码编写人员要确保提供数据的正确性，且代码对该数据的处理效率，所以该层的数据模板excel头数据固定设置。

其中，如图2所示为本发明提供的一种预构造域名及请求体的接口自动化测试框架系统文件存储层excel表头结构图，固定设置为以下字段：用例编号、用例名称、Header、cookie、请求URL、请求数据、期望结果、实际结果、测试最终结果。

数据头的用例编号由字母数字下划线组成,为必填项，三者任意一个开头均可，excel模板用例编号默认使用test_+数字的形式，如test_01,test_02。

数据头的用例名称为必填项，需要简单概括所对应行的用例基本功能，名称字数限制为100字，支持中文和英文识别。

Header为非必填项，若有些接口请求需要设置header作为请求数据，则需要填写该项，header一般是由一对数据组成的字典集合，有这些集合组成字典集合形式，如

"headers":[{"name":"Accept-Ranges","value":"bytes"},{"name":"Cache-Control","value":"max-age＝0"},{"name":"Content-Length","value":"0"},{"name":"Content-Type","value":"image/gif"}。

Cookie是个人身份的验证方式，为非必填项当接口用例之间存在关联性的时候，则需要填写该项，例如一个下单接口，请求该接口的前提是需要用户先登录，该下单接口关联了登录接口，因此需要使用调用登录接口成功后生成的cookie。在设计该条下单用例时则设置cookie假设用户已经先登录完成。Cookie一般是由一对数据组成的字典集合，如：Cookie:BAIDUID＝15C52C5E755E2DB1BCF2D948FBB97BE5:FG＝1；

BIDUPSID＝20E13624DAF3F85D32858B730E14F887；PSTM＝1584360071；BDUSS＝h1dmp5MzRNcmtrVGF-cVU3dmRYSUdsNWU3ZU9EbVdqMlV0S3pTVlljYUJFdDVlRVFBQUFBJCQAAAEAAAAuxqo94czLzQAIGFtl6BhbZea2；BDORZ＝FFFB88E999055A3F8A630C64834BD6D0；H_PS_PSSID＝1468_21086_31606。

请求URL是接口测试的基础，为必填项，URL即为通常说的网络地址，URL一般由域名+请求的具体接口组成，如www.baidu.com/？ou＝8&jik＝订单。此发明通过预构造域名的方式设置请求URL，因此无需手工设置请求域名，只需设置请求接口即可。

请求数据为非必填项，填写与否需要根据接口文档来确定，接口文档请求数据为空则不填写该项；接口文档请求数据不为空，则严格按照接口文档的请求参数填写，请求数据一般是由一对数据组成的字典集合，如{"pid":"201","pj":"www","fm":"behs","qid":"b5c6f43d0003e131"}。

期望结果为测试人员认为的符合测试用例请求数据发送后，服务端返回的期望数据，期望数据一般包括期望返回的状态码及期望返回的实际内容status：200；soutu-btn:hover{background-position:0-20px}.wrapper_l#kw{width:494px}该项内容为必填项。

实际结果为请求数据发送后，服务器端返回的客观结果，此项为非必填项。为了保证测试的准确性和客观性，因此实际结果不能提前设置，为空数据。

测试最终结果为对比期望结果和实际结果后筛选出的最终结果，最终该结果会在测试过程完成之后由相应应用层自动添加。

2、读取数据层，该层主要用于解析读取文件存储层的excel测试用例，解析出的结果作为传递给下一层的数据。

读取数据层的主要设计者为具有一定代码能力的人员，开发具有excel表格处理功能封装好的小程序，而代码能力欠缺的手工测试人员则可直接使用该小程序的功能。

该层会读取excel列表的每一行和每一列数据，将excel列表单元格的内容处理成一部分具有相同意义的字符串集合。

该层读取excel列表数据需要使用python软件自带的处理excel的库，xlrd模块和xlwt模块。其中，xlrd模块中使用相应的方法读取excel表格的内容；xlwt模块使用相应的方法将数据写入excel表格。

对于读取的URL地址而言，在该层预构造了域名，通过将预构造完成的域名与读取到的接口自动拼接形成新的请求地址作为新的测试数据。如:该层预构造好了域名www.sychi.com,通过excel读取到的接口地址为getProjeid/iju，自动将两者拼接成新的请求地址：www.sychi.com/getProjeid/iju，将其作为新的测试数据。

对于需要请求地址与请求体的部分参数替换的数据，该层通过正则表达式对其进行替换构成新的请求地址和请求体，作为新数据。如：该层读取到的请求地址为getStartTin/{proJ}；读取到的请求体为{“proJ”:34912hdfadiriirj,”endname”:”zhangsan”},由于需要将请求体的proJ的具体值代入请求地址，所以该层将请求地址自动构造成getStartTin/34912hdfadiriirj；将请求体自动构造成{”endname”:”zhangsan”}。最终将新构造出的结果作为新的数据。

使用上述xlrd模块中读取excel表格内容的方法，读取文件存储层excel模板内容；使用xlwt模块中写入excel表格内容的方法，将服务器端返回的实际结果数据写入文件存储层的excel模板中。

3、发送数据层，该层主要接收经过文件读取层处理后的数据，并将该数据通过该层特定的方法进行发送服务器端的操作，该层包含自动处理从读取数据层获取的数据，将这些数据处理成服务端可识别的数据形式；

该层的主要设计者为具有一定代码能力的人员，开发根据数据存储层的数据中不同请求方式自动选择正确请求方式的小程序，通过获取到的不同请求方式，智能选择对应的请求方式发送数据至服务端。

该层的请求方式默认支持GET，POST，DELETE,PUT的发送请求类型，如：从excel列表读取到的发送请求类型为POST类型，该层会自动使用发送POST请求类型的方法实现数据发送，不会错误选择其他请求类型。

发送数据方式的选择还具有拓展性，可以通过编写代码的方式来增加不同请求方法，从而拓展请求方式。如：可以编写PATCH请求方法，添加到该层的模块代码中，则该层拓展出了一个PATCH方法。

发送数据层具有异常处理功能，如果读取的excel列表数据发送失败，程序不再继续处理下一条数据，开始尝试对发送失败的用例尝试再次进行数据发送，在重发五次数据之后，不再继续进行对该条数据的发送，继而开始进行下一条数据的发送；若尝试发送限制次数范围内出现发送成功，不会再次发送，即只要重发成功，就执行下条数据的发送。如：前10条数据发送成功，第11条数据发送失败，那么尝试重新发送该第11条数据，第11条数据尝试5次仍然发送失败，则忽略第11条数据，进行第12条数据的发送；若在尝试到第三次的时候，第11条数据发送成功，不会再次尝试第4,5次，直接进行第12条数据的发送。

4、处理比较层，该层获取服务器测试返回的响应数据，响应数据主要包含响应状态码，及响应的具体数据。

获取到的状态码有多种，如：200，400，404等；不同的状态码代表不同的状态，如：200表示请求服务器成功、400表示请求错误、404表示服务器找不到请求的网页等。接收数据返回层可以对服务器返回的多种状态码进行接收，并将其存储准备发送给下一层。

服务器响应的具体数据格式一般为json，即用双引号包含的字典数据，如：{"employees":[{"firstName":"Bill","lastName":"Gates"},{"firstName":"George","lastName":"Bush"},{"firstName":"Thomas","lastName":"Carter"}]}。接收数据层会对该数据进行接收处理并存储准备发送给下一层。

处理该json数据，主要使用python的json模块提供的dumps方法和loads方法。如：有一个组json数据a，要对该数据进行解析，使用json.dump(a)，处理获取到的数据，loads方法的使用方法与之相同。

经过解析的json数据和接收到的状态码，通过断言判断是否包含读取到的excel数据的期望json数据，返回的响应状态码是否等于读取的excel数据的期望状态码；

断言判断返回json数据是否与读取的excel数据的预定json数据完全一致，返回的状态响应吗是否等于读取的excel数据的预定状态码；

接收返回数据层会通过自定义的断言方式对返回结果和预定结果进行比较，将比较结果记录并存储，比较出所有数据结果后，通过字典进行数据统计，之后存放结果数据。

存放结果数据主要包括布尔值和解析后的对比差异json数据：

布尔值：主要是将服务器返回的状态码和期望结果中的状态码是否相等，对比后产生的最终状态，如：期望的状态码是200，服务器返回得到的状态码是400，200！＝400，最终布尔值为False；若服务器返回得到的状态码是200,200＝＝200,最终布尔值为Ture。

差异json数据：主要是将服务器返回的具体json数据与期望的json数据进行对比，找出其中差异的数据，如：服务器返回的json数据是：{“name”:”tanlet”,”cookie”:”213421hf8894ji39213h”,"firstName":"George","lastName":"Bush"}，期望的json数据是：{“name”:”tanlet”,"lastName":"Bush"}

期望返回结果与实际返回结果json数据不一致，差异数据为”cookie”:”213421hf8894ji39213h”，"firstName":"George"。

综合对比两种数据的结果，作为最终结果,以{布尔值,差异数据}的形式输出，如:{Ture,[”cookie”:”213421hf8894ji39213h”，"firstName":"George"]}。该层含有处理结果数据的程序使用python的xlwt模块写入数据到excel列表的方法，再将最终结果逐个写入一个新的excel列表，得到集合所有最终结果的新excel列表。

5、发送服务层，如图3为本发明提供的一种预构造域名及请求体的接口自动化测试框架系统发送服务层的邮件配置结构图。发送服务层会接收到数据层汇总的对比结果excel数据，并将该数据通过邮件形式发送，除了该对比结果数据外，邮件的其他内容可通过配置的方式进行发送；其他内容如:邮件的发送人的邮箱地址，接收人的邮箱地址，除结果数据的外的发送文字内容描述，邮件发送内容的默认签名。邮件发送过程会以日志形式展示，若邮件发送失败，发送程序会尝试发送三次。三次中若发送成功则不会再次进行尝试发送操作，若三次尝试都失败，那么邮件最终发送结果为发送邮件失败。日志形式如:邮件正在发送…，邮件发送成功,邮件发送失败…。

发送人和接收人的邮箱类型支持多种主流邮箱，也可以是企业邮箱、个人员工邮箱。主流邮箱如:163邮箱、QQ邮箱；企业邮箱即为个人所在部门的邮箱，个人员工邮箱即为公司归属下属于个人的邮箱，如:yinwyu2xiaomi.com。

邮件接收人、邮件发送人的邮箱格式通过邮箱账号字符串代码的形式进行配置，配置内容手动输入部分账号即可，如:zhangsan，输入账号后配置系统自动带出所有可选择的邮箱后缀格式，如:@163.com,@qq.com,@xiaomi.com；系统中不存在的邮箱后缀格式，则需要用户手动输入。

邮件发送内容为可编辑，在邮件发送应用服务层提供了编辑邮件发送的具体内容和邮件签名的程序；发送内容如：“XXX项目测试结果，请查收”，方式为手动输入，当邮件在发送时就会按照此内容进行发送。

邮件签名，是发送邮件时设置的邮件内容最底部显示的内容，如：发件人：XXX，电话：XXXXXXXX，联系地址：XXXXXX，邮件签名为邮件提供了固定发送内容。

日志伴随着邮件发送结果而不同，如：邮件从发送开始到发送成功，日志显示：邮件发送中…邮件发送成功；邮件从发送开始到发送失败，再次尝试发送后发送成功，日志显示：邮件发送中…邮件发送失败…邮件发送中…邮件发送成功；邮件从发送开始到发送失败，再次尝试发送后仍然发送失败，日志显示：邮件发送中…邮件发送失败…邮件发送失败…邮件发送失败。

以上便是该框架各个设计流程详细描述，若将其应用到项目之中。该测试框架后期的维护工作，只是最简单层面的维护，对编码数据的维护几乎可以忽略不计，代码复用实现了最大化，测试人员只需提供含有期望结果的excel表格和配置属于项目的具体邮件内容，对数据的发送、接收、处理、生成结果，都由已经编写完成的程序自动执行。

本发明不局限于上述最佳实施方式，任何人在本发明的启示下做出的结构变化，凡是与本发明具有相同或相近的技术方案，均落入本发明的保护范围之内。

Claims (6)

1.一种预构造域名及请求体的接口自动化测试框架系统，其特征在于，包括：

文件存储层，该层用于构造并存储接口测试用例，同时在文件存储层还维护有一个与测试用例执行相关的电子表格；

读取数据层，该层用于读取文件存储层中电子表格数据，并基于根据预先设置的请求域名以及电子表格中的请求URL和请求数据，预构造请求地址和请求体的数据，并将预构造的数据作为提供的请求数据之一；

发送数据层，该层用于发送请求数据供服务器测试；

处理比较层，该层通过比较服务器返回的测试结果和文件存储层中电子表格中的期望结果，得出最终测试结论，并将最终测试结论发送至文件存储层中的电子表格保存；

发送服务层，该层用于将经过处理比较层处理后的数据进行展示并发送至指定人员。

2.如权利要求1所述的一种预构造域名及请求体的接口自动化测试框架系统，其特征在于，所述电子表格具体包含了以下字段：用例编号、用例名称、请求URL、请求数据、期望结果、实际结果和测试最终结果。

3.如权利要求2所述的一种预构造域名及请求体的接口自动化测试框架系统，其特征在于，所述电子表格还包含以下字段：Header和cookie。

4.如权利要求1所述的一种预构造域名及请求体的接口自动化测试框架系统，其特征在于，读取数据层预构造请求地址和请求体的步骤包括：

对于构造完整的请求地址的情形，首先预先设置请求域名，然后读取到电子表格的请求URL时，将预先设置的请求域名与读取到的请求URL拼接，最终形成完整的请求地址；

对于需要将请求地址与请求体中的部分参数替换的情形，通过正则表达式对读取到请求地址与请求体进行替换，从而构成新的请求地址和请求体。

5.如权利要求1所述的一种预构造域名及请求体的接口自动化测试框架系统，其特征在于，读取数据层每执行一条测试用例，会打印出当前请求的完整地址。

6.如权利要求1所述的一种预构造域名及请求体的接口自动化测试框架系统，其特征在于，发送服务层以邮件的方式发送至指定人员，邮件发送过程会以日志形式展示。

Images