python + request + pytest+ pytest-html集成的API自动化测试框架

对于框架任何问题,欢迎联系我!

一、框架功能说明

解决痛点:

  1. 通过session会话方式,解决了登录之后cookie关联处理
模块: case_utils.requests_handle 
相关代码cls.session = requests.Session()
  1. 框架天然支持接口动态传参、关联灵活处理
1) 通过全局变量替换用例数据值
用例数据中,存在如下格式 data: { "user_id": "${user_id}"}
全局变量GLOBAL_VAR中存在user_id=84522通过替换后最终变为{ "user_id": 84522}

2) 通过执行函数替换用例数据值
用例数据中,存在如下格式 "repository_name": ${faker.name().replace(" ", "").replace(".", "")}。
通过代码替换后,最终变为:"repository_name": "Mike"

  1. 支持Excel、Yaml文件格式编写接口用例,通过简单配置框架自动读取并执行
通读取配置文件 config.settings.py中的CASE_FILE_TYPE决定是运行excel/yaml用例也可都读取
  1. 执行环境一键切换,解决多环境相互影响问题
1) 通过pytest_addoption将命令行参数--env添加到pytest配置对象中
2) 通过get_config去配置文件config.settings.py中读取不同环境的配置信息包括域名测试账号
3) 在主运行文件run.py中通过click模块读取输入的-env的值
4) 最后在运行时输入 python run.py -env=test可以指定运行的环境
  1. 支持http/https协议各种请求、传参类型接口

  2. 响应数据格式支持json、str类型的提取操作

通过request_handle.after_extract根据响应数据进行提取
  1. 断言方式支持等于、包含、大于、小于、不等于等方法
用例数据中通过字段validate进行断言。通过断言的关键字eq等决定断言是等于、包含、大于、小于、不等于。
具体断言逻辑见case_utils.assert_util
  1. 框架可以直接交给不懂代码的功能测试人员使用,只需要安装规范编写接口用例就行
只需要按照yaml或者excel格式正确编写测试用例即可自动生成测试用例文件运行测试用例
  1. 框架也可以交给懂代码的功能测试人员使用可以在test_case目录下通过python编写脚本
脚本的编写规范符合pytest要求即可。
注意框架默认在pytest.ini中配置了只运行test_auto_case目录下的用例如果需要运行其他符合pytest要求的用例需要注释掉该配置testpaths = ./test_auto_case
  1. 采用luguru管理日志可以输出更为优雅简洁的日志

二、框架使用说明

  1. 拉取代码到本地

  2. 使用pipenv管理安装环境。

python版本要求3.9.5
安装pipenv: pip install pipenv必须在项目根目录下
创建虚拟环境pipenv install (必须在项目根目录下执行)
激活已存在的虚拟环境如果不存在会创建一个pipenv shell (必须在项目根目录下执行)
查看项目虚拟环境路径: pipenv --venv
退出虚拟环境exit

注意使用pipenv install会自动安装Pipfile里面的依赖包该依赖包仅安装在虚拟环境里不安装在测试机。

注意检查一下pip的安装源位置Pipfile
以下安装源均可:
pip默认的镜像地址是https://pypi.org/simple
清华大学https://pypi.tuna.tsinghua.edu.cn/simple 清华大学的pip源是官网pypi的镜像每隔5分钟同步一次重点推荐

阿里云http://mirrors.aliyun.com/pypi/simple/

中国科技大学 https://pypi.mirrors.ustc.edu.cn/simple/

华中理工大学http://pypi.hustunique.com/

山东理工大学http://pypi.sdutlinux.org/

豆瓣http://pypi.douban.com/simple/
  1. 更改配置文件config.settings.py修改用例文件读取来源CASE_FILE_TYPE以及配置test和live环境及测试账号

  2. 在data目录下新建测试用例数据文件编写测试用例 Excel或者Yaml或者在test_case目录下通过python语言编写用例

  3. 框架主入口为 run.py文件

	必须在项目根目录下,输入命令运行(如果依赖包是安装在虚拟环境中,需要先启动虚拟环境)。
    注意本机环境中没有安装依赖包的情况下不要直接在run.py中右键直接run
  > python run.py  (默认在test环境运行测试用例)
  > python run.py -env live 在live环境运行测试用例
  > python run.py -env=test 在test环境运行测试用例

三、框架使用过程中遇到的问题

测试机安装的是python3.7但是本框架要求3.9.5,怎么办?

方法一:建议采纳此方法 1首先在项目根目录下打开命令窗口移除虚拟环境pipenv --rm 2安装虚拟环境时忽略锁定的版本号同时安装依赖包pipenv install --skip-lock 如果使用上述命令报错Warning: Python 3.9 was not found on your system... Neither 'pyenv' nor 'asdf' could be found to install Python. 请使用如下命令pipenv install --pyhon 3.7 --skip-lock (注意这里的版本号如果你的是3.8就应该如下写命令pipenv install --python 3.8 --skip-lock)

3激活虚拟环境pipenv shell

4运行框架python run.py

方法二: 1首先在项目根目录下打开命令窗口移除虚拟环境pipenv --rm 2更改项目根目录下的Pipfile文件

# 如下所示3.9更改为3.7
[requires]
python_version = "3.7"

3更改项目根目录下的Pipfile.lock文件

# 如下所示3.9更改为3.7
        "requires": {
            "python_version": "3.7"
        },

4安装虚拟环境同时安装依赖包pipenv install

5激活虚拟环境pipenv shell

6运行框架python run.py

Description
No description provided
Readme ZPL-2.0 35 MiB
Languages
Python 85%
JavaScript 8.1%
Shell 4.6%
Batchfile 1.8%
CSS 0.5%