CN110198247B - 接口测试方法及系统 - Google Patents

Abstract

本发明涉及互联网技术领域，尤其涉及一种接口测试方法及系统。本发明通过构建接口测试系统，接口开发者向测试系统录入协议数据后，系统会解析协议描述文件提取元数据，利用元数据、协议类型和服务部署信息自动生成测试程序，基于元数据自动构建前端测试页面，并对协议相关信息进行维护；后续接口调用者对协议进行测试时，通过查看协议维护信息，选择测试协议就能自动加载所选协议对应的测试页面，进一步通过设置协议下包括的接口信息，就可以对所选接口进行测试，自动获取测试结果。整个测试过程中无需接口调用者与接口开发者沟通，也不需要检出完整的项目代码，大幅降低了时间成本、沟通成本，减少了对存储资源和计算资源的占用，提升了开发效率。

Description

接口测试方法及系统

技术领域

本发明涉及互联网技术领域，尤其涉及一种接口测试方法及系统。

背景技术

随着业务规模的增长，涉及到的后台服务grpc接口越来越多，新服务开发前如何对grpc接口进行快速验证、测试成为了必须要面对的问题。

目前，开发人员只能通过现有的接口测试方法来测试，现有的接口测试方法时序图如图1所示。请参见图1，开发者1代表服务开发人员，其将服务代码、proto文件提交至版本控制系统，并完成服务部署。开发者2代表新业务开发者，其希望测试该服务的grpc接口请求参数、响应结果，按照现有的测试方法首先要从版本控制系统获取服务的源代码，然后解决编译依赖问题、构建项目代码中的接口测试程序、与服务开发者沟通部署细节，然后才能运行测试程序对接口进行测试。现有grpc接口测试方法存在以下缺点：

1)沟通所花费的时间成本高。接口调用者(开发者2)需要与接口开发者(开发者1)沟通项目代码地址、沟通解决编译依赖问题、沟通服务署细节等。考虑到业务开发中可能依赖多个开发者的多个服务的多个接口，这样沟通成本更高。此外，不管是询问的一方还是被询问的一方都在不断地重复这一沟通过程，沟通时间随着沟通次数而增加，时间浪费严重。

2)接口调用者重复生成测试代码，浪费公司存储资源、计算资源。每个开发者测试grpc接口时，都需要自己检出一份项目代码，检出项目代码的目的并不是为了维护该项目而只是为了测试其中的个别接口，这对开发极有限的存储资源是一个不小的浪费。而且构建可执行程序的过程生成的中间文件浪费了比源代码本身更多的存储资源，也浪费了CPU计算资源。理想状态下，同一个服务有且只有一份最新的构建好的测试程序。

3)接口调用者检出了完整的项目代码，虽然其目的只是为了测试接口，但是也不能完全排除误修改、误删除源代码文件和误添加编译临时文件的可能，会对项目代码造成较为严重的污染，为之后的维护带来了额外的负担。

发明内容

针对现有技术的上述问题，本发明的目的在于提供一种接口测试方法及系统，有利于帮助开发人员提高工作效率，减少沟通成本和时间成本。

第一方面，本发明提供了一种接口测试方法，所述方法包括：

接收查看服务协议列表的请求，根据所述请求加载数据生成服务协议列表，所述服务协议列表包括协议的服务名称以及与所述协议对应的测试程序和测试页面的存储地址，并输出所述服务协议列表；

响应于选择测试协议的请求，根据所选协议对应的服务名称查询与该协议对应的测试页面的存储地址，根据所述测试页面的存储地址反馈测试页面；

响应于对测试页面操作生成的接口测试请求，所述接口测试请求包括接口数据和接口请求参数，根据接口数据查询测试程序的存储地址，根据测试程序的存储地址和接口请求参数获得测试结果，输出所述测试结果。

第二方面，本发明提供了一种接口测试系统，所述系统包括：

管理模块，用于接收用户查看服务协议列表的请求，根据所述请求从存储模块加载数据生成服务协议列表，所述服务协议列表包括协议的服务名称以及与所述协议对应的测试程序和测试页面的存储地址，并输出所述服务协议列表；响应于选择测试协议的请求，根据所选协议对应的服务名称查询与该协议对应的测试页面的存储地址，根据所述测试页面的存储地址反馈测试页面；以及响应于对测试页面操作生成的接口测试请求，所述接口测试请求包括接口数据和接口请求参数，根据接口数据查询测试程序的存储地址，根据测试程序的存储地址和接口请求参数获得测试结果，输出所述测试结果。

本发明具有如下有益效果：

本发明构建接口测试系统，接口开发者向测试系统录入协议数据后，系统会解析协议描述文件提取元数据，利用元数据、协议类型和服务部署信息自动生成测试程序，基于元数据自动构建前端测试页面，并对协议相关信息进行维护；后续接口调用者对协议进行测试时，通过查看协议维护信息，选择测试协议就能自动加载所选协议对应的测试页面，进一步通过设置协议下包括的接口信息，就可以对所选接口进行测试，自动获取测试结果。整个测试过程中无需接口调用者与接口开发者沟通，也不需要检出完整的项目代码，大幅降低了时间成本、沟通成本，减少了对存储资源和计算资源的占用，提升了开发效率。

附图说明

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

图1是现有的grpc接口测试方法的流程图；

图2是可用于实施本发明实施例的接口测试系统的计算机终端的硬件结构框图；

