Save report.html in custom generated directory

[snuufkiin]

Greetings everyone,
Rather new user of pytest here, please be gentle if there is an obvious answer here :D

I have a question concerning saving the report.html file in a generated directory.

I am aware of the fact, that you can specify the path in CLI arg --html=path/report.html, however, in my case, I need something different:
For every test-run (test-session), I am generating a folder named (eg.): test_session2022.19.12T10:03 (simply test_session + date and time).
I want to save each report.html file in the generated test_session folder. Is there a way to specify the variable path in pytest_config (or similar)?

Thank you in advance :)

[BeyondEvil]

How is the directory-generating happening?

If it's shell/bash, you can do it inline in the flag. The plugin (or the shell) will make it happen before trying to write the report to disk.

Example:

--html=test_session$(date +"%Y.%m.%dT%T")/report.html

[snuufkiin]

Hey, thank you for the reply.
Unfortunately the generation of the folder structure is a little bit complicated and happens inside my python code.
Any suggestions?

[snuufkiin]

I figured it out - thank you anyways :)

[BeyondEvil]

Please share how you solved it, in general terms at least.

[snuufkiin]

sure thing - apologize for not doing this right away.

log = logging.getLogger(__name__)

default_formatter = logging.Formatter(
    datefmt="%d.%m.%Y %H:%M:%S",
    fmt="%(asctime)s.%(msecs)03d   %(levelname)-9s %(name)s %(message)s",
)

_DATETIME_NOW: Final = datetime.datetime.now()
_SESSION_DATA_DIR: Final = (
    pathlib.Path() / "test_session" / _DATETIME_NOW.strftime("%Y-%m-%dT%H.%M.%S.%f%z")
)


@pytest.hookimpl(  # type: ignore[misc]  # required until decorator gets typed in pytest
    tryfirst=True  # has to be called BEFORE the pytest-html plugin hook
)
def pytest_configure(config: pytest.Config) -> None:
    """Configure HTML reporting."""
    global _SESSION_DATA_DIR
    if config.getoption("log_cli_level") is None:
        logging.getLogger().setLevel(logging.DEBUG)

    if config.pluginmanager.getplugin("html") and config.option.htmlpath is None:
        config.option.self_contained_html = True

        config.option.htmlpath = _SESSION_DATA_DIR / "report.html"


@pytest.fixture(scope="session")
def session_date() -> Generator[datetime.datetime, None, None]:
    """Session Date, unique once per pytest session."""
    global _DATETIME_NOW
    yield _DATETIME_NOW


@pytest.fixture(scope="session")
def data_dir() -> pathlib.Path:
    """Test session data directory used to store test results per session."""
    global _SESSION_DATA_DIR
    return _SESSION_DATA_DIR


@pytest.fixture
def data_default_file() -> Generator[data_definitions.DataFile, None, None]:
    """Get data file default settings."""
    yield data_definitions.DataFile()

[RaakeshRaja]

Hi @snuffkiin, what arguments do you pass when you call pytest in cli or using the addopts in the pytest.ini?
if I don't pass the --html=report.html the report generation is not being triggered and if I do pass, config.option.htmlpath doesn't seem to take effect. The report.html ends up the in rootdirectory.

[snuufkiin]

I stopped working on this implementation since we've decided to move away from pytest-html. We're using a different approach now (NOT USING pytest-html but instead using pytest-reporter-html1):
This is the session_directory_plugin.py:

"""Plugin to generate a directory per test session."""
import datetime
import pathlib

import pytest

session_directory_key = pytest.StashKey[pathlib.Path]()
"""`pytest.stash` key to `pathlib.Path` of this session's `<date_time>_pytest_session` directory.

Use this key to access the location from pytest plugins and hooks.
"""


@pytest.hookimpl(tryfirst=True)  # generate directory ASAP, before others try to use it
def pytest_configure(config: pytest.Config) -> None:
    """Create `<date_time>_pytest_session` dir & add to stash at `session_directory_key`."""
    config.stash[session_directory_key] = create_session_directory_at_pytest_rootpath(
        config
    )


def create_session_directory_at_pytest_rootpath(
    config: pytest.Config,
) -> pathlib.Path:
    """Create `<date_time>_pytest_session` directory inside pytest's rootpath.

    Read more about how pytest chooses its rootpath in the
    [official documentation](https://docs.pytest.org/en/stable/reference/customize.html#finding-the-rootdir).
    """  # noqa: E501  # allow long url in documentation
    formatted_time = datetime.datetime.now().strftime("%Y-%m-%dT%H%M%S")  # ISO 8601
    pytest_session_directory = (
        pathlib.Path(config.rootpath) / f"{formatted_time}_pytest_session"
    )
    pytest_session_directory.mkdir(parents=True)

    return pytest_session_directory


@pytest.fixture(scope="session")
def session_directory(pytestconfig: pytest.Config) -> pathlib.Path:
    """`pathlib.Path` to this session's `<date_time>_pytest_session` directory.

    Use this fixture to access the location from pytest fixtures or tests.
    """
    return pytestconfig.stash[session_directory_key]

And this is the html_report_plugin.py:

"""Generate `pytest_session_report.html` inside `session_directory` (with pytest-reporter-html1)."""
import pytest

import pytest_hw
from pytest_hw.plugin import session_directory_plugin


@pytest.hookimpl(tryfirst=True)  # need to be faster than pytest-reporter-html1
def pytest_configure(config: pytest.Config) -> None:
    """Configure pytest-reporter-html1 to use our template & forbid settings its options via cli."""
    if config.getoption("template") or config.getoption("report"):
        raise pytest.UsageError(
            "Specifying the `--template` or `--report` flag is not supported, when the "
            "`html_report_plugin` is loaded."
        )

    custom_template_directory = str(
        pytest_hw.PACKAGE_ROOT_DIRECTORY / "plugin" / "html_report" / "templates"
    )
    # add our directory as template directory & explicitly use our index.html template
    config.option.template_dir = [custom_template_directory]
    config.option.template = ["custom/index.html"]

    # save the report to our session directory
    session_directory = config.stash[session_directory_plugin.session_directory_key]
    config.option.report = [str(session_directory / "pytest_session_report.html")]

Although not using pytest-html, you might be able to reuse some snippets of my implementation - I hope this is somewhat useful for you!