yamlpy 1.1.1

yamlpy接口测试框架

yamlpy

yamlpy接口测试框架

yamlpy即为yaml文件+pytest单元测试框架的缩写
可看作是一个脚手架工具
可快速生成项目的各个目录与文件
只需维护一份或者多份yaml文件即可

pip install yamlpy
安装

yamlpy -h（或yamlpy --help）
查看参数信息

yamlpy -v（或yamlpy --v）
查看版本号

pip install -U yamlpy
安装最新版

yamlpy --p=项目名称
创建项目
例如在某个路径下执行命令：
yamlpy --p=demo_project

pip uninstall yamlpy
卸载

一、思路

1、采用requests+PyMySQL+DBUtils+demjson+loguru+PyYAML+ruamel.yaml+pytest+pytest-html+allure-pytest+pytest-reportlog+pytest-assume+pytest-rerunfailures+pytest-sugar+pytest-timeout+pytest-parallel
2、requests是发起HTTP请求的第三方库
3、PyMySQL是连接MySQL的第三方库
4、DBUtils是数据库连接池的第三方库
5、demjson是解析非标json的第三方库
6、loguru是记录日志的第三方库
7、PyYAML与ruamel.yaml是读写yaml文件的第三方库
8、pytest是单元测试的第三方库
9、pytest-html是生成html测试报告的插件
10、allure-pytest是生成allure测试报告的插件
11、pytest-reportlog是替换--resultlog选项的插件
12、pytest-assume是多重断言的插件
13、pytest-rerunfailures是失败重跑的插件
14、pytest-sugar是显示进度的插件
15、pytest-timeout是设置超时时间的插件
16、pytest-parallel是多线程的插件

二、目录结构

1、case是测试用例包
2、report_log是测试报告的目录
3、resource是yaml文件的目录
4、setting是工程的配置文件包
5、tool是常用方法的封装包
6、.gitignore是.ignore插件需要排除的文件
7、conftest.py是全局钩子文件
8、Jenkinsfile是Jenkins Pipeline文件
9、pytest.ini是pytest的配置文件
10、requirements.txt是第三方依赖库

三、yaml文件说明

- case_name: 用例名称
  step:
    - step_name: 步骤名称
      mysql: 
        - 
        - 
        - 
      request_mode: POST
      api: /api/test
      body: 
        {"key_1":"value_1","key_2":"value_2"}
      headers:
        {"Content-Type":"application/json"}
      expected_time: 3
      expected_code: 200
      expected_result:
        {"code":1,"message":"成功"}
      regular:
        variable:
          - name_1
          - name_2
        expression:
          - '"response_1":"(.+?)"'
          - '"response_2":"(.+?)"'

1、外层有2个字段，内层有13个字段
命名和格式不可修改，顺序可以修改
外层：
case_name：用例名称，必填
step：步骤，-列表格式
一条用例可以有多个步骤，全部的步骤通过，本条用例才算通过
内层：
step_name：步骤名称，必填
mysql： MySQL语句，-列表格式，顺序不可修改，选填
第一行：mysql[0]
第二行：mysql[1]
第三行：mysql[2]
第一行为增、删、改语句，第二行为查语句，第三行为查语句（数据库双重断言）
第一行是发起请求之前的动作，没有返回结果
第二行是发起请求之前的动作，有返回结果，是为了动态传参
第三行是发起请求之后的动作，有返回结果，但是不可用于动态传参，是为了断言实际的响应结果
当不需要增删改查和双重断言时，可以不写mysql字段，或者三行都为空
当只需要增删改时，第一行为增删改语句，第二行为空，第三行为空
当只需要查时，第一行为空，第二行为查语句，第三行为空
当只需要双重断言时，第一行为空，第二行为空，第三行为查语句
request_mode: 请求方式，必填
api: 接口路径，必填
body: 请求体，缩进字典格式或者json格式，选填
headers: 请求头，缩进字典格式或者json格式，选填
query_string: 请求参数，缩进字典格式或者json格式，选填
expected_time: 预期的响应时间，选填
expected_code: 预期的响应代码，必填
expected_result: 预期的响应结果，-列表格式、缩进字典格式或者json格式，必填
regular: 正则，缩进字典格式，选填

variable:变量名，-列表格式
expression:表达式，-列表格式

2、参数化
正则表达式提取的结果用${变量名}匹配，一条用例里面可以有多个
MySQL查询语句返回的结果，即第二行mysql[1]返回的结果，用{__SQL索引}匹配
即{__SQL0}、{__SQL1}、{__SQL2}、{__SQL3}。。。。。。一条用例里面可以有多个
随机数字用{__RN位数}，一条用例里面可以有多个
随机英文字母用{__RL位数}，一条用例里面可以有多个
随机手机号码用{__MP}，一条用例里面可以有多个
以上5种类型在一条用例里面可以混合使用
${变量名}的作用域是全局的，其它4种的作用域仅限该条用例

四、运行

在工程的根目录下执行命令
pytest+--cmd=环境缩写
pytest --cmd=dev
pytest --cmd=test
pytest --cmd=pre
pytest --cmd=formal

五、从阿里云镜像仓库拉取镜像

docker pull registry.cn-hangzhou.aliyuncs.com/yangjianliang/yamlapi:[镜像版本号]