简介

基于 pytest。

版权所有 未经授权 请勿使用

用例编写

1. 新增API

   如果编写的用到的api不存在，那么就需在在对应服务的yaml配置文件中添加

   # 百度首页                                          # 1、为了后期维护，api都应该写上备注
   home:                                             # 2、api 名字，测试数据中通过这个名字引用
     url: "/"
     method: "GET"

2. 用例模版

   # >>> 用例模版字段详解
   
   test_template_01: # 用例标题
     spec:
       marks: [ "daily", "smoke" ]  # 用例的标记
       branches: [ "release/1.1" ]  # 归属分支，使用勾子可实现分支和用例的解耦
       fixtures: [ "params" ]  # 自定义的夹具名称，使用自定义夹具，必须自己编写夹具并在 settings 中配置
   
     meta: # 用例元信息，体现在报告中
       desc: "模版用例1"
       author: "goodman"
       level: "P1"
       time: "2022.10.26"  # 更新时间
   
     param: # 用例参数化，生成多个参数化的用例
       K1: [ "k1_v1", "k1_v2" ]
       K2: [ [ "a1", "b1" ], [ "a2", "b2" ] ]  # 参数化支持多层嵌套
   
     steps: [ # 用例步骤，每一个 {} 表示一步
       {
         api: "httpbin.post",  # 产品名称.接口名称 这表示一个http请求
         desc: "演示post接口调用",  # 当前步骤的描述信息，会打印到日志
         rule: { "timeout": 12, "interval": 3 },  # 调度规则，控制当前步骤重试次数及间隔
         param: { # 同用例级别的参数，这里对统一步骤参数化
           K1: [ "k1_v1", "k1_v2" ],
           K2: [ [ "a1", "b1" ], [ "a2", "b2" ] ]
         },
         request: { # 请求部分。内部KV同 python requests 标准库的入参。这里不关心 url和 method 这两个参数通常被 接口管理对象管理
           data: {
             key: "豫章故郡，洪都新府",
             val: "萍水相逢，尽是他乡之客"
           },
           headers: {
             "Auth": "Copyright reserved, please purchase"
           }
         },
         response: { # 响应对象为接口返回的json对象。响应体中自动装配status_code；如果是文件下载接口，还会装载size和file字段
           json: {
             key: "豫章故郡，洪都新府",
             val: "萍水相逢，尽是他乡之客"
           },
           status_code: 200
         }
       },
       {
         api: "MailService.SendMail(SendMailRequest(**request))",  # 服务名称.接口名称(请求对象) 这表示一个rpc请求
         desc: "演示post接口调用",  # 当前步骤的描述信息，会打印到日志
         rule: { "timeout": 12, "interval": 3 },  # 调度规则，控制当前步骤重试次数及间隔
         param: {
           K1: [ "k1_v1", "k1_v2" ],
           K2: [ [ "a1", "b1" ], [ "a2", "b2" ] ]
         },
         request: { # 请求部分，KV键值对，执行时作为 入参 传到 api 参数的请求中
           key: "豫章故郡，洪都新府",
           val: "萍水相逢，尽是他乡之客"
         },
         response: { # rpc 请求时，返回的结果自动将 proto 对象转成字典对象返回
           key: "豫章故郡，洪都新府",
           val: "萍水相逢，尽是他乡之客"
         }
       },
       { }
     ]
   
   test_template_02:  # 用例标题

