Migrate from nose2 to pytest for tests

Author: caleb531

.github/workflows/tests.yml

@@ -30,10 +30,8 @@ jobs:
     - name: Check lockfile
       run: uv lock --check
 
-    - name: Test with nose2
-      run: |
-        uv run coverage run -m nose2
-        uv run coverage lcov -o cover/coverage.lcov
+    - name: Test with pytest
+      run: uv run pytest --cov --cov-report=term-missing --cov-report=lcov:cover/coverage.lcov
 
     - name: Coveralls
       uses: coverallsapp/github-action@master

CONTRIBUTING.md

@@ -27,11 +27,11 @@ uv sync
 
 ### Running unit tests
 
-The project's unit tests are written using and managed under the [nose2][nose2]
-Python package. You can run all unit tests via the `nose2` command.
+The project's unit tests are written using [pytest](https://docs.pytest.org/).
+You can run all unit tests via the `pytest` command.
 
 ```bash
-nose2
+uv run pytest
 ```
 
 ## Code coverage
@@ -41,16 +41,13 @@ Contributions are expected to maintain this high standard. You can view the
 current coverage report via the `coverage` command:
 
 ```bash
-coverage run -m nose2
-coverage report
+uv run pytest --cov --cov-report=term-missing
 ```
 
 If you want to examine which lines are/aren't covered, you can generate and view
 a detailed HTML view of the coverage report like so:
 
 ```bash
-coverage html
+uv run pytest --cov --cov-report=html
 open htmlcov/index.html
 ```
-
-[nose2]: https://docs.nose2.io/en/latest/

pyproject.toml

@@ -16,10 +16,10 @@ dependencies = []
 [dependency-groups]
 dev = [
     "alfred-workflow-packager==3.1.1",
-    "coverage==7.2.5",
     "freezegun==1.5.2",
     "mypy==1.4.1",
-    "nose2==0.13.0",
+    "pytest>=8.4.2",
+    "pytest-cov>=7.0.0",
     "python-dotenv==1.0.0",
     "ruff>=0.12.0",
 ]

tests/conftest.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+
+from typing import Optional
+
+import pytest
+from dotenv import load_dotenv
+
+
+@pytest.hookimpl(tryfirst=True)
+def pytest_report_teststatus(
+    report: pytest.TestReport, config: pytest.Config
+) -> Optional[tuple[str, str, str]]:
+    if report.passed and report.when == "call":
+        # Silence the dot progress output for successful call phases
+        return report.outcome, "", report.outcome.upper()
+    return None
+
+
+@pytest.fixture(autouse=True, scope="session")
+def load_tests_env():
+    """Load test-specific environment variables for the entire test session."""
+    load_dotenv("tests/.env.test")

tests/test_base_calendar.py

@@ -1,21 +1,22 @@
 #!/usr/bin/env python3
 
-import unittest
 from unittest.mock import Mock
 
+import pytest
+
 from ocu.calendars.base_calendar import BaseCalendar
 
 
-class TestBaseCalendar(unittest.TestCase):
-    def test_base_calendar_not_instantiable(self):
-        """Should not be able to instantiate a BaseCalendar object by itself"""
-        with self.assertRaises(TypeError):
-            BaseCalendar()  # type: ignore
+def test_base_calendar_not_instantiable():
+    """Should not be able to instantiate a BaseCalendar object by itself"""
+    with pytest.raises(TypeError):
+        BaseCalendar()  # type: ignore
+
 
-    def test_get_event_dicts_not_implemented(self):
-        """
-        Should require the BaseCalendar.get_event_dicts() method to be implemented
-        by any subclass of BaseCalendar
-        """
-        with self.assertRaises(NotImplementedError):
-            BaseCalendar.get_event_dicts(Mock())
+def test_get_event_dicts_not_implemented():
+    """
+    Should require the BaseCalendar.get_event_dicts() method to be implemented
+    by any subclass of BaseCalendar
+    """
+    with pytest.raises(NotImplementedError):
+        BaseCalendar.get_event_dicts(Mock())