lemon-easytest 内测版发布

easytest

easytest 是一个接口自动化框架。

功能特点:

安装

pip install lemon_easytest

快速使用

不需要写任何代码,所有你需要做的就是按照规则编写用例文档,然后运行命令 easytest

easytest 支持 yaml 格式和 excel 格式的用例文档。

在任意目录下创建文件 singe_test.yaml,内容如下:

test:                                 # 表名这是单个测试用例
  title: 一个简单的测试                 # 用例名称
  url: http://httpbin.org/get         # url
  method: get                         # 请求方法
  request:                            # 请求参数字段
    headers:                          # 请求头
      CustomerHeader: lemonban        # 头信息
    params:                           # url参数
      search: lemonban                # url参数键值对
  res_type: json                      # 响应数据类型
  status_code: 200                    # 状态码
  assertion:                          # 断言表达式
    -
      - eq                            # 相等
      - $..Customerheader             # 结果提取表达式
      - lemonban                      # 期望值
    -
      - eq
      - $..search
      - lemonban

然后在命令行运行

easytest yourpath/single_test.yaml
INFO 2021-10-30 14:53:26,081 :==========single_test测试开始============
INFO 2021-10-30 14:53:26,081 :用例【一个简单的测试】开始测试>>>>>>>>
INFO 2021-10-30 14:53:26,591 :用例【一个简单的测试】测试结束<<<<<<<<<
INFO 2021-10-30 14:53:26,591 :==========single_test测试结束============
用例总数:1,成功:1个,跳过:0,失败:0个,错误:0个

通过 python 代码调用 easytest

可以直接通过 python 调用 easytest

import easytest
easytest.main()

也可传递参数

easytest.main(['test_dir', '--debug', '--logfile', 'test.log'])

编写用例

测试用例

easytest 中编写单条测试用例可以使用 yaml 格式,也可以使用 Excel 文件。

Excel 格式

使用 Excel 文件编写单条测试用例非常简单,例如将上面的案例编写到 Excel 文件中格式如下:!

企业微信截图 e8827888e26443579c321815ae42f806.png

当用 Excel 文件编写用例时保持数据的整洁,其他单元格不要有任何数据,以免加载用例数据失败。easytest 会根据 Excel 文件的 sheetname 来组织用例,所以单条用例请删除其他的表。

YAML 格式

当使用 YAML 文件编写单条测试用例时最外层键必须为 test,因为 easytest 根据它来确定一个 YAML 文件中的数据是单条测试用例。

test:                                 # 表名这是单个测试用例
  title: 一个简单的测试                 # 用例名称
  url: http://httpbin.org/get         # url
  method: get                         # 请求方法
  request:                            # 请求参数字段
    headers:                          # 请求头
      CustomerHeader: lemonban        # 头信息
    params:                           # url参数
      search: lemonban                # url参数键值对
  res_type: json                      # 响应数据类型
  status_code: 200                    # 状态码
  assertion:                          # 断言表达式
    -
      - eq                            # 相等
      - $..Customerheader             # 结果提取表达式
      - lemonban                      # 期望值
    -
      - eq
      - $..search
      - lemonban

测试套件

easytest 中测试套件表示一组有顺序的测试用例,当启动多线程时,以测试套件为单位交给线程去按照套件中的顺序执行测试用例。注意套件和套件间的执行顺序是不固定的。

单个测试用例也会被套上一层测试套件的壳子,yaml 格式的单测试用例会被封装到以 YAML 文件名为名字的测试套件中,Excel 格式的单测试用例会被封装到以表名为名字的测试套件中。

Excel 格式

Excel 文件中编写测试套件与单测试用例没有区别,按照执行顺序从上往下依次编写即可,例如:

wecomtempa0c3a6d9a95896ee44d4bbb6993e12e4.png

在单个 Excel 文件中可以编写多个测试套件,一个表即为一个测试套件,所以非测试用例或者项目设置的表请删除。

YAML 格式

在 YAML 文件中编写测试套件,最外层的 key 必须为 test_suit,因为 easytest 根据它来确定一个 YAML 文件中的数据是一个测试套件。注意和 Excel 不同,YAML 格式不支持在一个文件中编写多个测试套件,因为多层级的嵌套缩进将是噩梦。

