Merge pull request #32 from itk-dev-rpa/release/1.3.0

Release/1.3.0

Author: ghbm-itk

.github/workflows/Linting.yml

@@ -10,9 +10,9 @@ jobs:
         python-version: ["3.11"]
       fail-fast: false
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 

changelog.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.0] - 2024-02-20
+
+### Added
+
+- SAP.fmcacov module 
+  - Function to dismiss "key-popup" in SAP.
+  - Function to reliably open forretningspartners in SAP.
+- Test for all of the above.
+
+### Changed
+
+- opret_kundekontakt uses the new SAP.fmcacov module.
+- Updated Github actions dependencies.
+
+### Removed
+
+- SAP login using web portal. Wasn't used or maintained.
+
 ## [1.2.0] - 2024-02-12
 
 ### Added
@@ -43,7 +61,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.2.0...HEAD
+[Unreleased] https://github.com/itk-dev-rpa/ITK-dev-shared-components/compare/1.3.0...HEAD
+[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/sap/fmcacov.py

@@ -0,0 +1,76 @@
+"""This module contains functions to help with actions in the fmcacov transaction."""
+
+
+def open_forretningspartner(session, fp: str) -> None:
+    """Start the transaction FMCACOV and open the given forretningspartner.
+    If the fp-number also matches a cvr-number the fp-number will be opened.
+
+    Args:
+        session: The SAP session to perform the action.
+        fp: The forretningspartner number.
+
+    Raises:
+        ValueError: If the forretningspartner wasn't found.
+    """
+    session.StartTransaction('fmcacov')
+
+    # Find forretningspartner
+    session.findById("wnd[0]/usr/ctxtGPART_DYN").text = fp
+    session.findById("wnd[0]").sendVKey(0)
+
+    # Detect window "Forretningspartner * Entries"
+    if session.findById('wnd[1]/usr', False) is not None:
+        # Pop-up detected
+        for row_id in range(3, 5):
+            fp_row = session.FindById(f'wnd[1]/usr/lbl[103,{row_id}]')
+            if fp_row.text == fp:
+                fp_row.SetFocus()
+                # Press 'Accept' button.
+                session.FindById('wnd[1]/tbar[0]/btn[0]').press()
+                break
+        else:
+            # Range exhausted
+            raise ValueError(f"Forretningspartner '{fp}' was not found in pop-up.")
+
+
+def dismiss_key_popup(session, fp: str = "25564617") -> None:
+    """Once a day a popup appears asking to generate a new "afstemningsnøgle".
+    This function forces it to appear and clicks "Ja" on it.
+    This is done by pretending to do "Kontovedligehold" on the given forretningspartner.
+    The function should start and end at the home screen.
+
+    Args:
+        session: The SAP session object.
+        fp: The forretningspartner to used. Defaults to "25564617" a fictional person in AAK.
+
+    Raises:
+        RuntimeError: If a popup other than the expected ones appear.
+    """
+    open_forretningspartner(session, fp)
+
+    # Right click the first row in the postliste and click "Kontovedligehold med filter"
+    postliste = session.findById("wnd[0]/usr/tabsDATA_DISP/tabpDATA_DISP_FC1/ssubDATA_DISP_SCA:RFMCA_COV:0202/cntlRFMCA_COV_0100_CONT5/shellcont/shell")
+    postliste.setCurrentCell(0, "VTREF")
+    postliste.contextMenu()
+    postliste.selectContextMenuItem("ACC_MAINT_FILTER")
+
+    # Check if the key popup appeared
+    popup = session.findbyid("wnd[1]", False)
+    if popup:
+        if popup.text == "Kontrol af afstemningsnøgle":
+            # Press "Ja"
+            session.findbyid("wnd[1]/usr/btnSPOP-OPTION1").press()
+        else:
+            raise RuntimeError(f"Another popup is blocking: {popup.text}")
+
+        # Check and dismiss confirmation dialog
+        confirmation_text = session.findbyid("wnd[1]/usr/txtMESSTXT1").text
+        if 'oprettet' in confirmation_text:
+            session.findById("wnd[1]/tbar[0]/btn[0]").press()
+        else:
+            raise RuntimeError(f"Confirmation dialog wasn't as expected: {confirmation_text}.")
+
+    # Go back to home screen (Afbryd x 3)
+    session.findById("wnd[0]/tbar[0]/btn[12]").press()
+    session.findById("wnd[0]/tbar[0]/btn[12]").press()
+    session.findById("wnd[0]/tbar[0]/btn[12]").press()

itk_dev_shared_components/sap/gridview_util.py

@@ -1,5 +1,7 @@
 """This module provides static functions to perform common tasks with SAP GuiGridView COM objects."""
 
+from typing import Iterator
+
 
 def scroll_entire_table(grid_view, return_to_top=False) -> None:
     """This function scrolls through the entire table to load all cells.
@@ -72,7 +74,7 @@ def get_row(grid_view, row: int, scroll_to_row=False) -> tuple[str]:
     return tuple(row_data)
 
 
-def iterate_rows(grid_view) -> tuple[str]:
+def iterate_rows(grid_view) -> Iterator[tuple[str]]:
     """This generator yields each row of the table in order.
     This is preferable to loading all rows as this will only load a row when it's needed.
     As a side effect this function scrolls the yielded row into view, so the

itk_dev_shared_components/sap/opret_kundekontakt.py

@@ -5,7 +5,7 @@
 
 import win32clipboard
 
-from itk_dev_shared_components.sap import tree_util
+from itk_dev_shared_components.sap import tree_util, fmcacov
 
 
 def opret_kundekontakter(session, fp: str, aftaler: list[str] | None,
@@ -24,11 +24,7 @@ def opret_kundekontakter(session, fp: str, aftaler: list[str] | None,
     Raises:
         RuntimeError: If the kundekontakt wasn't created.
     """
-    session.StartTransaction('fmcacov')
-
-    # Find forretningspartner
-    session.findById("wnd[0]/usr/ctxtGPART_DYN").text = fp
-    session.findById("wnd[0]").sendVKey(0)
+    fmcacov.open_forretningspartner(session, fp)
 
     # Click 'Opret kundekontakt-flere
     session.findById("wnd[0]/shellcont/shell").nodeContextMenu("GP0000000001")

itk_dev_shared_components/sap/sap_login.py

@@ -2,67 +2,15 @@
 as well as a function to change user passwords."""
 
 import os
-import pathlib
 import subprocess
 import time
 
-from selenium import webdriver
-from selenium.webdriver.common.by import By
 import pywintypes
 import win32com.client
 
 from itk_dev_shared_components.sap import multi_session
 
 
-def login_using_portal(username: str, password: str):
-    """Open KMD Portal in Edge, login and start SAP GUI.
-    Args:
-        user: KMD Portal username.
-        password: KMD Portal password.
-    """
-    driver = webdriver.Chrome()
-    driver.implicitly_wait(10)
-    driver.get('https://portal.kmd.dk/irj/portal')
-    driver.maximize_window()
-
-    # Login
-    user_field = driver.find_element(By.ID, 'logonuidfield')
-    pass_field = driver.find_element(By.ID, 'logonpassfield')
-    login_button = driver.find_element(By.ID, 'buttonLogon')
-    user_field.clear()
-    user_field.send_keys(username)
-    pass_field.clear()
-    pass_field.send_keys(password)
-    login_button.click()
-
-    # Opus
-    mine_genveje = driver.find_element(By.CSS_SELECTOR, "div[title='Mine Genveje']")
-    mine_genveje.click()
-
-    # Wait for download and launch file
-    _wait_for_download()
-
-    driver.quit()
-    _wait_for_sap_session(10)
-
-
-def _wait_for_download():
-    """Private function that checks if the SAP.erp file has been downloaded.
-    Raises:
-        TimeoutError: If the file hasn't been downloaded within 5 seconds.
-    """
-    downloads_folder = str(pathlib.Path.home() / "Downloads")
-    for _ in range(10):
-        for file in os.listdir(downloads_folder):
-            if file.endswith(".sap"):
-                path = os.path.join(downloads_folder, file)
-                os.startfile(path)
-                return
-
-        time.sleep(0.5)
-    raise TimeoutError(f".sap file not found in {downloads_folder}")
-
-
 def login_using_cli(username: str, password: str, client: str = '751', system: str = 'P02', timeout: int = 10) -> None:
     """Open and login to SAP with commandline expressions.
     Args:

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "itk_dev_shared_components"
-version = "1.2.0"
+version = "1.3.0"
 authors = [
   { name="ITK Development", email="itk-rpa@mkb.aarhus.dk" },
 ]
@@ -18,7 +18,6 @@ classifiers = [
 ]
 dependencies = [
   "pywin32 >= 306",
-  "selenium >= 4.10.0",
   "msal >= 1.24.1",
   "requests >= 2.31.0",
   "beautifulsoup4 >= 4.12.2"

tests/test_sap/test_fmcacov.py

@@ -0,0 +1,50 @@
+"""Tests relating to the module SAP.fmcacov."""
+
+import unittest
+import os
+from itk_dev_shared_components.sap import fmcacov, sap_login, multi_session
+
+# Some tests might look similar, and we want this. pylint: disable=duplicate-code
+
+
+class TestFmcacov(unittest.TestCase):
+    """Tests relating to the module SAP.fmcacov."""
+    @classmethod
+    def setUpClass(cls):
+        """Launch SAP and get the main session."""
+        sap_login.kill_sap()
+
+        user, password = os.environ['SAP Login'].split(';')
+        sap_login.login_using_cli(user, password)
+
+        cls.session = multi_session.get_all_sap_sessions()[0]
+
+    @classmethod
+    def tearDownClass(cls):
+        sap_login.kill_sap()
+
+    def test_find_forretningspartner(self):
+        """Find a test-person in fmcacov and check cpr and name.
+        To properly test it the fp needs to match a cvr number, but that doesn't exist
+        as test data.
+        """
+        fmcacov.open_forretningspartner(self.session, "25564617")
+
+        cpr = self.session.findById("wnd[0]/usr/txtZDKD_BP_NUM").text
+        self.assertEqual(cpr, '841289-3981')
+
+        name = self.session.findById("wnd[0]/usr/subHEAD_DATA_SUBSCREEN:SAPLZDKD_SUBSCREENS:0100/txtBUS000FLDS-DESCRIP").text
+        self.assertEqual(name, 'Testbruger Et')
+
+        # Go back to home screen.
+        self.session.findById("wnd[0]/tbar[0]/btn[12]").press()
+
+    def test_dismiss_key_popup(self):
+        """Try to find 'afstemningsnøgle'-popup and dismiss it.
+        The popup only appears once a day after midnight.
+        """
+        fmcacov.dismiss_key_popup(self.session)
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/test_sap/test_gridview_util.py

@@ -70,7 +70,7 @@ def test_get_column_titles(self):
     def test_find_row_index_by_value(self):
         """Test finding a single row by column value."""
         # Test finding an actual value.
-        index = gridview_util.find_row_index_by_value(self.table, "TXTU2", "Test Deltrans")
+        index = gridview_util.find_row_index_by_value(self.table, "TXTU2", "Test deltrans")
         self.assertNotEqual(index, -1)
 
         # Test NOT finding a wrong value.
@@ -94,3 +94,7 @@ def test_find_all_row_indices_by_value(self):
         # Test error on wrong column name.
         with self.assertRaises(ValueError):
             gridview_util.find_all_row_indices_by_value(self.table, "Foo", "Bar")
+
+
+if __name__ == '__main__':
+    unittest.main()