robo_appian 0.0.4__tar.gz → 0.0.6__tar.gz

{robo_appian-0.0.4/robo_appian.egg-info → robo_appian-0.0.6}/PKG-INFO

@@ -1,43 +1,20 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.3
 Name: robo_appian
-Version: 0.0.4
-Summary: Selenium-based automation utilities for Appian applications
-Home-page: https://github.com/yourusername/robo_appian
-Author: Your Name
-Author-email: your.email@example.com
-Project-URL: Bug Reports, https://github.com/yourusername/robo_appian/issues
-Project-URL: Source, https://github.com/yourusername/robo_appian
-Project-URL: Documentation, https://robo-appian.readthedocs.io/
-Keywords: selenium,automation,testing,appian,ui
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Testing
-Classifier: Topic :: Software Development :: Quality Assurance
-Classifier: License :: OSI Approved :: MIT License
+Version: 0.0.6
+Summary: Automate your Appian code testing with Python. Boost quality, save time.
+Author: Dinil Mithra
+Author-email: dinilmithra@mailme@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: numpy
+Requires-Dist: requests (>=2.25.1,<3.0.0)
+Requires-Dist: selenium (>=4.34.0)
+Project-URL: Homepage, https://github.com/dinilmithra/robo_appian
+Project-URL: Repository, https://github.com/dinilmithra/robo_appian.git
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: selenium>=4.34.0
-Requires-Dist: requests>=2.25.0
-Requires-Dist: numpy>=1.21.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # Robo Appian
 

{robo_appian-0.0.4 → robo_appian-0.0.6}/pyproject.toml

@@ -1,7 +1,6 @@
 [tool.poetry]
-include = ["*.pyc"]
 name = "robo_appian"
-version = "0.0.4"
+version = "0.0.6"
 description = "Automate your Appian code testing with Python. Boost quality, save time."
 authors = ["Dinil Mithra <dinilmithra@mailme@gmail.com>"]
 readme = "README.md"
@@ -17,7 +16,6 @@ python = "^3.12"
 requests = "^2.25.1"
 numpy = "*"
 selenium = ">=4.34.0"
-pyarmor = ">=8.0.0"
 
 [tool.poetry.group.dev.dependencies]
 mkdocs = "^1.5.0"

robo_appian-0.0.6/robo_appian/__init__.py

@@ -0,0 +1,23 @@
+from robo_appian.components.ButtonUtils import ButtonUtils
+from robo_appian.utils.ComponentUtils import ComponentUtils
+from robo_appian.components.DateUtils import DateUtils
+from robo_appian.components.DropdownUtils import DropdownUtils
+from robo_appian.components.InputUtils import InputUtils
+from robo_appian.components.LabelUtils import LabelUtils
+from robo_appian.components.LinkUtils import LinkUtils
+from robo_appian.components.TableUtils import TableUtils
+from robo_appian.components.TabUtils import TabUtils
+
+__version__ = "0.0.2"
+
+__all__ = [
+    "ButtonUtils",
+    "ComponentUtils", 
+    "DateUtils",
+    "DropdownUtils",
+    "InputUtils",
+    "LabelUtils",
+    "LinkUtils",
+    "TableUtils",
+    "TabUtils"
+]

{robo_appian-0.0.4/robo_appian_source_backup/utils → robo_appian-0.0.6/robo_appian}/components/ButtonUtils.py

@@ -10,7 +10,7 @@ class ButtonUtils:
         Usage Example:
 
         from selenium.webdriver.support.ui import WebDriverWait
-        from robo_appian.utils.components.ButtonUtils import ButtonUtils
+        from robo_appian.components.ButtonUtils import ButtonUtils
 
         wait = WebDriverWait(driver, 10)
         ButtonUtils.click(wait, "Login")
@@ -68,5 +68,4 @@ class ButtonUtils:
 
         """
         component = wait.until(EC.element_to_be_clickable((By.ID, id)))
-        component.click()
-        component.click()
+        component.click()

{robo_appian-0.0.4/robo_appian_source_backup/utils → robo_appian-0.0.6/robo_appian}/components/DateUtils.py

@@ -4,7 +4,7 @@ from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.remote.webdriver import WebDriver
 from selenium.webdriver.remote.webelement import WebElement
 
-from robo_appian.utils.components.InputUtils import InputUtils
+from robo_appian.components.InputUtils import InputUtils
 
 
 class DateUtils:
@@ -14,7 +14,7 @@ class DateUtils:
         Usage Example:
 
         # Set a date value
-        from robo_appian.utils.components.DateUtils import DateUtils
+        from robo_appian.components.DateUtils import DateUtils
         DateUtils.setDateValue(wait, "Start Date", "01/01/2024")
 
     """
