CN117370217A - 一种基于python的接口测试结果自动生成方法 - Google Patents

Abstract

本发明提供了一种基于python的接口测试结果自动生成方法，包括：构建接口自动化测试框架，进行大规模接口测试；读取接口自动化测试框架中的测试用例数据，并进行参数变量替换操作；定义请求发送类和响应处理类，分别进行请求发送和响应校验操作；将测试结果写入测试报告，并通过邮件发送测试报告。本发明有益效果：适应***不断变化的需求，在短时间内执行大量测试，清晰准确的将测试结果展现出来并发送给相关人员，自动化测试框架可以消除人为错误，每次测试都按照相同的标准执行，提高了测试的准确性，自动化测试框架降低了人工测试资源的需求，减少成本。

Description

一种基于python的接口测试结果自动生成方法

技术领域

本发明属于计算机技术领域，尤其是涉及一种基于python的接口测试结果自动生成方法。

背景技术

接口测试在软件测试中扮演着重要的角色，它专注于测试不同组件、模块或***之间的交互，确保他们能够正确无误的协同工作，通过接口测试，可以及早发现并解决集成问题，防止错误扩散到整个软件***，此外，接口测试还有助于验证各组件的功能和数据的传递，提高***的可维护性，减少后期修复成本，接口测试可以不依赖前端页面发现很多页面上操作发现不了的bug，覆盖前端更多无法测试的场景，接口测试更早的介入，可以更早的发现并解决bug，缩短整个项目的上线时间。

工具类软件，主要用于在开发阶段工程师用于调试接口的连通性，多用于以手工测试人员为主的接口体量较小的公司，并不能对整个项目做完整的接口测试以及对测试结果的保存，对于复杂的场景，可能要编写复杂的脚本来处理数据、处理断言，对于没有编程经验的人来说可能会有难度，Jmeter在模拟大规模并发用户时，会占用大量的资源，包括内存和cpu，这可能对开发机器产生负担，影响其他任务的运行，现在业内常见的接口测试工具对于整个项目的测试以及结果的保存都难以满足。

发明内容

有鉴于此，本发明旨在提出一种基于python的接口测试结果自动生成方法，以期解决部分技术问题中的至少之一。

为达到上述目的，本发明的技术方案是这样实现的：

一种基于python的接口测试结果自动生成方法，包括：

构建接口自动化测试框架，进行大规模接口测试；

读取接口自动化测试框架中的测试用例数据，并进行参数变量替换操作；

定义请求发送类和响应处理类，分别进行请求发送和响应校验操作；

将测试结果写入测试报告，并通过邮件发送测试报告。

进一步的，接口自动化测试框架设有多级目录，多级目录的功能包括：

存放启动文件以及多线程文件，驱动框架运行；存放测试用例；存放处理字符串、读取数据相关的配置文件；解析数据并发送请求；存放日志文件；存储测试报告。

进一步的，读取接口自动化测试框架中的测试用例数据，并进行参数变量替换操作的过程包括：

由指定文件的文件路径读取测试用例数据；

打开指定文件，并从文件的第二行开始遍历每行的测试数据；

提取每行的测试数据中第2至7列的数据，作为测试用例信息；

将请求参数和请求头传递至参数替换函数中，执行参数变量替换操作；

参数替换函数遍历预定义函数，替换字符串中的函数名部分。

进一步的，参数替换函数遍历预定义函数，替换字符串中的函数名部分的过程包括：

参数替换函数遍历预先定义的函数映射函数，函数映射函数中存储函数名及相对应的函数对象；

检测输入字符串是否包含函数映射函数中的函数名，若包含，则取出对应的函数对象，执行函数；

用函数执行结果替换原字符串中函数名部分。

进一步的，定义请求发送类和响应处理类，分别进行请求发送和响应校验操作，其中定义请求发送类，进行请求发送操作的过程包括：

根据测试用例中的参数类型，动态选择使用相应的参数发送请求；

请求发送成功后，将响应结果转换为Json格式以及字符串格式，并分别存储。

进一步的，定义请求发送类和响应处理类，分别进行请求发送和响应校验操作，其中定义响应处理类，进行响应校验操作的过程包括：

定义解析响应类，在解析响应类中定义构造函数，构造函数接收校验规则以及响应结果两个参数；

其中校验规则为字符串格式，响应结果为Json格式；

