CN110489349B - 一种基于json配置文件的接口测试方法 - Google Patents

Abstract

本发明公开了一种基于JSON配置文件的接口测试方法，该方法包括步骤1：根据功能需求确定JSON中需要参数化的字段；步骤2：把JSON定义为测试工程的一个.json文件，参数化数据保存为文本表格；步骤3：创建unittest测试工程，并创建测试类；步骤4：在步骤2的基础上，下沉参数化数据，在testcase对JSON进行参数化，在测试类中使用json.load方法加载JSON文件直接得到一个JSON对象，在testcase中使用访问字典的方式对JSON进行具体的参数化赋值；步骤5：testcase通过requests发起请求进行接口测试，解决了测试类的空间复杂度高以及JSON和testcase的高耦合的问题。

Description

一种基于JSON配置文件的接口测试方法

技术领域

本发明涉计算机软件技术领域，具体的说，是一种基于JSON配置文件的接口测试方法。

背景技术

在互联网项目中，基于http协议的RESTful风格接口越来越常见，这类接口通常使用JSON作为前后端数据交互的载体。对于这类接口的自动化测试，通常使用unittest框架，在testcase中使用requests库的方法来模拟基于JSON的前后端交互。在testcase中，为了验证功能的正确性，通常需要对JSON部分字段进行参数化。

通常有两种方法来对JSON进行测试用例参数化。

1、通过文本的方式,把整个JSON作为用例的一部分进行编辑，文本中每一行数据对应一条参数化后的JSON,在测试类的testcase中通过读取已经参数化文本数据来进行测试。在具体的测试类中，由于testcase需要遍历文本测试用例集来得到具体的请求参数。该方法导致测试类的空间复杂度高。

2、把JSON定义为测试类中的一个参数。在初始化测试类的时候定义变量保存JSON，testcase具体参数化JSON。这样JSON和testcase在同一个测试类中，这种方式造成JSON和testcase的高耦合，无法在测试工程其他测试类中共享该JSON对象。

发明内容

本发明的目的在于提供一种基于JSON配置文件的接口测试方法，用于解决现有技术中在测试的时候由于testcase需要遍历文本测试用例集来得到具体的请求参数导致测试类的空间复杂度高以及把JSON定义为测试类中的一个参数，造成JSON和testcase的高耦合，无法在测试工程其他测试类中共享该JSON对象的问题。

本发明通过下述技术方案解决上述问题：

一种基于JSON配置文件的接口测试方法，该方法包括如下步骤：

步骤1：根据功能需求确定JSON中需要参数化的字段；

步骤2：把JSON定义为测试工程的一个.json文件，参数化数据保存为文本表格；

步骤3：创建unittest测试工程，并创建测试类；

步骤4：在步骤2的基础上，下沉参数化数据，在testcase对JSON进行参数化，在测试类中使用json.load方法加载JSON文件直接得到一个JSON对象，在testcase中使用访问字典的方式对JSON进行具体的参数化赋值；

步骤5：testcase通过requests发起请求进行接口测试。

传统的方法中，是通过参数化数据对JSON部分字段赋值,来对JSON进行参数化，保存为文本用例。这样参数化用例由两部分组成，JSON和参数化数据，并存于一个文本表格中，如果JSON字段发生变化，需要修改所有用例的JSON值，用例的可维护性低。同时，在unittest框架下，如果每一个testcase需要读取文本用例集中的参数，需要遍历步骤2中的文本用例，这样测试类的空间复杂度高，测试工程性能低下。而本方法，通过把JSON定义为测试工程的一个.json文件，参数化数据保存为文本表格，可以起到解耦JSON提高用例可维护性的效果；现有技术一般采用把JSON定义为测试类的一个变量，参数化数据保存为文本表格，JSON和testcase在同一个测试类中，所以JSON依然和测试类是一种强耦合的关系。为了解决测试工程空间复杂度高，提高性能，在通过分层把JSON定义为测试类文件基础上，放弃文本组织参数化数据的方式，下沉参数化数据，在testcase对JSON进行参数化。在测试类中使用json.load方法加载JSON文件直接得到一个JSON对象，在testcase中使用访问字典的方式对JSON进行具体的参数化赋值。这样执行请求前，testcase可以不用遍历参数化数据，以此达到降低空间复杂度的目的。因此本方法很好的解决了现有技术中由于testcase需要遍历文本测试用例集来得到具体的请求参数导致测试类的空间复杂度高以及把JSON定义为测试类中的一个参数，造成JSON和testcase的高耦合，无法在测试工程其他测试类中共享该JSON对象的问题。

进一步，所述步骤5中，接口测试包括如下步骤：

步骤5.1：创建会话session；

步骤5.2：session的post请求传入，然后得到返回值；

步骤5.3：使用断言方法assert对response进行断言，并对返回值进行判断。

进一步，所述步骤4中对JSON进行具体参数化赋值包括以下步骤：

步骤4.1：，首先在工程的一级目录下创建测试工程，然后在测试工程里面创建测试方法；

步骤4.2：使用多对json进行赋值参数化，一条参数化数据对应一个testcase方法，test.class中根据参数化JSON文件的条数创建对应数量的测试方法。

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