@@ -75,7 +75,7 @@ class DateUtils:
         # component = wait.until(EC.element_to_be_clickable((By.XPATH, f".//div/label[text()='{label}']/following-sibling::input")))
 
         component = DateUtils.findComponent(wait, label)
-        InputUtils.setValueUsingComponent(component, value)
+        InputUtils._setComponentValue(component, value)
         return component
 
     @staticmethod

robo_appian-0.0.6/robo_appian/components/DropdownUtils.py

@@ -0,0 +1,136 @@
+import stat
+from turtle import st
+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.webdriver import WebDriver
+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
+            wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+
+            # 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")  # type: ignore[reportUnknownMemberType]
+        combobox.click()
+
+        option_xpath = f'.//div/ul[@id="{dropdown_id}"]/li[./div[normalize-space(text())="{value}"]]'
+        component = wait.until(EC.presence_of_element_located((By.XPATH, option_xpath)))
+        component = wait.until(EC.element_to_be_clickable((By.XPATH, option_xpath)))
+        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"
+                input_component = wait.until(
+                    EC.element_to_be_clickable((By.ID, input_component_id))
+                )
+                InputUtils._setComponentValue(input_component, value)
+
+                xpath = f'.//ul[@id="{dropdown_id}"]/li[./div[normalize-space(text())="{value}"]][1]'
+                component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+                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 = f'./div/div[@role="combobox" and @tabindex="0"]'
+        combobox = component.find_element(By.XPATH, xpath)
+        DropdownUtils.selectDropdownValueByComponent(wait, combobox, value)
+        return combobox

robo_appian-0.0.6/robo_appian/components/InputUtils.py

@@ -0,0 +1,107 @@
+from numpy import size
+from robo_appian.utils.ComponentUtils import ComponentUtils
+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.support.ui import WebDriverWait
+from selenium.webdriver.remote.webelement import WebElement
+from typing import List
+
+
+class InputUtils:
+    """
+    Utility class for interacting with input components in Appian UI.
+
+        Usage Example:
+
+        # Set a value in an input field
+        from robo_appian.components.InputUtils import InputUtils
+        InputUtils.setValueByLabelText(wait, "Username", "test_user")
+
+    """
+
+    @staticmethod
+    def setValueAndSubmitUsingComponent(component: WebElement, value: str):
+        """
+        Sets a value in an input component and submits it using the provided component element.
+
+        Parameters:
+            component: The Selenium WebElement for the input component.
+            value: The value to set in the input field.
+
+        Returns:
+            The Selenium WebElement for the input component after setting the value and submitting.
+
+        Example:
+            InputUtils.setValueAndSubmitUsingComponent(component, "test_user")
+
+        """
+        # This method assumes that the component is already found and passed as an argument.
+
+        if not component.is_displayed():
+            raise Exception(
+                f"Component with label '{component.text}' is not displayed."
+            )
+
+        component = InputUtils._setComponentValue(component, value)
+        component.send_keys(Keys.ENTER)
+        return component
+
+    @staticmethod
+    def __findInputComponentsByLabelPath(wait: WebDriverWait, xpath: str):
+        label_components = ComponentUtils.findComponentsByXPath(wait, xpath)
+        input_components = []
+        for label_component in label_components:
+            attribute: str = "for"
+            component_id = label_component.get_attribute(attribute)  # type: ignore[reportUnknownMemberType]
+            if component_id:
+                component = wait.until(
+                    EC.element_to_be_clickable((By.ID, component_id))
+                )
+                input_components.append(component)
+        return input_components
+
+    @staticmethod
+    def __findInputComponentsByPartialLabel(wait: WebDriverWait, label: str):
+        xpath = f'.//div/label[contains(normalize-space(text()), "{label}")]'
+        components = InputUtils.__findInputComponentsByLabelPath(wait, xpath)
+        return components
+
+    @staticmethod
+    def __findInputComponentsByLabel(wait: WebDriverWait, label: str):
+        xpath = f'.//div/label[normalize-space(text())="{label}"]'
+        components = InputUtils.__findInputComponentsByLabelPath(wait, xpath)
+        return components
+
+    @staticmethod
+    def _setComponentValue(component: WebElement, value: str):
+        component.clear()
+        component.send_keys(value)
+        return component
+
+    @staticmethod
+    def __setValueByComponents(wait: WebDriverWait, input_components, value: str):
+        """
+        Sets a value in an input component identified by its label text.
+        Parameters:
+            wait: Selenium WebDriverWait instance.
+            label: The visible text label of the input component.
+            value: The value to set in the input field.
+        Returns:
+            None
+        Example:
+            InputUtils.setValueByLabelText(wait, "Username", "test_user")
+        """
+
+        for component in input_components:
+            InputUtils._setComponentValue(component, value)
+
+    @staticmethod
+    def setValueByPartialLabelText(wait: WebDriverWait, label: str, value: str):
+        input_components = InputUtils.__findInputComponentsByPartialLabel(wait, label)
+        InputUtils.__setValueByComponents(wait, input_components, value)
+
+    @staticmethod
+    def setValueByLabelText(wait: WebDriverWait, label: str, value: str):
+        input_components = InputUtils.__findInputComponentsByLabel(wait, label)
+        InputUtils.__setValueByComponents(wait, input_components, value)