在构造函数中，将校验规则以及响应结果保存到对象的属性中，并定义核心函数执行校验逻辑。

进一步的，定义核心函数执行校验逻辑的过程包括：

根据校验规则拆分出多个校验条件，每个校验条件包含键名、操作符和预期值三部分；

根据键名从响应结果中获取实际值，将实际值和预期值与操作符组成比较表达式；

执行比较表达式判断是否满足条件，循环校验每个校验条件并记录校验结果；

校验结束后，根据校验条件的结果判断校验是否通过。

进一步的，将测试结果写入测试报告，并通过邮件发送测试报告的过程包括：

读取指定目录下文件，获取所有符合条件的测试用例文件路径列表；

读取测试用例文件中的测试用例数据，发送请求获取接口响应，对响应进行检查；

更新总用例数和通过用例数，将测试结果写入测试报告中，每个用例通过独立线程并发运行，等待所有线程结束；

执行完毕后发送报告邮件。

相对于现有技术，本发明所述的一种基于python的接口测试结果自动生成方法具有以下有益效果：

可以轻松添加新的测试case，适应***不断变化的需求；

可以在短时间内执行大量测试case；

可以很清晰准确的将测试结果展现出来并发送给相关人员；

自动化测试框架可以消除人为错误，每次测试都按照相同的标准执行，提高了测试的准确性；

自动化测试框架降低了人工测试资源的需求，减少成本。

附图说明

构成本发明的一部分的附图用来提供对本发明的进一步理解，本发明的示意性实施例及其说明用于解释本发明，并不构成对本发明的不当限定。在附图中：

图1为本发明实施例所述的一种基于python的接口测试结果自动生成方法的流程示意图。

具体实施方式

需要说明的是，在不冲突的情况下，本发明中的实施例及实施例中的特征可以相互组合。

下面将参考附图并结合实施例来详细说明本发明。

一种基于python的接口测试结果自动生成方法，包括：

S1、构建接口自动化测试框架，进行大规模接口测试；

S2、读取接口自动化测试框架中的测试用例数据，并进行参数变量替换操作；

S3、定义请求发送类和响应处理类，分别进行请求发送和响应校验操作；

S4、将测试结果写入测试报告，并通过邮件发送测试报告。

步骤S1中的接口自动化测试框架设有多级目录，多级目录的结构为：bin\cases\config\lib\logs\report；

多级目录结构中各级的功能如下：

bin目录存放启动文件和多线程相关代码，用于驱动框架运行；

cases目录存放测试用例，便于管理和维护；

config目录存放配置文件，包括处理字符串、读取数据等相关函数配置；

lib目录为框架的核心功能模块，解析数据并发送请求；

logs目录用于存放日志文件，方便问题定位和调试；

report目录用来存储测试报告。

所述多级目录的结构按功能清晰划分目录，方便代码和资源的管理与维护，且日志和报告独立存储，便于回溯和追踪，其核心功能与配置相对隔离保证各功能与各文件的安全性。

步骤S2中读取接口自动化测试框架中的测试用例数据，并进行参数变量替换操作的过程包括：

S21、定义read_excel函数，从指定Excel文件路径读取测试用例数据；

S22、打开Excel文件，从第二行开始遍历每行测试数据；

S23、提取每行从第2列到第7列的数据作为测试用例信息；

S24、将请求参数和请求头(第3列和第4列)传递给replace_param函数进行参数化替换；

S25、replace_param函数遍历预定义函数，在字符串中替换函数名为实际值，实现参数化替换；

S26、将替换后的整行测试数据添加到case_list列表中；

读取Excel数据封装在类中，通过replace_param实现参数化，统一处理后返回标准格式的数据列表；

所述case_list列表充当了测试用例数据的交接和传递载体作用，用于存储读取并处理完毕后的所有测试用例数据，具体为：将从Excel文件中读取的每行测试用例数据，经过参数化处理后统一添加到这个case_list列表中；

且case_list列表中的数据格式为标准化后的字典形式，方便后续直接取用各项数据，在后续的CaseRun类中，会根据case_list列表中的数据进行测试用例的执行；

每执行一个用例，会从case_list列表中取出一条数据进行测试，执行完成后，会更新对应用例在case_list中的状态，最终生成报告也是基于case_list列表中的测试结果数据。

步骤S25中replace_param函数遍历预定义函数，在字符串中替换函数名为实际值，实现参数化替换，的过程包括：

