AI 助理
备案控制台
开发者社区 数据库 文章 正文

怎么基于Pytest+Requests+Allure实现接口自动化测试？

2024-06-12 183
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
云数据库 RDS MySQL，集群系列 2核4GB
推荐场景：
搭建个人博客
RDS MySQL Serverless 基础系列，0.5-2RCU 50GB
推荐场景：
学生管理系统数据库设计 搭建个人博客
云数据库 Tair（兼容Redis），内存型 2GB
推荐场景：
通过缓存加速数据库访问
简介： 该文介绍了一个基于Python的自动化测试框架，主要由pytest、requests和allure构成，采用关键字驱动模式。项目结构分为六层：工具层（api_keyword）封装了如get、post的请求；参数层（params）存储公共参数；用例层（case）包含测试用例；数据驱动层（data_driver）处理数据；数据层（data）提供数据；逻辑层（logic）实现用例逻辑。代码示例展示了如何使用allure装饰器增强测试报告，以及如何使用yaml文件进行数据驱动。

一、整体结构

  • 框架组成：pytest+requests+allure
  • 设计模式：
  • 关键字驱动
  • 项目结构：
  • 工具层：api_keyword/
  • 参数层：params/
  • 用例层：case/
  • 数据驱动：data_driver/
  • 数据层：data/
  • 逻辑层：logic/

二、具体步骤及代码

1、工具层

将get、post等常用行为进行二次封装。

代码（api_key.py）如下：

python

复制代码

import allure
import json
import jsonpath
import requests

# 定义一个关键字类
class ApiKey:
    # 将get请求行为进行封装
    @allure.step("发送get请求")
    def get(self, url, params=None, **kwargs):
        return requests.get(url=url, params=params, **kwargs)

    # 将post请求行为进行封装
    @allure.step("发送post请求")
    def post(self, url, data=None, **kwargs):
        return requests.post(url=url, data=data, **kwargs)

    # 由于接口之间可能相互关联，因此下一个接口需要上一个接口的某个返回值，此处采用jsonpath对上一个接口返回的值进行定位并取值
    @allure.step("获取返回结果字典值")
    def get_text(self, data, key):
        # json数据转换为字典
        json_data = json.loads(data)
        # jsonpath取值
        value = jsonpath.jsonpath(json_data, '$..{0}'.format(key))
        return value[0]
  • 其中引用allure.step()装饰器进行步骤详细描述，使测试报告更加详细。
  • 使用jsonpath对接口的返回值进行取值。

2、数据层

数据采用yaml文件。

代码（user.yaml）如下：

python

复制代码

-
  user:
    username: admin
    password: '123456'
  msg: success
  title: 输入正确账号、密码，登录成功
-
  user:
    username: admin1
    password: '1234561'
  msg: 用户名或密码错误
  title: 输入错误账号1、密码1，登录失败
-
  user:
    username: admin2
    password: '1234562'
  msg: 用户名或密码错误
  title: 输入错误账号2、密码2，登录失败
  • 其中title是为了在用例进行时动态获取参数生成标题。

3、数据驱动层

对数据进行读写。

代码（yaml.driver.py）如下:

python

复制代码

import yaml


def load_yaml(path):
    file = open(path, 'r', encoding='utf-8')
    data = yaml.load(file, Loader=yaml.FullLoader)
    return data

4、参数层

参数层存放公共使用的参数，在使用时对其进行调用。

代码（allParams.py）如下：

python

复制代码

'''python
    规则：
    全局变量使用大写字母表示
'''

# 地址
URL = 'http://39.98.138.157:'

# 端口
PORT = '5000'

5、逻辑层

用例一：进行登录的接口请求，此处登录请求在yaml文件里设置了三组不同的数据进行请求。

用例二：进行个人查询的接口请求，此处需要用到登录接口返回的token值。

用例三、进行添加商品到购物车的接口请求，此处需要用到登录接口返回的token值以及个人查询接口返回的openid、userid值

用例四、进行下单的接口请求，此处需要用到登录接口返回的token值以及个人查询接口返回的openid、userid、cartid值

注意：由于多数接口需要用到登录接口返回的token值，因此封装一个conftest.py定义项目级前置fixture，在整个项目只执行一次，可以在各个用例中进行调用（其他共用参数也可以采取类似前置定义）。同时由于此处定义的项目级fixture，因此可以将初始化工具类ak = ApiKey()也放入其中。

代码（conftest.py）如下：

python

复制代码

from random import random

import allure
import pytest

from pytest_demo_2.api_keyword.api_key import ApiKey
from pytest_demo_2.params.allParams import *