图3是本发明实施例提供的接口测试系统的结构框图；

图4是本发明实施例提供的管理模块与其他模块协作示意图；

图5是本发明实施例提供的管理模块的界面示意图；

图6是本发明实施例提供的前端测试页面的示意图；

图7是本发明实施例提供的构建测试程序的流程图；

图8是本发明实施例提供的构建测试页面的流程图；

图9是本发明实施例提供的接口测试方法的流程图；

图10是本发明实施例提供的接口测试方法的流程图；

图11是本发明实施例提供的接口测试系统中各组件协作关系图；

图12是根据本发明实施例的计算机终端的结构框图。

具体实施方式

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

本发明实施例所涉及的实施环境包括用户终端和接口测试系统，用户终端与接口测试系统之间通过网络进行通信，该网络可以为无线网络或有线网络。接口测试系统如下述实施例所述的接口测试系统，每个用户终端可以通过接口测试系统进行接口测试。接口测试系统可以配置在用户终端中，也可以独立于用户终端而配置。

本申请所提供的接口测试系统可以设置在移动终端、计算机终端或者类似的运算装置中。以运行在计算机终端上为例，图2是可用于实施本发明实施例的接口测试系统的计算机终端的硬件结构框图。如图2所示，计算机终端100可以包括一个或多个(图中仅示出一个)处理器102(处理器102可以包括但不限于微处理器MCU或可编程逻辑器件FPGA等的处理装置)、用于存储数据的存储器104、以及用于通信功能的传输装置106。本领域普通技术人员可以理解，图2所示的结构仅为示意，其并不对上述电子装置的结构造成限定。例如，计算机终端100还可包括比图2中所示更多或者更少的组件，或者具有与图2所示不同的配置。

存储器104可用于存储应用软件的软件程序以及模块，如本发明实施例中的接口测试系统对应的程序指令/模块，处理器102通过运行存储在存储器104内的软件程序以及模块，从而执行各种功能应用以及数据处理，即实现上述的接口测试系统的各项功能。存储器104可包括高速随机存储器，还可包括非易失性存储器，如一个或者多个磁性存储装置、闪存、或者其他非易失性固态存储器。在一些实例中，存储器104可进一步包括相对于处理器102远程设置的存储器，这些远程存储器可以通过网络连接至计算机终端10。上述网络的实例包括但不限于互联网、企业内部网、局域网、移动通信网及其组合。

传输装置106用于经由一个网络接收或者发送数据。上述的网络具体实例可包括计算机终端100的通信供应商提供的无线网络。在一个实例中，传输装置106包括一个网络适配器(Network Interface Controller，简称为NIC)，其可通过基站与其他网络设备相连从而可与互联网进行通讯。在一个实例中，传输装置106可以为射频(Radio Frequency，简称为RF)模块，其用于通过无线方式与互联网进行通讯。

下面对本发明实施例涉及的名词术语作解释。

Protobuf：Protobuf是Google Protocol Buffers的简称，是一种与语言、平台无关的能够对可扩展的结构化数据执行串行化、反串行化操作的一种技术。开发者通过定义proto文件来描述其服务，利用protoc的proto文件解析能力和插件机制可以开发出很多自定义功能的插件，比如用于项目代码生成、配置文件生成等。

RPC：RPC是Remote Procedural Call的简称，它是一种计算机通信协议，该协议允许运行于一台计算机的程序调用另一台计算机的子程序，而程序员无需额外地为这个交互编程。

gRPC：gRPC是谷歌基于Protobuf的RPC实现，RPC调用过程中涉及到的数据交换均按照Protobuf进行串行化、反串行化操作。

实施例

本实施例提供一种接口测试系统。图3是本发明实施例提供的接口测试系统的结构框图，如图3所示，该系统包括管理模块10、解析模块20、测试程序构建模块30、测试页面构建模块40和存储模块50。

其中，管理模块10用于获取协议数据，所述协议数据包括协议描述文件、协议类型和服务部署信息。

解析模块20用于从管理模块10获取协议描述文件，对所述协议描述文件进行处理获得元数据，并将所述元数据返回至所述管理模块10。

测试程序构建模块30用于从所述管理模块获取协议类型、服务部署信息和元数据，根据所述协议类型、服务部署信息和元数据构建用于请求服务接口的测试程序，并将所述测试程序发送至存储模块50。

测试页面构建模块40用于从所述管理模块获取元数据，根据所述元数据创建测试页面，并将所述测试页面发送至存储模块50。

存储模块50用于存储所述测试程序和测试页面。

进一步地，测试程序构建模块30还用于在将所述测试程序发送至存储模块50之后，向所述管理模块10反馈第一处理信息，所述第一处理信息用于指示测试程序构建完成。测试页面构建模块40还用于在将所述测试页面发送至存储模块50之后，向所述管理模块10反馈第二处理信息，所述第二处理信息用于指示测试页面构建完成。管理模块10还用于在收到所述第一处理信息和第二处理信息之后，输出第三处理信息，所述第三处理信息用于指示协议数据处理完成。

作为一种优选地实施方式，所述解析模块20用于解析协议描述文件获得文件描述符信息，从所述文件描述符信息中提取服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息，并将所述服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息按照预设格式进行记录，生成元数据。