S251、replace_param函数遍历预先定义的func_map函数映射，所述func_map函数中存储有函数名和对应的函数对象；

S252、检测输入字符串是否包含func_map中的函数名，若包含，则取出对应的函数对象，执行函数；若不包含，则无需对当前输入字符串进行处理；

S253、用函数执行结果替换原字符串中函数名部分，这样就实现了参数值的动态获取和替换。

步骤S3中定义请求发送类和响应处理类，分别进行请求发送和响应校验操作，其中定义请求发送类，进行请求发送操作的过程包括：

S31、判断测试用例中的测试数据是否为Json格式的数据，动态选择使用params还是json参数发送请求，以适应不同接口的请求格式，既支持表单请求，也支持Json请求；

S32、请求发送成功后，将响应结果Response转换为Json对象存储在self.result中，同时将Response也转换为字符串存储在self.text中。

其中，将Response存储为Json对象和字符串两个版本的效果为：

Json对象格式的Response方便后续直接取用字段进行校验，字符串格式的Response方便记录失败原因时输出；

这种设计解耦了请求参数的格式，同时存储两种格式的响应结果，便于后续校验和失败信息输出，是发送请求类应有的完整功能。

步骤S3中定义请求发送类和响应处理类，分别进行请求发送和响应校验操作，其中定义响应处理类，进行响应校验操作的过程包括：

S33、自定义ParseResponse类，用于对接口响应结果进行校验；

S34、在ParseResponse类中定义构造函数__init__，__init__接收两个参数：

check_str：字符串形式的校验规则；

response：接口调用返回的响应结果（json格式）；

S35、在__init__函数中，将check_str、response两个参数保存到对象的属性中，为后续校验做准备；并在__init__函数中，将校验规则以及响应结果保存到对象的属性中，并定义核心函数check_response()执行校验逻辑。

步骤S35中定义核心函数check_response()执行校验逻辑的过程包括：

S351、根据规则字符串check_str拆分出每个校验条件，每个条件包含键名、操作符和预期值三部分；

S352、根据键名从response中获取实际值，将实际值和预期值与操作符组成比较表达式；

S353、使用eval函数执行比较表达式，判断是否满足条件；

S354、check_response函数循环校验每个条件并记录校验结果，校验结束后，根据个别条件结果判断整体是否通过；

可以调用check_response()函数执行校验，既实现了响应结果自动校验，也支持通过规则字符串动态配置校验逻辑。

步骤S4中将测试结果写入测试报告，并通过邮件发送测试报告的过程包括：

S41、定义CaseRun类用于测试用例的获取、执行、统计和报告邮件发送工作；

S42、定义get_case函数，通过读取指定目录下文件，获取所有符合条件(Excel)的测试用例文件路径列表；

S43、创建ParamDeal实例，用于读取Excel文件中的测试用例数据，使用MyRequest实例发送请求，获取接口响应，使用ParseResponse实例对响应进行检查；

S44、更新总用例数和通过用例数，将结果存入response_list，将测试结果写入Excel报告，报告名添加到report_list；

S45、每个用例通过独立线程并发运行，等待所有线程结束；执行完毕后，通过send_mail函数发送报告邮件。

工作过程：

编写接口自动化测试测试用例，所述自动化测试用例包括：项目名称、请求URL、请求方式、请求参数（变量形式）、Header、入参是否为Json、预期结果；

定义ParamDeal类，其主要作用是处理接口测试用例的参数和读取，判断测试用例是否读取成功，定义read_excel函数用于从指定的Excel文件中读取测试用例数据，将其转换为一个List，并返回，在read_excel函数中又调用了replace_param和str_to_dict函数，其中replace_param用于在字符串中替换参数化标记，通过调用预先定义的函数获取实际参数值，并将参数化标记替换为实际值，str_to_dict函数用于将请求参数的字符串形式转换为字典；

定义MyRequest类用于发送HTTP请求，首先根据is_json参数选择使用params或json参数来发送请求，然后将Response转换为Json对象，并存储在self.result中，同时将Response转换为字符串存储在self.text中，方便记录失败原因；

通过ParseResponse校验结果的正确性，检查是否满足指定的条件，如果条件不满足，则记录失败原因和状态，统计成功测试用例和失败测试用例以及失败的原因，并将这些结果写进测试用例；

