django-constance/constance/test/pytest.py

"""
Pytest constance override config plugin.

Inspired by https://github.com/pytest-dev/pytest-django/.
"""
import pytest
from contextlib import ContextDecorator
from constance import config as constance_config


@pytest.hookimpl(trylast=True)
def pytest_configure(config):  # pragma: no cover
    """
    Register override_config marker.
    """
    config.addinivalue_line(
        "markers",
        (
            "override_config(**kwargs): "
            "mark test to override django-constance config"
        )
    )


@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_call(item):  # pragma: no cover
    """
    Validate constance override marker params. Run test with overridden config.
    """
    marker = item.get_closest_marker("override_config")
    if marker is not None:
        if marker.args:
            pytest.fail(
                "Constance override can not not accept positional args"
            )
        with override_config(**marker.kwargs):
            yield
    else:
        yield


class override_config(ContextDecorator):
    """
    Override config while running test function.

    Act as context manager and decorator.
    """
    def enable(self):
        """
        Store original config values and set overridden values.
        """
        for key, value in self._to_override.items():
            self._original_values[key] = getattr(constance_config, key)
            setattr(constance_config, key, value)

    def disable(self):
        """
        Set original values to the config.
        """
        for key, value in self._original_values.items():
            setattr(constance_config, key, value)

    def __init__(self, **kwargs):
        self._to_override = kwargs.copy()
        self._original_values = {}

    def __enter__(self):
        self.enable()

    def __exit__(self, exc_type, exc_val, exc_tb):
        self.disable()


@pytest.fixture(name="override_config")
def _override_config():
    """
    Make override_config available as a function fixture.
    """
    return override_config