Merge pull request #38 from itk-dev-rpa/release/2.0.0

ghbm-itk · web-flow · commit b9fb89ee935c · 2024-04-03T09:54:00.000+02:00
Release/2.0.0
diff --git a/changelog.md b/changelog.md
@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2024-04-03
+
+### Changed
+
+#### KMD Nova
+
+- Department and Caseworker classes added.
+- Ability to set security unit, department and caseworker on cases.
+- Better tests for cases.
+
+### Fixed
+
+- Security unit not set properly on Nova cases.
+
 ## [1.3.1] - 2024-02-21
 
 ### Fixed
@@ -67,7 +81,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased] https://github.com/itk-dev-rpa/ITK-dev-shared-components/compare/1.3.1...HEAD
+[Unreleased] https://github.com/itk-dev-rpa/ITK-dev-shared-components/compare/2.0.0...HEAD
+[2.0.0] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.0.0
 [1.3.1] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/1.3.1
 [1.3.0] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/1.3.0
 [1.2.0] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/1.2.0
diff --git a/itk_dev_shared_components/kmd_nova/nova_cases.py b/itk_dev_shared_components/kmd_nova/nova_cases.py
@@ -8,7 +8,7 @@
 import requests
 
 from itk_dev_shared_components.kmd_nova.authentication import NovaAccess
-from itk_dev_shared_components.kmd_nova.nova_objects import NovaCase, CaseParty, JournalNote
+from itk_dev_shared_components.kmd_nova.nova_objects import NovaCase, CaseParty, JournalNote, Caseworker, Department
 from itk_dev_shared_components.kmd_nova.util import datetime_from_iso_string
 
 
@@ -83,7 +83,30 @@ def get_cases(nova_access: NovaAccess, cpr: str = None, case_number: str = None,
             },
             "sensitivity": {
                 "sensitivity": True
-            }
+            },
+            "caseworker": {
+                "kspIdentity": {
+                    "novaUserId": True,
+                    "fullName": True,
+                    "racfId": True
+                }
+            },
+            "responsibleDepartment": {
+                "losIdentity": {
+                    "novaUnitId": True,
+                    "administrativeUnitId": True,
+                    "fullName": True,
+                    "userKey": True
+                }
+            },
+            "securityUnit": {
+                "losIdentity": {
+                    "novaUnitId": True,
+                    "administrativeUnitId": True,
+                    "fullName": True,
+                    "userKey": True
+                }
+            },
         }
     }
 
