CN111782517B

CN111782517B - 一种自动化文件校验方法

Info

Publication number: CN111782517B
Application number: CN202010595288.7A
Authority: CN
Inventors: 单炎辰; 胡剑剑; 陈汉源
Original assignee: Zhejiang Baorong Technology Co ltd
Current assignee: Zhejiang Baorong Technology Co ltd
Priority date: 2020-06-23
Filing date: 2020-06-23
Publication date: 2021-06-04
Anticipated expiration: 2040-06-23
Also published as: CN111782517A

Abstract

本发明公开了一种自动化文件校验方法。本发明首先约定接口文档协议，确定文件格式；其次根据预设的标志位数值进行判断，若银行结算类交易业务属于报文类型，进入报文类型校验；若银行结算类交易业务属于文件类型，进入进行文件类型校验。本发明能根据文件模板字段，自动解析文件内容，转换成一般通用的json格式。快速根据预设好的校验表达式，比对结果是否符合期望。文件模板可设置配置方法灵活多样，可以根据文件结构，参数顺序，参数长度，参数个数，参数具体值，进行个性化配置。

Description

一种自动化文件校验方法

技术领域

本发明是一款应用于软件测试自动化框架应用平台中的一种自动化文件校验方法。

背景技术

现有的开源接口自动化框架通常只停留在接口请求通讯方面，与服务器通讯正常，对应发送的json格式请求有对应的返回。

现有的自动化框架验证方案采用最多的一般都是写一些断言来进行返回参数的验证，比如判断返回参数中是否存在“hello”字段，存在就判断用例通过，不存在则用例验证失败。这样的要求可以满足日常的接口测试自动化需求，但是无法满足银行结算高要求的报文细节精度。

本发明系统涵盖了目前外界所有使用比较广泛的开源自动化框架功能，实现了对产品的自动化持续集成、持续交付之外，还专门设计了针对银行支付结算业务报文的自动化验证方法。

发明内容

外界被广泛应用的一些自动化测试平台或框架，目前并没有一套对银行支付结算类交易比较试用的自动化测试解决方案，最接近的应该只有一些即将被淘汰的类似soapui，此类工具提供了单单联通性方面的解决方案，对于这类测试自动化测试如何解决并无方案。

本发明针对上述问题提供一种自动化文件校验方法：

本发明针对银行支付结算类交易业务特殊性，银行常用的传输形式分为两类：“报文类”和“文件类”。根据公司业务测试专家在此方面经验的积累，整理出最合理最精准的测试方案，以直接上线交付、节约研发生命周期为目标完成的自动化测试工作。

本发明解决采用的实现步骤如下：

步骤1、根据预设的标志位数值对银行结算类交易业务进行分类；若标志位数值为1，则银行结算类交易业务属于报文类型；若标志位数值为0，则银行结算类交易业务属于文件类型；

步骤2、根据请求对应的类型，银行API接口返回相同类型的报文信息或文件信息。

步骤3、根据预设的标志位数值进行判断，若标志位数值为1，则银行结算类交易业务属于报文类型，进入步骤4进行报文类型校验；若标志位数值为0，则银行结算类交易业务属于文件类型，进入步骤5进行文件类型校验。

步骤4、报文类型校验

4-1.判断响应头中content-type字段的类型，并进行对应的校验；

如果content-type字段的值等于application/json，则进行 json校验，获取接口校验表达式；；如果content-type字段的值等于application/xml，则进行xml校验，获取接口校验表达式；如果 content-type字段的值等于其他值，例如text/html；则进行文本校验；

所述的json校验、xml校验和文本校验均为现有自动化测试平台或框架自带校验方式；

4-2.判断接口校验表达式语法；

4-2-1.通过调用python的eval()函数,对表达式基本格式进行判断；若表达式基本格式正确，则进入步骤4-2-2，否则提示“用户表达式语法错误”。

所述的表达式基本格式为ABC，其中B为校验运算符，A和C是表达式中校验符两端的值；其中左侧A为银行API接口返回的报文信息中提取的值；右侧C为预设的期望值。

所述的A和B即为获取的接口校验表达式；

4-2-2.对表达式语法进行判断：