作为一种优选地实施方式，所述测试程序构建模块30用于读取协议描述文件对应的元数据，为测试程序命名，根据元数据中的grpc接口信息，逐一为各个grpc接口生成对应的网络请求初始化代码，根据协议类型和服务部署信息生成服务监听地址的初始化代码，并生成适用于不同协议类型和不同访问环境的网络IO代码，所述访问环境包括现网环境和测试环境，所述协议类型包括传输控制协议和用户数据报协议。

作为一种优选地实施方式，所述测试页面构建模块40用于初始化页面中的通用图层，所述通用图层用于显示服务描述信息、访问环境列表、请求grpc接口描述及参数设置、请求grpc接口响应字段信息和接口测试按钮，为页面操作生成前端控制代码。

进一步地，所述管理模块10还用于接收用户查看服务协议列表的请求，根据所述请求从存储模块加载数据生成服务协议列表，所述服务协议列表包括协议的服务名称以及与所述协议对应的测试程序和测试页面的存储地址，并输出所述服务协议列表；响应于选择测试协议的请求，根据所选协议对应的服务名称查询与该协议对应的测试页面的存储地址，根据所述测试页面的存储地址反馈测试页面；以及响应于对测试页面操作生成的接口测试请求，所述接口测试请求包括接口数据和接口请求参数，根据接口数据查询测试程序的存储地址，根据测试程序的存储地址和接口请求参数获得测试结果，输出所述测试结果。

具体的，所述接口数据包括grpc接口信息和访问环境，所述访问环境包括现网环境和测试环境。所述管理模块10还用于根据grpc接口信息和访问环境查询获得测试程序的地址，根据所述测试程序的地址调用测试程序，并基于接口请求参数运行测试程序得到测试结果。

本发明构建接口测试系统，接口开发者向测试系统录入协议数据后，系统会解析协议描述文件提取元数据，利用元数据、协议类型和服务部署信息自动生成测试程序，基于元数据自动构建前端测试页面，并对协议相关信息进行维护；后续接口调用者对协议进行测试时，通过查看协议维护信息，选择测试协议就能自动加载所选协议对应的测试页面，进一步通过设置协议下包括的接口信息，就可以对所选接口进行测试，自动获取测试结果。整个测试过程中无需接口调用者与接口开发者沟通，也不需要检出完整的项目代码，大幅降低了时间成本、沟通成本，减少了对存储资源和计算资源的占用，提升了开发效率。

实施例

本实施例提供一种接口测试系统，与现有技术相比，该系统能够降低开发者2在进行协议测试时与开发者1之间的时间交流成本。

所述接口测试系统包括管理模块、解析模块、测试程序构建模块、测试页面构建模块和存储模块，其中，管理模块分别与解析模块、测试程序构建模块、测试页面构建模块和存储模块通信。以下对各个模块的功能进行展开说明。

(1)解析模块

所述解析模块用于从管理模块获取协议描述文件，对所述协议描述文件进行处理获得元数据，并将所述元数据返回至所述管理模块。

优选地，该协议描述文件是协议proto文件。本实施例设计并实现了一个解析协议proto文件、提取元数据(metadata)的工具解析模块(XProto-Parser)，该工具基于protoc插件机制设计，在protoc解析协议proto文件能力的基础上生成更加结构化的元数据来指导后续代码生成。具体地，解析模块解析协议proto文件并通过文件描述符信息(FileDescriptor)提取服务名称、服务中包括的命令字、grpc接口信息、grpc接口的请求信息及响应信息(message)以及各个message中的字段类型、名称、是否可选、注释等信息，并进一步组织成更加结构化的元数据，元数据可指导如何构建测试页面以展示服务包含的grpc接口列表以及各个grpc接口列表的请求参数、响应字段信息，也可指导如何生成测试程序。

进一步的，基于开发者定义的服务描述文件*.proto得到更简单、结构化的元数据具体包括：

基于protobuf规范定义的proto文件，其文件中的内容不管怎么变化，最终都可以由protobuf工程中的src/google/protobuf/descriptor.proto来完整描述，该descriptor.proto文件中定义了如下几个关键的类型对用户定义的proto进行描述：

1)FieldDescriptorProto，对message中各个字段的类型进行描述，包括字段的名称、字段的数据类型、字段出现的顺序(tag编号)、字段修饰符(optional或者required，即是否必填)、字段的默认值；

2)DescriptorProto，message中包括了多个字段，DescriptorProto在FieldDescriptorProto的基础上描述message内部的各个字段，从而具备完整描述一个message的能力，包括message的名称、包括的字段列表；

3)MethodDescriptorProto，对rpc接口进行了描述，包括rpc接口的名称、rpc请求message类型、响应message类型；

4)ServiceDescriptorProto，服务(service)中包括了多个rpc接口，ServiceDescriptorProto在MethodDescriptorProto的基础上完整描述了服务的名称、所有的rpc接口；

5)FileDescriptorProto，proto文件内容就是由一系列的信息(message)及服务(service)构成，FileDescriptorProto在上述1)～4)的基础上实现了对一个proto文件的完整解析，另外FileDescriptorProto还基于SourceCodeInfo实现了对Proto中注释的提取，可以提取每一行内容的前置注释、行注释、后置注释信息。

protoc编译器将对proto文件解析后生成的文件描述符信息传递给解析模块。解析模块根据文件描述符信息对象提取构建元数据所需要的服务名称、rpc接口名称、各个接口的请求和响应信息类型、各个信息的类型名称及其包含的成员类型、顺序和名称，并将其按照一定的格式进行记录，形成元数据。

