Refactor test.util into mako.testing

Fixes: #349
Change-Id: I202c252a913fb72cc328a6e7f0f33174802487d3

Author: bourke

doc/build/unreleased/mako_testing.rst

@@ -0,0 +1,6 @@
+.. change::
+    :tags: changed
+    :tickets: 349
+
+    Refactored test utilities into ``mako.testing`` module. Removed
+    ``unittest.TestCase`` dependency in favor of ``pytest``.

mako/testing/__init__.py

@@ -0,0 +1,128 @@
+import configparser
+import dataclasses
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Callable
+from typing import ClassVar
+from typing import Optional
+from typing import Union
+
+from .helpers import make_path
+
+
+class ConfigError(BaseException):
+    pass
+
+
+class MissingConfig(ConfigError):
+    pass
+
+
+class MissingConfigSection(ConfigError):
+    pass
+
+
+class MissingConfigItem(ConfigError):
+    pass
+
+
+class ConfigValueTypeError(ConfigError):
+    pass
+
+
+class _GetterDispatch:
+    def __init__(self, initialdata, default_getter: Callable):
+        self.default_getter = default_getter
+        self.data = initialdata
+
+    def get_fn_for_type(self, type_):
+        return self.data.get(type_, self.default_getter)
+
+    def get_typed_value(self, type_, name):
+        get_fn = self.get_fn_for_type(type_)
+        return get_fn(name)
+
+
+def _parse_cfg_file(filespec: Union[Path, str]):
+    cfg = configparser.ConfigParser()
+    try:
+        filepath = make_path(filespec, check_exists=True)
+    except FileNotFoundError as e:
+        raise MissingConfig(f"No config file found at {filespec}") from e
+    else:
+        with open(filepath) as f:
+            cfg.read_file(f)
+        return cfg
+
+
+def _build_getter(cfg_obj, cfg_section, method, converter=None):
+    def caller(option, **kwargs):
+        try:
+            rv = getattr(cfg_obj, method)(cfg_section, option, **kwargs)
+        except configparser.NoSectionError as nse:
+            raise MissingConfigSection(
+                f"No config section named {cfg_section}"
+            ) from nse
+        except configparser.NoOptionError as noe:
+            raise MissingConfigItem(f"No config item for {option}") from noe
+        except ValueError as ve:
+            # ConfigParser.getboolean, .getint, .getfloat raise ValueError
+            # on bad types
+            raise ConfigValueTypeError(
+                f"Wrong value type for {option}"
+            ) from ve
+        else:
+            if converter:
+                try:
+                    rv = converter(rv)
+                except Exception as e:
+                    raise ConfigValueTypeError(
+                        f"Wrong value type for {option}"
+                    ) from e
+            return rv
+
+    return caller
+
+
+def _build_getter_dispatch(cfg_obj, cfg_section, converters=None):
+    converters = converters or {}
+
+    default_getter = _build_getter(cfg_obj, cfg_section, "get")
+
+    # support ConfigParser builtins
+    getters = {
+        int: _build_getter(cfg_obj, cfg_section, "getint"),
+        bool: _build_getter(cfg_obj, cfg_section, "getboolean"),
+        float: _build_getter(cfg_obj, cfg_section, "getfloat"),
+        str: default_getter,
+    }
+
+    # use ConfigParser.get and convert value
+    getters.update(
+        {
+            type_: _build_getter(
+                cfg_obj, cfg_section, "get", converter=converter_fn
+            )
+            for type_, converter_fn in converters.items()
+        }
+    )
+
+    return _GetterDispatch(getters, default_getter)
+
+
+@dataclass
+class ReadsCfg:
+    section_header: ClassVar[str]
+    converters: ClassVar[Optional[dict]] = None
+
+    @classmethod
+    def from_cfg_file(cls, filespec: Union[Path, str]):
+        cfg = _parse_cfg_file(filespec)
+        dispatch = _build_getter_dispatch(
+            cfg, cls.section_header, converters=cls.converters
+        )
+        kwargs = {
+            field.name: dispatch.get_typed_value(field.type, field.name)
+            for field in dataclasses.fields(cls)
+        }
+        return cls(**kwargs)

mako/testing/_config.py

@@ -8,6 +8,21 @@ def eq_(a, b, msg=None):
     assert a == b, msg or "%r != %r" % (a, b)
 
 
