Requests + Pytest + Allure 实现 API 自动化测试

2024-04-16 12:58

本文主要是介绍Requests + Pytest + Allure 实现 API 自动化测试,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

项目地址:https://github.com/tomoyachen/api-test-scaffold

基于 Pytest + Requests + Allure 实现快速搭建 API 自动化测试项目的脚手架。

文章目录

  • TODO
  • 已实现
  • 目录结构
  • 用例示例
  • Allure 报告
  • 日志
  • GitLab CI

TODO

  1. 基于 GitLab CI 的 飞书、钉钉的通知
  2. 基于 pre-commit 规范提交代码风格
  3. 进一步完善 GitLab CI 过程(触发器、美化报告)

已实现

(Changes)

  1. 基本的测试用例示例
  2. 简单、易维护的分层
  3. 多套环境的配置、静态数据
  4. 接口会话信息输出
  5. 支持 Allure 报告
  6. 登录态用例示例(包含免登录策略)
  7. 经典场景用例示例(动态传参、遍历测试、tags)
  8. 支持操作 Mysql、Redis
  9. 基于 GitLab CI 的执行用例、生成 allure 报告、部署 pages
  10. 基于 GitLab CI 支持 allure 单次报告、增量报告
  11. 基于 GitLac CI 支持根据提交所影响的范围来动态执行用例

目录结构

api-test-scaffold
├─common
│      config.py # 读取配置(dev.yaml)、静态数据(dev/project_1.yaml)
│      request.py # 请求基类
│
├─config
│      dev.yaml # 环境配置(URL、数据库连接信息)
│      dev-01.yaml
│
├─fixtures
│  └─dev
│          project_1.yaml # 静态数据(用户信息、各种常量)
│
├─outputs
│  ├─report # allure 原始文件
│  └─report-html # allure 生成的 html 目录(用于部署在线报告)
│
├─request
│  └─project_1 # 项目文件夹
│      └─module_1 # 模块文件夹
│              post_method_request.py # 被测接口(维护接口基本信息、工具方法)
│              get_method_request.py 
│
├─testcase
│  └─project_1
│      └─module_1
│              post_method_test.py # 测试用例
│              get_method_test.py
│
│  .gitignore
│  conftest.py # Pytest 最先执行的文件(大量内置钩子、定义全局fixture)
│  poetry.lock
│  pyproject.toml
│  pytest.ini # Pytest 配置文件
│  .gitlab-ci.yml # GitLab CI 配置
└─ README.md

用例示例

testcase\project_1\module_1\post_method_test.py

import pytest
import allure
from request.project_1.module_1.post_method_request import PostMethodRequest@allure.epic("Project 1")
@allure.feature("Module 1")
@allure.story("Post 请求接口")
class PostMethodTest():@pytest.fixture(scope='function')def api(self):request = PostMethodRequest()yield request@allure.title("成功请求")def test_post_method(self, api):api.request()api.assertion(expect_code=200)@allure.title("id 不存在")def test_post_method_with_id_not_exists(self, api):api.data['id'] = -1api.request()api.assertion(expect_code=1001, expect_message='id 不存在')

Allure 报告

在这里插入图片描述
在这里插入图片描述

日志

2021-11-26 21:16:40    INFO    conftest.py:38    用户 zhangsan 免登录
2021-11-26 21:16:41    INFO    request.py:77    Caller: <FrameSummary file D:\chen\PycharmProjects\api-test-scaffold\testcase\project_1\module_1\classic_scene_test.py, line 44 in test_classic_scene_with_parametrize>
POST  https://httpbin.org/post
Request Headers: {'content-type': 'application/json; charset=utf-8'}
Request Body: {'id': 1, 'status': 1, 'code': 200, 'message': None}
HTTP Code: 200
Response Body: {  "json": {    "code": 200,     "id": 1,     "message": null,     "status": 1  }}

GitLab CI

在这里插入图片描述

这篇关于Requests + Pytest + Allure 实现 API 自动化测试的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/908849

相关文章

mybatis执行insert返回id实现详解

《mybatis执行insert返回id实现详解》MyBatis插入操作默认返回受影响行数,需通过useGeneratedKeys+keyProperty或selectKey获取主键ID,确保主键为自... 目录 两种方式获取自增 ID:1. ​​useGeneratedKeys+keyProperty(推

Spring Boot集成Druid实现数据源管理与监控的详细步骤

《SpringBoot集成Druid实现数据源管理与监控的详细步骤》本文介绍如何在SpringBoot项目中集成Druid数据库连接池,包括环境搭建、Maven依赖配置、SpringBoot配置文件... 目录1. 引言1.1 环境准备1.2 Druid介绍2. 配置Druid连接池3. 查看Druid监控

Linux在线解压jar包的实现方式

《Linux在线解压jar包的实现方式》:本文主要介绍Linux在线解压jar包的实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录linux在线解压jar包解压 jar包的步骤总结Linux在线解压jar包在 Centos 中解压 jar 包可以使用 u

c++ 类成员变量默认初始值的实现

《c++类成员变量默认初始值的实现》本文主要介绍了c++类成员变量默认初始值,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录C++类成员变量初始化c++类的变量的初始化在C++中,如果使用类成员变量时未给定其初始值,那么它将被

Qt使用QSqlDatabase连接MySQL实现增删改查功能

《Qt使用QSqlDatabase连接MySQL实现增删改查功能》这篇文章主要为大家详细介绍了Qt如何使用QSqlDatabase连接MySQL实现增删改查功能,文中的示例代码讲解详细,感兴趣的小伙伴... 目录一、创建数据表二、连接mysql数据库三、封装成一个完整的轻量级 ORM 风格类3.1 表结构

基于Python实现一个图片拆分工具

《基于Python实现一个图片拆分工具》这篇文章主要为大家详细介绍了如何基于Python实现一个图片拆分工具,可以根据需要的行数和列数进行拆分,感兴趣的小伙伴可以跟随小编一起学习一下... 简单介绍先自己选择输入的图片,默认是输出到项目文件夹中,可以自己选择其他的文件夹,选择需要拆分的行数和列数,可以通过

Python中将嵌套列表扁平化的多种实现方法

《Python中将嵌套列表扁平化的多种实现方法》在Python编程中,我们常常会遇到需要将嵌套列表(即列表中包含列表)转换为一个一维的扁平列表的需求,本文将给大家介绍了多种实现这一目标的方法,需要的朋... 目录python中将嵌套列表扁平化的方法技术背景实现步骤1. 使用嵌套列表推导式2. 使用itert

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

在Linux中改变echo输出颜色的实现方法

《在Linux中改变echo输出颜色的实现方法》在Linux系统的命令行环境下,为了使输出信息更加清晰、突出,便于用户快速识别和区分不同类型的信息,常常需要改变echo命令的输出颜色,所以本文给大家介... 目python录在linux中改变echo输出颜色的方法技术背景实现步骤使用ANSI转义码使用tpu

Knife4j+Axios+Redis前后端分离架构下的 API 管理与会话方案(最新推荐)

《Knife4j+Axios+Redis前后端分离架构下的API管理与会话方案(最新推荐)》本文主要介绍了Swagger与Knife4j的配置要点、前后端对接方法以及分布式Session实现原理,... 目录一、Swagger 与 Knife4j 的深度理解及配置要点Knife4j 配置关键要点1.Spri