Merge pull request #81 from itk-dev-rpa/release/2.7.0

Release/2.7.0

Author: bakspace-itk

changelog.md

@@ -7,9 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.7.0] - 2024-09-16
+
+### Added
+
+- Added functionality for approving, checking approval status and noting cases
+
 ## [2.6.1] - 2024-09-04
 
-### Fixed - 2024-09-04
+### Fixed
 
 - Fixed column number on case_worker
 
@@ -22,6 +28,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - eflyt.eflyt_case.change_tab now checks if the tab needs to be changed before doing it.
+- Dependenices are now only locked to major versions.
+- Changed test for change sap password to use dotenv.
 
 ## [2.5.0] - 2024-08-14
 
@@ -160,8 +168,9 @@ 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.6.1...HEAD
-[2.6.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.6.1
+[Unreleased]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/compare/2.7.0...HEAD
+[2.7.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.7.0
+[2.6.1]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.6.1
 [2.6.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.6.0
 [2.5.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.5.0
 [2.4.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.4.0

itk_dev_shared_components/eflyt/eflyt_case.py

@@ -4,6 +4,7 @@
 
 from selenium import webdriver
 from selenium.webdriver.common.by import By
+from selenium.webdriver.common.keys import Keys
 
 
 @dataclass
@@ -126,3 +127,69 @@ def change_tab(browser: webdriver.Chrome, tab_index: int):
 
     if current_index != tab_index:
         browser.execute_script(f"__doPostBack('ctl00$ContentPlaceHolder2$ptFanePerson$ImgJournalMap','{tab_index}')")
+
+
+def approve_case(browser: webdriver.Chrome):
+    """Approve a case, even if blocked by a note."""
+    change_tab(browser, 0)
+
+    deadline_field = browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_txtDeadline")
+    deadline_field.clear()
+    note_field = browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_txtDeadlineNote")
+    note_field.clear()
+
+    browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_stcPersonTab1_btnGodkend").click()
+    browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_stcPersonTab1_btnApproveYes").click()
+
+    approve_persons_button = browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_stcPersonTab1_btnGodkendAlle")
+    if not approve_persons_button.is_enabled():
+
+        person_table = browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_GridViewMovingPersons")
+        rows = person_table.find_elements(By.TAG_NAME, "tr")
+        rows.pop(0)
+
+        for row in rows:
+            row.find_element(By.XPATH, "td[2]").click()
+            browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_stcPersonTab1_btnGodkend").click()
+            approve_button = browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_stcPersonTab1_btnApproveYes")
+            if approve_button.is_displayed():
+                approve_button.click()
+    else:
+        approve_persons_button.click()
+
+
+def check_all_approved(browser: webdriver.Chrome) -> bool:
+    """Check all inhabiatants in table have a status 'Godkendt'.
+    """
+    person_table = browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_GridViewMovingPersons")
+    rows = person_table.find_elements(By.TAG_NAME, "tr")
+    rows.pop(0)
+
+    for row in rows:
+        row_status = row.find_element(By.XPATH, "td[6]").text
+        if row_status != "Godkendt":
+            return False
+    return True
+
+
+def add_note(browser: webdriver.Chrome, message: str):
+    """Add a note to a case."""
+    message = f"{date.today().strftime('%Y-%m-%d')} Besked fra Robot: {message}"
+    browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_ButtonVisOpdater").click()
+
+    existing_note = browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_txtVisOpdaterNote").text
+    if len(existing_note) > 0:
+        message = "\n\n" + message
+        browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_txtVisOpdaterNote").send_keys(Keys.CONTROL+Keys.END)
+
+    browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_txtVisOpdaterNote").send_keys(message)
+    browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_btnLongNoteUpdater").click()
+
+
+def get_note_text(browser: webdriver.Chrome) -> str:
+    """Read note text and close the window, returning the value.
+    """
+    browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_ButtonVisOpdater").click()
+    text = browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_txtVisOpdaterNote").text
+    browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_btnLuk").click()
+    return text

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "itk_dev_shared_components"
-version = "2.6.1"
+version = "2.7.0"
 authors = [
   { name="ITK Development", email="itk-rpa@mkb.aarhus.dk" },
 ]
@@ -18,11 +18,11 @@ classifiers = [
 ]
 dependencies = [
   "pywin32 >= 306",
-  "msal >= 1.24.1",
-  "requests >= 2.31.0",
-  "beautifulsoup4 >= 4.12.2",
-  "selenium==4.16.0",
-  "uiautomation == 2.0.18"
+  "msal == 1.*",
+  "requests == 2.*",
+  "beautifulsoup4 == 4.*",
+  "selenium == 4.*",
+  "uiautomation == 2.*"
 ]
 
 [project.urls]

tests/readme.md

@@ -38,12 +38,15 @@ mailpit --smtp-tls-cert cert.pem --smtp-tls-key key.pem
 ```
 
 ## Environment variables
-You need to setup a .env file in the root directory with the following parameters:
 
+You need to setup a .env file in the root directory with the following parameters:
 
 ### SAP
 
 SAP_LOGIN = 'login;password'
+SAP_NEW_PASSWORD = 'new password'
+
+If SAP_NEW_PASSWORD is not set, the change password test is skipped.
 
 ### GRAPH
 
@@ -74,4 +77,4 @@ CVR_CREDS = 'login;password'
 EFLYT_LOGIN = 'username,password'
 TEST_CPR = 'XXXXXXXXXX'
 TEST_CASE = '123456' # A test case with multiple current inhabitants, with relations registered
-TEST_CASE_NOONE = '56789' # A test case without any current inhabitants
+TEST_CASE_NOONE = '56789' # A test case without any current inhabitants

tests/test_eflyt/test_case.py

@@ -7,9 +7,7 @@
 from dotenv import load_dotenv
 from selenium.webdriver.common.by import By
 
-from itk_dev_shared_components.eflyt.eflyt_login import login
-from itk_dev_shared_components.eflyt.eflyt_search import open_case
-from itk_dev_shared_components.eflyt import eflyt_case
+from itk_dev_shared_components.eflyt import eflyt_case, eflyt_login, eflyt_search
 
 load_dotenv()
 
@@ -21,12 +19,12 @@ class CaseTest(unittest.TestCase):
     def setUpClass(cls):
         """Setup test class"""
         eflyt_credentials = os.getenv("EFLYT_LOGIN").split(",")
-        cls.browser = login(eflyt_credentials[0], eflyt_credentials[1])
+        cls.browser = eflyt_login.login(eflyt_credentials[0], eflyt_credentials[1])
 
     def setUp(self):
         """Go to a clean case state"""
         test_case = os.getenv("TEST_CASE")
-        open_case(self.browser, test_case)
+        eflyt_search.open_case(self.browser, test_case)
 
     def test_get_beboere(self):
         """Test inhabitant functions"""
@@ -44,7 +42,7 @@ def test_get_beboere(self):
         for relation in inhabitant.relations:
             self.assertRegex(relation, r"\d{6}-\d{4}")
 
-        open_case(self.browser, test_no_inhabitants_case)
+        eflyt_search.open_case(self.browser, test_no_inhabitants_case)
         inhabitants = eflyt_case.get_beboere(self.browser)
 
         self.assertEqual(len(inhabitants), 0, "Some inhabitants found when none was expected")
@@ -74,6 +72,30 @@ def test_get_room_count(self):
         self.assertIsInstance(room_count, int, "Room count is not a number")
         self.assertGreater(room_count, 0, "Room count is less than 1")
 
+    def test_write_note(self):
+        """Test writing a note to a case. Check if the note is added and that the existing note is preserved.
+        """
+        existing_note = eflyt_case.get_note_text(self.browser)
+
+        note_text = "Test"
+        eflyt_case.add_note(self.browser, note_text)
+
+        new_note = eflyt_case.get_note_text(self.browser)
+
+        # Reset note to original text
+        self.browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_ButtonVisOpdater").click()
+        self.browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_txtVisOpdaterNote").clear()
+        self.browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_txtVisOpdaterNote").send_keys(existing_note)
+        self.browser.find_element(By.ID, "ctl00_ContentPlaceHolder2_ptFanePerson_ncPersonTab_btnLongNoteUpdater").click()
+
+        self.assertNotEqual(existing_note, new_note)
+        self.assertEqual(existing_note, new_note[:len(existing_note)])
+        self.assertEqual(note_text, new_note[-len(note_text):])
+
+    @unittest.skip("No test system available for approving dummy cases.")
+    def test_approve_case(self):
+        """Empty test for approve_case"""
+
 
 if __name__ == '__main__':
     unittest.main()

tests/test_sap/test_sap_login.py

@@ -2,7 +2,6 @@
 
 import os
 import unittest
-from tkinter import simpledialog
 
 from dotenv import load_dotenv, set_key
 
@@ -20,7 +19,6 @@ def setUpClass(cls) -> None:
         used in the following tests.
         """
         cls.username, cls.password = os.environ['SAP_LOGIN'].split(';')
-        cls.new_password = simpledialog.askstring("Enter new password", "Enter the new password to be used in testing the change SAP password function.\nRemember to write down the new password!\nLeave empty to skip test_change_password.")
 
     def setUp(self) -> None:
         sap_login.kill_sap()
@@ -44,17 +42,19 @@ def test_change_password(self):
         Due to a limit in SAP you can only run this function once per day.
         If no new_password is entered in the setup, test is skipped.
         """
-        if not self.new_password:
-            raise unittest.SkipTest("Test not run because new_password was missing.")
+        new_password = os.getenv('SAP_NEW_PASSWORD')
+        if not new_password:
+            raise unittest.SkipTest("Test skipped because SAP_NEW_PASSWORD was missing.")
+
+        sap_login.change_password(self.username, self.password, new_password)
 
-        sap_login.change_password(self.username, self.password, self.new_password)
         # Change password for all coming tests
-        self.password = self.new_password
-        os.environ['SAP_LOGIN'] = f"{self.username};{self.password}"
-        set_key(".env", 'SAP_LOGIN', self.password)
+        self.password = new_password
+        set_key(".env", 'SAP_LOGIN', f"{self.username};{self.password}")
+        set_key(".env", 'SAP_NEW_PASSWORD', '')
 
         with self.assertRaises(ValueError):
-            sap_login.change_password(self.username, "Foo", self.new_password)
+            sap_login.change_password(self.username, "Foo", new_password)
 
         with self.assertRaises(ValueError):
             sap_login.change_password(self.username, self.password, "")