robo_appian 0.0.10__tar.gz → 0.0.11__tar.gz

{robo_appian-0.0.10 → robo_appian-0.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: robo_appian
-Version: 0.0.10
+Version: 0.0.11
 Summary: Automate your Appian code testing with Python. Boost quality, save time.
 Author: Dinil Mithra
 Author-email: dinilmithra@mailme@gmail.com

{robo_appian-0.0.10 → robo_appian-0.0.11}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "robo_appian"
-version = "0.0.10"
+version = "0.0.11"
 description = "Automate your Appian code testing with Python. Boost quality, save time."
 authors = ["Dinil Mithra <dinilmithra@mailme@gmail.com>"]
 readme = "README.md"

{robo_appian-0.0.10 → robo_appian-0.0.11}/robo_appian/components/ButtonUtils.py

@@ -4,49 +4,13 @@ from selenium.webdriver.support.ui import WebDriverWait
 
 
 class ButtonUtils:
-    """
-    Utility class for interacting with button elements in Selenium-based Appian UI automation.
-
-        Usage Example:
-
-        from selenium.webdriver.support.ui import WebDriverWait
-        from robo_appian.components.ButtonUtils import ButtonUtils
-
-        wait = WebDriverWait(driver, 10)
-        ButtonUtils.click(wait, "Login")
-
-    """
-
     @staticmethod
     def find(wait: WebDriverWait, label: str):
-        """
-        Finds a button element by its label.
-
-        Parameters:
-            wait: Selenium WebDriverWait instance.
-            label: The visible text label of the button.
-
-        Returns:
-            The Selenium WebElement for the button.
-
-        Example:
-            ButtonUtils.find(wait, "Submit")
-
-        """
-
-        # This method locates a button that contains a span with the specified label text.
-
         xpath = f".//button[./span[contains(translate(normalize-space(.), '\u00a0', ' '), '{label}')]]"
         try:
             component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
-        except TimeoutError as e:
-            raise TimeoutError(
-                f"Button with label '{label}' not found or not clickable."
-            ) from e
         except Exception as e:
-            raise RuntimeError(
-                f"Button with label '{label}' not found or not clickable."
-            ) from e
+            raise RuntimeError(f"Button with label '{label}' not found or not clickable.") from e
         return component
 
     @staticmethod
@@ -80,12 +44,8 @@ class ButtonUtils:
         try:
             component = wait.until(EC.element_to_be_clickable((By.ID, id)))
         except TimeoutError as e:
-            raise TimeoutError(
-                f"Input button with id '{id}' not found or not clickable."
-            ) from e
+            raise TimeoutError(f"Input button with id '{id}' not found or not clickable.") from e
         except Exception as e:
-            raise RuntimeError(
-                f"Input button with id '{id}' not found or not clickable."
-            ) from e
+            raise RuntimeError(f"Input button with id '{id}' not found or not clickable.") from e
 
         component.click()

robo_appian-0.0.11/robo_appian/components/DropdownUtils.py

@@ -0,0 +1,132 @@
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.remote.webelement import WebElement
+from selenium.common.exceptions import NoSuchElementException
+
+
+class DropdownUtils:
+    """
+    Utility class for interacting with dropdown components in Appian UI.
+    Usage Example:
+        # Select a value from a dropdown
+        from robo_appian.components.DropdownUtils import DropdownUtils
+        DropdownUtils.selectDropdownValueByLabelText(wait, "Status", "Approved")
+    """
+
+    @staticmethod
+    def __findComboboxByPartialLabelText(wait: WebDriverWait, label: str):
+        xpath = f'.//div[./div/span[contains(normalize-space(text()), "{label}")]]/div/div/div/div[@role="combobox" and not(@aria-disabled="true")]'
+        try:
+            component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+        except Exception as e:
+            raise Exception(f'Could not find combobox with partial label "{label}" : {str(e)}')
+
+        return component
+
+    @staticmethod
+    def __findComboboxByLabelText(wait: WebDriverWait, label: str):
+        xpath = f'.//div[./div/span[normalize-space(text())="{label}"]]/div/div/div/div[@role="combobox" and not(@aria-disabled="true")]'
+        try:
+            component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+        except Exception as e:
+            raise Exception(f'Could not find combobox with label "{label}" : {str(e)}')
+
+        return component
+
+    @staticmethod
+    def __clickCombobox(wait: WebDriverWait, combobox: WebElement):
+        combobox.click()
+
+    @staticmethod
+    def __findDropdownOptionId(wait: WebDriverWait, combobox: WebElement):
+        dropdown_option_id = combobox.get_attribute("aria-controls")
+        if dropdown_option_id is None:
+            raise Exception('Dropdown component does not have a valid "aria-controls" attribute.')
+        return dropdown_option_id
+
+    @staticmethod
+    def __checkDropdownOptionValueExistsByDropdownOptionId(wait: WebDriverWait, dropdown_option_id: str, value: str):
+        option_xpath = f'.//div/ul[@id="{dropdown_option_id}"]/li[./div[normalize-space(text())="{value}"]]'
+        try:
+            wait.until(EC.element_to_be_clickable((By.XPATH, option_xpath)))
+            return True
+        except NoSuchElementException:
+            return False
+        except Exception as e:
+            raise Exception(f'Could not find dropdown option "{value}" with dropdown option id "{dropdown_option_id}": {str(e)}')
+
+    @staticmethod
+    def __selectDropdownValueByDropdownOptionId(wait: WebDriverWait, dropdown_option_id: str, value: str):
+        option_xpath = f'.//div/ul[@id="{dropdown_option_id}"]/li[./div[normalize-space(text())="{value}"]]'
+        try:
+            try:
+                component = wait.until(EC.presence_of_element_located((By.XPATH, option_xpath)))
+                component = wait.until(EC.element_to_be_clickable((By.XPATH, option_xpath)))
+            except Exception as e:
+                raise Exception(
+                    f'Could not locate or click dropdown option "{value}" with dropdown option id "{dropdown_option_id}": {str(e)}'
+                )
+        except Exception as e:
+            raise Exception(f'Could not find or click dropdown option "{value}" with xpath "{option_xpath}": {str(e)}')
+        component.click()
+
+    @staticmethod
+    def __selectDropdownValueByPartialLabelText(wait: WebDriverWait, label: str, value: str):
+        """
+        Selects a value from a dropdown by its label text.
+
+        :param wait: WebDriverWait instance to wait for elements.
+        :param label: The label of the dropdown.
+        :param value: The value to select from the dropdown.
+        """
+        combobox = DropdownUtils.__findComboboxByPartialLabelText(wait, label)
+        DropdownUtils.__clickCombobox(wait, combobox)
+        dropdown_option_id = DropdownUtils.__findDropdownOptionId(wait, combobox)
+        DropdownUtils.__selectDropdownValueByDropdownOptionId(wait, dropdown_option_id, value)
+
+    @staticmethod
+    def __selectDropdownValueByLabelText(wait: WebDriverWait, label: str, value: str):
+        """
+        Selects a value from a dropdown by its label text.
+
+        :param wait: WebDriverWait instance to wait for elements.
+        :param label: The label of the dropdown.
+        :param value: The value to select from the dropdown.
+        """
+        combobox = DropdownUtils.__findComboboxByLabelText(wait, label)
+        DropdownUtils.__clickCombobox(wait, combobox)
+        dropdown_option_id = DropdownUtils.__findDropdownOptionId(wait, combobox)
+        DropdownUtils.__selectDropdownValueByDropdownOptionId(wait, dropdown_option_id, value)
+
+    @staticmethod
+    def checkReadOnlyStatusByLabelText(wait: WebDriverWait, label: str):
+        xpath = f'.//div[./div/span[normalize-space(text())="{label}"]]/div/div/p[text()]'
+        try:
+            wait._driver.find_element(By.XPATH, xpath)
+            return True
+        except NoSuchElementException:
+            return False
+        except Exception:
+            raise Exception(f'Error checking read-only status for label "{label}"')
+
+    @staticmethod
+    def selectDropdownValueByComboboxComponent(wait: WebDriverWait, combobox: WebElement, value: str):
+        dropdown_option_id = DropdownUtils.__findDropdownOptionId(wait, combobox)
+        DropdownUtils.__clickCombobox(wait, combobox)
+        DropdownUtils.__selectDropdownValueByDropdownOptionId(wait, dropdown_option_id, value)
+
+    @staticmethod
+    def selectDropdownValueByLabelText(wait: WebDriverWait, dropdown_label: str, value: str):
+        DropdownUtils.__selectDropdownValueByLabelText(wait, dropdown_label, value)
+
+    @staticmethod
+    def selectDropdownValueByPartialLabelText(wait: WebDriverWait, dropdown_label: str, value: str):
+        DropdownUtils.__selectDropdownValueByPartialLabelText(wait, dropdown_label, value)
+
+    @staticmethod
+    def checkDropdownOptionValueExists(wait: WebDriverWait, dropdown_label: str, value: str):
+        combobox = DropdownUtils.__findComboboxByLabelText(wait, dropdown_label)
+        DropdownUtils.__clickCombobox(wait, combobox)
+        dropdown_option_id = DropdownUtils.__findDropdownOptionId(wait, combobox)
+        return DropdownUtils.__checkDropdownOptionValueExistsByDropdownOptionId(wait, dropdown_option_id, value)

robo_appian-0.0.11/robo_appian/components/SearchDropdownUtils.py

@@ -0,0 +1,75 @@
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.common.by import By
+from robo_appian.components.InputUtils import InputUtils
+
+
+class SearchDropdownUtils:
+    """
+    Utility class for interacting with search dropdown components in Appian UI.
+    Usage Example:
+        # Select a value from a search dropdown
+        from robo_appian.components.SearchDropdownUtils import SearchDropdownUtils
+        SearchDropdownUtils.selectSearchDropdownValueByLabelText(wait, "Status", "Approved")
+    """
+
+    @staticmethod
+    def __selectSearchDropdownValueByDropdownOptionId(wait, component_id, dropdown_option_id, value):
+        input_component_id = str(component_id) + "_searchInput"
+        try:
+            input_component = wait.until(EC.element_to_be_clickable((By.ID, input_component_id)))
+        except Exception as e:
+            raise RuntimeError(f"Failed to locate or click input component with ID '{input_component_id}': {e}")
+        InputUtils._setComponentValue(input_component, value)
+
+        xpath = f'.//ul[@id="{dropdown_option_id}"]/li[./div[normalize-space(text())="{value}"]][1]'
+        try:
+            component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+        except Exception as e:
+            raise RuntimeError(f"Failed to locate or click dropdown option with XPath '{xpath}': {e}")
+        component.click()
+
+    @staticmethod
+    def __selectSearchDropdownValueByPartialLabelText(wait: WebDriverWait, label: str, value: str):
+        xpath = f'.//div[./div/span[contains(normalize-space(text()), "{label}")]]/div/div/div/div[@role="combobox" and not(@aria-disabled="true")]'
+        try:
+            component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+        except Exception as e:
+            raise RuntimeError(f"Failed to locate or click dropdown component with XPath '{xpath}': {e}")
+        component_id = component.get_attribute("aria-labelledby")
+        dropdown_id = component.get_attribute("aria-controls")
+        component.click()
+
+        SearchDropdownUtils.__selectSearchDropdownValueByDropdownOptionId(wait, component_id, dropdown_id, value)
+
+    @staticmethod
+    def __selectSearchDropdownValueByLabelText(wait: WebDriverWait, label: str, value: str):
+        xpath = f'.//div[./div/span[normalize-space(text())="{label}"]]/div/div/div/div[@role="combobox" and not(@aria-disabled="true")]'
+        try:
+            component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+        except Exception as e:
+            raise RuntimeError(f"Failed to locate or click dropdown component with XPath '{xpath}': {e}")
+        component_id = component.get_attribute("aria-labelledby")
+        dropdown_option_id = component.get_attribute("aria-controls")
+        component.click()
+        SearchDropdownUtils.__selectSearchDropdownValueByDropdownOptionId(wait, component_id, dropdown_option_id, value)
+
+    @staticmethod
+    def selectSearchDropdownValueByLabelText(wait: WebDriverWait, dropdown_label: str, value: str):
+        """Selects a value from a search dropdown by label text.
+        Args:
+            wait (WebDriverWait): The WebDriverWait instance to use for waiting.
+            dropdown_label (str): The label text of the dropdown.
+            value (str): The value to select from the dropdown.
+        """
+        SearchDropdownUtils.__selectSearchDropdownValueByLabelText(wait, dropdown_label, value)
+
+    @staticmethod
+    def selectSearchDropdownValueByPartialLabelText(wait: WebDriverWait, dropdown_label: str, value: str):
+        """Selects a value from a search dropdown by partial label text.
+        Args:
+            wait (WebDriverWait): The WebDriverWait instance to use for waiting.
+            dropdown_label (str): The label text of the dropdown.
+            value (str): The value to select from the dropdown.
+        """
+        SearchDropdownUtils.__selectSearchDropdownValueByPartialLabelText(wait, dropdown_label, value)

{robo_appian-0.0.10 → robo_appian-0.0.11}/robo_appian/controllers/ComponentDriver.py

@@ -7,6 +7,7 @@ from robo_appian.components.LabelUtils import LabelUtils
 from robo_appian.components.LinkUtils import LinkUtils
 from robo_appian.components.TabUtils import TabUtils
 from robo_appian.components.SearchInputUtils import SearchInputUtils
+from robo_appian.components.SearchDropdownUtils import SearchDropdownUtils
 
 
 class ComponentDriver:
@@ -49,9 +50,7 @@ class ComponentDriver:
             case "Search Input Text":
                 match action:
                     case "Select":
-                        SearchInputUtils.selectSearchDropdownByLabelText(
-                            wait, label, value
-                        )
+                        SearchInputUtils.selectSearchDropdownByLabelText(wait, label, value)
                     case _:
                         raise ValueError(f"Unsupported action for {type}: {action}")
             case "Label":
@@ -75,9 +74,7 @@ class ComponentDriver:
             case "Search Drop Down":
                 match action:
                     case "Select":
-                        DropdownUtils.selectSearchDropdownValueByLabelText(
-                            wait, label, value
-                        )
+                        SearchDropdownUtils.selectSearchDropdownValueByLabelText(wait, label, value)
                     case _:
                         raise ValueError(f"Unsupported action for {type}: {action}")
             case "Button":

{robo_appian-0.0.10 → robo_appian-0.0.11}/robo_appian/utils/ComponentUtils.py

@@ -4,6 +4,7 @@ from selenium.webdriver.common.by import By
 from selenium.webdriver.common.keys import Keys
 from selenium.webdriver.support import expected_conditions as EC
 from selenium.webdriver.remote.webdriver import WebDriver
+from selenium.webdriver.remote.webelement import WebElement
 from selenium.webdriver.support.ui import WebDriverWait
 
 
@@ -37,6 +38,10 @@ class ComponentUtils:
         yesterday_formatted = yesterday.strftime("%m/%d/%Y")
         return yesterday_formatted
 
+    @staticmethod
+    def findChildComponent(wait: WebDriverWait, component: WebElement, xpath: str):
+        return component.find_element(By.XPATH, xpath)
+
     @staticmethod
     def findSuccessMessage(wait: WebDriverWait, message: str):
         """
@@ -161,9 +166,7 @@ class ComponentUtils:
         length = 0
 
         try:
-            component = wait.until(
-                EC.presence_of_all_elements_located((By.XPATH, xpath))
-            )
+            component = wait.until(EC.presence_of_all_elements_located((By.XPATH, xpath)))
             length = len(component)
         except NoSuchElementException:
             pass

robo_appian-0.0.10/robo_appian/components/DropdownUtils.py

@@ -1,177 +0,0 @@
-from selenium.webdriver.common.by import By
-from selenium.webdriver.support import expected_conditions as EC
-from selenium.webdriver.support.ui import WebDriverWait
-from selenium.webdriver.remote.webelement import WebElement
-
-from robo_appian.components.InputUtils import InputUtils
-
-
-class DropdownUtils:
-    """
-    Utility class for interacting with dropdown components in Appian UI.
-
-        Usage Example:
-
-        # Select a value from a dropdown
-        from robo_appian.components.DropdownUtils import DropdownUtils
-        DropdownUtils.selectDropdownValueByLabelText(wait, "Status", "Approved")
-
-        # Select a value from a search dropdown
-        from robo_appian.components.DropdownUtils import DropdownUtils
-        DropdownUtils.selectSearchDropdownValueByLabelText(wait, "Category", "Finance")
-    """
-
-    @staticmethod
-    def __findDropdownComponentsByXpath(wait: WebDriverWait, xpath: str):
-        try:
-            # Wait for at least one element to be present
-            try:
-                wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
-            except TimeoutError as e:
-                raise TimeoutError(
-                    f'No clickable dropdown component found for xpath "{xpath}": {str(e)}'
-                )
-            except Exception as e:
-                raise Exception(
-                    f'No clickable dropdown component found for xpath "{xpath}": {str(e)}'
-                )
-
-            # Find all matching elements
-            driver = wait._driver
-            components = driver.find_elements(By.XPATH, xpath)
-
-            # Filter for clickable and displayed components
-            valid_components = []
-            for component in components:
-                try:
-                    if component.is_displayed() and component.is_enabled():
-                        valid_components.append(component)
-                except Exception:
-                    continue
-
-            if not valid_components:
-                raise Exception(
-                    f'No valid dropdown components with xpath "{xpath}" found.'
-                )
-
-            # Return single component if only one found, list if multiple
-            return valid_components
-
-        except Exception as e:
-            raise Exception(
-                f'Dropdown component with xpath "{xpath}" not found: {str(e)}'
-            )
-
-    @staticmethod
-    def selectDropdownValueByComponent(wait, combobox, value):
-        dropdown_id = combobox.get_attribute("aria-controls")
-        combobox.click()
-
-        option_xpath = f'.//div/ul[@id="{dropdown_id}"]/li[./div[normalize-space(text())="{value}"]]'
-        try:
-            component = wait.until(
-                EC.presence_of_element_located((By.XPATH, option_xpath))
-            )
-            component = wait.until(EC.element_to_be_clickable((By.XPATH, option_xpath)))
-        except TimeoutError as e:
-            raise TimeoutError(
-                f'Could not find or click dropdown option "{value}" with xpath "{option_xpath}": {str(e)}'
-            )
-        except Exception as e:
-            raise Exception(
-                f'Could not find or click dropdown option "{value}" with xpath "{option_xpath}": {str(e)}'
-            )
-        component.click()
-
-    @staticmethod
-    def __selectDropdownValueByXpath(wait, xpath, value):
-        components = DropdownUtils.__findDropdownComponentsByXpath(wait, xpath)
-        for combobox in components:
-            if combobox.is_displayed() and combobox.is_enabled():
-                DropdownUtils.selectDropdownValueByComponent(wait, combobox, value)
-
-    @staticmethod
-    def selectDropdownValueByLabelText(
-        wait: WebDriverWait, dropdown_label: str, value: str
-    ):
-        xpath = f'.//div[./div/span[normalize-space(text())="{dropdown_label}"]]/div/div/div/div[@role="combobox" and @tabindex="0"]'
-        DropdownUtils.__selectDropdownValueByXpath(wait, xpath, value)
-
-    @staticmethod
-    def selectDropdownValueByPartialLabelText(
-        wait: WebDriverWait, dropdown_label: str, value: str
-    ):
-        xpath = f'.//div[./div/span[contains(normalize-space(text()), "{dropdown_label}")]]/div/div/div/div[@role="combobox" and @tabindex="0"]'
-        DropdownUtils.__selectDropdownValueByXpath(wait, xpath, value)
-
-    @staticmethod
-    def __selectSearchDropdownValueByXpath(wait, xpath, value):
-        components = DropdownUtils.__findDropdownComponentsByXpath(wait, xpath)
-
-        for component in components:
-            if component.is_displayed() and component.is_enabled():
-                component_id = component.get_attribute("aria-labelledby")  # type: ignore[reportUnknownMemberType]
-                dropdown_id = component.get_attribute("aria-controls")  # type: ignore[reportUnknownMemberType]
-                component.click()
-
-                input_component_id = str(component_id) + "_searchInput"
-                try:
-                    input_component = wait.until(
-                        EC.element_to_be_clickable((By.ID, input_component_id))
-                    )
-                except TimeoutError as e:
-                    raise TimeoutError(
-                        f'Could not find or click search input component with id "{input_component_id}": {str(e)}'
-                    )
-                except Exception as e:
-                    raise Exception(
-                        f'Could not find or click search input component with id "{input_component_id}": {str(e)}'
-                    )
-                InputUtils._setComponentValue(input_component, value)
-
-                xpath = f'.//ul[@id="{dropdown_id}"]/li[./div[normalize-space(text())="{value}"]][1]'
-                try:
-                    component = wait.until(
-                        EC.element_to_be_clickable((By.XPATH, xpath))
-                    )
-                except TimeoutError as e:
-                    raise TimeoutError(
-                        f'Could not find or click search dropdown option "{value}" with xpath "{xpath}": {str(e)}'
-                    )
-                except Exception as e:
-                    raise Exception(
-                        f'Could not find or click search dropdown option "{value}" with xpath "{xpath}": {str(e)}'
-                    )
-                component.click()
-
-    @staticmethod
-    def selectSearchDropdownValueByLabelText(
-        wait: WebDriverWait, dropdown_label: str, value: str
-    ):
-        xpath = f'.//div[./div/span[normalize-space(text())="{dropdown_label}"]]/div/div/div/div[@role="combobox" and @tabindex="0"]'
-        DropdownUtils.__selectSearchDropdownValueByXpath(wait, xpath, value)
-
-    @staticmethod
-    def selectSearchDropdownValueByPartialLabelText(
-        wait: WebDriverWait, dropdown_label: str, value: str
-    ):
-        xpath = f'.//div[./div/span[contains(normalize-space(text()), "{dropdown_label}")]]/div/div/div/div[@role="combobox" and @tabindex="0"]'
-        DropdownUtils.__selectSearchDropdownValueByXpath(wait, xpath, value)
-
-    @staticmethod
-    def selectValueByDropdownWrapperComponent(
-        wait: WebDriverWait, component: WebElement, value: str
-    ):
-        xpath = './div/div[@role="combobox" and @tabindex="0"]'
-        try:
-            combobox = component.find_element(By.XPATH, xpath)
-        except TimeoutError as e:
-            raise TimeoutError(
-                f'Could not find combobox element with xpath "{xpath}" in the provided component: {str(e)}'
-            )
-        except Exception as e:
-            raise Exception(
-                f'Could not find combobox element with xpath "{xpath}" in the provided component: {str(e)}'
-            )
-        DropdownUtils.selectDropdownValueByComponent(wait, combobox, value)
-        return combobox