CN107562623A - 一种rest api自动化测试方法及系统 - Google Patents

Abstract

本发明公开了一种REST API自动化测试方法及系统，其中该方法包括：获取预先设定的公共函数，公共函数为预先将不同测试用例中相同的步骤封装得到的函数；获取预先设定的测试公共数据，测试公共数据为不同测试用例中包含的相同的数据；获取与测试当前REST API接口对应的测试函数，测试函数为测试当前REST API接口所需的特有的函数；将公共函数、测试公共数据和测试函数组合成当前测试用例，并基于当前测试用例完成对当前REST API接口的测试。本发明提供的一种REST API自动化测试方法解决了如何提高测试REST API的测试效率的技术问题。

Description

一种REST API自动化测试方法及系统

技术领域

本发明涉及REST API技术领域，更具体地说，涉及一种REST API自动化测试方法及系统。

背景技术

REST API是基于REST(Representational State Transfer，表述性状态传递)标准的开放接口，是设计Web服务的一种方法，对外通过URL提供http访问资源。实际应用中，需要对REST API接口的功能进行测试。

现有的一种测试REST API接口的方法是根据不同的测试要求创建不同的测试用例，这里的测试用例是为测试REST API接口而编制的一组测试输入、执行条件以及预期结果。每个测试用例的内容均包括：先在包含PEST API接口的存储设备上创建和设置测试内容，再通过测试工具设置参数组合各种请求，发送请求至REST API接口，然后测试发送过去的请求能否被REST API接口通过，以及REST API接口能否根据请求返回正确的测试内容。

然而，现有的一种测试REST API接口的方法中，不同测试用例的测试步骤基本完全相同，重复工作多，测试效率低。

综上所述，如何提高测试REST API的测试效率是目前本领域技术人员亟待解决的问题。

发明内容

本发明的目的是提供一种REST API自动化测试方法，其能解决如何提高测试RESTAPI的测试效率的技术问题。本发明还提供了一种REST API自动化测试系统。

为了实现上述目的，本发明提供如下技术方案：

一种REST API自动化测试方法，包括：

获取预先设定的公共函数，所述公共函数为预先将不同测试用例中相同的步骤封装得到的函数；

获取预先设定的测试公共数据，所述测试公共数据为不同测试用例中包含的相同的数据；

获取与测试当前REST API接口对应的测试函数，所述测试函数为测试所述当前REST API接口所需的特有的函数；

将所述公共函数、所述测试公共数据和所述测试函数组合成当前测试用例，并基于所述当前测试用例完成对所述当前REST API接口的测试。

优选的，所述基于所述当前测试用例完成对所述当前REST API接口的测试之后，还包括：

调整所述当前测试用例，基于调整后的所述当前测试用例完成对所述当前RESTAPI接口的回归测试。

优选的，预先将不同测试用例中相同的步骤封装得到所述公共函数，包括：

基于python语言的第三方库paramiko对不同测试用例中相同的登录存储设备、发送CLI命令至所述存储设备、接收所述存储设备发送的执行所述CLI命令的执行结果的步骤进行二次封装得到对应的公共函数，所述存储设备为包括REST API接口的设备；

基于所述python语言内置模块logging对不同测试用例中相同的保存日志、分级日志的步骤进行二次封装得到对应的公共函数；

基于所述python语言的第三方库requests对不同测试用例中相同的发送web请求至包括REST API接口的存储设备、接收包括REST API接口的存储设备返回与所述web请求对应的数据的步骤进行二次封装得到对应的公共函数。

优选的，预先设定测试公共数据，包括：

预先将不同REST API接口对应的URL中相同的资源设定为对应的测试公共数据；

预先将包括REST API接口的存储设备中不同的用户名、密码设定为对应的测试公共数据。

本发明还提供了一种REST API自动化测试系统，包括：

获取公共函数模块，用于获取预先设定的公共函数，所述公共函数为预先将不同测试用例中相同的步骤封装得到的函数；

获取测试公共数据模块，用于获取预先设定的测试公共数据，所述测试公共数据为不同测试用例中包含的相同的数据；

获取测试函数模块，用于获取与测试当前REST API接口对应的测试函数，所述测试函数为测试所述当前REST API接口所需的特有的函数；

组合模块，用于将所述公共函数、所述测试公共数据和所述测试函数组合成当前测试用例，并基于所述当前测试用例完成对所述当前REST API接口的测试。

优选的，还包括：

回归测试模块，用于在所述组合模块基于所述当前测试用例完成对所述当前RESTAPI接口的测试之后，调整所述当前测试用例，基于调整后的所述当前测试用例完成对所述当前REST API接口的回归测试。