转换后的元数据既包括了构建测试程序、测试页面所需要的信息，可读性也更好。测试程序构建模块可以很方便地解析该Json文件来以获知测试程序需要支持那几个rpc测试接口，测试页面构建模块也可以很方便地解析该Json文件来构建测试页面表单。

(2)管理模块

管理模块用于获取协议数据，所述协议数据包括协议描述文件、协议类型和服务部署信息。

本实施例设计并实现了一个管理模块XProto-Admin，用于维护服务描述、协议proto文件、协议类型(包括tcp传输控制协议和udp用户数据报协议)、测试及现网环境ip地址和端口、负责人，便于开发者创建、修改、删除、查询配置，也提供了测试协议页面的入口，如图5所示。

管理模块以Web的形式对外提供服务，当“新增服务”配置时，管理模块会调用(3)中提到的测试程序构建模块生成请求服务的测试代码并完成构建，也会调用(4)中提到的测试页面构建模块来生成对应的前端测试页面。管理模块与其他模块的协作示意图如图4所示。

针对不同的协议类型(tcp/udp)，需生成适用于该协议类型的网络IO代码，例如服务监听tcp端口就需要创建基于tcp通信的测试程序。管理模块可以通过命令行参数“-prototype＝[tcp|udp]”来控制测试程序构建模块生成基于tcp或udp通信的测试程序。同时还通过参数“-env_test＝ip:port–env_prod＝ip:port”来传递服务部署信息，生成的测试程序支持访问测试环境和现网环境，测试程序通过命令行参数“-env＝[test|prod]”来区分请求测试环境还是现网环境。开发者在前端测试页面中测试时可以通过选择开关在测试、现网环境之间切换，而无需关心服务部署的细节。

(3)测试程序构建模块

测试程序构建模块用于从管理模块获取协议类型、服务部署信息和元数据，根据所述协议类型、服务部署信息和元数据构建用于请求服务接口的测试程序，并将所述测试程序发送至存储模块。

具体的，设计实现了一个工具测试程序构建模块(XProto-Build-NetClient)来生成请求服务接口的测试代码。该工具需要根据协议类型的不同生成适用该协议的网络通信代码，同时生成的代码要能根据配置参数来决定访问测试环境还是现网环境。

该工具通过stdin读取管理模块传递过来的proto文件的元数据；通过启动参数“-prototype＝[tcp|udp]”来控制生成基于tcp或udp通信的测试程序；通过启动参数“-env_test＝ip:port–env_prod＝ip:port”来控制生成的测试程序访问测试环境、现网环境时的网络地址设置。

该工具生成的测试程序通过命令行参数“-cmd”读取服务命令字,如CMD_GETROOMINFO；通过其他参数读取请求消息中的字段信息，如命令行参数“-room_id”代表GetRoomInfoReq中的room_id字段值；通过stdout返回服务grpc接口返回的响应结果。管理模块调用测试程序并通过pipe的形式读取grpc接口返回的结果。

图7是本发明实施例提供的构建测试程序的流程图。基于协议proto文件对应的元数据、协议类型和部署信息构建测试程序的方法包括：

首先读取协议描述文件对应的元数据，从元数据中提取服务名字段“service”，然后创建以服务名称为文件名的测试程序，接着提取元数据中字段“rpc”对应的接口列表并逐一为各个接口生成对应的网络请求初始化代码，并通过cmd为每个rpc接口生成条件判断分支语句(意味着可以通过命令行参数-cmd来指引测试程序调用不同的服务接口)。然后根据管理模块传递过来的协议类型、服务部署信息生成服务监听socket地址的初始化代码，并进一步生成适用于协议类型tcp或udp的网络IO代码。到此，利用元数据指导构建协议测试程序的工作完成。

(4)测试页面构建模块

测试程序构建模块用于从所述管理模块获取协议类型、服务部署信息和元数据，根据所述协议类型、服务部署信息和元数据构建用于请求服务接口的测试程序，并将所述测试程序发送至存储模块。

本实施例通过测试页面构建模块(XProto-Build-PageForm)加载proto文件的元数据并创建前端测试页面，前端测试页面包括了服务包含的grpc接口列表、访问环境选项、请求参数表单、响应结果表单、发送请求按钮。表单中的字段名为message中的字段名，表单中字段的描述信息为message中字段的注释信息。Send(发送)按钮上方的表单为请求表单，用于设置grpc接口请求信息，send按钮下方的表单为响应表单，用于展示grpc接口返回的信息。生成的前端测试页面如图6所示。

图8是本发明实施例提供的构建测试页面的流程图。基于协议proto文件对应的元数据构建前端测试页面的方法包括：

测试页面构建模块首先初始化页面中的几个通用div(图层)区域，用于显示服务描述信息、访问环境列表、请求rpc接口描述及参数设置、请求rpc接口响应字段信息、接口测试按钮。例如，初始化如下html展示元素：于页面左上角创建服务描述、rpc列表对应的div1，于页面左下角创建访问环境对应的div2，于页面右上角创建已选中的rpc接口对应的描述信息div3、已选中的rpc接口对应的请求信息div4和请求发送按钮btn，于页面右下角创建已选中的rpc接口对应的响应信息div5。

