Настройка динамической c папки и имени отчета в pytest - PullRequest
Новая
       21

Настройка динамической c папки и имени отчета в pytest

2 голосов
/ 07 марта 2020

У меня проблема с динамическим заданием имени отчета и папки с ним в Python pytest. Например: я запустил все тесты pytest @ 2020-03-06 21:50, поэтому я бы хотел, чтобы мой отчет хранился в папке 20200306 с именем report_2150.html. Я хочу, чтобы он был автоматизирован и запущен сразу после завершения тестов.

Я работаю в VS Code и собираюсь поделиться своей работой с коллегами, не имеющими опыта автоматизации, поэтому я собираюсь использовать это как «нажмите тест, чтобы начать».

Структура моего проекта: 

webtools/
|── .vscode/
|──── settings.json
|── drivers/
|── pages/
|── reports/
|── tests/
|──── __init__.py
|──── config.json
|──── conftest.py
|──── test_1.py
|──── test_2.py
|── setup.py

Примеры кода:

settings.json

{
    "python.linting.pylintEnabled": false,
    "python.linting.flake8Enabled": true,
    "python.linting.enabled": true,
    "python.pythonPath": "C:\\Users\\user\\envs\\webtools\\Scripts\\python.exe",
    "python.testing.pytestArgs": [
        "tests",
        "--self-contained-html",
        "--html=./reports/tmp_report.html" 
    ],
    "python.testing.unittestEnabled": false,
    "python.testing.nosetestsEnabled": false,
    "python.testing.pytestEnabled": true,
    "python.testing.unittestArgs": [
        "-v",
        "-s",
        "./tests",
        "-p",
        "test_*.py"
    ]
}

config.json

{
    "browser": "chrome",
    "wait_time": 10
}

conftest.py

import json
import pytest
from datetime import datetime
import time
import shutil
import os


from selenium import webdriver
from selenium.webdriver import Chrome

CONFIG_PATH = 'tests/config.json'
DEFAULT_WAIT_TIME = 10
SUPPORTED_BROWSERS = ['chrome', 'explorer']


@pytest.fixture(scope='session')
def config():
    # Read the JSON config file and returns it as a parsed dict
    with open(CONFIG_PATH) as config_file:
        data = json.load(config_file)
    return data


@pytest.fixture(scope='session')
def config_browser(config):
    # Validate and return the browser choice from the config data
    if 'browser' not in config:
        raise Exception('The config file does not contain "browser"')
    elif config['browser'] not in SUPPORTED_BROWSERS:
        raise Exception(f'"{config["browser"]}" is not a supported browser')
    return config['browser']


@pytest.fixture(scope='session')
def config_wait_time(config):
    # Validate and return the wait time from the config data
    return config['wait_time'] if 'wait_time' in config else DEFAULT_WAIT_TIME


@pytest.fixture
def browser(config_browser, config_wait_time):
    # Initialize WebDriver
    if config_browser == 'chrome':
        driver = webdriver.Chrome(r"./drivers/chromedriver.exe")
    elif config_browser == 'explorer':
        driver = webdriver.Ie(r"./drivers/IEDriverServer.exe")
    else:
        raise Exception(f'"{config_browser}" is not a supported browser')

    # Wait implicitly for elements to be ready before attempting interactions
    driver.implicitly_wait(config_wait_time)

    # Maximize window for test
    driver.maximize_window()

    # Return the driver object at the end of setup
    yield driver

    # For cleanup, quit the driver
    driver.quit()


@pytest.fixture(scope='session')
def cleanup_report():
    timestamp = datetime.now().strftime('%Y%m%d_%H%M%S')
    os.chdir("./reports")
    os.mkdir(timestamp)

    yield

    shutil.move("./tmp_report.html", "./%s/test_report.html" % timestamp)

В текущей ситуации отчет создается как tmp_report.html в папке отчетов, но я не знаю, как заставить работать cleanup_report() после завершения всех тестов и tmp_report.html присутствует и завершено в папке. Для проверки завершения я предполагаю, что мне придется проверить, все ли теги html закрыты (или хотя бы <html> один).

Может ли кто-нибудь помочь мне с этим? Если вам понадобятся дополнительные части кода, я предоставлю их как можно скорее.

Заранее спасибо!

1 Ответ

3 голосов
/ 07 марта 2020

Вы можете настроить параметры плагина в пользовательском значении pytest_configure. Поместите этот пример кода в файл conftest.py в вашем проекте root dir: 

from datetime import datetime
from pathlib import Path
import pytest


@pytest.hookimpl(tryfirst=True)
def pytest_configure(config):
    # set custom options only if none are provided from command line
    if not config.option.htmlpath:
        now = datetime.now()
        # create report target dir
        reports_dir = Path('reports', now.strftime('%Y%m%d'))
        reports_dir.mkdir(parents=True, exist_ok=True)
        # custom report file
        report = reports_dir / f"report_{now.strftime('%H%M')}.html"
        # adjust plugin options
        config.option.htmlpath = report
        config.option.self_contained_html = True

Если вы хотите полностью игнорировать то, что передано из командной строки, удалите условие if not config.option.htmlpath:.

Если вы хотите придерживаться своего текущего значения, обратите внимание, что при демонтаже приборов pytest-html еще не написал отчет. Переместите код с cleanup_report на пользовательский имплик хука pytest_sessionfinish, чтобы убедиться, что pytest-html уже записал файл отчета по умолчанию: 

@pytest.hookimpl(trylast=True)
def pytest_sessionfinish(session, exitstatus):
    shutil.move(...)
...