优选的，还包括：

预设公共函数模块，用于基于python语言的第三方库paramiko对不同测试用例中相同的登录存储设备、发送CLI命令至所述存储设备、接收所述存储设备发送的执行所述CLI命令的执行结果的步骤进行二次封装得到对应的公共函数，所述存储设备为包括RESTAPI接口的设备；基于所述python语言内置模块logging对不同测试用例中相同的保存日志、分级日志的步骤进行二次封装得到对应的公共函数；基于所述python语言的第三方库requests对不同测试用例中相同的发送web请求至包括REST API接口的存储设备、接收包括REST API接口的存储设备返回与所述web请求对应的数据的步骤进行二次封装得到对应的公共函数。

优选的，还包括：

预设测试公共数据模块，用于预先将不同REST API接口对应的URL中相同的资源设定为对应的测试公共数据；预先将包括REST API接口的存储设备中不同的用户名、密码设定为对应的测试公共数据。

本发明提供的一种REST API自动化测试方法，包括获取预先设定的公共函数，公共函数为预先将不同测试用例中相同的步骤封装得到的函数；获取预先设定的测试公共数据，测试公共数据为不同测试用例中包含的相同的数据；获取与测试当前REST API接口对应的测试函数，测试函数为测试当前REST API接口所需的特有的函数；将公共函数、测试公共数据和测试函数组合成当前测试用例，并基于当前测试用例完成对当前REST API接口的测试。本发明提供的一种REST API自动化测试方法，通过获取预先设定的公共函数和测试公共数据，获取与测试当前REST API接口对应的测试函数，然后将公共函数、公共数据和测试函数组合成当前测试用例，从而使得不需要重复不同测试用例中相同的函数和数据，简化了组合测试用例的过程，进而提高了测试REST API接口的测试效率。综上所述，本发明提供的一种REST API自动化测试方法解决了如何提高测试REST API的测试效率的技术问题。本发明提供的一种REST API自动化测试系统也解决了相应的技术问题。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。

图1为本发明实施例提供的一种REST API自动化测试方法的流程图；

图2为本发明实施例提供的一种REST API自动化测试系统的结构示意图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

请参阅图1，图1为本发明实施例提供的一种REST API自动化测试方法的流程图。

本发明实施例提供的一种REST API自动化测试方法中各个步骤的动作执行主体可以是REST API自动化测试系统，以下将该系统简称为自动化测试系统实现对应功能的说明。

本发明实施例提供的一种REST API自动化测试方法可以包括以下步骤：

步骤S1：获取预先设定的公共函数，公共函数为预先将不同测试用例中相同的步骤封装得到的函数。

实际应用中，自动化测试系统可以在外界或其他终端下发的指令下等触发方式进行触发后直接获取预先设定的公共函数，这里的公共函数是预先将不同测试用例中相同的步骤封装得到的函数。

步骤S2：获取预先设定的测试公共数据，测试公共数据为不同测试用例中包含的相同的数据。

实际应用中，自动化测试系统可以在外界或其他终端下发的指令下等触发方式进行触发后下直接获取预先设定的测试公共数据，这里的测试公共数据为不同测试用例中包含的相同的数据。

步骤S3：获取与测试当前REST API接口对应的测试函数，测试函数为测试当前REST API接口所需的特有的函数。

实际应用中，自动化测试系统可以在外界或其他终端下发的指令下等触发方式进行触发后直接获取与测试当前REST API接口对应的测试函数，这里的测试函数为测试当前REST API接口所需的特有的函数。可以为预先根据当前REST API接口的业务编写的对应测试函数。

步骤S4：将公共函数、测试公共数据和测试函数组合成当前测试用例，并基于当前测试用例完成对当前REST API接口的测试。

实际应用中，自动化测试系统在获取公共函数、测试公共数据和测试函数后，便可自动将公共函数、测试公共数据和测试函数组合成当前测试用例，并自动基于当前测试用例完成对当前REST API接口的测试。其中基于当前测试用例完成上述测试也即通过运行当前测试用例使之自动完成上述测试，以当前REST API接口对应存储设备为例对基于当前测试用例完成对当前REST API接口的测试进行说明：获取命令存储设备返回对应数据的命令行，使得存储设备在该命令行的触发下返回对应的数据作为校准数据；调用当前REST API接口实现对存储设备中存储的与命令行对应数据的获取，调用当前REST API接口获取的上述数据可以称为实时数据；将实时数据与校准数据进行比对，如果两者一致，则说明当前REST API接口通过测试，否则，则说明当前REST API接口未通过测试，从而完成基于当前测试用例对当前REST API接口的测试。其中，REST API接口返回的实时数据可以是以JSON(JS标记对象)数据结构的形式返回的。