+def ne_(a, b, msg=None):
+    """Assert a != b, with repr messaging on failure."""
+    assert a != b, msg or "%r == %r" % (a, b)
+
+
+def in_(a, b, msg=None):
+    """Assert a in b, with repr messaging on failure."""
+    assert a in b, msg or "%r not in %r" % (a, b)
+
+
+def not_in(a, b, msg=None):
+    """Assert a in not b, with repr messaging on failure."""
+    assert a not in b, msg or "%r is in %r" % (a, b)
+
+
 def _assert_proper_exception_context(exception):
     """assert that any exception we're catching does not have a __context__
     without a __cause__, and that __suppress_context__ is never set.

test/util/assertions.py mako/testing/assertions.pytest/util/assertions.py renamed to mako/testing/assertions.py

@@ -0,0 +1,17 @@
+from dataclasses import dataclass
+from pathlib import Path
+
+from ._config import ReadsCfg
+from .helpers import make_path
+
+
+@dataclass
+class Config(ReadsCfg):
+    module_base: Path
+    template_base: Path
+
+    section_header = "mako_testing"
+    converters = {Path: make_path}
+
+
+config = Config.from_cfg_file("./setup.cfg")

mako/testing/config.py

@@ -0,0 +1,80 @@
+import pytest
+
+from mako.ext.beaker_cache import has_beaker
+from mako.util import update_wrapper
+
+
+try:
+    import babel.messages.extract as babel
+except ImportError:
+    babel = None
+
+
+try:
+    import lingua
+except ImportError:
+    lingua = None
+
+
+try:
+    import dogpile.cache  # noqa
+except ImportError:
+    has_dogpile_cache = False
+else:
+    has_dogpile_cache = True
+
+
+requires_beaker = pytest.mark.skipif(
+    not has_beaker, reason="Beaker is required for these tests."
+)
+
+
+requires_babel = pytest.mark.skipif(
+    babel is None, reason="babel not installed: skipping babelplugin test"
+)
+
+
+requires_lingua = pytest.mark.skipif(
+    lingua is None, reason="lingua not installed: skipping linguaplugin test"
+)
+
+
+requires_dogpile_cache = pytest.mark.skipif(
+    not has_dogpile_cache,
+    reason="dogpile.cache is required to run these tests",
+)
+
+
+def _pygments_version():
+    try:
+        import pygments
+
+        version = pygments.__version__
+    except:
+        version = "0"
+    return version
+
+
+requires_pygments_14 = pytest.mark.skipif(
+    _pygments_version() < "1.4", reason="Requires pygments 1.4 or greater"
+)
+
+
+# def requires_pygments_14(fn):
+
+#     return skip_if(
+#         lambda: version < "1.4", "Requires pygments 1.4 or greater"
+#     )(fn)
+
+
+def requires_no_pygments_exceptions(fn):
+    def go(*arg, **kw):
+        from mako import exceptions
+
+        exceptions._install_fallback()
+        try:
+            return fn(*arg, **kw)
+        finally:
+            exceptions._install_highlighting()
+
+    return update_wrapper(go, fn)

mako/testing/exclusions.py

@@ -1,49 +1,29 @@
 import os
-import unittest
 
 from mako.cache import CacheImpl
 from mako.cache import register_plugin
 from mako.template import Template
 from .assertions import eq_
+from .config import config
 
 
-def _ensure_environment_variable(key, fallback):
-    env_var = os.getenv(key)
-    if env_var is None:
-        return fallback
-    return env_var
-
-
-def _get_module_base():
-    return _ensure_environment_variable(
-        "TEST_MODULE_BASE", os.path.abspath("./test/templates/modules")
-    )
-
-
-def _get_template_base():
-    return _ensure_environment_variable(
-        "TEST_TEMPLATE_BASE", os.path.abspath("./test/templates/")
-    )
-
-
-module_base = _get_module_base()
-template_base = _get_template_base()
-
-
-class TemplateTest(unittest.TestCase):
+class TemplateTest:
     def _file_template(self, filename, **kw):
         filepath = self._file_path(filename)
         return Template(
-            uri=filename, filename=filepath, module_directory=module_base, **kw
+            uri=filename,
+            filename=filepath,
+            module_directory=config.module_base,
+            **kw,
         )
 
     def _file_path(self, filename):
         name, ext = os.path.splitext(filename)
-        py3k_path = os.path.join(template_base, name + "_py3k" + ext)
+        py3k_path = os.path.join(config.template_base, name + "_py3k" + ext)
         if os.path.exists(py3k_path):
             return py3k_path
 
-        return os.path.join(template_base, filename)
+        return os.path.join(config.template_base, filename)
 
     def _do_file_test(
         self,

test/util/fixtures.py mako/testing/fixtures.pytest/util/fixtures.py renamed to mako/testing/fixtures.py

@@ -1,11 +1,11 @@
 import contextlib
 import pathlib
+from pathlib import Path
 import re
 import time
+from typing import Union
 from unittest import mock
 
-from test.util.fixtures import module_base
-
 
 def flatten_result(result):
     return re.sub(r"[\s\r\n]+", " ", result).strip()
@@ -19,6 +19,19 @@ def result_lines(result):
     ]
 
 
+def make_path(
+    filespec: Union[Path, str],
+    make_absolute: bool = True,
+    check_exists: bool = False,
+) -> Path:
+    path = Path(filespec)
+    if make_absolute:
+        path = path.resolve(strict=check_exists)
+    if check_exists and (not path.exists()):
+        raise FileNotFoundError(f"No file or directory at {filespec}")
+    return path
+
+
 def _unlink_path(path, missing_ok=False):
     # Replicate 3.8+ functionality in 3.7
     cm = contextlib.nullcontext()
@@ -52,9 +65,3 @@ def rewind_compile_time(hours=1):
     with mock.patch("mako.codegen.time") as codegen_time:
         codegen_time.time.return_value = rewound
         yield
-
-
-def teardown():
-    import shutil
-
-    shutil.rmtree(module_base, True)

test/util/helpers.py mako/testing/helpers.pytest/util/helpers.py renamed to mako/testing/helpers.py

@@ -42,6 +42,8 @@ exclude =
     examples*
 
 [options.extras_require]
+testing =
+    pytest
 babel =
     Babel
 lingua =
@@ -73,6 +75,7 @@ tag_build = dev
 [tool:pytest]
 addopts= --tb native -v -r fxX -W error
 python_files=test/*test_*.py
+python_classes=*Test
 
 [upload]
 sign = 1
@@ -92,3 +95,7 @@ ignore =
 exclude = .venv,.git,.tox,dist,docs/*,*egg,build
 import-order-style = google
 application-import-names = mako,test
+
+[mako_testing]
+module_base = ./test/templates/modules
+template_base = ./test/templates/