refactor(dpi_ng): enforce abstract service_path on BaseCapabilityConfig

Author: Ashwith-N

src/sap_cloud_sdk/core/dpi_ng/config.py

@@ -2,6 +2,7 @@
 
 import logging
 import re
+from abc import ABC, abstractmethod
 from dataclasses import dataclass, field
 
 from .auth import AuthProvider, ClientCertificateAuth
@@ -12,11 +13,11 @@
 
 
 @dataclass
-class BaseCapabilityConfig:
+class BaseCapabilityConfig(ABC):
     """Base configuration for a DPI NG capability client.
 
-    Subclasses add a ``service_path`` (and any other capability-specific fields)
-    on top of these shared fields.
+    Subclasses override ``service_path`` with a capability-specific default
+    and may add extra fields on top of these shared fields.
 
     Args:
         base_url: URL of the DPI external service router
@@ -25,6 +26,8 @@ class BaseCapabilityConfig:
                   service instance.
         auth: Authentication strategy - one of BearerTokenAuth, ClientCredentialsAuth,
               or ClientCertificateAuth.
+        service_path: Base OData path used to build service URLs.  Subclasses
+                      override this field with a capability-specific default.
         timeout: HTTP request timeout in seconds (default 30).
         verify_ssl: Verify TLS certificates - set False only in local dev.
                     Overridden by ``ClientCertificateAuth`` when a custom ``ca_file`` is provided.
@@ -42,6 +45,11 @@ class BaseCapabilityConfig:
     verify_ssl: bool = True
     tenant_id: str | None = field(default=None)
 
+    @property
+    @abstractmethod
+    def service_path(self) -> str:
+        """Base OData path used to build service URLs."""
+
     def __post_init__(self) -> None:
         """Validate config after dataclass construction.
 

tests/core/unit/dpi_ng/unit/test_base_config.py

@@ -1,6 +1,7 @@
 """Unit tests for BaseCapabilityConfig — shared fields and tenant_id validation."""
 
 import pytest
+from dataclasses import dataclass
 from unittest.mock import MagicMock
 
 from sap_cloud_sdk.core.dpi_ng.auth import AuthProvider, ClientCertificateAuth
@@ -11,89 +12,94 @@ def valid_auth():
     return MagicMock(spec=AuthProvider)
 
 
+@dataclass
+class _TestConfig(BaseCapabilityConfig):
+    service_path: str = "/sap/test/odata/v4"
+
+
 class TestValidConstruction:
     def test_https_url_accepted(self):
-        cfg = BaseCapabilityConfig(base_url="https://example.com", auth=valid_auth())
+        cfg = _TestConfig(base_url="https://example.com", auth=valid_auth())
         assert cfg.base_url == "https://example.com"
 
     def test_http_url_accepted(self):
-        cfg = BaseCapabilityConfig(base_url="http://example.com", auth=valid_auth())
+        cfg = _TestConfig(base_url="http://example.com", auth=valid_auth())
         assert cfg.base_url == "http://example.com"
 
     def test_trailing_slash_stripped(self):
-        cfg = BaseCapabilityConfig(base_url="https://example.com/", auth=valid_auth())
+        cfg = _TestConfig(base_url="https://example.com/", auth=valid_auth())
         assert cfg.base_url == "https://example.com"
 
     def test_multiple_trailing_slashes_stripped(self):
-        cfg = BaseCapabilityConfig(base_url="https://example.com///", auth=valid_auth())
+        cfg = _TestConfig(base_url="https://example.com///", auth=valid_auth())
         assert cfg.base_url == "https://example.com"
 
     def test_auth_stored(self):
         auth = valid_auth()
-        cfg = BaseCapabilityConfig(base_url="https://example.com", auth=auth)
+        cfg = _TestConfig(base_url="https://example.com", auth=auth)
         assert cfg.auth is auth
 
 
 class TestDefaults:
     def test_timeout_default(self):
-        cfg = BaseCapabilityConfig(base_url="https://example.com", auth=valid_auth())
+        cfg = _TestConfig(base_url="https://example.com", auth=valid_auth())
         assert cfg.timeout == 30.0
 
     def test_verify_ssl_default(self):