def pytest_collection_modifyitems(items):
    """
    测试用例收集完成时，将收集到的item的name和nodeid的中文显示在控制台上
    """
    for item in items:
        item.name = item.name.encode("utf-8").decode("unicode_escape")
        item._nodeid = item.nodeid.encode("utf-8").decode("unicode_escape")


# 项目级fix，整个项目只初始化一次
@pytest.fixture(scope='session')
def token_fix():
    # 初始化工具类
    ak = ApiKey()
    with allure.step("发送登录接口请求，并获取token，整个项目只生成一次"):
        # 请求接口
        # url = 'http://39.98.138.157:5000/api/login'
        url = URL + PORT + '/api/login'
        # 请求参数
        userInfo = {
            'username': 'admin',
            'password': '123456'
        }
        # post请求
        res = ak.post(url=url, json=userInfo)
        # 获取token
        token = ak.get_text(res.text, 'token')
        # 验证代码，验证token只生成一次
        token_random = random()
        return ak, token, res, token_random
  • 其中也包含了防止中文乱码，加入了pytest_collection_modifyitems（函数）。

设置好conftest后，就可以应用在逻辑层里面了。

代码（shopingApi.py）如下：

python

复制代码

import pytest
import allure
from pytest_demo_2.api_keyword.api_key import ApiKey
from pytest_demo_2.params.allParams import *


class ApiCase():
    # 登录逻辑
    def params_login(self, userdata):
        # 动态获取参数生成标题
        allure.dynamic.title(userdata['title'])
        # 初始化工具类
        ak = ApiKey()
        # 请求接口
        url = URL + PORT + '/api/login'
        # 请求参数
        userInfo = {
            'username': userdata['user']['username'],
            'password': userdata['user']['password']
        }
        res = ak.post(url=url, json=userInfo)
        with allure.step("接口返回信息校验及打印"):
            print("/api/login登录接口请求响应信息")
            print(res.text)
            # 获取响应结果
            msg = ak.get_text(res.text, 'msg')
            print(msg)
            # 断言
            assert msg == userdata['msg']

    def params_getuserinfo(self, token_fix):
        # 从fix中获取预置的工具类和token,所有返回值都需要接收
        ak, token, res, token_random01 = token_fix
        with allure.step("发送个人查询接口请求"):
            url = URL + PORT + '/api/getuserinfo'
            headers = {
                'token': token
            }
            res1 = ak.get(url=url, headers=headers)
        with allure.step("接口返回信息校验及打印"):
            print("/api/getuserinfo个人用户查询接口请求响应信息")
            print(res1.text)
            # print("验证的random值，测试用")
            # print(token_random01)
            name = ak.get_text(res1.text, 'nikename')
            # 断言
            assert "风清扬" == name
        return res1

    def params_addcart(self, token_fix):
        # 从fix中获取预置的工具类和token
        # 所有返回都要获取，不然会报错
        ak, token, res, token_random01 = token_fix
        with allure.step("调用getuserinfo接口获取返回信息"):
            res1 = self.params_getuserinfo(token_fix)
        with allure.step("发送添加商品到购物车请求"):
            # 添加商品到购物车,基于token、userid、openid、productid
            url = URL + PORT + '/api/addcart'
            hd = {
                "token": token
            }
            data = {
                "userid": ak.get_text(res1.text, 'userid'),
                "openid": ak.get_text(res1.text, 'openid'),
                "productid": 8888
            }
            # 发送请求
            res2 = ak.post(url=url, headers=hd, json=data)
        with allure.step("接口返回信息校验及打印"):
            print("/api/addcart添加商品到购物车请求响应信息")
            print(res2.text)
            # print("验证的random值，测试用")
            # print(token_random01)
            result = ak.get_text(res2.text, 'result')
            assert 'success' == result
        return res2

    def params_createorder(self, token_fix):
        ak, token, res, token_random01 = token_fix
        with allure.step("调用addcart接口获取返回信息"):
            res1 = self.params_addcart(token_fix)
        with allure.step("发送下单请求"):
            url = URL + PORT + '/api/createorder'
            # 从项目级fix中获取token
            hd = {
                "token": token
            }
            # 从添加商品到购物车接口中获取userid,openid,cartid
            data = {
                "userid": ak.get_text(res1.text, 'userid'),
                "openid": ak.get_text(res1.text, 'openid'),
                "productid": 8888,
                "cartid": ak.get_text(res1.text, 'cartid')
            }
            res2 = ak.post(url=url, headers=hd, json=data)
        with allure.step("接口返回信息校验及打印"):
            print("/api/createorder下单请求响应信息")
            print(res2.text)
            # print("验证的random值，测试用")
            # print(token_random01)
            result = ak.get_text(res1.text, 'result')
            assert 'success' == result