另外，在完成上述测试之后还可以生成对应的测试报告，该测试报告中可以包括REST API接口的标识、校准数据、实时数据及校准数据和实时数据是否一致的结果等，从而使得工作人员可以通过查看该测试报告分析上述对REST API接口的测试结果。

本发明提供的一种REST API自动化测试方法，包括获取预先设定的公共函数，公共函数为预先将不同测试用例中相同的步骤封装得到的函数；获取预先设定的测试公共数据，测试公共数据为不同测试用例中包含的相同的数据；获取与测试当前REST API接口对应的测试函数，测试函数为测试当前REST API接口所需的特有的函数；将公共函数、测试公共数据和测试函数组合成当前测试用例，并基于当前测试用例完成对当前REST API接口的测试。本发明提供的一种REST API自动化测试方法，通过获取预先设定的公共函数和测试公共数据，获取与测试当前REST API接口对应的测试函数，然后将公共函数、公共数据和测试函数组合成当前测试用例，从而使得不需要重复不同测试用例中相同的函数和数据，简化了组合测试用例的过程，进而提高了测试REST API接口的测试效率。综上所述，本发明提供的一种REST API自动化测试方法解决了如何提高测试REST API的测试效率的技术问题。

本发明实施例提供的一种REST API自动化测试方法中，基于当前测试用例完成对当前REST API接口的测试之后，还可以包括：

调整当前测试用例，基于调整后的当前测试用例完成对当前REST API接口的回归测试。

实际应用中，有时需要调整当前测试用例，然后基于调整后的当前测试用例完成对当前REST API接口的二次测试，也即对当前REST API接口的回归测试，这样既可以对当前REST API接口进行二次测试，又可以降低当前测试用例因为自身错误而对当前REST API接口测试结果的影响，从而使得对当前REST API接口的测试结果更加准确。可以按照工作人员根据实际需要设定的规则来调整当前测试用例中测试函数的对应参数来调整当前测试用例，基于调整后的当前测试用例完成对当前REST API接口二次测试的原理与基于当前测试用例完成对当前REST API接口测试的原理相同，这里不再赘述。

本发明实施例提供的一种REST API测试方法中，预先将不同测试用例中相同的步骤封装得到公共函数，可以包括：

基于python语言的第三方库paramiko对不同测试用例中相同的登录存储设备、发送CLI命令至存储设备、接收存储设备发送的执行CLI命令的执行结果的步骤进行二次封装得到对应的公共函数，存储设备为包括REST API接口的设备；

基于python语言内置模块logging对不同测试用例中相同的保存日志、分级日志的步骤进行二次封装得到对应的公共函数；

基于python语言的第三方库requests对不同测试用例中相同的发送web请求至包括REST API接口的存储设备、接收包括REST API接口的存储设备返回与web请求对应的数据的步骤进行二次封装得到对应的公共函数。

实际应用中，REST API接口可以与对应的存储设备进行数据通信，本申请中包括REST API接口的存储设备均可以指能够与REST API接口进行数据通信的存储设备，从而使得存储设备具有对外提供web服务的功能，这样可以通过web服务登录存储设备，借助存储设备完成对REST API接口的测试，而不同测试用例中通过web服务登录存储设备的步骤可以是一样的，所以可以基于python语言的第三方库paramiko对不同测试用例中相同的登录存储设备、发送CLI命令至存储设备、接收存储设备发送的执行CLI命令的执行结果的步骤进行二次封装得到对应的公共函数，存储设备为包括REST API接口的设备；基于python语言内置模块logging对不同测试用例中相同的保存日志、分级日志的步骤进行二次封装得到对应的公共函数，这里的日志是与登录存储设备相关的日志，比如登录存储设备失败的日志等；基于python语言的第三方库requests对不同测试用例中相同的发送web请求至存储设备、接收存储设备返回与web请求对应的数据的步骤进行二次封装得到对应的公共函数，封装成功后便可以利用第三方库requests实现对存储设备的web访问。应当指出，自动化测试系统可以通过一组setUp和tearDown函数完成对测试用例中相同的设置测试环境和清理测试环境的步骤。这里及后面所说的存储设备均指可以与REST API接口仅数据通信的设备。

预先将不同测试用例中相同的登录存储设备的步骤设定为公共函数，可以使得在每次组合当前测试用例时不必再重新创建相同的步骤，简化组合当前测试用例的步骤，从而可以提高本发明提供的一种REST API自动化测试方法的测试速度。当然也可以预先将不同测试用例中相同的步骤设定为公共类，本发明在这里不做具体限定。