-        cfg = BaseCapabilityConfig(base_url="https://example.com", auth=valid_auth())
+        cfg = _TestConfig(base_url="https://example.com", auth=valid_auth())
         assert cfg.verify_ssl is True
 
     def test_tenant_id_default_is_none(self):
-        cfg = BaseCapabilityConfig(base_url="https://example.com", auth=valid_auth())
+        cfg = _TestConfig(base_url="https://example.com", auth=valid_auth())
         assert cfg.tenant_id is None
 
 
 class TestInvalidBaseUrl:
     def test_empty_string_raises(self):
         with pytest.raises(ValueError, match="base_url must be a valid HTTP"):
-            BaseCapabilityConfig(base_url="", auth=valid_auth())
+            _TestConfig(base_url="", auth=valid_auth())
 
     def test_plain_string_raises(self):
         with pytest.raises(ValueError, match="base_url must be a valid HTTP"):
-            BaseCapabilityConfig(base_url="not-a-url", auth=valid_auth())
+            _TestConfig(base_url="not-a-url", auth=valid_auth())
 
     def test_ftp_scheme_raises(self):
         with pytest.raises(ValueError, match="base_url must be a valid HTTP"):
-            BaseCapabilityConfig(base_url="ftp://example.com", auth=valid_auth())
+            _TestConfig(base_url="ftp://example.com", auth=valid_auth())
 
     def test_missing_scheme_raises(self):
         with pytest.raises(ValueError, match="base_url must be a valid HTTP"):
-            BaseCapabilityConfig(base_url="example.com", auth=valid_auth())
+            _TestConfig(base_url="example.com", auth=valid_auth())
 
 
 class TestInvalidAuth:
     def test_none_auth_raises(self):
         with pytest.raises(ValueError, match="auth must be an AuthProvider"):
-            BaseCapabilityConfig(base_url="https://example.com", auth=None)  # ty: ignore[invalid-argument-type]
+            _TestConfig(base_url="https://example.com", auth=None)  # ty: ignore[invalid-argument-type]
 
     def test_string_auth_raises(self):
         with pytest.raises(ValueError, match="auth must be an AuthProvider"):
-            BaseCapabilityConfig(base_url="https://example.com", auth="Bearer token")  # ty: ignore[invalid-argument-type]
+            _TestConfig(base_url="https://example.com", auth="Bearer token")  # ty: ignore[invalid-argument-type]
 
 
 class TestTenantId:
     def test_cert_auth_without_tenant_id_raises(self):
         with pytest.raises(ValueError, match="tenant_id is required"):
-            BaseCapabilityConfig(
+            _TestConfig(
                 base_url="https://example.com",
                 auth=ClientCertificateAuth(cert_file="cert.pem", key_file="key.pem"),
             )
 
     def test_non_cert_auth_with_tenant_id_raises(self):
         with pytest.raises(ValueError, match="tenant_id must not be set"):
-            BaseCapabilityConfig(
+            _TestConfig(
                 base_url="https://example.com",
                 auth=valid_auth(),
                 tenant_id="tenant-123",
             )
 
     def test_cert_auth_with_tenant_id_stored(self):
-        cfg = BaseCapabilityConfig(
+        cfg = _TestConfig(
             base_url="https://example.com",
             auth=ClientCertificateAuth(cert_file="cert.pem", key_file="key.pem"),
             tenant_id="tenant-abc",

tests/core/unit/dpi_ng/unit/test_base_odata_client.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from dataclasses import dataclass
 from unittest.mock import MagicMock, patch
 
 import pytest
@@ -11,9 +12,14 @@
 from sap_cloud_sdk.core.dpi_ng.odata_client import BaseODataClient
 
 
+@dataclass
+class _TestConfig(BaseCapabilityConfig):
+    service_path: str = "/test/odata/v4"
+
+
 def _make_config():
     auth = MagicMock(spec=AuthProvider)
-    return BaseCapabilityConfig(base_url="https://example.com", auth=auth)
+    return _TestConfig(base_url="https://example.com", auth=auth)
 
 
 class _ConcreteClient(BaseODataClient):