Mypy coverage of our tests

.github/workflows/python-app.yml

@@ -43,6 +43,9 @@ jobs:
     - name: Run mypy
       run: |
         venv/bin/mypy --non-interactive --config-file mypy.ini -p problemtools
+    - name: Run mypy on tests
+      run: |
+        venv/bin/mypy --non-interactive --config-file mypy.ini --exclude '^tests/data/' tests/
 
   packages: # Use a separate job to test debian packaging to speed things up (no need to test this for every python version above)
     runs-on: ubuntu-latest

run_tests.sh

@@ -10,3 +10,4 @@ venv/bin/ruff check .
 venv/bin/ruff format --check .
 venv/bin/pytest
 venv/bin/mypy --non-interactive --config-file mypy.ini -p problemtools
+venv/bin/mypy --non-interactive --config-file mypy.ini --exclude '^tests/data/' tests/

tests/conftest.py

@@ -1,10 +1,22 @@
 """Shared pytest fixtures and test doubles."""
 
+from pathlib import Path
+
 import pytest
 
 from problemtools.diagnostics import Diagnostics
 
 
+def datadir() -> Path:
+    """Root directory holding static test fixture data."""
+    return (Path(__file__).parent / 'data').resolve()
+
+
+def example_directory(problem_name: str) -> Path:
+    """Path to one of the example problems shipped in the repo's top-level examples/ directory."""
+    return (Path(__file__).parent.parent / 'examples' / problem_name).resolve()
+
+
 class RecordingDiagnostics(Diagnostics):
     """A Diagnostics that records messages instead of emitting them, for asserting on in tests."""
 

tests/default_validator_tests/run_and_generate_expected.py

@@ -21,7 +21,7 @@
 from pathlib import Path
 
 
-def main():
+def main() -> None:
     """Main function"""
     parser = argparse.ArgumentParser(description='Run default_validator and generate expected output files.')
     parser.add_argument('test_dir', type=Path, help='Path to the test directory.')

tests/test_config.py

@@ -1,43 +1,44 @@
+from pathlib import Path
+
 import pytest
 
 from problemtools import config
+from tests.conftest import datadir
 
 
-def config_paths_mock():
-    from pathlib import Path
-
-    return [Path(__file__).parent / 'config1', Path(__file__).parent / 'config2']
+def config_paths_mock() -> list[Path]:
+    return [datadir() / 'config1', datadir() / 'config2']
 
 
-def test_load_basic_config(monkeypatch):
+def test_load_basic_config(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.setattr(config, '__config_file_paths', config_paths_mock)
 
     conf = config.load_config('test.yaml')
     assert conf == {'prop1': 'hello', 'prop2': 5}
 
 
-def test_load_updated_config(monkeypatch):
+def test_load_updated_config(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.setattr(config, '__config_file_paths', config_paths_mock)
 
     conf = config.load_config('test2.yaml')
     assert conf == {'prop1': 'abc', 'prop2': 23, 'prop3': ['hello', 'world']}
 
 
-def test_load_missing_config(monkeypatch):
+def test_load_missing_config(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.setattr(config, '__config_file_paths', config_paths_mock)
 
     with pytest.raises(config.ConfigError):
         config.load_config('non_existent_file')
 
 
-def test_load_broken_config(monkeypatch):
+def test_load_broken_config(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.setattr(config, '__config_file_paths', config_paths_mock)
 
     with pytest.raises(config.ConfigError):
         config.load_config('broken.yaml')
 
 
-def test_update_dict():
+def test_update_dict() -> None:
     update_dict = config.__dict__['__update_dict']
 
     dict1 = {'a': 1, 'b': {'sub1': 1, 'sub2': False}, 'c': 3}

tests/test_default_validator.py

@@ -35,7 +35,7 @@ def validator() -> Path:
     return VALIDATOR_PATH
 
 
-def discover_test_cases():
+def discover_test_cases() -> list[Path]:
     """
     Finds and returns a list of all test case directories.
     A test case directory is expected to start with 'test_'.
@@ -46,7 +46,7 @@ def discover_test_cases():
 
 
 @pytest.mark.parametrize('test_dir', discover_test_cases(), ids=lambda d: d.name)
-def test_default_validator(validator: Path, test_dir: Path):
+def test_default_validator(validator: Path, test_dir: Path) -> None:
     """
     Runs a single validator test case.
     The test is parametrized to run for each directory discovered by `discover_test_cases`.
@@ -90,4 +90,4 @@ def test_default_validator(validator: Path, test_dir: Path):
                 # If no message is expected, assert that no message was generated.
                 if judgemessage_path.is_file():
                     actual_message = judgemessage_path.read_bytes()
-                    assert not actual_message, f'A validation message was generated but none was expected: {actual_message}'
+                    assert not actual_message, f'A validation message was generated but none was expected: {actual_message!r}'