{robo_appian-0.0.4/robo_appian_source_backup/utils → robo_appian-0.0.6/robo_appian}/components/LabelUtils.py

@@ -11,7 +11,7 @@ class LabelUtils:
         Usage Example:
 
         # Find a label component
-        from robo_appian.utils.components.LabelUtils import LabelUtils
+        from robo_appian.components.LabelUtils import LabelUtils
         label_component = LabelUtils.find(wait, "Username")
 
     """

{robo_appian-0.0.4/robo_appian_source_backup/utils → robo_appian-0.0.6/robo_appian}/components/LinkUtils.py

@@ -12,7 +12,7 @@ class LinkUtils:
         Usage Example:
 
         # Click a link with a specific label
-        from robo_appian.utils.components.LinkUtils import LinkUtils
+        from robo_appian.components.LinkUtils import LinkUtils
         LinkUtils.click(wait, "Learn More")
 
     """

robo_appian-0.0.6/robo_appian/components/SearchInputUtils.py

@@ -0,0 +1,64 @@
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support import expected_conditions as EC
+from robo_appian.components.InputUtils import InputUtils
+from robo_appian.utils.ComponentUtils import ComponentUtils
+
+
+class SearchInputUtils:
+
+    @staticmethod
+    def __findSearchInputComponentsByLabelPathAndSelectValue(
+        wait: WebDriverWait, xpath: str, value: str
+    ):
+        search_input_components = ComponentUtils.findComponentsByXPath(wait, xpath)
+        input_components = []
+        for search_input_component in search_input_components:
+            attribute: str = "aria-controls"
+            dropdown_list_id = search_input_component.get_attribute(attribute)
+            if dropdown_list_id:
+                InputUtils._setComponentValue(search_input_component, value)
+                xpath = f".//ul[@id='{dropdown_list_id}' and @role='listbox' ]/li[@role='option']/div/div/div/div/div/div/p[text()='{value}'][1]"
+                drop_down_item = wait.until(
+                    EC.element_to_be_clickable((By.XPATH, xpath))
+                )
+                drop_down_item.click()
+            else:
+                raise ValueError(
+                    f"Search input component with label '{search_input_component.text}' does not have 'aria-controls' attribute."
+                )
+
+        return input_components
+
+    @staticmethod
+    def __selectSearchInputComponentsByPartialLabelText(
+        wait: WebDriverWait, label: str, value: str
+    ):
+        xpath = f".//div[./div/span[contains(normalize-space(text())='{label}']]/div/div/div/input[@role='combobox']"
+        SearchInputUtils.__findSearchInputComponentsByLabelPathAndSelectValue(
+            wait, xpath, value
+        )
+
+    @staticmethod
+    def __selectSearchInputComponentsByLabelText(
+        wait: WebDriverWait, label: str, value: str
+    ):
+        xpath = (
+            f".//div[./div/span[text()='{label}']]/div/div/div/input[@role='combobox']"
+        )
+        SearchInputUtils.__findSearchInputComponentsByLabelPathAndSelectValue(
+            wait, xpath, value
+        )
+
+    @staticmethod
+    def selectSearchDropdownByLabelText(wait: WebDriverWait, label: str, value: str):
+
+        SearchInputUtils.__selectSearchInputComponentsByLabelText(wait, label, value)
+
+    @staticmethod
+    def selectSearchDropdownByPartialLabelText(
+        wait: WebDriverWait, label: str, value: str
+    ):
+        SearchInputUtils.__selectSearchInputComponentsByPartialLabelText(
+            wait, label, value
+        )

{robo_appian-0.0.4/robo_appian_source_backup/utils → robo_appian-0.0.6/robo_appian}/components/TabUtils.py

@@ -9,11 +9,11 @@ class TabUtils:
     Usage Example:
 
         # Select a tab by its label