test_suit:
  - title: 一个简单的测试
    url: http://httpbin.org/post
    method: post
    status_code: 200
    res_type: json
    request:
      json:
        username: xinlan
        password: 123456
    assertion:
      - [eq,$..username,xinlan]
      - [eq,$..password,123456]

  - title: 一个不简单的测试
    url: http://httpbin.org/post
    method: post
    status_code: 200
    res_type: json
    request:
      json:
        username: xinlan
        password: 123456
    assertion:
      - [ eq,$..username,xinlan ]
      - [ eq,$..password,123456 ]

用例收集规则

easytest 命令后接受一个位置参数 file_or_dir,它可以是一个用例文件,也可以是一个目录。

当传入一个用例文件时,它必须是上一节提到的符合格式的 excel 或者 yaml 文件,Excel 文件只支持 .xlsx 后缀的格式,YAML 文件支持 .yaml 或者 .yml 后缀。

当传入一个目录时,easytest 会递归的去这个目录下搜索所有符合规则的用例文件(excel、yaml),并从中提取用例,当遇到格式错误时,程序会中断,所以不要把无关的 Excel 文件和 YAML 文件放在用例目录下。

用例字段说明

项目配置

easytest 命令会从当前目录下读取名为 easytest.ini 的配置文件,下面是一个完整配置文件的例子:

[project]  																# 项目配置段
name = xxx项目													   # 项目名称	  
host = http://some.api.root.com           # 项目接口根地址
[db_config]																# 数据库配置
host = dbhost										          # 数据库主机
user = root																# 数据库用户
password = 123456                         # 数据库密码
db = somedb																# 数据库名
charset = utf8														# 字符编码
port = 3306																# 端口
[interfaces]															# 接口地址
register: /member/register								# 注册接口对应地址
login: /member/login											# 登录接口对应地址
withdraw: /member/withdraw
recharge: /member/recharge
add: /loan/add
audit: /loan/audit
invest: /member/invest
[run]																			# 运行时参数
debug=true																# 开启调试模式
logfile=a.log															# 日志文件
marks=success,login												# 筛选标记
thread_num=10															# 启动线程数量
retry=3																		# 失败重跑次数
report=result.json												# 报告文件

project

project 段,支持 name 和 host

db_config

db_config 段,数据库配置,目前仅支持 MySQL

interfaces

interfaces 段,接口名称配置,格式:key=value,key 是接口名称字符串,value 是去掉主机后的接口地址以 / 开头,在用例中 url 字段可以填写 key,easytest 内部会使用项目 host+ 接口地址进行拼接。

run

run 字段,运行时的参数。

注意:命令行参数会覆盖项目配置。

生成模拟测试数据

在测试过程中有时需要动态的生成测试数据,例如手机号码,人名等。easytest 通过 Faker 模块来生产模拟数据,暂时只支持简体中文语言下的接口,详情见 Faker 简体中文 providers

用例中支持生产模拟测试数据的字段有,url,request,db_assertion

使用格式为 $生成数据接口名$

例如在 Faker 中生成手机号码的方法名为 phone_number,那么在用例中使用 $phone_number$ 表示动态生成手机号码。

test:                                 # 表名这是单个测试用例
  title: 一个简单的测试                  # 用例名称
  url: http://httpbin.org/get         # url
  method: get                         # 请求方法
  request:                            # 请求参数字段
    headers:                          # 请求头
      CustomerHeader: lemonban        # 头信息
    params:                           # url参数
      search: lemonban                # url参数键值对
      phone: $phone_number$

上面这个用例表示 url 参数 phone 是一个动态生成的手机号码。

接口依赖的处理

easytest 中,同一个测试套件下,前一个用例返回的数据可以通过变量传递给下一个用例。

例如登录成功后将返回的 token 值传递给下一个需要 token 的用例。传递步骤如下:

  1. 在登录用例中添加 extract 字段提取响应回的 token 值,并绑定到你定义的变量名 admin_token
  2. 在后面的用例中,在需要使用到 token 的数据部分就可以使用 #admin_token#,来表示,easytest 会在自动进行替换

所有你需要做的,只是按照规则编写用例,剩下的交给 easytest。

命令行参数说明

字符串,运行时选择的标记
1 回帖
请输入回帖内容 ...