每一个服务都包括这些字段，只是不同的服务上述通用div区域中的信息展示有所不同而已。例如datasvr.proto对应的服务描述信息是“DataSvr”，对应的rpc接口列表是“GetUserInfo、SetUserInfo、GetRoomInfo、SetRoomInfo”，其他div区域也只展示与对应rpc接口相关的信息。

从元数据中读取服务，生成更新服务描述的代码，进一步判断是否存在下一个待读取的rpc接口，如果存在下一个待读取的rpc接口，则生成更新服务rpc接口列表的代码，如果不存在下一个待读取的rpc接口，则生成选择不同的rpc接口时的js控制代码，然后生成访问环境列表切换时的js控制代码，最后生成请求发送按钮点击时要执行动作的js控制代码。

测试页面构建模块生成的大部分代码都是些js控制代码，用于控制页面加载时、切换grpc接口列表时、切换访问环境时、点击发送请求按钮时的动作。图9中展示了为上述页面操作生成的前端js控制代码，当用户操作时，页面将执行js控制代码更新页面中各个通用div区域的展示信息。到此，利用元数据指导构建前端页面的构建工作完成。

(5)存储模块

存储模块用于接收测试程序构建模块发送的测试程序和测试页面构建模块发送的测试页面表单，并将所述测试程序和测试页面进行对应存储。

本发明构建接口测试系统，接口开发者向测试系统录入协议数据后，系统会自动解析协议描述文件提取元数据，利用元数据、协议类型和服务部署信息自动生成测试程序，基于元数据自动构建前端测试页面，并对协议相关信息进行维护；后续接口调用者对协议进行测试时，通过查看协议维护信息，选择测试协议就能自动加载所选协议对应的测试页面，进一步通过设置协议下包括的接口信息，就可以对所选接口进行测试，自动获取测试结果。整个测试过程中无需接口调用者与接口开发者沟通，也不需要检出完整的项目代码，大幅降低了时间成本、沟通成本，减少了对存储资源和计算资源的占用，提升了开发效率。

实施例

本实施例提供一种基于开发者方的接口测试方法，该方法利用接口测试系统实现。所述接口测试系统包括管理模块、解析模块、测试程序构建模块、测试页面构建模块和存储模块，管理模块分别与解析模块、测试程序构建模块、测试页面构建模块和存储模块通信。

图9是本发明实施例提供的接口测试方法的流程图。请参见图9，该接口测试方法包括如下步骤：

S901：管理模块获取协议数据，所述协议数据包括协议描述文件、协议类型和服务部署信息，将所述协议描述文件发送至解析模块。

管理模块以web的形式对外提供服务，开发者可以通过web页面录入协议数据，协议数据录入后会自动传递给管理模块，以供后续处理。

S902：解析模块处理所述协议描述文件获得元数据，并将所述元数据返回至管理模块。

当管理模块收到协议数据后，会将协议数据中的协议描述文件发送给解析模块，解析模块对协议描述文件进行处理获得元数据，其中处理流程如下：

解析协议描述文件获得文件描述符信息；从文件描述符信息中提取服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息；然后将所述服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息按照一定格式进行记录，从而生成元数据。

解析模块进一步将元数据发送给管理模块，以供管理模块利用该元数据指导生成测试程序和测试页面。

S903：测试程序构建模块从管理模块获取协议类型、服务部署信息和元数据，根据所述协议类型、服务部署信息和元数据构建用于请求服务接口的测试程序，并将所述测试程序发送至存储模块。

测试程序构建模块接收管理模块发送的协议类型、服务部署信息和元数据，并根据协议类型、服务部署信息和元数据构建用于请求服务接口的测试程序。具体的构建方法包括：

读取协议描述文件对应的元数据，提取元数据中的服务名称为测试程序命名；根据元数据中的grpc接口信息，逐一为各个grpc接口生成对应的网络请求初始化代码；根据协议类型和服务部署信息生成服务监听地址的初始化代码；生成适用于不同协议类型和不同访问环境的网络IO代码，所述访问环境包括现网环境和测试环境，所述协议类型包括传输控制协议和用户数据报协议。

测试程序构建完毕后，将测试程序发送至存储模块保存，进一步向管理模块反馈第一处理信息，第一处理信息用于指示测试程序构建完成。

S904：测试页面构建模块从管理模块获取元数据，根据所述元数据创建测试页面，并将所述测试页面发送至存储模块。

测试页面构建模块接收管理模块发送的元数据，并根据元数据构建面向调用者操作的测试页面。具体的构建方法包括：

初始化页面中的通用图层，所述通用图层用于显示服务描述信息、访问环境列表、请求grpc接口描述及参数设置、请求grpc接口响应字段信息和接口测试按钮，为页面操作生成前端控制代码。

测试页面构建完毕后，将测试页面表单发送至存储模块保存，进一步向所述管理模块反馈第二处理信息，所述第二处理信息用于指示测试页面构建完成。

S905：存储模块接收所述测试程序和测试页面，将所述测试程序和测试页面进行对应存储，生成测试程序和测试页面的存储地址。

进一步地，管理模块接收到测试程序构建模块发送的第一处理信息和测试页面构建模块发送的第二处理信息后，会输出第三处理信息，所述第三处理信息用于指示协议数据处理完成，开发者通过第三处理信息可以判断协议加载是否成功。