-        from robo_appian.utils.components.TabUtils import TabUtils
+        from robo_appian.components.TabUtils import TabUtils
         TabUtils.select_tab(wait, "Settings")
 
         # Find the currently selected tab by its label
-        from robo_appian.utils.components.TabUtils import TabUtils
+        from robo_appian.components.TabUtils import TabUtils
         selected_tab = TabUtils.find_selected_tab(wait, "Settings")
     """
 

{robo_appian-0.0.4/robo_appian_source_backup/utils → robo_appian-0.0.6/robo_appian}/components/TableUtils.py

@@ -11,7 +11,7 @@ class TableUtils:
         Usage Example:
 
         # Find a table using a column name
-        from robo_appian.utils.components.TableUtils import TableUtils
+        from robo_appian.components.TableUtils import TableUtils
         table = TableUtils.findTableUsingColumnName(wait, "Status")
 
     """
@@ -140,6 +140,10 @@ class TableUtils:
 
         xpath = f'./thead/tr/th[@scope="col" and @abbr="{columnName}"]'
         component = tableObject.find_element(By.XPATH, xpath)
+
+        if component is None:
+            raise ValueError(f"Could not find a column with abbr '{columnName}' in the table header.")
+        
         class_string = component.get_attribute("class")
         partial_string = "headCell_"
         words = class_string.split()
@@ -149,6 +153,9 @@ class TableUtils:
             if partial_string in word:
                 selected_word = word
 
+        if selected_word is None:
+            raise ValueError(f"Could not find a class containing '{partial_string}' in the column header for '{columnName}'.")
+        
         data = selected_word.split("_")
         return int(data[1])
 

{robo_appian-0.0.4/robo_appian_source_backup/utils → robo_appian-0.0.6/robo_appian}/controllers/ComponentDriver.py

@@ -1,10 +1,13 @@
-from robo_appian.utils.components.ComponentUtils import ComponentUtils
-from robo_appian.utils.components.DateUtils import DateUtils
-from robo_appian.utils.components.DropdownUtils import DropdownUtils
-from robo_appian.utils.components.InputUtils import InputUtils
-from robo_appian.utils.components.LabelUtils import LabelUtils
-from robo_appian.utils.components.LinkUtils import LinkUtils
-from robo_appian.utils.components.TabUtils import TabUtils
+from robo_appian.components.ButtonUtils import ButtonUtils
+from selenium.webdriver.support.ui import WebDriverWait
+from robo_appian.utils.ComponentUtils import ComponentUtils
+from robo_appian.components.DateUtils import DateUtils
+from robo_appian.components.DropdownUtils import DropdownUtils
+from robo_appian.components.InputUtils import InputUtils
+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
 
 
 class ComponentDriver:
@@ -17,7 +20,7 @@ class ComponentDriver:
     """
 
     @staticmethod
-    def execute(wait : WebDriverWait, type, action, label, value):
+    def execute(wait: WebDriverWait, type, action, label, value):
         """
         Executes an action on a specified component type.
         Parameters:
@@ -42,13 +45,15 @@ class ComponentDriver:
             case "Input Text":
                 match action:
                     case "Set Value":
-                        InputUtils.setInputValue(wait, label, value)
+                        InputUtils.setValueByLabelText(wait, label, value)
                     case _:
                         raise ValueError(f"Unsupported action for {type}: {action}")
             case "Search Input Text":
                 match action:
                     case "Select":
-                        InputUtils.setSearchInputValue(wait, label, value)
+                        SearchInputUtils.selectSearchDropdownByLabelText(
+                            wait, label, value
+                        )
                     case _:
                         raise ValueError(f"Unsupported action for {type}: {action}")
             case "Label":
@@ -66,19 +71,19 @@ class ComponentDriver:
             case "Drop Down":
                 match action:
                     case "Select":
-                        DropdownUtils.selectDropdownValue(wait, label, value)
+                        DropdownUtils.selectDropdownValueByLabelText(wait, label, value)
                     case _:
                         raise ValueError(f"Unsupported action for {type}: {action}")
             case "Search Drop Down":
                 match action:
                     case "Select":
-                        DropdownUtils.selectSearchDropdownValue(wait, label, value)
+                        DropdownUtils.selectSearchDropdownValueByLabelText(wait, label, value)
                     case _:
                         raise ValueError(f"Unsupported action for {type}: {action}")
             case "Button":
                 match action:
                     case "Click":
-                        ComponentUtils.click_button(wait, label)
+                        ButtonUtils.click(wait, label)
                     case _:
                         raise ValueError(f"Unsupported action for {type}: {action}")
             case "Tab":