Как сделать снимок экрана при сбое тестового примера с помощью PyTest

В настоящее время я использую следующее решение, чтобы сделать снимок экрана в конце каждой тестовой функции с помощью PyTest. Как сделать так, чтобы скриншоты делались только в случае неудачного теста? Это вопрос о механике PyTest. Этот вопрос НЕ касается селена или аппия.

Я нашел похожие вопросы здесь, в Stackoverflow, но не совсем то же самое. Решения, предоставленные на эти другие вопросы, не отвечают на мой вопрос. Поскольку снятие скриншота при сбое теста с помощью PyTest — распространенная проблема, я считаю, что она заслуживает отдельного и вполне конкретного ответа.

@pytest.fixture(scope="function", autouse=True)
def take_screenshot(self, appium_driver):
    yield
    time.sleep(1)
    current_filename_clean = os.path.basename(__file__).replace("test_", "").replace(".py", "")
    current_test_name = os.environ.get("PYTEST_CURRENT_TEST").split(":")[-1].split(" ")[0].replace("test_", "")
    appium_driver.get_screenshot_as_file(
        f'test_reports/{current_filename_clean}_android_{current_test_name}_{datetime.today().strftime("%Y-%m-%d")}.png')

person Ostap Didenko    schedule 13.02.2020    source источник
comment
Это довольно популярная тема, которая несколько раз упоминалась в документации. Пример фиксации: Создание информация о результатах теста доступна в фикстурах, пример хука: отчеты о тестировании после обработки/отказы.   -  person hoefling    schedule 13.02.2020
comment
Я нашел эти статьи, однако решение там не так просто для моей проблемы. Я считаю, что, поскольку это довольно распространенная проблема, лучше посвятить ей конкретный и конкретный ответ и своего рода каталог лучших практик.   -  person Ostap Didenko    schedule 18.02.2020


Ответы (2)


Вот полное решение для вашего файла conftest.py для его запуска без головы в контейнере докеров:

import time
from datetime import datetime    
import pytest
import os
from selenium import webdriver as selenium_webdriver
from selenium.webdriver.chrome.options import Options

# set up webdriver fixture
@pytest.fixture(scope='session')
def selenium_driver(request):
    chrome_options = Options()
    chrome_options.add_argument('--headless')
    chrome_options.add_argument('--no-sandbox')
    chrome_options.add_argument('--disable-dev-shm-usage')

    driver = selenium_webdriver.Chrome(options=chrome_options)
    driver.set_window_size(1920, 1080)
    driver.maximize_window()
    driver.implicitly_wait(5)

    yield driver
    driver.quit()

# set up a hook to be able to check if a test has failed
@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):
    # execute all other hooks to obtain the report object
    outcome = yield
    rep = outcome.get_result()

    # set a report attribute for each phase of a call, which can
    # be "setup", "call", "teardown"

    setattr(item, "rep_" + rep.when, rep)

# check if a test has failed
@pytest.fixture(scope="function", autouse=True)
def test_failed_check(request):
    yield
    # request.node is an "item" because we use the default
    # "function" scope
    if request.node.rep_setup.failed:
        print("setting up a test failed!", request.node.nodeid)
    elif request.node.rep_setup.passed:
        if request.node.rep_call.failed:
            driver = request.node.funcargs['selenium_driver']
            take_screenshot(driver, request.node.nodeid)
            print("executing test failed", request.node.nodeid)

# make a screenshot with a name of the test, date and time
def take_screenshot(driver, nodeid):
    time.sleep(1)
    file_name = f'{nodeid}_{datetime.today().strftime("%Y-%m-%d_%H:%M")}.png'.replace("/","_").replace("::","__")
    driver.save_screenshot(file_name)
person Ostap Didenko    schedule 10.05.2020

Есть еще один способ, похожий на способ @Ostap: использование pytest_runtest_makereport (документы, справочник по API ) возможности постобработки. Чуть проще:

@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):
    outcome = yield
    rep = outcome.get_result()
    if rep.when == 'call' and rep.failed:
        now = datetime.now().strftime('%Y-%m-%d_%H-%M-%S')
        driver.save_screenshot(f".\\Screenshots\\fail_{now}.png")
person Mate Mrše    schedule 20.04.2021