Test improvements

bugwarrior/config/validation.py

@@ -1,6 +1,6 @@
 import logging
 import sys
-from typing import TYPE_CHECKING, Annotated, Any, NoReturn, Union
+from typing import Annotated, Any, Literal, NoReturn, Union
 
 from pydantic import Field, TypeAdapter, ValidationError
 from pydantic_core import ErrorDetails
@@ -14,10 +14,6 @@
     get_service,
 )
 
-if TYPE_CHECKING:
-    ServiceConfigType = ServiceConfig
-
-
 log = logging.getLogger(__name__)
 
 
@@ -123,6 +119,18 @@ def raise_validation_error(
     sys.exit(1)
 
 
+class _MissingServiceDiscriminator(BaseConfig):
+    """
+    Placeholder schema used to report missing service discriminators.
+
+    We need 'service' to be a Literal, so we can use it in a discriminator Field.
+    Regular ServiceConfig base class defines it as a plain str, which does not work
+    with discriminators.
+    """
+
+    service: Literal["__bugwarrior_missing_service__"]
+
+
 def get_service_config_union_type(services: list[dict[str, Any]]) -> Any:
     """
     Return a Union type of the ServiceConfig subclasses of the services actually configured.
@@ -134,16 +142,14 @@ def get_service_config_union_type(services: list[dict[str, Any]]) -> Any:
     to ensure that each service configuration is validated against
     the ServiceConfig corresponding to the correct service.
     """
-    service_config_classes = tuple(
-        get_service(service["service"]).CONFIG_SCHEMA
-        for service in services
-        if "service" in service
+    service_config_classes = (
+        tuple(
+            get_service(service["service"]).CONFIG_SCHEMA
+            for service in services
+            if "service" in service
+        )
+        or _MissingServiceDiscriminator
     )
-
-    # Default to generic ServiceConfig if no service defined, mostly for tests
-    if not service_config_classes:
-        return ServiceConfig
-
     return Annotated[Union[service_config_classes], Field(discriminator="service")]
 
 

bugwarrior/docs/other-services/tutorial.rst

@@ -255,15 +255,15 @@ If you're developing in the bugwarrior repo, you can simply add your entry to th
 
 
 
-Create a test file and implement at least the minimal service tests by inheriting from ``AbstractServiceTest``.
+Create a test file and implement at least the minimal service tests by inheriting from ``ServiceIssueTest``.
 
 .. code:: bash
 
-   touch tests/test_gitbug.py
+   touch tests/services/test_gitbug.py
 
 .. code:: python
 
-  class TestGitBugIssue(AbstractServiceTest, ServiceTest):
+  class TestGitBugIssue(ServiceIssueTest):
       SERVICE_CONFIG = {
           'service': 'gitbug',
           'path': '/dev/null',

tests/base.py

@@ -1,15 +1,16 @@
-import abc
+import contextlib
 import os.path
 import shutil
+import sys
 import tempfile
 import typing
 import unittest
+import unittest.mock
 
 import pytest
-import responses
 
 from bugwarrior import config, services
-from bugwarrior.config import schema, validation
+from bugwarrior.config import validation
 from bugwarrior.config.load import format_config
 
 
@@ -22,48 +23,81 @@ class DumbConfig(config.ServiceConfig):
 
 
 class DumbIssue(services.Issue):
-    UDAS: dict = {}
-    UNIQUE_KEY: tuple[str, ...] = ("id",)
+    URL = "dumburl"
+    TYPE = "dumbtype"
+
+    UDAS = {
+        URL: {"type": "string", "label": "Dumb URL"},
+        TYPE: {"type": "string", "label": "Dumb Type"},
+    }
+    UNIQUE_KEY = (URL,)
     PRIORITY_MAP: dict = {}
 
     def get_default_description(self):
-        raise NotImplementedError
+        return self.build_default_description(
+            title=self.record.get("title", ""),
+            url=self.record.get("url", ""),
+            number=self.record.get("number", ""),
+        )
 
     def to_taskwarrior(self):
-        raise NotImplementedError
+        return {
+            "project": self.extra.get("project"),
+            "priority": self.config.default_priority,
+            "annotations": self.extra.get("annotations", []),
+            "tags": self.get_tags_from_labels(self.record.get("labels", [])),
+            self.URL: self.record.get("url", ""),
+            self.TYPE: self.extra.get("type", "issue"),
+        }
 
 
 class DumbService(services.Service):
     API_VERSION = services.LATEST_API_VERSION
     ISSUE_CLASS = DumbIssue
     CONFIG_SCHEMA = DumbConfig
 
-    def get_owner(self, _):
-        raise NotImplementedError
-
     def issues(self):
         raise NotImplementedError
 
 
-class AbstractServiceTest(abc.ABC):
-    """Ensures that certain test methods are implemented for each service."""
+#: Modules that import get_service by name and must be patched together so the
+#: fake service resolves consistently across config loading, collection, and db.
+_GET_SERVICE_MODULES = (
+    'bugwarrior.config.schema',
+    'bugwarrior.config.validation',
+    'bugwarrior.config',
+    'bugwarrior.db',
+    'bugwarrior.collect',
+)
 
-    @abc.abstractmethod
-    def test_to_taskwarrior(self):
-        """Test Service.to_taskwarrior()."""
-        raise NotImplementedError
 
-    @abc.abstractmethod
-    def test_issues(self):
-        """
-        Test Service.issues().
+@contextlib.contextmanager
+def register_services(mapping=None):
+    """
+    Make fake services resolvable via get_service for the duration of a block.
 
-        - When the API is accessed via requests, use the responses library to
-        mock requests.
-        - When the API is accessed via a third party library, substitute a fake
-        implementation class for it.
-        """
-        raise NotImplementedError
+    Patches get_service in every module that imports it so that orchestration
+    code (config loading, collection, db) resolves the given name-to-class
+    mapping instead of the real entry points. Defaults to mapping the "test"
+    service to DumbService.
+    """
+    mapping = mapping or {'test': DumbService}
+
+    def fake_get_service(name):
+        try:
+            return mapping[name]
+        except KeyError:
+            raise ValueError(
+                f"Configured service '{name}' not found. "
+                "Is it installed? Or misspelled?"
+            )
+
+    with contextlib.ExitStack() as stack:
+        for module in _GET_SERVICE_MODULES:
+            stack.enter_context(
+                unittest.mock.patch(f'{module}.get_service', fake_get_service)
+            )
+        yield
 
 
 class ConfigTest(unittest.TestCase):
@@ -99,6 +133,14 @@ def tearDown(self):
     def inject_fixtures(self, caplog):
         self.caplog = caplog
 
+    if sys.version_info < (3, 11):
+
+        def enterContext(self, cm):
+            """Backport of unittest.TestCase.enterContext for Python 3.10."""
+            value = cm.__enter__()
+            self.addCleanup(cm.__exit__, None, None, None)
+            return value
+
     def validate(self) -> validation.Config:
         config = self.config.copy()
         config['general'] = config.get('general', {})
@@ -116,39 +158,3 @@ def assertValidationError(self, expected):
 
         # We may want to use this assertion more than once per test.
         self.caplog.clear()
-
-
-class ServiceTest(ConfigTest):
-    GENERAL_CONFIG = {'annotation_length': 100, 'description_length': 100}
-    SERVICE_CONFIG = {}
-
-    @classmethod
-    def setUpClass(cls):
-        cls.maxDiff = None
-
-    def get_mock_service(
-        self,
-        service_class,
-        section='unspecified',
-        config_overrides=None,
-        general_overrides=None,
-    ):
-        options = {
-            'general': {**self.GENERAL_CONFIG, 'targets': [section]},
-            section: {**self.SERVICE_CONFIG.copy(), 'target': section},
-        }
-        if config_overrides:
-            options[section].update(config_overrides)
-        if general_overrides:
-            options['general'].update(general_overrides)
-
-        service_config = service_class.CONFIG_SCHEMA(**options[section])
-        main_config = schema.MainSectionConfig(**options['general'])
-
-        return service_class(service_config, main_config)
-
-    @staticmethod
-    def add_response(url, method='GET', **kwargs):
-        responses.add(
-            responses.Response(url=url, method=method, match_querystring=True, **kwargs)
-        )

tests/config/test_data.py

@@ -1,8 +1,7 @@
 import json
 import os
 
-from bugwarrior.config import data, validation
-from bugwarrior.config.load import format_config
+from bugwarrior.config import data, schema
 
 from ..base import ConfigTest
 
@@ -41,24 +40,10 @@ def test_path_attribute(self):
 class TestGetDataPath(ConfigTest):
     def setUp(self):
         super().setUp()
-        rawconfig = {
-            'general': {'targets': ['my_service']},
-            'my_service': {
-                'service': 'github',
-                'login': 'ralphbean',
-                'token': 'abc123',
-                'username': 'ralphbean',
-            },
-        }
-        formatted = format_config(rawconfig)
-        self.validated_config = validation.validate_config(
-            formatted, 'general', 'configpath'
-        )
+        self.main_config = schema.MainSectionConfig(targets=[])
 
     def assertDataPath(self, expected_datapath):
-        self.assertEqual(
-            expected_datapath, data.get_data_path(self.validated_config.main.taskrc)
-        )
+        self.assertEqual(expected_datapath, data.get_data_path(self.main_config.taskrc))
 
     def test_TASKDATA(self):
         """