通过校验运算符对表达式进行判断，若表达式成立，则返回校验结果，否则提示“用户校验运算符不通过”，若A为“1”,B为“＝”， C为“1”，则表达式运算校验1＝1通过；若A为“1”,B为“＝”，C 为“2”，则表达式运算校验1＝2不通过；若A为“1”,B为“＝！”(不等于)，C为“2”，则表达式运算校验1＝！2通过。

进一步的，实际代码中“＝”表示赋值，“＝＝”表示运算等式，以上描述暂以“＝”表示方便理解。

步骤5、文件类型校验：

5-1.根据文件的后缀名匹配预设模板，若文件对应多个后缀名相同的预设模板，则进一步匹配该文件与预设模板的文件名，选择与该文件的文件名相同的预设模板进行校验；

5-2.根据预设模板提取文件中的对应的内容，如果提取的内容符合预设模板配置规则，则将内容转换为json格式的报文内容。

5-3.对已转换json格式的报文内容进行校验，校验方法参看步骤4-2。

所述的步骤5中的文件是预先与银行约定的对外结算接口文档，，且文件的格式与银行API接口返回的文件信息满足如下要求：

首先，预先约定的文档中的文件名命名规则：企业编号+下划线+ 接口版本号+下划线+提交日期+下划线+批次号+扩展名；且具体要求如表1所示；

其次，预先约定的文档中的文件头要素规则，如表2所示；

然后，预先约定的文档中的文件明细要素说明，如表3所示；

表1：文件名命名规则要求表格

表2文件头要素规则

表3文件明细要素说明

序号	说明	长度(字节)	必填	备注
					1	请求流水号	50X	Y
2	企业方帐号	32X	Y
					3	企业方名称	64X	N
4	客户方账号	32X	Y
					5	客户方名称	128X	Y
6	证件类型	1X	N
					7	证件号码	32X	N
8	返回码	8X	N
					9	返回信息	32X	N

其中，长度(字节)表示，这个字段在文件中所占长度，不论具体参数内容多长这个字段中的参数值+空格＝总长度(字节)。

进一步，所述的报文类：报文类型主要是指与银行约定的远程调用协议Webservice接口中，数据内容使用xml数据格式向银行发起请求，银行也会实时或非实时返回一个对应格式类型的返回报文，达到双方交易数据交互的一个过程。

进一步，所述的文件类：文件类型是银行比较特殊的一种交易数据传输方式，银行在数据传输中对数据的安全性有较高的要求，因此会对需要传输的文件使用自己的秘钥进行加压加密，并且对解压解密后的数据内容，也有严谨的格式要求且主要分为两种格式“空格分隔” 类型和“双竖分隔”类型，两种解析后的明文报文内容也有不同的校验逻辑。因此，预设模板根据两种格式“空格分隔”类型和“双竖分隔”类型分别进行预先设置。

进一步的，所述的文件类中为两种文件格式类型，不同类型则具体计算表达式也不同：

1.“空格分隔”文件类型，参数之间使用空格进行分隔，这种格式是一种严格限制长度的格式，根据接口文档每个字段都有固定的字节长度，如：接口要求姓名字段要求占十个字节长度，那姓名所占字节+空格所占字节长度＝10字节，姓名为“张三”，张三(4个字节) +空格(6个字节)＝10字节，姓名为“王一二”，王一二(6个字节) +空格(4个字节)＝10个字节。类似这样，需要对所有会根据业务信息变更的字段字节长度进行严格校验。本系统可以根据字段的内容、字节长度、进行可配置化的文件类报文内容自动检测，当我方和银行约定接口文档格式未发生变化，即可以随时对大量业务测试数据进行自动化比对，如果银行接口文档改变或者更新，也可以及时更新我们检测规则配置，继续完成自动化数据文件对比。

2.“双竖分隔”文件类型，每个参数字段之间都会用“||”进行分隔，本发明会自动根据每个“||”之间的参数，进行提取并与我们提前在报文模板根据已有的接口文档维护好的报文模板进行每个字段的比较，比较内容有参数长度、参数格式、参数值。

本发明有益效果如下：

1.能根据文件模板字段，自动解析文件内容，转换成一般通用的json格式。

2.能快速根据预设好的校验表达式，比对结果是否符合期望。

