#79 - New caching keywords

GDATASoftwareAG · Dec 28, 2022 · 1634d3f · 1634d3f
1 parent cd99a7a
commit 1634d3f
Showing 29 changed files with 268 additions and 71 deletions.
diff --git a/atests/Application.robot b/atests/Application.robot
@@ -9,7 +9,7 @@ Documentation   Test suite for application keywords.
 ...             Launch Application With Args          Launch Application With Arguments
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         StringFormat
 
 Resource        util/Common.robot

diff --git a/atests/Checkbox.robot b/atests/Checkbox.robot
@@ -7,7 +7,7 @@ Documentation   Test suite for checkbox keywords.
 ...             Get Checkbox State                    Get Checkbox State
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         StringFormat
 
 Resource        util/Common.robot

diff --git a/atests/Combobox.robot b/atests/Combobox.robot
@@ -17,7 +17,7 @@ Documentation   Test suite for combobox keywords.
 ...             Get Combobox Items Count              Get Combobox Items Count
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 Library         Collections

diff --git a/atests/Configuration.robot b/atests/Configuration.robot
@@ -0,0 +1,35 @@
+*** Settings ***
+Documentation   Test suite for configuration keywords.
+...             Keyword                               Test Case Names
+...             Enable Caching                        Enable Caching
+...             Disable Caching                       Disable Caching
+...             Refresh Cache                         Refresh Cache
+...             Is Cache Enabled                      Is Cache Enabled
+...
+
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
+
+*** Test Cases ***
+Is Cache Enabled
+   ${RESULT}  Is Cache Enabled
+   ${IDENTIFIER}  Get Uia Identifier
+   IF  '${IDENTIFIER}'=='UIA2'
+     Should Be Equal  ${TRUE}   ${RESULT}
+   ELSE
+     Should Be Equal  ${FALSE}  ${RESULT}
+   END
+
+Enable Caching
+   Enable Caching
+   ${RESULT}  Is Cache Enabled
+   Should Be Equal  ${TRUE}   ${RESULT}
+
+Disable Caching
+   Disable Caching
+   ${RESULT}  Is Cache Enabled
+   Should Be Equal  ${FALSE}   ${RESULT}
+
+Refresh Cache
+   Fail  TODO IMPLEMENT ME
+   ${IDENTIFIER}  Get Uia Identifier
+   Should Be Equal  ${IDENTIFIER}  ${UIA}
diff --git a/atests/Debug.robot b/atests/Debug.robot
@@ -6,7 +6,7 @@ Documentation   Test suite for debug keywords.
 ...             Get UIA Identifier                    Get UIA Identifier
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 

diff --git a/atests/Element.robot b/atests/Element.robot
@@ -30,7 +30,7 @@ Documentation   Test suite for element keywords.
 ...                                                           Wait Until Element Is Visible Timeout Is Reached By Wrong Number
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 Library         DateTime

diff --git a/atests/ErrorHandling.robot b/atests/ErrorHandling.robot
@@ -2,7 +2,7 @@
 Documentation   Error handling test suite for all common flaui keywords.
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  timeout=0
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  timeout=0  use_cache=${USE_CACHE}
 Library         StringFormat
 
 Resource        util/Error.robot

diff --git a/atests/Grid.robot b/atests/Grid.robot
@@ -13,7 +13,7 @@ Documentation   Test suite for grid ui keyword usage.
 ...             Get Grid Rows Count                   Get Grid Rows Count
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 

diff --git a/atests/Keyboard.robot b/atests/Keyboard.robot
@@ -14,7 +14,7 @@ Documentation   Test suite for keyboard keywords.
 ...                                                   False Argument Type
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 

diff --git a/atests/Listbox.robot b/atests/Listbox.robot
@@ -16,7 +16,7 @@ Documentation   Test suite for list box keywords.
 ...             Get Listbox Items Count               Get Listbox Items Count
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 Library         Collections

diff --git a/atests/Mouse.robot b/atests/Mouse.robot
@@ -9,7 +9,7 @@ Documentation   Test suite for mouse keywords.
 ...             Drag And Drop                         Drag And Drop
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         StringFormat
 
 Resource        util/Common.robot

diff --git a/atests/RadioButton.robot b/atests/RadioButton.robot
@@ -6,7 +6,7 @@ Documentation   Test suite for radio button keywords.
 ...             Get Radiobutton State                 Get Radiobutton State
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 

diff --git a/atests/Screenshot.robot b/atests/Screenshot.robot
@@ -9,7 +9,7 @@ Documentation   Test suite for screenshot keywords.
 ...                                                   Take Manual Screenshot By Keyword
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=True
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=True  use_cache=${USE_CACHE}
 Library         StringFormat
 Library         Process
 Library         String