本发明实施例提供的一种REST API自动化测试方法中，预先设定测试公共数据，可以包括：

预先将不同REST API接口对应的URL中相同的资源设定为对应的测试公共数据；

预先将包括REST API接口的存储设备中不同的用户名、密码设定为对应的测试公共数据。

不同测试用例中包含的相同的用于登录存储设备的数据可以包括：不同REST API接口对应的URL中相同的资源，这些相同的资源可以包括REST API接口所属的存储设备的IP、存储设备提供服务的端口等；REST API接口所属的存储设备中不同的用户名、密码等。预先将不同测试用例中包含的相同的用于登录存储设备的数据设定为测试公共数据，可以使得在每次组合当前测试用例时不必再重新创建相同的数据，简化组合当前测试用例的步骤，从而可以提高REST API自动化测试的测试速度。

另外需要说明的是，本发明实施例提供的上述技术方案可以基于pyUnit(Pythonunit testing frameworkPython，单元测试框架)实现，具体来说，可以将得到的上述测试用例与pyUnit结合起来，其中，pyUnit中有以下几个重要的概念：

TestCase类：软件测试中最基本的组成单元是测试用例(test case)，pyUnit使用TestCase类来表示测试用例，所有执行测试的类都必须从该类继承，pyUnit在运行一个测试用例时，TestCase子类定义的setUp()、runTest()和tearDown()方法被依次执行。

测试用例集TestSuite：完整的单元测试很少只执行一个测试用例，开发人员通常都需要编写多个测试用例才能对某一软件功能进行比较完整的测试，这些相关的测试用例称为一个测试用例集。

执行测试test runner：组织安排测试脚本执行测试活动的主件，主要用于生成测试报告。

由此，pyUnit可以代替使用者完成一些调用、IO等与单元、自动化测试无直接关系的支撑代码，让开发测试人员可以专注于测试用例的编写，简化测试工作，提高测试效率；结合使用单元测试框架pyUnit来完成组织测试用例/判断/测试结果整理的工作并生成对应测试报告，从而达到自动化的完成REST API测试的效果。如基于pyUnit可以实现以下操作：基于pyUnit提供的断言机制实现对当前REST API接口返回的实时数据与校准数据一致性判断；当将需要执行的测试用例组合成测试用例集后，利用pyUnit提供的对应功能来加载测试用例集，对其中的测试用例运行批量测试，生成测试报告；将对应软件版本的测试用例集合成回归测试用例，运行特定的测试用例集。本发明还提供了一种REST API自动化测试系统，其具有本发明实施例提供的一种REST API自动化测试方法具有的对应效果。请参阅图2，图2为本发明实施例提供的一种REST API自动化测试系统的结构示意图。

本发明实施例提供的一种REST API自动化测试系统可以包括：

获取公共函数模块A1，用于获取预先设定的公共函数，所述公共函数为预先将不同测试用例中相同的步骤封装得到的函数；

获取测试公共数据模块A2，用于获取预先设定的测试公共数据，所述测试公共数据为不同测试用例中包含的相同的数据；

获取测试函数模块A3，用于获取与测试当前REST API接口对应的测试函数，所述测试函数为测试所述当前REST API接口所需的特有的函数；

组合模块A4，用于将所述公共函数、所述测试公共数据和所述测试函数组合成当前测试用例，并基于所述当前测试用例完成对所述当前REST API接口的测试。

本发明实施例提供的一种REST API测试系统中，还可以包括：

回归测试模块，用于在组合模块基于当前测试用例完成对当前REST API接口的测试之后，调整当前测试用例，基于调整后的当前测试用例完成对所述当前REST API接口的回归测试。

本发明实施例提供的一种REST API自动化测试系统中，还可以包括：

预设公共函数模块，用于基于python语言的第三方库paramiko对不同测试用例中相同的登录存储设备、发送CLI命令至存储设备、接收存储设备发送的执行CLI命令的执行结果的步骤进行二次封装得到对应的公共函数，存储设备为包括REST API接口的设备；基于python语言内置模块logging对不同测试用例中相同的保存日志、分级日志的步骤进行二次封装得到对应的公共函数；基于python语言的第三方库requests对不同测试用例中相同的发送web请求至包括REST API接口的存储设备、接收包括REST API接口的存储设备返回与web请求对应的数据的步骤进行二次封装得到对应的公共函数。

本发明实施例提供的一种REST API自动化测试系统中，还可以包括：

预设测试公共数据模块，用于预先将不同REST API接口对应的URL中相同的资源设定为对应的测试公共数据；预先将包括REST API接口的存储设备中不同的用户名、密码设定为对应的测试公共数据。