3.文件模板可设置配置方法灵活多样，可以根据文件结构，参数顺序，参数长度，参数个数，参数具体值，进行个性化配置。

其他目前已有的自动化平台或框架，暂时没有能够支持对上述的报文类型进行自动化解析校验的功能，本身银行结算业务也存在一定的特殊性，平时需要测试人员人工进行大量数据准确性的校验，确实花费大量时间和人力资源，这项发明能替代非常多的人工工作量和时间，提高公司的生产效能。

附图说明

图1为判断报文类型。

图2为报文类型校验逻辑流程。

图3为文件类型校验逻辑流程。

图4为预设模板的设置截面图。

图5为预设模板的设置完成的截面图。

具体实施方式

银行的文件一般存在两种格式，即按字节长度规范每个参数字段长度的格式和使用||进行参数之间的分隔的格式，我们在后面称这两种格式分别为“字节长度格式”和“双竖分隔符格式”。

在日常与银行对外开放接口进行联调调试时，我们一般都需要靠银行提供的接口文档，通过人工进行非常细致的字段逐个比对。

通常在数据量比较大，银行方传输几千几万笔数据的同时，我们需要通过手工或者一些文本工具如notepad++去对比这些细节(如字节长度、字段内容)，甚至一些文档对比工具也不能完全满足字节长度对比的需求，使用本发明只需要你在建立好自己自定义模板的前提下，就可以满足你对比字节长度，对比字节内容的需求，把这个流程融入到企业自动化中，可以大大节省测试人员时间成本，提高效率。

以下为空格文件类型具体实施举例：

步骤1：约定接口文档协议，确定文件格式。以下为定义的“空格文件”类型举例，文档包含空格文件三个要素：文件名命名规则、文件内容头部规则、文件内容明细规则。“双竖文件”类型，约定文档类似，区别只是传输时不需要像空格文件类型一样补足字段空格长度，只需以“||”分隔每个字段。

文件名命名规则：企业编号+下划线+接口版本号+下划线+提交日期+下划线+批次号+扩展名；

示例文件命名：QT330001(企业编号)1120(接口版本号) 20200401(提交日期)20200401141111……(批次号).scs不同的交易文件扩展名不同

步骤2：自动化框架本地服务器上，根据约定接口文档新增维护一个文件模板，模板内容包括文件名、文件类型、文件字段顺序、长度、内容等要素，如设置的文件模板的文件名为 QT330001_112020200401_20200401141111.scs，并定义这个文件为空格类型文件，拓展名为scs；

文件内容设定，以下表示设置的字段名称，需要校验的长度，字段期望比对内容：

1)请求流水号，50字符长度，期望请求流水号＝a；

2)企业方账号，32字符长度，期望企业方账号＝b；

3)企业方名称，64字符长度，期望企业方名称＝c；

4)客户方账号，32字符长度，期望客户方账号＝d；

5)客户方名称，128字符长度，期望客户方名称＝e；

6)证件类型，1字符长度，期望证件类型＝f；

7)证件号码，32字符长度，期望证件号码＝g；

8)返回码，8字符长度，期望返回码＝h；

9)返回信息，32字符长度，期望返回信息＝i；

步骤3：通过框架自带轮询下载任务，从指定IP的ftp服务器上，下载与文件模板的文件名格式匹配的待校验文件。如从IP为 127.0.0.1的服务器上，路径为/bank下，下载成功名称为QT330001_112020200401_20200401141111.scs的文件；

步骤3：下载到自动化框架平台指定目录下后，首先根据待校验文件拓展名匹配待校验文件的预设模板，如果结果不唯一则根据文件名称匹配拓展名相同的全部预设模板，若匹配到拓展名和文件名称相同的据预设模板QT330001_112020200401_20200401141111.scs，则待校验文件符合文件名称命名规则，校验通过。

步骤4：根据预设模板中字段的名称、长度，解析文件内容。校验通过的文件中只会有参数值，不会有参数名称。经过预设模板转换，对校验通过的文件生成一份json格式的参数值和参数名称对应的报文。

如原文件只会有：