**6、用例层

**调用逻辑层进行用例管理和数据传输。

代码（test_Tree.py）如下：

python

复制代码

import allure
import pytest
from pytest_demo_2.data_driver import yaml_driver
from pytest_demo_2.logic.shopingApi import ApiCase


@allure.epic("shopXo电商平台接口-接口测试")
class TestTree():
    # 初始化用例库
    actions1 = ApiCase()

    @allure.feature("01.登陆")
    @allure.story("02.一般场景")
    @pytest.mark.parametrize('userdata', yaml_driver.load_yaml('./data/user.yaml'))
    def test_case01(self, userdata):
        self.actions1.params_login(userdata)

    @allure.feature("02.个人查询")
    @allure.story("01.典型场景")
    @allure.title("个人查询")
    def test_case02(self, token_fix):
        self.actions1.params_getuserinfo(token_fix)

    @allure.feature("03.添加商品到购物车")
    @allure.story("01.典型场景")
    @allure.title("添加商品到购物车")
    def test_case03(self, token_fix):
        self.actions1.params_addcart(token_fix)

    @allure.feature("04.下单")
    @allure.story("01.典型场景")
    @allure.title("下单")
    def test_case04(self, token_fix):
        self.actions1.params_createorder(token_fix)

**7、运行

**代码（main_run.py）如下：

python

复制代码

import os
import pytest


def run():
    pytest.main(['-v', './case/test_Tree.py',
                 '--alluredir', './result', '--clean-alluredir'])
    os.system('allure serve result')
    # os.system('allure generate ./result/ -o ./report_allure/ --clean')

if __name__ == '__main__':
    run()


转载来源：https://juejin.cn/post/7358336719166275636

文章标签：
测试技术
Python
存储
设计模式
关键词：
自动化测试
自动化测试allure
allure测试
pytest测试
pytest allure测试
大数据文摘
目录
相关文章
八百标兵奔北坡
|
10天前
|
安全 前端开发 测试技术
如何选择合适的自动化安全测试工具
选择合适的自动化安全测试工具需考虑多个因素，包括项目需求、测试目标、系统类型和技术栈，工具的功能特性、市场评价、成本和许可，以及集成性、误报率、社区支持、易用性和安全性。综合评估这些因素，可确保所选工具满足项目需求和团队能力。
八百标兵奔北坡
33 5
八百标兵奔北坡
|
10天前
|
机器学习/深度学习 SQL 安全
如何确保自动化安全测试的全面性和准确性？
如何确保自动化安全测试的全面性和准确性？
八百标兵奔北坡
22 4
zzy的aly
|
1月前
|
测试技术
自动化测试项目学习笔记(五)：Pytest结合allure生成测试报告以及重构项目
本文介绍了如何使用Pytest和Allure生成自动化测试报告。通过安装allure-pytest和配置环境，可以生成包含用例描述、步骤、等级等详细信息的美观报告。文章还提供了代码示例和运行指南，以及重构项目时的注意事项。
zzy的aly
187 1
自动化测试项目学习笔记(五)：Pytest结合allure生成测试报告以及重构项目
土木林森
|
20天前
|
前端开发 数据管理 测试技术
前端自动化测试：Jest与Cypress的实战应用与最佳实践
【10月更文挑战第27天】本文介绍了前端自动化测试中Jest和Cypress的实战应用与最佳实践。Jest适合React应用的单元测试和快照测试，Cypress则擅长端到端测试，模拟用户交互。通过结合使用这两种工具，可以有效提升代码质量和开发效率。最佳实践包括单元测试与集成测试结合、快照测试、并行执行、代码覆盖率分析、测试环境管理和测试数据管理。
土木林森
37 2
土木林森
|
21天前
|
前端开发 JavaScript 数据可视化
前端自动化测试：Jest与Cypress的实战应用与最佳实践
【10月更文挑战第26天】前端自动化测试在现代软件开发中至关重要，Jest和Cypress分别是单元测试和端到端测试的流行工具。本文通过解答一系列问题，介绍Jest与Cypress的实战应用与最佳实践，帮助开发者提高测试效率和代码质量。
土木林森
31 2
请看我回答~
|
15天前
|
Web App开发 测试技术 数据安全/隐私保护
自动化测试的魔法：使用Python进行Web应用测试
【10月更文挑战第32天】本文将带你走进自动化测试的世界，通过Python和Selenium库的力量，展示如何轻松对Web应用进行自动化测试。我们将一起探索编写简单而强大的测试脚本的秘诀，并理解如何利用这些脚本来确保我们的软件质量。无论你是测试新手还是希望提升自动化测试技能的开发者，这篇文章都将为你打开一扇门，让你看到自动化测试不仅可行，而且充满乐趣。
请看我回答~
25 0
zzy的aly
|
1月前
|
测试技术 Python
自动化测试项目学习笔记(四)：Pytest介绍和使用
本文是关于自动化测试框架Pytest的介绍和使用。Pytest是一个功能丰富的Python测试工具，支持参数化、多种测试类型，并拥有众多第三方插件。文章讲解了Pytest的编写规则、命令行参数、执行测试、参数化处理以及如何使用fixture实现测试用例间的调用。此外，还提供了pytest.ini配置文件示例。
zzy的aly
28 2
zzy的aly
|
1月前
|
测试技术 数据安全/隐私保护 Python
自动化测试项目实战笔记(四)：测试用户登录（账号密码错误，成功，出现弹框等情况）
本文介绍了使用Selenium进行自动化测试时如何测试用户登录的不同情况，包括账号密码错误、登录成功以及处理登录时出现的弹框，并提供了相应的Python代码实现。
zzy的aly
59 0
自动化测试项目实战笔记(四)：测试用户登录（账号密码错误，成功，出现弹框等情况）
zzy的aly
|
1月前
|
测试技术 Python
自动化测试项目学习笔记(三)：Unittest加载测试用例的四种方法
本文介绍了使用Python的unittest框架来加载测试用例的四种方法，包括通过测试用例类、模块、路径和逐条加载测试用例。
zzy的aly
62 0
自动化测试项目学习笔记(三)：Unittest加载测试用例的四种方法
mrq4nk6ni2neg
|
18天前
|
Web App开发 设计模式 JavaScript
自动化测试之美：如何利用Selenium实现Web应用的高效测试
【10月更文挑战第29天】在软件开发的世界中，测试是确保产品质量的关键步骤。本文将带你了解如何使用Selenium这一强大的自动化测试工具，提高Web应用测试的效率和准确性。通过实际案例，我们将探索Selenium的核心功能及其在现代软件开发中的应用，旨在帮助读者掌握自动化测试的精髓，从而提升软件测试工作的整体效能。
mrq4nk6ni2neg
16 0