本实施例中，协议开发者向测试系统录入协议数据后，系统会解析协议描述文件提取元数据，利用元数据、协议类型和服务部署信息自动生成测试程序，基于元数据自动构建前端测试页面，并对协议相关信息进行维护。可以减少开发者操作流程，节省人力成本。

实施例

本实施例提供一种基于调用者方的接口测试方法，该方法利用接口测试系统实现。所述接口测试系统包括管理模块、解析模块、测试程序构建模块、测试页面构建模块和存储模块，管理模块分别与解析模块、测试程序构建模块、测试页面构建模块和存储模块通信。

图10是本发明实施例提供的接口测试方法的流程图。请参见图10，该接口测试方法包括如下步骤：

S1001：接收用户查看服务协议列表的请求，根据所述请求从存储模块加载数据生成服务协议列表，所述服务协议列表包括协议的服务名称以及与所述协议对应的测试程序和测试页面的存储地址，并输出所述服务协议列表。

管理模块对外提供查询服务，当收到用户发送的查看服务协议列表的请求时，会根据该请求从存储模块加载数据，根据加载的数据生成服务协议列表，服务协议列表展示服务名称、测试页面、存储地址等信息，这些信息在服务列表中以服务名称、测试程序信息等进行关联；获取服务协议列表之后，进一步将服务协议列表返回给调用者，以便调用者选择具体的协议进行测试。

S1002：响应于选择测试协议的请求，根据所选协议对应的服务名称查询与该协议对应的测试页面的存储地址，根据所述测试页面的存储地址反馈测试页面。

管理模块接收用户选择测试协议的请求，查询所选协议对应的服务名称，进而根据服务名称查找对应的测试页面的存储地址，根据测试页面表单的存储地址加载测试页面表单，在用户的显示器上显示测试页面。测试页面如图6所示，包括了服务包含的grpc接口列表、访问环境选项、请求参数表单、响应结果表单、发送请求按钮；send按钮上方的表单为请求表单，用于设置grpc接口请求message，send按钮下方的表单为响应表单，用于展示grpc接口返回的message。

S1003：响应于对测试页面操作生成的接口测试请求，所述接口测试请求包括接口数据和接口请求参数，根据接口数据查询测试程序的存储地址，根据测试程序的存储地址和接口请求参数获得测试结果，输出所述测试结果。

用户在测试页面上进行选择和输入操作，并点击send按钮，会生成接口测试请求，其中，接口测试请求包括grpc接口信息、访问环境和接口请求参数；管理模块接收到该接口测试请求后，会对请求包含的接口进行测试。具体的测试过程如下：

根据grpc接口信息和访问环境查询获得测试程序的地址；根据所述测试程序的地址调用测试程序；基于接口请求参数运行测试程序得到测试结果。

进一步将测试结果在测试页面上进行显示，供用户查看。

本实施例中，接口调用者对协议进行测试时，通过查看协议维护信息，选择测试协议就能自动加载所选协议对应的测试页面，进一步通过设置协议下包括的接口信息，就可以对所选接口进行测试，自动获取测试结果。整个测试过程中无需接口调用者与接口开发者沟通，也不需要检出完整的项目代码，大幅降低了时间成本、沟通成本，减少了对存储资源和计算资源的占用，提升了开发效率。

实施例

图11是本发明实施例提供的接口测试系统中各模块之间的协作关系图。其中，开发者1是接口开发者，开发者2是接口调用者，接口开发者、接口调用者在进行开发、测试工作时系统中各个组件的详细协作过程如下。

开发者1向管理模块提交新的协议描述文件*.proto，并完善协议类型和部署信息，管理模块基于解析模块解析获得元数据，并进一步通过测试程序构建模块构建出协议测试工具、通过测试页面构建模块构建出前端协议测试页面，将构建完成的测试工具、测试页面存储在存储模块中，存储模块可以位于DB数据库或者文件系统中。

开发者2后续要对协议进行测试之前，先查看管理模块中维护了哪些协议，管理模块从存储模块中加载出当前维护的服务协议列表进行展示，同时也定位到各个协议对应的测试程序、前端测试页面在系统中的位置。当开发者2选择了具体的某个协议进行测试时，管理模块会将对应的前端测试页面返回给开发者2并在开发者2的浏览器中显示出来，开发者2进一步在页面中选择协议下包括的rpc接口、填写rpc接口请求参数、选择请求的访问环境(访问环境包括测试环境和现网环境)，最后点击发送请求按钮完成请求发送。管理模块收到用户请求参数后，创建一个shell进程调用之前构建好的协议测试程序，并通过测试工具的stdin传递用户请求参数给测试程序，如传递命令cmd＝1就是通过“./${service}Client–cmd＝1”来完成，之所以可以通过-cmd＝1来完成参数传递，是因为自动生成协议测试工具代码时就通过FLAGS_cmd在程序中注册了该命令行参数。协议测试工具执行完成之后，会将标准输出写到stdout，这里管理模块会对协议测试工具输出到stdout的protobufrsp message信息进行读取并转换为json形式，然后返回给开发者2的浏览器，并在测试页面中的请求响应message区域进行展示。

与图1相比，本实施例方案降低了开发者2在进行协议测试时与开发者1之间的时间交流成本。