上述格式的文件内容(空格类型文件)，按文件的预设模板解析后得到{‘name’:’1’,’account’:’123456’,’bankcode’:’ 103’,’org’:’QT330001’}，其中name、account、bankcode、 org即为名称；1、123456、103、QT330001即为与名称对应的长度；

所述的预设模板中字段的名称、长度根据银行要求预先设定。

步骤5-1-1：判断为“双竖分隔”文件类型；

步骤5-1-2：根据“||”对双竖格式文件内容进行转译，按已配置报文模板各个参数字段名称按顺序，依次对每个“||”分隔的参数进行配对。假设模板按接口文档已经按序号维护：1.name；2.account； 3.bankcode；4.org，文件内容为：1||123456||103||QT330001，则转译成json格式的结果为：

{‘name’:’1’,’account’:’123456’,’bankcode’:’103’,’ org’:’QT330001’}；

预设模板的设置表达如图4所示：

步骤5-2-1：判断为“空格分隔”文件类型；

步骤5-2-2：按已配置预设模板各个参数字段名称顺序和字段字节长度，直接依次对文件内容进行解析；

步骤5-2-3：根据文件模板中每个字段的长度直接在文件中截取这个字段的长度，并进行去空格处理。如：

1 123456 103 QT330001

根据第一字段10字节(9空格)，第二字段10字节(4空格)，第三字段5字节(2空格)，第四字段18字节(10空格)按预设模板中预设长度截取，字段字节长度都包含空格，组成了一个总共含 43个字节的文件内容。

预设模板中明确设置要求后的表达如下图5所示：

得到后，进行去空格处理，并与预设模板中字段名称按顺序配对得到json格式如下；{‘name’:’1’,’account’:’123456’,’ bankcode’:’103’,’org’:’QT330001’}；

步骤6：校验文档内字段具体需要校验的值，校验值也可以随时通过正则获取变量；

如：在调用local_file_check()函数时，同时填写参数→{‘scs, ‘QT330001_112020200401_20200401141111.scs’,[‘org＝QT330001’, ’bankcode＝103’]}

则表示：

1)先校验文件拓展名是否为scs；

2)校验文件名称是否为 QT330001_112020200401_20200401141111.scs，因为这里可以选择模糊匹配校验方式所以可以选择带或者不带后缀名；

3)[‘org＝QT330001’,’bankcode＝103’]表示在这里需要校验的转译后报文的参数字段键值对，如上述转译结果为{‘name’:’1’,’ account’:’123456’,’bankcode’:’103’,’org’:’QT330001’}，这里需要校验这些键值对中org是否为QT330001，bankcode是否为 103；

即步骤3)中的org＝QT330001相当于表达式，其基本格式对应 ABC，“org”对应A，“＝”对应B，“QT330001”对应C；

步骤7：校验通过，自动化文件校验用例执行结果返回Pass；校验不通过，自动化文件校验执行结果返回Fail；

步骤8：自动生成测试报告，返回校验结果，成功只显示Pass，失败显示报错内容或者匹配失败字段名称。

进一步的，json校验：是通过Python的基础requset库实现；在实现时，事先通过import request引用完成，后直接通过get(a) 方法得到，如下是一个json格式报文：

