nwb-linkml/nwb_linkml/tests/conftest.py

import os
from pathlib import Path
from typing import List

import pytest
import requests_cache

from .fixtures import *  # noqa: F403


def pytest_addoption(parser):
    parser.addoption(
        "--clean",
        action="store_true",
        default=False,
        help="Don't reuse cached resources like cloned git repos or generated files",
    )
    parser.addoption(
        "--with-output",
        action="store_true",
        help="keep test outputs for richer debugging information",
    )
    parser.addoption(
        "--without-cache", action="store_true", help="Don't use a sqlite cache for network requests"
    )
    parser.addoption(
        "--dev",
        action="store_true",
        help=(
            "run tests that are intended only for development use, eg. those that generate output"
            " for inspection"
        ),
    )


def pytest_collection_modifyitems(config, items: List[pytest.Item]):
    # remove dev tests from collection if we're not in dev mode!
    if config.getoption("--dev"):
        remove_tests = [t for t in items if not t.get_closest_marker("dev")]
    else:
        remove_tests = [t for t in items if t.get_closest_marker("dev")]
    for t in remove_tests:
        items.remove(t)


@pytest.fixture(autouse=True, scope="session")
def set_config_vars(tmp_output_dir):
    os.environ["NWB_LINKML_CACHE_DIR"] = str(tmp_output_dir)


@pytest.fixture(scope="session", autouse=True)
def patch_requests_cache(pytestconfig):
    """
    Cache network requests - for each unique network request, store it in
    an sqlite cache. only do unique requests once per session.
    """
    if pytestconfig.getoption("--without-cache"):
        yield
        return
    cache_file = Path(__file__).parent / "output" / "requests-cache.sqlite"
    requests_cache.install_cache(
        str(cache_file),
        backend="sqlite",
        urls_expire_after={"localhost": requests_cache.DO_NOT_CACHE},
    )
    requests_cache.clear()
    yield
    # delete cache file unless we have requested it to persist for inspection
    if not pytestconfig.getoption("--with-output"):
        cache_file.unlink(missing_ok=True)