本方法通过解析模块解析proto文件提取协议描述信息元数据，并通过管理模块统一维护proto文件、协议类型(tcp/udp)、服务部署、负责人信息，结合元数据来指导如何自动化生成测试程序和测试页面。调用者进行协议测试时，通过选择grpc接口、访问环境，填写请求参数，点击发送按钮即可完成测试请求，请求会被自动转换为对后台grpc接口的请求，并返回grpc接口的响应信息在对应表单中展示。整个测试过程中无需接口调用者与接口开发者沟通，也不需要检出完整的项目代码，大幅降低了时间成本和沟通成本。

实施例

本发明的实施例还提供一种计算机终端，该计算机终端可以是计算机终端群中的任意一个计算机终端设备。可选地，在本实施例中，上述计算机终端也可以替换为移动终端等终端设备。

可选地，在本实施例中，上述计算机终端可以位于计算机网络的多个网络设备中的至少一个网络设备。

可选地，图12是根据本发明实施例的计算机终端的结构框图。如图12所示，该计算机终端A可以包括：一个或多个(图中仅示出一个)处理器1201、存储器1203、以及传输装置1205。

其中，存储器1203可用于存储软件程序以及模块，如本发明实施例中的接口测试方法对应的程序指令/模块，处理器1201通过运行存储在存储器1203内的软件程序以及模块，从而执行各种功能应用以及数据处理，即实现上述的接口测试。存储器1203可包括高速随机存储器，还可以包括非易失性存储器，如一个或者多个磁性存储装置、闪存、或者其他非易失性固态存储器。在一些实例中，存储器1203可进一步包括相对于处理器1201远程设置的存储器，这些远程存储器可以通过网络连接至计算机终端A。上述网络的实例包括但不限于互联网、企业内部网、局域网、移动通信网及其组合。

上述的传输装置1205用于经由一个网络接收或者发送数据。上述的网络具体实例可包括有线网络及无线网络。在一个实例中，传输装置1205包括一个网络适配器，其可通过网线与其他网络设备与路由器相连从而可与互联网或局域网进行通讯。在一个实例中，传输装置1205为射频模块，其用于通过无线方式与互联网进行通讯。

其中，具体地，存储器1203用于存储预设动作条件和预设权限用户的信息、以及应用程序。

处理器1201可以通过传输装置调用存储器1203存储的信息及应用程序，以执行下述步骤：

第一步，获取协议数据，所述协议数据包括协议描述文件、协议类型和服务部署信息。

第二步，处理所述协议描述文件获得元数据。

第三步，发送所述元数据、协议类型和服务部署信息。

第四步，根据所述协议类型、服务部署信息和元数据构建用于请求服务接口的测试程序；以及根据所述元数据创建测试页面。

第五步，将所述测试程序和测试页面进行对应存储，生成测试程序和测试页面的存储地址。

处理器1201还用于执行：解析所述协议描述文件获得文件描述符信息，

从所述文件描述符信息中提取服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息，将所述服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息按照预设格式进行记录，生成元数据。

处理器1201还用于执行：读取协议描述文件对应的元数据，根据元数据中的grpc接口信息，逐一为各个grpc接口生成对应的网络请求初始化代码，根据协议类型和服务部署信息生成服务监听地址的初始化代码，生成适用于不同协议类型和不同访问环境的网络IO代码，所述访问环境包括现网环境和测试环境，所述协议类型包括传输控制协议和用户数据报协议。

处理器1201还用于执行：初始化页面中的通用图层，所述通用图层用于显示服务描述信息、访问环境列表、请求grpc接口描述及参数设置、请求grpc接口响应字段信息和接口测试按钮，为页面操作生成前端控制代码。

进一步地，处理器1201还用于执行以下步骤：

第一步：接收查看服务协议列表的请求，根据所述请求加载数据生成服务协议列表，所述服务协议列表包括协议的服务名称以及与所述协议对应的测试程序和测试页面的存储地址，并输出所述服务协议列表；

第二步：响应于选择测试协议的请求，根据所选协议对应的服务名称查询与该协议对应的测试页面的存储地址，根据所述测试页面的存储地址反馈测试页面；

第三步：响应于对测试页面操作生成的接口测试请求，所述接口测试请求包括接口数据和接口请求参数，根据接口数据查询测试程序的存储地址，根据测试程序的存储地址和接口请求参数获得测试结果，输出所述测试结果。

具体的，所述接口数据包括grpc接口信息和访问环境，所述访问环境包括现网环境和测试环境，处理器1201还用于执行：根据grpc接口信息和访问环境查询获得测试程序的地址；根据所述测试程序的地址调用测试程序；基于接口请求参数运行测试程序得到测试结果。

本实施例中的具体示例可以参考上述实施例中所描述的示例，在此不再赘述。

上述本发明实施例序号仅仅为了描述，不代表实施例的优劣。

上述实施例中的集成的单元如果以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在上述计算机可读取的存储介质中。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的全部或部分可以以软件产品的形式体现出来，该计算机软件产品存储在存储介质中，包括若干指令用以使得一台或多台计算机设备(可为个人计算机、服务器或者网络设备等)执行本发明各个实施例所述方法的全部或部分步骤。

在本发明的上述实施例中，对各个实施例的描述都各有侧重，某个实施例中没有详述的部分，可以参见其他实施例的相关描述。

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

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

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

Claims (10)

1.一种接口测试方法，其特征在于，所述方法包括：

接收查看服务协议列表的请求，根据所述请求加载数据生成服务协议列表，所述服务协议列表包括协议的服务名称以及与所述协议对应的测试程序和测试页面的存储地址，并输出所述服务协议列表；