通过requests.get(http://127.0.0.1).get(code)得到code字段在返回中的值，用这里的值去替换校验表达式中的一侧，ABC中的 A，看等式结果左右两边是否符合运算结果。

进一步的，xml校验，以下是一个xml格式报文：

当想获取CommandCode的值时，需要根据xml的外层进行一个链式表达式，Root.Head.CommandCode获取，如果 Root.Head.CommandCode＝11111则表示通过Root.Head.CommandCode 获取的值进行表达式运算，左侧获取值判断是否等于1，判断结果1＝1 相等符合等式，用例通过PASS。

当如下xml报文存在多个同名字段时：

则Root.Trans[0].TransNo表示获取第一个Trans的值，数据顺序从0开始计数，Root.Trans[0].TransNo＝AUTO0610150213385842，同上判断等式左右两侧结果，

AUTO0610150213385842＝AUTO0610150213385842，校验运算表达式通过，用例PASS。

Claims

1.一种自动化文件校验方法，其特征在于包括如下步骤：

步骤2、根据请求对应的类型，银行API接口返回相同类型的报文信息或文件信息；

步骤3、根据预设的标志位数值进行判断，若标志位数值为1，则银行结算类交易业务属于报文类型，进入步骤4进行报文类型校验；若标志位数值为0，则银行结算类交易业务属于文件类型，进入步骤5进行文件类型校验；

步骤4、报文类型校验；

4-1.判断响应头中content-type字段的类型，并进行对应的校验；

如果content-type字段的值等于application/json，则进行json校验，获取接口校验表达式；如果content-type字段的值等于application/xml，则进行xml校验，获取接口校验表达式；如果content-type字段的值等于其他值，则进行文本校验；

4-2.判断接口校验表达式语法；

步骤5、文件类型校验：

5-2.根据预设模板提取文件中的对应的内容，如果提取的内容符合预设模板配置规则，则将内容转换为json格式的报文内容；

2.根据权利要求1所述的一种自动化文件校验方法，其特征在于所述的json校验通过Python的基础requset库实现，实现时，事先通过import request引用完成，后直接通过get(a)方法得到a字段在返回中的值。

3.根据权利要求1所述的一种自动化文件校验方法，其特征在于步骤4-2所述的判断接口校验表达式语法，具体实现如下：

4-2-1.通过调用python的eval()函数,对表达式基本格式进行判断；若表达式基本格式正确，则进入步骤4-2-2，否则提示“用户表达式语法错误”；

步骤4-2-2所述的对表达式语法进行判断：

通过校验运算符对表达式进行判断，若表达式成立，则返回校验结果，否则提示“用户校验运算符不通过”，若A为“1”,B为“＝”，C为“1”，则表达式运算校验1＝1通过；若A为“1”,B为“＝”，C为“2”，则表达式运算校验1＝2不通过；若A为“1”,B为“＝！”，C为“2”，则表达式运算校验1＝！2通过；

4.根据权利要求1或3所述的一种自动化文件校验方法，其特征在于所述的A和C也可以为获取的接口校验表达式。

5.根据权利要求4所述的一种自动化文件校验方法，其特征在于

所述的步骤5中的文件是预先与银行约定的对外结算接口文档，且文件的格式与银行API接口返回的文件信息均满足如下要求：

首先，预先约定的对外结算接口文档中的文件名命名规则：企业编号+下划线+接口版本号+下划线+提交日期+下划线+批次号+扩展名；且具体要求如表1所示；

其次，预先约定的对外结算接口文档中的文件头要素规则，如表2所示；

然后，预先约定的对外结算接口文档中的文件明细要素说明，如表3所示；

表1：文件名命名规则要求表格

表2 文件头要素规则

表3 文件明细要素说明

其中，长度表示这个字段在文件中所占长度，不论具体参数内容多长，这个字段中的参数值+空格＝长度。

6.根据权利要求5所述的一种自动化文件校验方法，其特征在于

所述的报文类型：报文类型主要是指与银行约定的远程调用协议Webservice接口中，数据内容使用xml数据格式向银行发起请求，银行也会实时或非实时返回一个对应格式类型的返回报文。

7.根据权利要求5所述的一种自动化文件校验方法，其特征在于

所述的文件类型：文件类型分为两种格式“空格分隔”类型和“双竖分隔”类型，两种解析后的明文报文内容也有不同的校验逻辑；因此，预设模板根据两种格式“空格分隔”类型和“双竖分隔”类型分别进行预先设置。

8.根据权利要求7所述的一种自动化文件校验方法，其特征在于所述的“空格分隔”文件类型：参数之间使用空格进行分隔，这种格式是一种严格限制长度的格式，接口文档每个字段都有固定的字节长度；根据字段的内容、字节长度、进行可配置化的文件类报文内容进行自动检测，当企业和银行约定接口文档格式未发生变化，可随时对大量业务测试数据进行自动化比对，如果银行接口文档改变或者更新，也可以及时更新规则配置，继续完成自动化数据文件对比。

9.根据权利要求7或8所述的一种自动化文件校验方法，其特征在于所述的“双竖分隔”文件类型，每个参数字段之间都会用“||”进行分隔，根据每个“||”之间的参数，进行提取并与预设模板根据已有的接口文档维护好的报文模板进行每个字段的比较，比较内容有参数长度、参数格式、参数值。