(1)本发明通过把JSON定义为测试工程的一个.json文件，参数化数据保存为文本表格，一改传统的把JSON定义为测试类的一个变量，参数化数据保存为文本表格的方式，从而达到了解耦JSON提高用例可维护性的目的。

(2)本发明通过分层把JSON定义为测试类文件基础上，放弃文本组织参数化数据的方式，下沉参数化数据，在testcase对JSON进行参数化，在测试类中使用json.load方法加载JSON文件直接得到一个JSON对象，在testcase中使用访问字典的方式对JSON进行具体的参数化赋值，这样执行请求前，testcase可以不用遍历参数化数据达到了降低空间复杂度的目的，又因为直接得到一个JSON对象，不需要从字符串转化为JSON对象，同时也降低了测试类的时间复杂度。

附图说明

图1为本发明的JSON分层解耦流程示意图；

图2为本发明在unittest框架下保存的文件具体说明unittest框架下测试用例执行流程示意图。

具体实施方式

下面结合实施例对本发明作进一步地详细说明，但本发明的实施方式不限于此。

实施例1：

一种基于JSON配置文件的接口测试方法，该方法包括如下步骤：

步骤1：根据功能需求确定JSON中需要参数化的字段；

步骤2：把JSON定义为测试工程的一个.json文件，参数化数据保存为文本表格；

步骤3：创建unittest测试工程，并创建测试类；

步骤4：在步骤2的基础上，下沉参数化数据，在testcase对JSON进行参数化，在测试类中使用json.load方法加载JSON文件直接得到一个JSON对象，在testcase中使用访问字典的方式对JSON进行具体的参数化赋值；

步骤5：testcase通过requests发起请求进行接口测试。

结合附图1所示，首先基于一个参数化JSON文件test.xlsx来讲解JSON参数化用例拆分方法。test.xlsx包含两条参数化用例。定义一个JSON{“name”:“zhangsan”，“age”：“”}，定义两条对age进行参数化后的用例并写入test.xlsx文件.

{“name”:“zhangsan”，“age”：“20”},

{“name”：“zhangsan”，“age”：“21”}

然后拆分test.xlsx得到JSON和data.xlsx，由于test.xlsx每一条参数化用例都有JSON，提取出公共数据{“name”：“zhangsan”，“age”：“”}，把余下的参数化数据20,21保存到data.xlsx文件。接着保存拆分出来的JSON为测试工程文件：

第一步，创建测试工程test.project；

第二步，在test.project一级目录下新建test.json文件；

第三步，把步骤1拆分出来的{“name”：“zhangsan”，“age”：“”}粘贴到新建的test.json文件中。

需要注意的是，除了拆分得到的JSON保存为工程文件外，参数化数据data.xlsx下沉到testcase中,不再通过遍历文本读取数据的方式对JSON进行参数化，同时一级目录的json文件可以被多个测试类共享。

结合图2所示，unittest框架下基于JSON配置文件测试执行流程包括：

第一步，读取JSON文件：在test.project工程的一级目录下创建测试工程test.class，读取test.json得到得到一个JSON对象json＝{“name”:“zhangsan”,“age”：“”}；

第二步，参数化json：在test.class里面创建测试方法test_001；使用20对json进行赋值参数化，得到body＝{“name”:“zhangsan”，“age”：20}；重复此步骤，用21对json进行参数化，得到body＝{“name”:“zhangsan”，“age”：21}，一条参数化数据对应一个testcase方法。

最后，在testcase中结合requests库进行接口测试：创建会话session；session的post请求传入body:{“name”:”zhangsan”,”age”:20}，得到返回值{“address”:”sichuan”}；使用断言方法assert对response进行断言，判断address是否为sichuan。

尽管这里参照本发明的解释性实施例对本发明进行了描述，上述实施例仅为本发明较佳的实施方式，本发明的实施方式并不受上述实施例的限制，应该理解，本领域技术人员可以设计出很多其他的修改和实施方式，这些修改和实施方式将落在本申请公开的原则范围和精神之内。

Claims (2)

1.一种基于JSON配置文件的接口测试方法，其特征在于，该方法包括如下步骤：

步骤1：根据功能需求确定JSON中需要参数化的字段；

步骤2：把JSON定义为测试工程的一个.json文件，参数化数据保存为文本表格；

步骤3：创建unittest测试工程，并创建测试类；

步骤4：在步骤2分层的基础上，下沉参数化数据，在testcase对JSON进行参数化，在测试类中使用json.load方法加载JSON文件直接得到一个JSON对象，在testcase中使用访问字典的方式对JSON进行具体的参数化赋值；

步骤5：testcase通过requests发起请求进行接口测试；

所述步骤4中对JSON进行具体参数化赋值包括以下步骤：

步骤4.1：首先在工程的一级目录下创建测试工程，然后在测试工程里面创建测试方法；

步骤4.2：使用多对json进行赋值参数化，一条参数化数据对应一个testcase方法，test.class中根据参数化JSON文件的条数创建对应数量的测试方法。

2.根据权利要求1所述的基于JSON配置文件的接口测试方法，其特征在于，所述步骤5中，接口测试包括如下步骤：

步骤5.1：创建会话session；

步骤5.2：session的post请求传入，然后得到返回值；

步骤5.3：使用断言方法assert对response进行断言，并对返回值进行判断。

Images