pytest 截图功能

pytest 中,将截图功能放在 conftest.py 中实现并将截图添加到测试报告中是一种常见的做法。这样可以确保在任何测试失败时自动执行截图操作,同时将截图信息添加到测试报告中,以便于后续查看和分析。

以下是详细步骤和代码示例,说明如何在 conftest.py 中实现截图功能,并将截图添加到测试报告中。

步骤:

  1. conftest.py 中实现截图功能

    • 使用 pytest 的钩子函数 pytest_runtest_makereport 来判断测试是否失败。
    • 如果测试失败,通过 Selenium 的 driver.save_screenshot() 方法进行截图。
    • 使用 allure 插件将截图添加到测试报告中。
  2. 配置文件 pytest.ini

    • 配置 pytest 插件、测试报告输出路径等。

代码示例:

1. conftest.py 文件实现
python 复制代码
import pytest
import os
import time
from selenium import webdriver
import allure

# 配置截图保存路径
SCREENSHOT_DIR = './screenshots/'
if not os.path.exists(SCREENSHOT_DIR):
    os.makedirs(SCREENSHOT_DIR)

# 设置 WebDriver
@pytest.fixture(scope='function')
def driver():
    # 启动浏览器
    driver = webdriver.Chrome()
    yield driver
    driver.quit()

# 截图函数
def take_screenshot(driver, test_name):
    """将截图保存到指定路径"""
    screenshot_path = os.path.join(SCREENSHOT_DIR, f"{test_name}_{int(time.time())}.png")
    driver.save_screenshot(screenshot_path)
    return screenshot_path

# 监听测试报告,并在失败时截图
def pytest_runtest_makereport(item, call):
    """在测试失败时执行截图"""
    if call.when == 'call' and call.excinfo is not None:
        # 获取测试名称
        test_name = item.name
        driver = item.funcargs.get('driver')  # 获取 driver 实例
        if driver:
            # 获取截图路径
            screenshot_path = take_screenshot(driver, test_name)
            # 将截图添加到 Allure 报告
            allure.attach.file(screenshot_path, name="Screenshot", attachment_type=allure.attachment_type.PNG)
            print(f"截图已保存到: {screenshot_path}")
2. pytest.ini 配置文件

确保你的项目根目录下有一个 pytest.ini 文件,并包含以下配置来启用 Allure 报告功能。

复制代码
[pytest]
# 指定 Allure 的输出目录
alluredir = allure_results
3. 示例测试代码

test_example.py 中编写一个简单的测试,故意让其失败,从而触发截图功能。

python 复制代码
def test_example(driver):
    driver.get("https://www.google.com")
    assert driver.title == "Incorrect Title"  # 故意断言失败,触发截图
4. 运行测试
  1. 运行测试 : 使用 pytest 运行测试,测试失败时截图将会自动保存到 ./screenshots/ 目录,同时 Allure 报告中会包含截图信息。

    bash 复制代码
    pytest --alluredir=allure_results
  2. 生成 Allure 报告: 使用 Allure 生成并查看测试报告:

    bash 复制代码
    allure serve allure_results

说明:

  • pytest_runtest_makereport 钩子函数:用于在每个测试执行后生成报告。此函数判断测试是否失败,如果失败则触发截图保存操作。
  • take_screenshot(driver, test_name):此函数负责将失败的测试截图保存到指定目录。
  • allure.attach.file:此方法将截图添加到 Allure 报告中,确保每次测试失败时,可以在报告中查看到截图。
  • pytest.ini 配置:配置了 Allure 报告的输出目录,确保可以正确生成报告。

优点:

  • 集中化管理 :将截图和报告逻辑放在 conftest.py 中,避免了在每个测试中重复编写截图逻辑。
  • 增强可维护性 :如果需要更改截图的路径或其他相关逻辑,只需修改 conftest.py 中的内容,所有测试都会自动使用最新的配置。
  • 测试报告完备:将截图直接添加到 Allure 等测试报告中,有助于问题的快速定位和修复。

扩展:

  • 你还可以根据需要调整截图保存的路径或在 pytest_runtest_makereport 中添加更多的截图细节(例如页面 HTML、浏览器控制台日志等),以便更好地帮助调试。
相关推荐
AI360labs_atyun9 分钟前
Java在AI时代的演进与应用:一个务实的视角
java·开发语言·人工智能·科技·学习·ai
心 一24 分钟前
Python 类型注解实战:`Optional` 与安全数据处理的艺术
服务器·python·安全
倔强青铜三35 分钟前
苦练Python第9天:if-else分支九剑
人工智能·python·面试
IRevers1 小时前
【自动驾驶】经典LSS算法解析——深度估计
人工智能·python·深度学习·算法·机器学习·自动驾驶
倔强青铜三1 小时前
苦练Python第8天:while 循环之妙用
人工智能·python·面试
凤年徐1 小时前
【数据结构与算法】203.移除链表元素(LeetCode)图文详解
c语言·开发语言·数据结构·算法·leetcode·链表·刷题
nbsaas-boot1 小时前
多租户架构下的多线程处理实践指南
java·开发语言·spring
倔强青铜三1 小时前
苦练Python第7天:布尔七日斩
人工智能·python·面试
倔强青铜三1 小时前
苦练Python第6天:数字魔法全解
人工智能·python·面试
无小道1 小时前
c++--typedef和#define的用法及区别
c语言·开发语言·汇编·c++