diff --git a/atests/Tab.robot b/atests/Tab.robot
@@ -10,7 +10,7 @@ Documentation   Test suite for tab keywords.
 ...
 
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         StringFormat
 Library         Collections
 

diff --git a/atests/Textbox.robot b/atests/Textbox.robot
@@ -6,7 +6,7 @@ Documentation   Test suite for textbox keywords.
 ...             Set Text To Textbox                   Set Text To Textbox
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 

diff --git a/atests/Tree.robot b/atests/Tree.robot
@@ -27,7 +27,7 @@ Documentation   Test suite for list box keywords.
 ...             Selected TreeItem Should Be           Selected TreeItem Should Be Item Not Exist
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 

diff --git a/atests/Window.robot b/atests/Window.robot
@@ -5,7 +5,7 @@ Documentation   Test suite for window keywords.
 ...             Close Window                          Close Window
 ...
 
-Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False
+Library         FlaUILibrary  uia=${UIA}  screenshot_on_failure=False  use_cache=${USE_CACHE}
 Library         Process
 Library         StringFormat
 

diff --git a/keen.bat b/keen.bat
@@ -28,13 +28,13 @@ EXIT /B %ERRORLEVEL%
 
 :test_uia2
     call cd atests
-    call robot --name "UIA2" --variable UIA:UIA2 --outputdir ../result/uia2 .
+    call robot --name "UIA2" --variable UIA:UIA2 --variable USE_CACHE:True --outputdir ../result/uia2 Configuration.robot
     call cd ..
 EXIT /B %ERRORLEVEL%
 
 :test_uia3
     call cd atests
-    call robot --name "UIA3" --variable UIA:UIA3 --outputdir ../result/uia3 .
+    call robot --name "UIA3" --variable UIA:UIA3 --variable USE_CACHE:False --outputdir ../result/uia3 Configuration.robot
     call cd ..
 EXIT /B %ERRORLEVEL%
 

diff --git a/src/FlaUILibrary/__init__.py b/src/FlaUILibrary/__init__.py
@@ -18,7 +18,7 @@
                                    RadioButtonKeywords,
                                    ListBoxKeywords,
                                    TreeKeywords,
-                                   TabKeywords)
+                                   TabKeywords, ConfigurationKeywords)
 from FlaUILibrary.flaui.interface.valuecontainer import ValueContainer
 from FlaUILibrary.robotframework import robotlog
 from FlaUILibrary.flaui.module import Screenshot
@@ -93,15 +93,17 @@ class KeywordModules(Enum):
         LISTBOX = "Listbox"
         TREE = "Tree"
         TAB = "Tab"
+        CONFIGURATION = "CONFIGURATION"
 
-    def __init__(self, uia='UIA3', screenshot_on_failure='True', screenshot_dir=None, timeout=1000):
+    def __init__(self, uia='UIA3', screenshot_on_failure='True', screenshot_dir=None, timeout=1000, use_cache='True'):
         """
         FlaUiLibrary can be imported by following optional arguments:
 
         ``uia`` Microsoft UI-Automation framework to use. UIA2 or UIA3
         ``screenshot_on_failure`` indicator to disable or enable screenshot feature.
         ``screenshot_dir`` is the directory where screenshots are saved.
         ``timeout`` maximum amount of waiting time in ms for an element find action. Default value is 1000ms.
+        ``use_cache`` flag to use cached elements. Default value is True.
 
         If the given directory does not already exist, it will be created when the first screenshot is taken.
         If the argument is not given, the default location for screenshots is the output directory of the Robot run,
@@ -111,16 +113,21 @@ def __init__(self, uia='UIA3', screenshot_on_failure='True', screenshot_dir=None
         self.mode = FlaUILibrary.RobotMode.TEST_NOT_RUNNING
         self.builtin = BuiltIn()
 
+        if use_cache == "False":
+            use_cache = False
+        else:
+            use_cache = True
+
         try:
             if timeout == "None" or int(timeout) <= 0:
                 timeout = 0
         except ValueError:
             timeout = 1000
 
         if uia == "UIA2":
-            self.module = UIA2(timeout)
+            self.module = UIA2(timeout, use_cache)
         else:
-            self.module = UIA3(timeout)
+            self.module = UIA3(timeout, use_cache)
 
         self.screenshots = Screenshot(screenshot_dir, screenshot_on_failure == 'True')
 
@@ -140,6 +147,7 @@ def __init__(self, uia='UIA3', screenshot_on_failure='True', screenshot_dir=None
             FlaUILibrary.KeywordModules.LISTBOX: ListBoxKeywords(self.module),
             FlaUILibrary.KeywordModules.TREE: TreeKeywords(self.module),
             FlaUILibrary.KeywordModules.TAB: TabKeywords(self.module),
+            FlaUILibrary.KeywordModules.CONFIGURATION: ConfigurationKeywords(self.module)
         }
 
         # Robot init

diff --git a/src/FlaUILibrary/flaui/automation/uia.py b/src/FlaUILibrary/flaui/automation/uia.py
@@ -14,11 +14,13 @@ class UIA(WindowsAutomationInterface, ABC):
     Generic window automation module for a centralized communication handling between robot keywords.
     """
 