响应于选择测试协议的请求，根据所选协议对应的服务名称查询与该协议对应的测试页面的存储地址，根据所述测试页面的存储地址反馈测试页面；

响应于对测试页面操作生成的接口测试请求，所述接口测试请求包括接口数据和接口请求参数，根据接口数据查询测试程序的存储地址，根据测试程序的存储地址和接口请求参数获得测试结果，输出所述测试结果；

所述接口数据包括grpc接口信息和访问环境；

所述根据接口数据查询测试程序的存储地址，根据测试程序的存储地址和接口请求参数获得测试结果包括：

根据grpc接口信息和访问环境查询获得测试程序的地址；

根据所述测试程序的地址调用测试程序；

基于接口请求参数运行测试程序得到测试结果。

2.根据权利要求1所述的方法，其特征在于，所述访问环境包括现网环境和测试环境。

3.根据权利要求1所述的方法，其特征在于，所述接收查看服务协议列表的请求之前还包括：

获取协议数据，所述协议数据包括协议描述文件、协议类型和服务部署信息；

处理所述协议描述文件获得元数据；

根据所述协议类型、服务部署信息和元数据构建用于请求服务接口的测试程序；以及根据所述元数据创建测试页面；

将所述测试程序和测试页面进行对应存储，生成测试程序和测试页面的存储地址。

4.根据权利要求3所述的方法，其特征在于，所述处理所述协议描述文件获得元数据包括：

解析所述协议描述文件获得文件描述符信息，

从所述文件描述符信息中提取服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息，

将所述服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息按照预设格式进行记录，生成元数据。

5.根据权利要求4所述的方法，其特征在于，所述根据所述协议类型、服务部署信息和元数据构建用于请求服务接口的测试程序包括：

读取协议描述文件对应的元数据，

根据元数据中的grpc接口信息，逐一为各个grpc接口生成对应的网络请求初始化代码，

根据协议类型和服务部署信息生成服务监听地址的初始化代码，

生成适用于不同协议类型和不同访问环境的网络IO代码，所述访问环境包括现网环境和测试环境，所述协议类型包括传输控制协议和用户数据报协议。

6.根据权利要求4所述的方法，其特征在于，所述根据所述元数据创建测试页面包括：

初始化页面中的通用图层，所述通用图层用于显示服务描述信息、访问环境列表、请求grpc接口描述及参数设置、请求grpc接口响应字段信息和接口测试按钮，为页面操作生成前端控制代码。

7.一种接口测试系统，其特征在于，所述系统包括：

管理模块，用于接收用户查看服务协议列表的请求，根据所述请求从存储模块加载数据生成服务协议列表，所述服务协议列表包括协议的服务名称以及与所述协议对应的测试程序和测试页面的存储地址，并输出所述服务协议列表；响应于选择测试协议的请求，根据所选协议对应的服务名称查询与该协议对应的测试页面的存储地址，根据所述测试页面的存储地址反馈测试页面；以及响应于对测试页面操作生成的接口测试请求，所述接口测试请求包括接口数据和接口请求参数，根据接口数据查询测试程序的存储地址，根据测试程序的存储地址和接口请求参数获得测试结果，输出所述测试结果：所述接口数据包括grpc接口信息和访问环境；所述根据接口数据查询测试程序的存储地址，根据测试程序的存储地址和接口请求参数获得测试结果包括：根据grpc接口信息和访问环境查询获得测试程序的地址；根据所述测试程序的地址调用测试程序；基于接口请求参数运行测试程序得到测试结果。

8.根据权利要求7所述的系统，其特征在于，

所述管理模块，还用于获取协议数据，所述协议数据包括协议描述文件、协议类型和服务部署信息；

所述系统还包括：

解析模块，用于从管理模块获取协议描述文件，对所述协议描述文件进行处理获得元数据，并将所述元数据返回至所述管理模块；

测试程序构建模块，用于从所述管理模块获取协议类型、服务部署信息和元数据，根据所述协议类型、服务部署信息和元数据构建用于请求服务接口的测试程序，并将所述测试程序发送至存储模块；

测试页面构建模块，用于从所述管理模块获取元数据，根据所述元数据创建测试页面，并将所述测试页面发送至存储模块；

存储模块，用于存储所述测试程序和测试页面，生成测试程序和测试页面的存储地址。

9.根据权利要求8所述的系统，其特征在于，

所述解析模块，用于解析所述协议描述文件获得文件描述符信息，从所述文件描述符信息中提取服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息，并将所述服务名称、grpc接口信息、grpc接口的请求信息和grpc接口的响应信息按照预设格式进行记录，生成元数据。

10.根据权利要求7所述的系统，其特征在于，

所述测试程序构建模块，用于读取协议描述文件对应的元数据，根据元数据中的grpc接口信息，逐一为各个grpc接口生成对应的网络请求初始化代码，根据协议类型和服务部署信息生成服务监听地址的初始化代码，并生成适用于不同协议类型和不同访问环境的网络IO代码，所述访问环境包括现网环境和测试环境，所述协议类型包括传输控制协议和用户数据报协议；

所述测试页面构建模块，用于初始化页面中的通用图层，所述通用图层用于显示服务描述信息、访问环境列表、请求grpc接口描述及参数设置、请求grpc接口响应字段信息和接口测试按钮，为页面操作生成前端控制代码。

Images