3. 新增用例数据

   • 所有 文件名称、用例名称都不应重复

   • 模版语法都必须放在字符串中，可以使用 多个 模版，但不能嵌套

   • 在 用例 和 steps 中都可以增加param字段来表示参数化（使用过程见示例）

   • step 级别的参数化，参数仅在当前 step 有效

   • 参数化的key，可在模版语法中直接当做变量使用

   • r对象。框架为每个用例提供一个r对象列表，后面的接口可通过r[i]的方式获取前面对象的返回值

   • 模版语法： 模版语法的作用就是为了动态的获取、关联数据而规定的一种写作格式。

     # 语法
     @<表达式>
     
     # 示例
     @<Fab.random_text('?')>
     
     # 说明
     1、框架会到factory模块中去找 Fab 类，并调用类中的 random_text 方法。这里 调用方法和在代码中一样，是可以直接传递参数的。
     2、在同一个模版语法内，可直接使用参数化字段作为变量使用，r对象也可直接作为变量使用，只需要遵循python语法规则即可。

   • 编写示例：

     test_demo_01:
       spec:
         marks: [ "smoke" ]  # 用例的mark
       meta:
         desc: "演示用例"
         author: "goodman"
         level: "P1"
         time: "2022.10.26"
       steps: [
         {
           api: "httpbin.post",  # 接口api名称
           desc: "演示post接口调用", # 当前步骤的描述信息
           request: { # 请求对象和标准库http中的字段相同，这里不关心url和method
             data: {
               key: "豫章故郡，洪都新府",
               val: "萍水相逢，尽是他乡之客"
             },
             headers: {
               "Auth": "Copyright reserved, please purchase"
             }
           },
           response: { # 响应对象为接口返回的json对象。响应体中自动装配status_code；如果是文件下载接口，还会装载size和file字段
             json: {
               key: "豫章故郡，洪都新府",
               val: "萍水相逢，尽是他乡之客"
             },
             status_code: 200
           }
         }
       ]
     
     test_demo_02:
       spec:
         marks: [ "smoke" ]
       meta:
         desc: "参数化演示用例"
         author: "goodman"
         level: "P1"
         time: "2022.10.26"
       param: # 用例参数化，下面的参数将逐个分组拆成多个用例
         text: "@<Fab.many_text(prefix='参数化随机文本: ', num=4, length=4)>"
         answer: [ '其疾如风', '其徐如林', '侵掠如火', '不动如山' ]  # text 参数经转化后会有4个值，所以这里也需要四个值
     
       steps: [
         {
           api: "httpbin.post",
           desc: "参数化演示 - @<answer>",  # 描述信息中也可以使用参数化中的变量
           param: { # 步骤参数化，有几组参数则该步骤执行几轮。注意：如果步骤参数化字段和用例参数化字段同名，那么在后续使用中前者将覆盖后者
             text: [ '第一次执行: @<text>', '第二次执行: @<text>' ],
             name: [ '@<answer>', '@<Fab.to_name(answer)>' ]
           },
           request: {
             data: {
               key: "@<text>",
               val: "@<name>"
             }
           },
           response: {
             status_code: 200
           }
         }
       ]
     
     test_demo_03:
       spec:
         marks: [ "smoke" ]
       meta:
         desc: "演示用例"
         author: "goodman"
         level: "P1"
         time: "2022.10.26"
       steps: [
         {
           api: "httpbin.post",
           desc: "演示post接口调用",
           request: {
             data: {
               key: "score",
               val: [ 99, 100, 98, 89 ]
             },
             headers: {
               "Auth": "Copyright reserved, please purchase"
             }
           },
           response: {
             json: {
               key: "score",
               val: [ 99, 100, 98, 89 ]
             },
             status_code: 200
           }
         },
         {
           api: "httpbin.post",
           desc: "演示post接口调用",
           request: {
             data: {
               score: "score",
               val: "@<r[0]['json']['val']>"  # 通过r对象加下标，来获取当前用例第0次请求的响应结果中的值
             },
             headers: {
               "Auth": "Copyright reserved, please purchase"
             }
           },
           response: {
             json: {
               score: "score",
               val: {  # 这里使用逻辑比较检验结果，如果是列表检验长度，如果是字符串数字等直接比较大小
                 ">": 2,  # 检验返回值是否大于2
                 "==": 4,  # 检验是否等于4
                 "not in": 100  # 检验返回值是否包含 100 这一项，这里校验会失败。错误日志可见测试报告 report/report.html
               }
             },
             status_code: 200
           }
         }
       ]

4. 调试及运行

   执行测试与pytest官方规则无异，此处不做介绍。仅对调试方法作说明

   # 调试单个用例。使用pytest命令行 --case 用例名称 即可
   pytest --case test_demo_01
   
   # 调试单个文件。使用pytest命令行 --case 测试文件名称 即可，测试文件需要带后缀
   pytest --case test_demo.yaml
   
   # 调试单个文件或用例时，同样可以使用pytest其他命令行参数
   pytest -sv --case test_demo.yaml