当前位置：首页 > article >正文

pytest 截图功能

article 2025/3/1 4:12:15

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

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

步骤：

在 conftest.py 中实现截图功能：
- 使用 pytest 的钩子函数 pytest_runtest_makereport 来判断测试是否失败。
- 如果测试失败，通过 Selenium 的 driver.save_screenshot() 方法进行截图。
- 使用 allure 插件将截图添加到测试报告中。
配置文件 pytest.ini：
- 配置 pytest 插件、测试报告输出路径等。

代码示例：

1. `conftest.py` 文件实现

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 中编写一个简单的测试，故意让其失败，从而触发截图功能。

def test_example(driver):
    driver.get("https://www.google.com")
    assert driver.title == "Incorrect Title"  # 故意断言失败，触发截图

4. 运行测试

运行测试：使用 pytest 运行测试，测试失败时截图将会自动保存到 ./screenshots/ 目录，同时 Allure 报告中会包含截图信息。
```
pytest --alluredir=allure_results
```
生成 Allure 报告：使用 Allure 生成并查看测试报告：
```
allure serve allure_results
```