feat(cases): add governed DSAR coverage
This commit is contained in:
@@ -0,0 +1,471 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import unittest
|
||||
from dataclasses import dataclass
|
||||
from datetime import UTC, datetime, timedelta
|
||||
|
||||
from sqlalchemy import create_engine
|
||||
from sqlalchemy.orm import Session
|
||||
|
||||
from govoplan_cases.backend.domain import CaseGrant, CaseRecord
|
||||
from govoplan_cases.backend.dsar_provider import (
|
||||
CASES_DSAR_CAPABILITY,
|
||||
CasesDsarProvider,
|
||||
)
|
||||
from govoplan_cases.backend.manifest import manifest
|
||||
from govoplan_cases.backend.service import (
|
||||
create_case,
|
||||
update_case,
|
||||
upsert_case_status,
|
||||
upsert_case_type,
|
||||
)
|
||||
from govoplan_core.core.dsar import (
|
||||
DsarErasureActionRef,
|
||||
DsarProvider,
|
||||
DsarRecordRef,
|
||||
DsarSubjectRef,
|
||||
)
|
||||
from govoplan_core.core.institutional import (
|
||||
EvidenceReference,
|
||||
GovernedContextEnvelope,
|
||||
InstitutionalReference,
|
||||
TemporalRevision,
|
||||
)
|
||||
from govoplan_core.db.base import Base
|
||||
from govoplan_core.privacy.dsar_workflow import (
|
||||
create_data_subject_request,
|
||||
search_data_subject_request,
|
||||
)
|
||||
|
||||
|
||||
NOW = datetime(2026, 8, 21, 12, 0, tzinfo=UTC)
|
||||
|
||||
|
||||
@dataclass
|
||||
class _Principal:
|
||||
tenant_id: str
|
||||
account_id: str
|
||||
|
||||
|
||||
class _Registry:
|
||||
def __init__(
|
||||
self,
|
||||
provider: CasesDsarProvider,
|
||||
*,
|
||||
cases_active: bool = True,
|
||||
) -> None:
|
||||
self.provider = provider
|
||||
self.cases_active = cases_active
|
||||
|
||||
def capability_names(self):
|
||||
return (CASES_DSAR_CAPABILITY,)
|
||||
|
||||
def capability_owner(self, name):
|
||||
self._assert_capability(name)
|
||||
return "cases"
|
||||
|
||||
def tenant_entitlement_resolver(self):
|
||||
cases_active = self.cases_active
|
||||
|
||||
class _Resolver:
|
||||
@staticmethod
|
||||
def resolve(session, tenant_id):
|
||||
del session, tenant_id
|
||||
return type(
|
||||
"State",
|
||||
(),
|
||||
{"effective_modules": ("cases",) if cases_active else ()},
|
||||
)()
|
||||
|
||||
return _Resolver()
|
||||
|
||||
def require_tenant_capability(self, name, session, **kwargs):
|
||||
del session, kwargs
|
||||
self._assert_capability(name)
|
||||
return self.provider
|
||||
|
||||
def manifests(self):
|
||||
return (type("Manifest", (), {"id": "cases"})(),)
|
||||
|
||||
@staticmethod
|
||||
def _assert_capability(name: str) -> None:
|
||||
if name != CASES_DSAR_CAPABILITY:
|
||||
raise KeyError(name)
|
||||
|
||||
|
||||
def _ref(
|
||||
kind: str,
|
||||
object_id: str,
|
||||
owner: str,
|
||||
*,
|
||||
tenant_id: str,
|
||||
version: str | None = "1",
|
||||
) -> InstitutionalReference:
|
||||
return InstitutionalReference(
|
||||
kind=kind, # type: ignore[arg-type]
|
||||
owner_module=owner,
|
||||
object_id=object_id,
|
||||
tenant_id=tenant_id,
|
||||
version=version,
|
||||
valid_at=NOW,
|
||||
)
|
||||
|
||||
|
||||
def _record(
|
||||
case_id: str,
|
||||
*,
|
||||
tenant_id: str = "tenant-1",
|
||||
title: str = "Subject permit",
|
||||
grants: tuple[CaseGrant, ...] = (),
|
||||
) -> CaseRecord:
|
||||
case_ref = _ref("case", case_id, "cases", tenant_id=tenant_id)
|
||||
service_ref = _ref("service", "permit", "services", tenant_id=tenant_id)
|
||||
return CaseRecord(
|
||||
reference=case_ref,
|
||||
case_number=f"PERMIT-{case_id}",
|
||||
case_type_key="permit",
|
||||
status_key="open",
|
||||
title=title,
|
||||
access_mode="restricted" if grants else "tenant",
|
||||
access_grants=grants,
|
||||
context=GovernedContextEnvelope(
|
||||
tenant_id=tenant_id,
|
||||
temporal=TemporalRevision(
|
||||
revision="1",
|
||||
valid_from=NOW,
|
||||
recorded_at=NOW,
|
||||
change_reason="private-context-reason-do-not-export",
|
||||
),
|
||||
service_ref=service_ref,
|
||||
case_ref=case_ref,
|
||||
),
|
||||
service_ref=service_ref,
|
||||
party_refs=(
|
||||
_ref(
|
||||
"party",
|
||||
"private-party-reference-do-not-export",
|
||||
"parties",
|
||||
tenant_id=tenant_id,
|
||||
),
|
||||
),
|
||||
evidence_refs=(
|
||||
EvidenceReference(
|
||||
kind="document",
|
||||
owner_module="files",
|
||||
evidence_id="private-evidence-id-do-not-export",
|
||||
tenant_id=tenant_id,
|
||||
version="1",
|
||||
),
|
||||
),
|
||||
opened_at=NOW,
|
||||
recorded_at=NOW,
|
||||
deadline_at=NOW + timedelta(days=30),
|
||||
change_reason="private-create-reason-do-not-export",
|
||||
metadata={"secret": "private-metadata-do-not-export"},
|
||||
)
|
||||
|
||||
|
||||
class CasesDsarProviderTests(unittest.TestCase):
|
||||
def setUp(self) -> None:
|
||||
self.engine = create_engine("sqlite+pysqlite:///:memory:")
|
||||
Base.metadata.create_all(self.engine)
|
||||
self.session = Session(self.engine)
|
||||
self.provider = CasesDsarProvider()
|
||||
self.assertIsInstance(self.provider, DsarProvider)
|
||||
|
||||
operator = _Principal("tenant-1", "operator-1")
|
||||
other_operator = _Principal("tenant-1", "operator-other")
|
||||
tenant_two_operator = _Principal("tenant-2", "operator-2")
|
||||
for principal in (operator, tenant_two_operator):
|
||||
upsert_case_status(
|
||||
self.session,
|
||||
principal,
|
||||
status_key="open",
|
||||
label="Open",
|
||||
)
|
||||
upsert_case_type(
|
||||
self.session,
|
||||
principal,
|
||||
type_key="permit",
|
||||
label="Permit",
|
||||
initial_status_key="open",
|
||||
allowed_status_keys=("open",),
|
||||
)
|
||||
|
||||
create_case(
|
||||
self.session,
|
||||
operator,
|
||||
record=_record(
|
||||
"case-1",
|
||||
grants=(
|
||||
CaseGrant("account", "account-subject", ("read",)),
|
||||
CaseGrant("identity", "identity-subject", ("read", "update")),
|
||||
),
|
||||
),
|
||||
idempotency_key="private-create-key-do-not-export",
|
||||
)
|
||||
update_case(
|
||||
self.session,
|
||||
operator,
|
||||
case_id="case-1",
|
||||
expected_revision=1,
|
||||
changes={
|
||||
"title": "Subject permit revised",
|
||||
"metadata": {"secret": "private-updated-metadata-do-not-export"},
|
||||
},
|
||||
recorded_at=NOW + timedelta(minutes=1),
|
||||
change_reason="private-update-reason-do-not-export",
|
||||
idempotency_key="private-update-key-do-not-export",
|
||||
)
|
||||
create_case(
|
||||
self.session,
|
||||
other_operator,
|
||||
record=_record(
|
||||
"case-unrelated",
|
||||
title="private-unrelated-title-do-not-export",
|
||||
grants=(CaseGrant("account", "account-other", ("read",)),),
|
||||
),
|
||||
idempotency_key="unrelated-key-do-not-export",
|
||||
)
|
||||
create_case(
|
||||
self.session,
|
||||
tenant_two_operator,
|
||||
record=_record(
|
||||
"case-other-tenant",
|
||||
tenant_id="tenant-2",
|
||||
title="private-other-tenant-title-do-not-export",
|
||||
grants=(CaseGrant("account", "account-subject", ("read",)),),
|
||||
),
|
||||
idempotency_key="other-tenant-key-do-not-export",
|
||||
)
|
||||
self.session.commit()
|
||||
|
||||
def tearDown(self) -> None:
|
||||
self.session.close()
|
||||
self.engine.dispose()
|
||||
|
||||
def test_subject_access_grants_are_exact_tenant_and_minimized(self) -> None:
|
||||
account_records = self.provider.search_subject(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=DsarSubjectRef(account_id="account-subject"),
|
||||
)
|
||||
self.assertEqual(1, len(account_records))
|
||||
self.assertEqual("cases_access_grant", account_records[0].resource_type)
|
||||
self.assertFalse(account_records[0].immutable_evidence)
|
||||
self.assertEqual("account-subject", account_records[0].data["subject_id"])
|
||||
|
||||
identity_records = self.provider.search_subject(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=DsarSubjectRef(identity_id="identity-subject"),
|
||||
)
|
||||
self.assertEqual(1, len(identity_records))
|
||||
self.assertEqual("identity", identity_records[0].data["subject_kind"])
|
||||
|
||||
exported = json.dumps(
|
||||
[item.to_dict() for item in account_records + identity_records],
|
||||
sort_keys=True,
|
||||
)
|
||||
self.assertNotIn("private-unrelated-title-do-not-export", exported)
|
||||
self.assertNotIn("private-other-tenant-title-do-not-export", exported)
|
||||
self.assertNotIn("private-metadata-do-not-export", exported)
|
||||
self.assertNotIn("private-evidence-id-do-not-export", exported)
|
||||
|
||||
def test_direct_case_exports_typed_history_without_opaque_content(self) -> None:
|
||||
records = self.provider.search_subject(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=DsarSubjectRef(external_references={"cases.case": "case-1"}),
|
||||
)
|
||||
|
||||
types = [item.resource_type for item in records]
|
||||
self.assertEqual(1, types.count("cases_case_identity"))
|
||||
self.assertEqual(2, types.count("cases_case_revision"))
|
||||
self.assertEqual(1, types.count("cases_current_case_fact"))
|
||||
self.assertEqual(2, types.count("cases_timeline_event"))
|
||||
exported = json.dumps([item.to_dict() for item in records], sort_keys=True)
|
||||
self.assertIn("Subject permit revised", exported)
|
||||
self.assertNotIn("account-subject", exported)
|
||||
self.assertNotIn("identity-subject", exported)
|
||||
self.assertNotIn("private-party-reference-do-not-export", exported)
|
||||
self.assertNotIn("private-evidence-id-do-not-export", exported)
|
||||
self.assertNotIn("private-create-reason-do-not-export", exported)
|
||||
self.assertNotIn("private-update-reason-do-not-export", exported)
|
||||
self.assertNotIn("private-create-key-do-not-export", exported)
|
||||
self.assertNotIn("private-update-key-do-not-export", exported)
|
||||
self.assertNotIn("private-metadata-do-not-export", exported)
|
||||
self.assertNotIn("private-updated-metadata-do-not-export", exported)
|
||||
|
||||
def test_operator_attribution_excludes_raw_case_content(self) -> None:
|
||||
records = self.provider.search_subject(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=DsarSubjectRef(account_id="operator-1"),
|
||||
)
|
||||
self.assertGreaterEqual(len(records), 5)
|
||||
self.assertTrue(
|
||||
all(
|
||||
item.resource_type
|
||||
in {"cases_operator_attribution", "cases_timeline_event"}
|
||||
for item in records
|
||||
)
|
||||
)
|
||||
exported = json.dumps([item.to_dict() for item in records], sort_keys=True)
|
||||
self.assertNotIn("Subject permit revised", exported)
|
||||
self.assertNotIn("account-subject", exported)
|
||||
self.assertNotIn("identity-subject", exported)
|
||||
self.assertNotIn("private-update-reason-do-not-export", exported)
|
||||
self.assertNotIn("private-updated-metadata-do-not-export", exported)
|
||||
|
||||
def test_direct_and_canonical_selector_conflicts_fail_closed(self) -> None:
|
||||
conflict = self.provider.search_subject(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=DsarSubjectRef(
|
||||
account_id="account-subject",
|
||||
external_references={"cases.case": "case-unrelated"},
|
||||
),
|
||||
)
|
||||
self.assertEqual((), conflict)
|
||||
|
||||
alias_conflict = self.provider.search_subject(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=DsarSubjectRef(
|
||||
account_id="account-subject",
|
||||
external_references={"cases.account": "account-other"},
|
||||
),
|
||||
)
|
||||
self.assertEqual((), alias_conflict)
|
||||
|
||||
def test_planning_retains_history_and_requires_current_fact_review(self) -> None:
|
||||
subject = DsarSubjectRef(external_references={"cases.case": "case-1"})
|
||||
records = self.provider.search_subject(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=subject,
|
||||
)
|
||||
actions = self.provider.plan_erasure(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=subject,
|
||||
records=records,
|
||||
)
|
||||
self.assertEqual(5, sum(item.kind == "retain" for item in actions))
|
||||
self.assertEqual(1, sum(item.kind == "manual_review" for item in actions))
|
||||
self.assertTrue(all(not item.executable for item in actions))
|
||||
results = self.provider.execute_erasure(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=subject,
|
||||
actions=actions,
|
||||
request_id="dsar-cases-1",
|
||||
)
|
||||
self.assertTrue(all(item.status == "blocked" for item in results))
|
||||
|
||||
def test_foreign_records_and_actions_are_rejected(self) -> None:
|
||||
subject = DsarSubjectRef(account_id="account-subject")
|
||||
foreign_record = DsarRecordRef(
|
||||
provider_id="foreign",
|
||||
module_id="foreign",
|
||||
resource_type="foreign",
|
||||
resource_id="foreign-1",
|
||||
category="foreign",
|
||||
title="Foreign record",
|
||||
)
|
||||
with self.assertRaisesRegex(ValueError, "foreign provider record"):
|
||||
self.provider.plan_erasure(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=subject,
|
||||
records=(foreign_record,),
|
||||
)
|
||||
|
||||
foreign_action = DsarErasureActionRef(
|
||||
action_id="foreign:delete:1",
|
||||
provider_id="foreign",
|
||||
module_id="foreign",
|
||||
kind="delete",
|
||||
resource_type="foreign",
|
||||
resource_id="foreign-1",
|
||||
title="Delete foreign",
|
||||
rationale="No",
|
||||
executable=True,
|
||||
)
|
||||
with self.assertRaisesRegex(ValueError, "foreign provider action"):
|
||||
self.provider.execute_erasure(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
subject=subject,
|
||||
actions=(foreign_action,),
|
||||
request_id="dsar-cases-1",
|
||||
)
|
||||
|
||||
def test_workflow_discovers_only_the_active_tenant_capability(self) -> None:
|
||||
active = create_data_subject_request(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
reference="DSAR-CASES-1",
|
||||
request_kind="access",
|
||||
subject=DsarSubjectRef(account_id="account-subject"),
|
||||
purpose="Subject access request",
|
||||
legal_basis=None,
|
||||
due_at=None,
|
||||
requested_by_account_id="privacy-operator",
|
||||
)
|
||||
search_data_subject_request(
|
||||
self.session,
|
||||
registry=_Registry(self.provider),
|
||||
row=active,
|
||||
expected_revision=1,
|
||||
)
|
||||
self.assertEqual("searched", active.status)
|
||||
self.assertEqual(
|
||||
[CASES_DSAR_CAPABILITY], active.coverage["provider_capabilities"]
|
||||
)
|
||||
self.assertEqual(["cases"], active.coverage["covered_modules"])
|
||||
|
||||
inactive = create_data_subject_request(
|
||||
self.session,
|
||||
tenant_id="tenant-1",
|
||||
reference="DSAR-CASES-2",
|
||||
request_kind="access",
|
||||
subject=DsarSubjectRef(account_id="account-subject"),
|
||||
purpose="Inactive module coverage",
|
||||
legal_basis=None,
|
||||
due_at=None,
|
||||
requested_by_account_id="privacy-operator",
|
||||
)
|
||||
search_data_subject_request(
|
||||
self.session,
|
||||
registry=_Registry(self.provider, cases_active=False),
|
||||
row=inactive,
|
||||
expected_revision=1,
|
||||
)
|
||||
self.assertEqual([], inactive.coverage["provider_capabilities"])
|
||||
self.assertEqual(
|
||||
[CASES_DSAR_CAPABILITY],
|
||||
inactive.coverage["inactive_provider_capabilities"],
|
||||
)
|
||||
self.assertEqual(0, inactive.search_result["record_count"])
|
||||
|
||||
def test_manifest_registers_and_documents_the_capability(self) -> None:
|
||||
self.assertIn(CASES_DSAR_CAPABILITY, manifest.capability_factories)
|
||||
self.assertIn(CASES_DSAR_CAPABILITY, manifest.capability_documentation)
|
||||
self.assertIn(
|
||||
CASES_DSAR_CAPABILITY,
|
||||
{item.name for item in manifest.provides_interfaces},
|
||||
)
|
||||
self.assertTrue(
|
||||
any(
|
||||
topic.id == "cases.data-subject-requests"
|
||||
and {"admin", "user"}.issubset(topic.documentation_types)
|
||||
for topic in manifest.documentation
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
Reference in New Issue
Block a user