@@ -98,6 +121,7 @@ def get_cases(nova_access: NovaAccess, cpr: str = None, case_number: str = None,
     # Convert json to NovaCase objects
     cases = []
     for case_dict in response.json()['cases']:
+        security_unit, responsible_department = _extract_departments(case_dict)
         case = NovaCase(
             uuid = case_dict['common']['uuid'],
             title = case_dict['caseAttributes']['title'],
@@ -110,14 +134,60 @@ def get_cases(nova_access: NovaAccess, cpr: str = None, case_number: str = None,
             note_count = case_dict['numberOfJournalNotes'],
             kle_number = case_dict['caseClassification']['kleNumber']['code'],
             proceeding_facet = case_dict['caseClassification']['proceedingFacet']['code'],
-            sensitivity = case_dict["sensitivity"]["sensitivity"]
+            sensitivity = case_dict["sensitivity"]["sensitivity"],
+            caseworker = _extract_case_worker(case_dict),
+            security_unit=security_unit,
+            responsible_department=responsible_department
         )
 
         cases.append(case)
 
     return cases
 
 
+def _extract_departments(case_dict: dict) -> tuple[Department, Department]:
+    """Extract the departments from a HTTP request response.
+
+    Args:
+        case_dict: The dictionary describing the case.
+
+    Returns:
+        The security unit and the responsible department.
+    """
+    security_unit = Department(
+        id=case_dict['securityUnit']['losIdentity']['administrativeUnitId'],
+        name=case_dict['securityUnit']['losIdentity']['fullName'],
+        user_key=case_dict['securityUnit']['losIdentity']['userKey']
+    )
+
+    responsible_department = Department(
+        id=case_dict['responsibleDepartment']['losIdentity']['administrativeUnitId'],
+        name=case_dict['responsibleDepartment']['losIdentity']['fullName'],
+        user_key=case_dict['responsibleDepartment']['losIdentity']['userKey']
+    )
+
+    return security_unit, responsible_department
+
+
+def _extract_case_worker(case_dict: dict) -> Caseworker | None:
+    """Extract the case worker from a HTTP request response.
+
+    Args:
+        case_dict: The dictionary describing the case.
+
+    Returns:
+        A case worker object describing the case worker if any.
+    """
+    if 'caseworker' in case_dict:
+        return Caseworker(
+            uuid = case_dict['caseworker']['kspIdentity']['novaUserId'],
+            name = case_dict['caseworker']['kspIdentity']['fullName'],
+            ident = case_dict['caseworker']['kspIdentity']['racfId']
+        )
+
+    return None
+
+
 def _extract_case_parties(case_dict: dict) -> list[CaseParty]:
     """Extract the case parties from a HTTP request response.
 
@@ -164,7 +234,7 @@ def _extract_journal_notes(case_dict: dict) -> list:
     return notes
 
 
-def add_case(case: NovaCase, nova_access: NovaAccess, security_unit_id: int = 818485, security_unit_name: str = "Borgerservice"):
+def add_case(case: NovaCase, nova_access: NovaAccess):
     """Add a case to KMD Nova. The case will be created as 'Active'.
 
     Args:
@@ -208,8 +278,16 @@ def add_case(case: NovaCase, nova_access: NovaAccess, security_unit_id: int = 81
         ],
         "securityUnit": {
             "losIdentity": {
-                "administrativeUnitId": security_unit_id,
-                "fullName": security_unit_name,
+                "administrativeUnitId": case.security_unit.id,
+                "fullName": case.security_unit.name,
+                "userKey": case.security_unit.user_key
+            }
+        },
+        "responsibleDepartment": {
+            "losIdentity": {
+                "administrativeUnitId": case.responsible_department.id,
+                "fullName": case.responsible_department.name,
+                "userKey": case.responsible_department.user_key
             }
         },
         "SensitivityCtrlBy": "Bruger",
@@ -222,6 +300,14 @@ def add_case(case: NovaCase, nova_access: NovaAccess, security_unit_id: int = 81
         "AvailabilityCtrlBy": "Regler"
     }
 
+    if case.caseworker:
+        payload['caseworker'] = {
+            "kspIdentity": {
+                "racfId": case.caseworker.ident,
+                "fullName": case.caseworker.name
+            }
+        }
+
     headers = {'Content-Type': 'application/json', 'Authorization': f"Bearer {nova_access.get_bearer_token()}"}
 
     response = requests.post(url, params=params, headers=headers, json=payload, timeout=60)
diff --git a/itk_dev_shared_components/kmd_nova/nova_objects.py b/itk_dev_shared_components/kmd_nova/nova_objects.py
@@ -8,6 +8,22 @@
 # pylint: disable=too-many-instance-attributes
 
 
+@dataclass(slots=True, kw_only=True)
+class Department:
+    """A dataclass representing a department in a KMD Nova case."""
+    id: int
+    name: str
+    user_key: str
+
+
+@dataclass(slots=True, kw_only=True)
+class Caseworker:
+    """A dataclass representing a caseworker in a KMD Nova case."""
+    uuid: str
+    name: str
+    ident: str
+
+
 @dataclass(slots=True, kw_only=True)
 class CaseParty:
     """A dataclass representing a case party in a KMD Nova case."""
@@ -51,8 +67,7 @@ class Task:
     uuid: str
     title: str
     description: Optional[str] = None
-    case_worker_ident: Optional[str] = None
-    case_worker_uuid: str
+    caseworker: Caseworker
     status_code: Literal['N', 'S', 'F']  # Not Started, Started, Finished
     deadline: datetime
     created_date: Optional[datetime] = None
@@ -70,8 +85,11 @@ class NovaCase:
     active_code: Optional[str] = None
     progress_state: Literal["Opstaaet", "Oplyst", "Afgjort", "Bestilt", "Udfoert", "Afsluttet"]
     case_parties: list[CaseParty]
+    caseworker: Optional[Caseworker] = None
     document_count: Optional[int] = 0
     note_count: Optional[int] = 0
     kle_number: str
     proceeding_facet: str
     sensitivity: Literal["Fortrolige", "IkkeFortrolige", "SærligFølsomme", "Følsomme"]
+    responsible_department: Department
+    security_unit: Department
diff --git a/itk_dev_shared_components/kmd_nova/nova_tasks.py b/itk_dev_shared_components/kmd_nova/nova_tasks.py
@@ -6,7 +6,7 @@
 import requests
 
 from itk_dev_shared_components.kmd_nova.authentication import NovaAccess
-from itk_dev_shared_components.kmd_nova.nova_objects import Task
+from itk_dev_shared_components.kmd_nova.nova_objects import Task, Caseworker
 from itk_dev_shared_components.kmd_nova.util import datetime_from_iso_string, datetime_to_iso_string
 
 
@@ -35,7 +35,7 @@ def attach_task_to_case(case_uuid: str, task: Task, nova_access: NovaAccess) ->
         "caseUuid": case_uuid,
         "title": task.title,
         "description": task.description,  # Optional
-        "caseworkerPersonId": task.case_worker_uuid,  # Optional
+        "caseworkerPersonId": task.caseworker.uuid,  # Optional
         "statusCode": task.status_code,
         "deadline": datetime_to_iso_string(task.deadline),
         "startDate": datetime_to_iso_string(task.started_date),  # Optional
@@ -89,8 +89,7 @@ def get_tasks(case_uuid: str, nova_access: NovaAccess, limit: int = 100) -> list
             uuid = task_dict['taskUuid'],
             title = task_dict['taskTitle'],
             description = task_dict.get('taskDescription'),
-            case_worker_ident = task_dict['caseWorker']['ident'] if 'caseWorker' in task_dict else None,
-            case_worker_uuid = task_dict['caseWorker']['id'] if 'caseWorker' in task_dict else None,
+            caseworker = _extract_caseworker(task_dict),
             status_code = task_dict['taskStatusCode'],
             deadline = datetime_from_iso_string(task_dict.get('taskDeadline')),
             created_date = datetime_from_iso_string(task_dict.get('taskCreateDate')),
@@ -102,6 +101,25 @@ def get_tasks(case_uuid: str, nova_access: NovaAccess, limit: int = 100) -> list
     return tasks
 
 
+def _extract_caseworker(task_dict: dict) -> Caseworker | None:
+    """Extract the case worker from a HTTP request response.
+
+    Args:
+        case_dict: The dictionary describing the task.
+
+    Returns:
+        A case worker object describing the case worker if any.
+    """
+    if 'caseWorker' in task_dict:
+        return Caseworker(
+            uuid = task_dict['caseWorker']['id'],
+            ident = task_dict['caseWorker']['ident'],
+            name = task_dict['caseWorker']['name']
+        )
+
+    return None
+
+
 def update_task(task: Task, case_uuid: str, nova_access: NovaAccess):
     """Update a task that already exists in KMD Nova with new
     information.
@@ -125,7 +143,7 @@ def update_task(task: Task, case_uuid: str, nova_access: NovaAccess):
         "caseUuid": case_uuid,
         "title": task.title,
         "description": task.description,
-        "caseworkerPersonId": task.case_worker_uuid,
+        "caseworkerPersonId": task.caseworker.uuid,
         "statusCode": task.status_code,
         "deadline": datetime_to_iso_string(task.deadline),
         "startDate": datetime_to_iso_string(task.started_date),
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "itk_dev_shared_components"
-version = "1.3.1"
+version = "2.0.0"
 authors = [
   { name="ITK Development", email="itk-rpa@mkb.aarhus.dk" },
 ]
diff --git a/tests/test_nova_api/test_cases.py b/tests/test_nova_api/test_cases.py
@@ -3,9 +3,10 @@
 import os
 import uuid
 from datetime import datetime
+import time
 
 from itk_dev_shared_components.kmd_nova.authentication import NovaAccess
-from itk_dev_shared_components.kmd_nova.nova_objects import NovaCase, CaseParty
+from itk_dev_shared_components.kmd_nova.nova_objects import NovaCase, CaseParty, Caseworker, Department
 from itk_dev_shared_components.kmd_nova import nova_cases
 
 
@@ -57,6 +58,18 @@ def test_add_case(self):
             name="Test Test"
         )
 
+        caseworker = Caseworker(
+            name='svcitkopeno svcitkopeno',
+            ident='AZX0080',
+            uuid='0bacdddd-5c61-4676-9a61-b01a18cec1d5'
+        )
+
+        department = Department(
+            id=818485,
+            name="Borgerservice",
+            user_key="4BBORGER"
+        )
+
         case = NovaCase(
             uuid=str(uuid.uuid4()),
             title=f"Test {datetime.now()}",
@@ -65,11 +78,35 @@ def test_add_case(self):
             case_parties=[party],
             kle_number="23.05.01",
             proceeding_facet="G01",
-            sensitivity="Fortrolige"
+            sensitivity="Fortrolige",
+            caseworker=caseworker,
+            responsible_department=department,
+            security_unit=department
         )
 
         nova_cases.add_case(case, self.nova_access)
 
+        # Wait up to 10 seconds for the case to be created in Nova
+        for _ in range(10):
+            time.sleep(1)
+            cases = nova_cases.get_cases(self.nova_access, cpr=party.identification, case_title=case.title)
+            if cases:
+                break
+
+        self.assertEqual(len(cases), 1)
+
+        nova_case = cases[0]
+        self.assertEqual(nova_case.uuid, case.uuid)
+        self.assertEqual(nova_case.title, case.title)
+        self.assertEqual(nova_case.progress_state, case.progress_state)
+        self.assertEqual(nova_case.kle_number, case.kle_number)
+        self.assertEqual(nova_case.proceeding_facet, case.proceeding_facet)
+        self.assertEqual(nova_case.sensitivity, case.sensitivity)
+        self.assertEqual(nova_case.caseworker.ident, case.caseworker.ident)
+        self.assertEqual(nova_case.case_parties[0].identification, case.case_parties[0].identification)
+        self.assertEqual(nova_case.responsible_department.id, case.responsible_department.id)
+        self.assertEqual(nova_case.security_unit.id, case.security_unit.id)
+
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/tests/test_nova_api/test_tasks.py b/tests/test_nova_api/test_tasks.py

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"`
`4`	`4`
`5`	`5`	`[project]`
`6`	`6`	`name = "itk_dev_shared_components"`
`7`		`-version = "1.3.1"`
	`7`	`+version = "2.0.0"`
`8`	`8`	`authors = [`
`9`	`9`	`{ name="ITK Development", email="itk-rpa@mkb.aarhus.dk" },`
`10`	`10`	`]`