"""
pytest plugin functions
"""


from __future__ import annotations

import pytest

from .download import DataFetcher


def pytest_addoption(parser):
    parser.addoption(
        "--regression",
        action="store_true",
        default=False,
        help="run regression tests. Download data for those tests if required",
    )


@pytest.fixture(scope="session")
def dials_data(request) -> DataFetcher:
    """
    Return the location of a regression dataset as py.path object.
    Download the files if they are not on disk already.
    Skip the test if the dataset can not be downloaded.
    """
    if not request.config.getoption("--regression"):
        pytest.skip("Test requires --regression option to run.")
    df = DataFetcher()

    def fail_test_if_lookup_failed(result):
        if not result:
            pytest.fail(
                "Test data could not be downloaded. Your version of dials.data may be out of date"
            )
        return result

    setattr(df, "result_filter", fail_test_if_lookup_failed)
    return df