Merge pull request #57 from itk-dev-rpa/2.4.0

2.4.0

Author: bakspace-itk

.github/workflows/Linting.yml

@@ -19,9 +19,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pylint
-        pip install flake8
         pip install .
+        pip install .[dev]
 
     - name: Analyzing the code with pylint
       run: |

changelog.md

@@ -5,8 +5,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
 ## [Unreleased]
 
+### Added
+
+### Changed
+
+## [2.4.0] - 2024-07-30
+
+### Added
+
+- Caseworker for notes
+- Directions for setting up environment variables for test
+- misc.file_util: Wait for download function.
+
+### Changed
+
+- Changed environmental variables to use an .env file
+
+### Fixed
+- Some SAP tests were failing due to a missing value
+- Changed department and security units from rules to user control
+- Minor doc fixes to get_drive_item.
+
 ## [2.3.0] - 2024-07-03
 
 ### Added
@@ -114,14 +136,15 @@ 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/2.3.0...HEAD
-[2.3.0] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.3.0
-[2.2.0] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.2.0
-[2.1.1] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.1.1
-[2.1.0] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.1.0
-[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
-[1.1.0] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/1.1.0
-[1.0.0] https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/1.0.0
+[Unreleased]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/compare/2.4.0...HEAD
+[2.4.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.4.0
+[2.3.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.3.0
+[2.2.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.2.0
+[2.1.1]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.1.1
+[2.1.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.1.0
+[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
+[1.1.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/1.1.0
+[1.0.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/1.0.0

itk_dev_shared_components/graph/file.py

@@ -16,7 +16,7 @@ class DriveItem:
     last_modified: str
 
 
-def get_drive_item(graph_access: GraphAccess, site_id: str, drive_item_path: str) -> str:
+def get_drive_item(graph_access: GraphAccess, site_id: str, drive_item_path: str) -> DriveItem:
     """Given a site id and a drive_item_path, gets the corresponding DriveItem
 
     You need to authorize against Graph to get the GraphAccess before using this function
@@ -28,7 +28,11 @@ def get_drive_item(graph_access: GraphAccess, site_id: str, drive_item_path: str
         graph_access: The GraphAccess object used to authenticate.
         site_id: The id of the site in SharePoint.
         drive_item_path: The path to the DriveItem in SharePoint.
+
+    Returns:
+        DriveItem: A DriveItem object.
     """
+
     endpoint = f"https://graph.microsoft.com/v1.0/sites/{site_id}/drive/root:/{drive_item_path}"
     response = get_request(endpoint, graph_access)
     raw_response = response.json()

itk_dev_shared_components/kmd_nova/nova_cases.py

@@ -338,8 +338,8 @@ def add_case(case: NovaCase, nova_access: NovaAccess):
             }
         },
         "SensitivityCtrlBy": "Bruger",
-        "SecurityUnitCtrlBy": "Regler",
-        "ResponsibleDepartmentCtrlBy": "Regler",
+        "SecurityUnitCtrlBy": "Bruger",
+        "ResponsibleDepartmentCtrlBy": "Bruger",
         "caseAvailability": {
             "unit": "År",
             "scale": 5

itk_dev_shared_components/kmd_nova/nova_notes.py

@@ -8,10 +8,10 @@
 import requests
 
 from itk_dev_shared_components.kmd_nova.authentication import NovaAccess
-from itk_dev_shared_components.kmd_nova.nova_objects import JournalNote
+from itk_dev_shared_components.kmd_nova.nova_objects import JournalNote, Caseworker
 
 
-def add_text_note(case_uuid: str, note_title: str, note_text: str, approved: bool, nova_access: NovaAccess) -> str:
+def add_text_note(case_uuid: str, note_title: str, note_text: str, caseworker: Caseworker, approved: bool, nova_access: NovaAccess) -> str:
     """Add a text based journal note to a Nova case.
 
     Args:
@@ -40,6 +40,13 @@ def add_text_note(case_uuid: str, note_title: str, note_text: str, approved: boo
                 "approved": approved,
                 "journalNoteAttributes": {
                     "journalNoteDate": datetime.today().isoformat(),
+                    "journalNoteAuthor": caseworker.ident,
+                    "author": {
+                        "kspIdentity": {
+                            "racfId": caseworker.ident,
+                            "fullName": caseworker.name
+                        }
+                    },
                     "title": note_title,
                     "journalNoteType": "Bruger",
                     "format": "Text",

itk_dev_shared_components/misc/file_util.py

@@ -0,0 +1,33 @@
+"""This module contains helper functions to do with handling files."""
+
+import os
+import time
+
+
+def wait_for_download(folder: str, file_name: str | None, file_extension: str, timeout: int = 10) -> str:
+    """Wait for a file to appear in a folder.
+    This checks the folder every second for the file.
+
+    Args:
+        folder: The absolute path of the folder to monitor.
+        file_name: The name of the file if know else None
+        file_extension: The file extension of the file with the dot.
+        timeout: The number of seconds to wait for the file.
+
+    Returns:
+        The absolute path to the file.
+
+    Raises:
+        TimeoutError: If the file didn't appear withing the given timeout.
+    """
+    for _ in range(timeout):
+        files = os.listdir(folder)
+        for file in files:
+            name, ext = os.path.splitext(file)
+
+            if file_extension == ext and (file_name is None or file_name == name):
+                return os.path.join(folder, file)
+
+        time.sleep(1)
+
+    raise TimeoutError(f"Downloaded file didn't appear within {timeout} seconds.")

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "itk_dev_shared_components"
-version = "2.3.0"
+version = "2.4.0"
 authors = [
   { name="ITK Development", email="itk-rpa@mkb.aarhus.dk" },
 ]
@@ -20,9 +20,16 @@ dependencies = [
   "pywin32 >= 306",
   "msal >= 1.24.1",
   "requests >= 2.31.0",
-  "beautifulsoup4 >= 4.12.2"
+  "beautifulsoup4 >= 4.12.2",
 ]
 
 [project.urls]
 "Homepage" = "https://github.com/itk-dev-rpa/itk-dev-shared-components"
 "Bug Tracker" = "https://github.com/itk-dev-rpa/itk-dev-shared-components/issues"
+
+[project.optional-dependencies]
+dev = [
+  "python-dotenv",
+  "flake8",
+  "pylint"
+]

tests/readme.md

@@ -7,6 +7,26 @@ This bat file sets up a new virtual environment and installs the package before
 
 Alternatively you can run each test file separately by simply running them as Python scripts.
 
+## Environment variables
+You need to setup a .env file in the root directory with the following parameters:
+
+GRAPH_API = '{"client_id":"something", "tenant_id":"something", "username":"something", "password":"something"}'
+SAP_LOGIN = 'login;password'
+
+MAIL_USER = "test@email.dk"
+MAIL_FOLDER1 = "Indbakke/Graph Test/Undermappe"
+MAIL_FOLDER2 = "Indbakke/Graph Test/Undermappe2"
+
+NOVA_PARTY = '6101009805,Test Test'
+NOVA_DEPARTMENT = '{"id": 818485,"name": "Borgerservice","user_key": "4BBORGER"}'
+NOVA_CREDENTIALS = 'nova_login,nova_password'
+NOVA_USER = '{"name": "svcitkopeno svcitkopeno", "ident": "AZX0080", "uuid": "0bacdddd-5c61-4676-9a61-b01a18cec1d5"}'
+
+NOVA_CVR_CASE = '{"cvr": "55133018", "case_title": "rpa_testcase", "case_number": "S2024-25614"}'
+NOVA_CPR_CASE = '{"cpr": "6101009805", "case_title": "Meget_Unik_Case_Overskrift", "case_number": "S2023-61078"}'
+
+Note: The NOVA_CVR_CASE and NOVA_CPR_CASE variables require cases to be created in Nova, and the parameters set from those cases.
+
 ## SMTP
 
 For testing SMTP you need [Mailpit](https://mailpit.axllent.org/) running on localhost.

tests/run_tests.bat

@@ -18,6 +18,7 @@ if errorlevel 2 (
 
     echo Installing package...
     pip install .
+    pip install .[dev]
 )
 
 echo Running unit tests...

tests/test_graph/test_mail.py

@@ -4,15 +4,19 @@
 import json
 import os
 
+from dotenv import load_dotenv
+
 from itk_dev_shared_components.graph import authentication, mail
 
+load_dotenv()
+
 
 class EmailTest(unittest.TestCase):
     """Tests relating to the graph.mail module."""
     @classmethod
     def setUpClass(cls) -> None:
         # Get Graph credentials from the environment variables.
-        credentials = json.loads(os.environ['GraphAPI'])
+        credentials = json.loads(os.environ['GRAPH_API'])
         client_id = credentials['client_id']
         tenant_id = credentials['tenant_id']
         username = credentials['username']
@@ -21,9 +25,9 @@ def setUpClass(cls) -> None:
         cls.graph_access = authentication.authorize_by_username_password(username, password, tenant_id=tenant_id, client_id=client_id)
 
         # Define mail user and folders
-        cls.user = "itk-rpa@mkb.aarhus.dk"
-        cls.folder1 = "Indbakke/Graph Test/Undermappe"
-        cls.folder2 = "Indbakke/Graph Test/Undermappe2"
+        cls.user = os.environ['MAIL_USER']
+        cls.folder1 = os.environ['MAIL_FOLDER1']
+        cls.folder2 = os.environ['MAIL_FOLDER2']
 
     def test_correct_usage(self):
         """Test all functions relating to the mail part of Graph.