conftest.py

#
# See https://github.com/dials/dials/wiki/pytest for documentation on how to
# write and run pytest tests, and an overview of the available features.
#


from __future__ import annotations

import argparse
import os
import re
import subprocess
from pathlib import Path

import pytest


def pytest_addoption(parser):
    """
    Option '--regression-full' needs to be used to run all regression tests,
    including the full-length xia2 runs.
    """

    class RFAction(argparse.Action):
        def __call__(self, parser, namespace, values, option_string):
            namespace.regression = True
            namespace.regression_full = True

    parser.addoption(
        "--regression-full",
        nargs=0,
        action=RFAction,
        help="run all regression tests, this will take a while. Implies --regression",
    )


@pytest.fixture(scope="session")
def regression_test(request):
    if not request.config.getoption("--regression-full"):
        pytest.skip("Test requires --regression-full option to run.")


@pytest.fixture(scope="session")
def ccp4():
    """
    Return information about the CCP4 installation.
    Skip the test if CCP4 is not installed.
    """
    if not os.getenv("CCP4"):
        pytest.skip("CCP4 installation required for this test")

    try:
        result = subprocess.run(["refmac5", "-i"], capture_output=True)
    except OSError:
        pytest.skip(
            "CCP4 installation required for this test - Could not find CCP4 executable"
        )
    if result.returncode:
        pytest.skip(
            "CCP4 installation required for this test - Could not run CCP4 executable"
        )
    version = re.search(rb"patch level *([0-9]+)\.([0-9]+)\.([0-9]+)", result.stdout)
    if not version:
        pytest.skip(
            "CCP4 installation required for this test - Could not determine CCP4 version"
        )
    return {"path": os.getenv("CCP4"), "version": [int(v) for v in version.groups()]}


@pytest.fixture(scope="session")
def xds():
    """
    Return information about the XDS installation.
    Skip the test if XDS is not installed.
    """
    try:
        result = subprocess.run(["xds"], capture_output=True)
    except OSError:
        pytest.skip("XDS installation required for this test")
    version = re.search(rb"BUILT=([0-9]+)\)", result.stdout)
    if version:
        return {"version": int(version.groups()[0])}
    if result.returncode:
        pytest.skip("XDS installation required for this test - Could not run XDS")
    if b"license expired" in result.stdout:
        raise RuntimeError(
            "XDS installation required for this test - XDS license is expired"
        )
    pytest.skip(
        "XDS installation required for this test - Could not determine XDS version"
    )


_repository = os.getcwd()


@pytest.fixture(autouse=True)
def ensure_repository_is_clean():
    yield
    if not os.getenv("CHECK_CLEAN_WORKDIR"):
        return
    print("Working directory:", _repository)
    status = subprocess.run(("git", "status", "-s"), cwd=_repository)
    if status.stdout:
        assert False, "Working directory is not clean"


@pytest.fixture
def run_in_tmp_path(tmp_path) -> Path:
    """
    A fixture to change the working directory for the test to a temporary directory.

    The original working directory is restored upon teardown of the fixture.

    Args:
        tmp_path: Pytest tmp_path fixture, see
                  https://docs.pytest.org/en/latest/how-to/tmp_path.html

    Yields:
        The path to the temporary working directory defined by tmp_path.
    """
    cwd = Path.cwd()
    os.chdir(tmp_path)
    yield tmp_path
    os.chdir(cwd)