本发明实施例提供的一种REST API自动化测试系统中相关部分的说明请参见本发明实施例提供的一种REST API自动化测试方法中对应部分的详细说明，在此不再赘述。另外，本发明实施例提供的上述技术方案中与现有技术中对应技术方案实现原理一致的部分并未详细说明，以免过多赘述。

对所公开的实施例的上述说明，使本领域技术人员能够实现或使用本发明。对这些实施例的多种修改对本领域技术人员来说将是显而易见的，本文中所定义的一般原理可以在不脱离本发明的精神或范围的情况下，在其它实施例中实现。因此，本发明将不会被限制于本文所示的这些实施例，而是要符合与本文所公开的原理和新颖特点相一致的最宽的范围。

Claims (8)

1.一种REST API自动化测试方法，其特征在于，包括：

获取预先设定的公共函数，所述公共函数为预先将不同测试用例中相同的步骤封装得到的函数；

获取预先设定的测试公共数据，所述测试公共数据为不同测试用例中包含的相同的数据；

获取与测试当前REST API接口对应的测试函数，所述测试函数为测试所述当前RESTAPI接口所需的特有的函数；

将所述公共函数、所述测试公共数据和所述测试函数组合成当前测试用例，并基于所述当前测试用例完成对所述当前REST API接口的测试。

2.根据权利要求1所述的方法，其特征在于，所述基于所述当前测试用例完成对所述当前REST API接口的测试之后，还包括：

调整所述当前测试用例，基于调整后的所述当前测试用例完成对所述当前REST API接口的回归测试。

3.根据权利要求1所述的方法，其特征在于，预先将不同测试用例中相同的步骤封装得到所述公共函数，包括：

基于python语言的第三方库paramiko对不同测试用例中相同的登录存储设备、发送CLI命令至所述存储设备、接收所述存储设备发送的执行所述CLI命令的执行结果的步骤进行二次封装得到对应的公共函数，所述存储设备为包括REST API接口的设备；

基于所述python语言内置模块logging对不同测试用例中相同的保存日志、分级日志的步骤进行二次封装得到对应的公共函数；

基于所述python语言的第三方库requests对不同测试用例中相同的发送web请求至包括REST API接口的存储设备、接收包括REST API接口的存储设备返回与所述web请求对应的数据的步骤进行二次封装得到对应的公共函数。

4.根据权利要求1所述的方法，其特征在于，预先设定测试公共数据，包括：

预先将不同REST API接口对应的URL中相同的资源设定为对应的测试公共数据；

预先将包括REST API接口的存储设备中不同的用户名、密码设定为对应的测试公共数据。

5.一种REST API自动化测试系统，其特征在于，包括：

获取公共函数模块，用于获取预先设定的公共函数，所述公共函数为预先将不同测试用例中相同的步骤封装得到的函数；

获取测试公共数据模块，用于获取预先设定的测试公共数据，所述测试公共数据为不同测试用例中包含的相同的数据；

获取测试函数模块，用于获取与测试当前REST API接口对应的测试函数，所述测试函数为测试所述当前REST API接口所需的特有的函数；

组合模块，用于将所述公共函数、所述测试公共数据和所述测试函数组合成当前测试用例，并基于所述当前测试用例完成对所述当前REST API接口的测试。

6.根据权利要求5所述的系统，其特征在于，还包括：

回归测试模块，用于在所述组合模块基于所述当前测试用例完成对所述当前REST API接口的测试之后，调整所述当前测试用例，基于调整后的所述当前测试用例完成对所述当前REST API接口的回归测试。

7.根据权利要求5所述的系统，其特征在于，还包括：

预设公共函数模块，用于基于python语言的第三方库paramiko对不同测试用例中相同的登录存储设备、发送CLI命令至所述存储设备、接收所述存储设备发送的执行所述CLI命令的执行结果的步骤进行二次封装得到对应的公共函数，所述存储设备为包括REST API接口的设备；基于所述python语言内置模块logging对不同测试用例中相同的保存日志、分级日志的步骤进行二次封装得到对应的公共函数；基于所述python语言的第三方库requests对不同测试用例中相同的发送web请求至包括REST API接口的存储设备、接收包括RESTAPI接口的存储设备返回与所述web请求对应的数据的步骤进行二次封装得到对应的公共函数。

8.根据权利要求5所述的系统，其特征在于，还包括：

预设测试公共数据模块，用于预先将不同REST API接口对应的URL中相同的资源设定为对应的测试公共数据；预先将包括REST API接口的存储设备中不同的用户名、密码设定为对应的测试公共数据。