-    def __init__(self, timeout=1000):
+    def __init__(self, timeout: int = 1000, use_cache=True):
         """
         Creates default UIA window automation module.
         ``timeout`` is the default waiting value to repeat element find action. Default value is 1000ms.
+        ``use_cache`` flag to use caching feature from elements. Default value is True.
         """
+        self._use_cache = use_cache
         self._actions = {}
         self._timeout = timeout
 
@@ -45,15 +47,23 @@ def action(self, action: Enum, values: ValueContainer = None, msg: str = None):
         except FlaUiError as error:
             raise FlaUiError(msg) if msg is not None else error
 
-    def register_action(self, automation: Any):
+    def register_action(self):
         """
         Register all supported core actions.
-
-        Args:
-            automation (Object)       : Windows user automation object.
         """
-        modules = [Application(automation), Debug(), Element(automation, self._timeout), Keyboard(), Selector(),
-                   Grid(), Mouse(), Textbox(), Tree(), ToggleButton(), Tab(), Window(automation), Combobox()]
+        modules = [Application(),
+                   Combobox(),
+                   Debug(),
+                   Element(self, self._timeout),
+                   Grid(),
+                   Keyboard(),
+                   Mouse(),
+                   Selector(),
+                   Tab(),
+                   Textbox(),
+                   ToggleButton(),
+                   Tree(),
+                   Window()]
 
         for module in modules:
             for value in module.Action:
@@ -77,6 +87,21 @@ def get_element(self, identifier: str, ui_type: InterfaceType = None, msg: str =
 
         return self.cast_element_to_type(element, ui_type)
 
+    def set_caching(self, enable: bool):
+        """
+        Enable or disable caching feature from windows automation interface.
+
+        Args:
+            enable : Boolean to enable or disable caching feature.
+        """
+        self._use_cache = enable
+
+    def is_cache_enabled(self):
+        """
+        Returns flag if cache is enabled or not.
+        """
+        return self._use_cache
+
     @staticmethod
     def cast_element_to_type(element: Any, ui_type: InterfaceType):
         """

diff --git a/src/FlaUILibrary/flaui/automation/uia2.py b/src/FlaUILibrary/flaui/automation/uia2.py
@@ -5,27 +5,55 @@
 class UIA2(UIA):
     """UIA2 window automation module for a centralized communication handling between robot keywords and Flaui. """
 
-    def __init__(self, timeout=1000):
+    def __init__(self, timeout=1000, use_cache=True):
         """
         Creates UIA2 window automation module.
         ``timeout`` is the default waiting value to repeat element find action. Default value is 1000ms.
+        ``use_cache`` flag to use caching feature from elements. Default value is True.
         """
-        super().__init__(timeout)
+        super().__init__(timeout, use_cache)
         self._uia2 = UIA2Automation()
-        super().register_action(self._uia2)  # pylint: disable=maybe-no-member
+        super().register_action()  # pylint: disable=maybe-no-member
 
     def __del__(self):
         """
         Destructor to clean up all C# interfaces
         """
-        try:
-            # C# --> class UIA2Automation : AutomationBase --> abstract class AutomationBase : IDisposable
-            self._uia2.Dispose()
-        except TypeError:
-            pass
+        self.dispose()
 
     def identifier(self):
         """
         Returns identifier which windows automation interface is in usage.
         """
         return "UIA2"
+
+    def get_desktop_element(self):
+        """
+        Returns desktop element from automation interface.
+        """
+        if self._use_cache:
+            return self._uia2.GetDesktop()
+
+        self.refresh_cache()
+        return self._uia2.GetDesktop()
+
+    def refresh_cache(self):
+        """
+        Refresh all desktop elements from windows automation interface.
+        """
+        self.dispose()
+        self._uia2 = UIA2Automation()
+
+    def dispose(self):
+        """
+        Dispose method to release user automation interface from FlaUI
+        """
+        if self._uia2 is None:
+            return
+
+        try:
+            # C# --> class UIA3Automation : AutomationBase --> abstract class AutomationBase : IDisposable
+            self._uia2.Dispose()
+            self._uia2 = None
+        except TypeError:
+            pass