数据库

热门文章

最新文章

  • 1
    德哥的PostgreSQL私房菜 - 史上最屌PG资料合集
  • 2
    redis4.0、codis、阿里云redis 3种redis集群对比分析
  • 3
    NoSQL最新现状和趋势：云NoSQL数据库将成重要增长引擎
  • 4
    什么场景应该用 MongoDB ？
  • 5
    PostgreSQL 如何实现批量更新、删除、插入
  • 6
    MongoDB Sharded cluster架构原理
  • 7
    Redis Stream——作为消息队列的典型应用场景
  • 8
    MongoDB 生态 - 可视化管理工具
  • 9
    PostgreSQL upsert功能(insert on conflict do)的用法
  • 10
    Linux 性能诊断 perf使用指南
  • 1
    实现Excel文件和其他文件导出为压缩包，并导入
    8
  • 2
    如何使用PHP开发1688商品详情API接口
    6
  • 3
    淘宝商品API接口的对接及收益
    14
  • 4
    【赵渝强老师】PostgreSQL的数据库集群
    10
  • 5
    智能调度、秒级弹性｜一文带你探索Compaction Service的进化之路
    12
  • 6
    如何开发一个网站：全面解析与实战指南
    10
  • 7
    SpringBoot 如何解决跨域问题?
    10
  • 8
    体验使用DAS实现数据库SQL优化，完成任务可得羊羔绒加厚坐垫！
    24
  • 9
    使用Python开发独立站的全面指南
    17
  • 10
    【赵渝强老师】PostgreSQL的逻辑存储结构
    26

    • 相关课程

    更多
  • MSE微服务测试最佳实践 - 自动化回归

    • 相关电子书

    更多
  • 新一代自动化渗透平台的设计与实现
  • 自动化、智能化网络运维
  • 无人值守自动化测试的实践之路

    • 相关实验场景

    更多
  • 云原生场景自动化响应ECS系统事件
  • 使用资源编排自动化开通云服务
  • 基于Mappings自动化配置yum源
  • 快速上手并跑通AnalyticDB PostgreSQL版TPC-H测试
    • 下一篇
    无影云桌面