全部测试完毕后，生成测试报告，并将测试报告通过邮件发送给测试人员和开发人员。

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

在本申请所提供的几个实施例中，应该理解到，所揭露的方法和***，可以通过其它的方式实现。例如，以上所述单元的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，例如多个单元或组件可以结合或者可以集成到另一个***，或一些特征可以忽略，或不执行。上述单元可以是或者也可以不是物理上分开的，作为单元显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本发明实施例方案的目的。

最后应说明的是：以上各实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述各实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分或者全部技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的范围，其均应涵盖在本发明的权利要求和说明书的范围当中。

以上所述仅为本发明的较佳实施例而已，并不用以限制本发明，凡在本发明的精神和原则之内，所作的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。

Claims (8)

1.一种基于python的接口测试结果自动生成方法，其特征在于，包括：

构建接口自动化测试框架，进行大规模接口测试；

读取接口自动化测试框架中的测试用例数据，并进行参数变量替换；

定义请求发送类和响应处理类，分别进行请求发送和响应校验操作；

将测试结果写入测试报告，并通过邮件发送测试报告。

2.根据权利要求1所述的一种基于python的接口测试结果自动生成方法，其特征在于：

接口自动化测试框架设有多级目录，多级目录中各级目录的功能分别为：

存放启动文件以及多线程文件，驱动框架运行；

存放测试用例；

存放处理字符串、读取数据相关的配置文件；

解析数据并发送请求；

存放日志文件；

存储测试报告。

3.根据权利要求1所述的一种基于python的接口测试结果自动生成方法，其特征在于：

读取接口自动化测试框架中的测试用例数据，并进行参数变量替换操作的过程包括：

由指定文件的文件路径读取测试用例数据；

打开指定文件，并从文件的第二行开始遍历每行的测试数据；

提取每行的测试数据中第2至7列的数据，作为测试用例信息；

将请求参数和请求头传递至参数替换函数中，执行参数变量替换操作；

参数替换函数遍历预定义函数，替换字符串中的函数名部分。

4.根据权利要求3所述的一种基于python的接口测试结果自动生成方法，其特征在于：

参数替换函数遍历预定义函数，替换字符串中的函数名部分的过程包括：

参数替换函数遍历预先定义的函数映射函数，函数映射函数中存储函数名及相对应的函数对象；

检测输入字符串是否包含函数映射函数中的函数名，若包含，则取出对应的函数对象，执行函数；

用函数执行结果替换原字符串中函数名部分。

5.根据权利要求1所述的一种基于python的接口测试结果自动生成方法，其特征在于：

定义请求发送类和响应处理类，分别进行请求发送和响应校验操作，其中定义请求发送类，进行请求发送操作的过程包括：

根据测试用例中的参数类型，动态选择使用相应的参数发送请求；

请求发送成功后，将响应结果转换为Json格式以及字符串格式，并分别存储。

6.根据权利要求5所述的一种基于python的接口测试结果自动生成方法，其特征在于：

定义请求发送类和响应处理类，分别进行请求发送和响应校验操作，其中定义响应处理类，进行响应校验操作的过程包括：

定义解析响应类，在解析响应类中定义构造函数，构造函数接收校验规则以及响应结果两个参数；

其中校验规则为字符串格式，响应结果为Json格式；

在构造函数中，将校验规则以及响应结果保存到对象的属性中，并定义核心函数执行校验逻辑。

7.根据权利要求6所述的一种基于python的接口测试结果自动生成方法，其特征在于：

定义核心函数执行校验逻辑的过程包括：

根据校验规则拆分出多个校验条件，每个校验条件包含键名、操作符和预期值三部分；

根据键名从响应结果中获取实际值，将实际值和预期值与操作符组成比较表达式；

执行比较表达式判断是否满足条件，循环校验每个校验条件并记录校验结果；

校验结束后，根据校验条件的结果判断校验是否通过。

8.根据权利要求1所述的一种基于python的接口测试结果自动生成方法，其特征在于：

将测试结果写入测试报告，并通过邮件发送测试报告的过程包括：

读取指定目录下文件，获取所有符合条件的测试用例文件路径列表；

读取测试用例文件中的测试用例数据，发送请求获取接口响应，对响应进行检查；

更新总用例数和通过用例数，将测试结果写入测试报告中，每个用例通过独立线程并发运行，等待所有线程结束；

执行完毕后发送报告邮件。