robo_appian 0.0.2__tar.gz

robo_appian-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 dinilmithra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

robo_appian-0.0.2/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.3
+Name: robo_appian
+Version: 0.0.2
+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.12
+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
+
+# Robo Appian
+
+Python library for automating Appian web UI test cases!
+
+# Modules
+## Components
+
+    ButtonUtils: Find and click buttons.
+    DateUtils: Interact with date fields.
+    DropdownUtils: Interact with dropdowns.
+    InputUtils: Interact with input fields.
+    LabelUtils: Find labels.
+    LinkUtils: Click links.
+    TableUtils: Interact with tables.
+    TabUtils: Interact with tabs.
+    ComponentUtils: General utilities for components (input, dropdown, tab, etc).
+
+## Controllers
+
+    ComponentDriver: High-level interface to execute actions on components.
+
+## Exceptions
+
+    MyCustomError: Custom exception for specific error conditions.
+
+# Usage
+
+Import the utilities in your test scripts:
+
+from robo_appian import (
+    ButtonUtils, ComponentUtils, DateUtils, DropdownUtils, InputUtils,
+    LabelUtils, LinkUtils, TableUtils, TabUtils
+)
+
+# Example: Set a Date Value
+    DateUtils.set_date_value("date_field_id", "2023-10-01")
+    
+# Example: Click a Button
+    ButtonUtils.click_button("submit_button_id")
+
+# Example: Select a Dropdown Value
+    DropdownUtils.select_value("dropdown_id", "Option 1")
+
+# Example: Enter Text in an Input Field
+    InputUtils.enter_text("input_field_id", "Sample Text")
+
+# Example: Click a Link
+    LinkUtils.click_link("link_id")
+
+# Example: Click a Tab
+    TabUtils.click_tab("tab_id")
+
+# Example: Get a Table Cell Value
+    TableUtils.get_cell_value("table_id", 1, 2)  # Row 1, Column 2
+
+# Example: Get a Label Value
+    LabelUtils.get_label_value("label_id")
+
+# Example: Get a Component Value
+    ComponentUtils.get_component_value("component_id")
+
+# Example: Use the Component Driver
+    from robo_appian.utils.controllers.ComponentDriver import ComponentDriver
+    ComponentDriver.execute(wait, "Button", "Click", "Submit", None)
+
+## Dependencies
+
+    Python >= 3.8
+    Uses selenium
+
+## License
+
+    MIT License. See LICENSE.

robo_appian-0.0.2/README.md

@@ -0,0 +1,73 @@
+# Robo Appian
+
+Python library for automating Appian web UI test cases!
+
+# Modules
+## Components
+
+    ButtonUtils: Find and click buttons.
+    DateUtils: Interact with date fields.
+    DropdownUtils: Interact with dropdowns.
+    InputUtils: Interact with input fields.
+    LabelUtils: Find labels.
+    LinkUtils: Click links.
+    TableUtils: Interact with tables.
+    TabUtils: Interact with tabs.
+    ComponentUtils: General utilities for components (input, dropdown, tab, etc).
+
+## Controllers
+
+    ComponentDriver: High-level interface to execute actions on components.
+
+## Exceptions
+
+    MyCustomError: Custom exception for specific error conditions.
+
+# Usage
+
+Import the utilities in your test scripts:
+
+from robo_appian import (
+    ButtonUtils, ComponentUtils, DateUtils, DropdownUtils, InputUtils,
+    LabelUtils, LinkUtils, TableUtils, TabUtils
+)
+
+# Example: Set a Date Value
+    DateUtils.set_date_value("date_field_id", "2023-10-01")
+    
+# Example: Click a Button
+    ButtonUtils.click_button("submit_button_id")
+
+# Example: Select a Dropdown Value
+    DropdownUtils.select_value("dropdown_id", "Option 1")
+
+# Example: Enter Text in an Input Field
+    InputUtils.enter_text("input_field_id", "Sample Text")
+
+# Example: Click a Link
+    LinkUtils.click_link("link_id")
+
+# Example: Click a Tab
+    TabUtils.click_tab("tab_id")
+
+# Example: Get a Table Cell Value
+    TableUtils.get_cell_value("table_id", 1, 2)  # Row 1, Column 2
+
+# Example: Get a Label Value
+    LabelUtils.get_label_value("label_id")
+
+# Example: Get a Component Value
+    ComponentUtils.get_component_value("component_id")
+
+# Example: Use the Component Driver
+    from robo_appian.utils.controllers.ComponentDriver import ComponentDriver
+    ComponentDriver.execute(wait, "Button", "Click", "Submit", None)
+
+## Dependencies
+
+    Python >= 3.8
+    Uses selenium
+
+## License
+
+    MIT License. See LICENSE.

robo_appian-0.0.2/pyproject.toml

@@ -0,0 +1,22 @@
+[tool.poetry]
+name = "robo_appian"
+version = "0.0.2"
+description = "Automate your Appian code testing with Python. Boost quality, save time."
+authors = ["Dinil Mithra <dinilmithra@mailme@gmail.com>"]
+readme = "README.md"
+homepage = "https://github.com/dinilmithra/robo_appian"
+repository = "https://github.com/dinilmithra/robo_appian.git"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[tool.poetry.dependencies]
+python = "^3.12"
+requests = "^2.25.1"
+numpy = "*"
+selenium = ">=4.34.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

robo_appian-0.0.2/robo_appian/__init__.py

@@ -0,0 +1,11 @@
+from robo_appian.utils.components.ButtonUtils import ButtonUtils
+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.TableUtils import TableUtils
+from robo_appian.utils.components.TabUtils import TabUtils
+
+__version__ = "0.1.0"

robo_appian-0.0.2/robo_appian/utils/components/ButtonUtils.py

@@ -0,0 +1,72 @@
+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
+
+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.utils.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}')]]"
+        component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+        return component
+
+    @staticmethod
+    def click(wait: WebDriverWait, label: str):
+        """
+        Clicks a button identified by its label.
+
+        Parameters:
+            wait: Selenium WebDriverWait instance.
+            label: The visible text label of the button.
+        Example:
+            ButtonUtils.click(wait, "Submit")
+
+        """
+        component = ButtonUtils.find(wait, label)
+        component.click()
+    @staticmethod
+    def clickInputButtonById(wait: WebDriverWait, id: str):
+        """
+        Finds and clicks an input button by its HTML id attribute.
+
+        Parameters:
+            wait: Selenium WebDriverWait instance.
+            id: The HTML id of the input button.
+
+        Example:
+            ButtonUtils.clickInputButtonById(wait, "button_id")
+
+        """
+        component = wait.until(EC.element_to_be_clickable((By.ID, id)))
+        component.click()
+        component.click()

robo_appian-0.0.2/robo_appian/utils/components/ComponentUtils.py

@@ -0,0 +1,289 @@
+from selenium.common.exceptions import NoSuchElementException
+from selenium.webdriver import ActionChains
+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.support.ui import WebDriverWait
+
+
+class ComponentUtils:
+    """
+    Utility class for interacting with various components in Appian UI.
+
+    """
+
+    @staticmethod
+    def today():
+        """
+        Returns today's date formatted as MM/DD/YYYY.
+        """
+
+        from datetime import date
+
+        today = date.today()
+        yesterday_formatted = today.strftime("%m/%d/%Y")
+        return yesterday_formatted
+
+    @staticmethod
+    def yesterday():
+        """
+        Returns yesterday's date formatted as MM/DD/YYYY.
+        """
+
+        from datetime import date, timedelta
+
+        yesterday = date.today() - timedelta(days=1)
+        yesterday_formatted = yesterday.strftime("%m/%d/%Y")
+        return yesterday_formatted
+
+    # @staticmethod
+    # def find_dropdown_id(wait, dropdown_label):
+    #     label_class_name = "FieldLayout---field_label"
+    #     xpath = f'.//div/span[normalize-space(text())="{dropdown_label}" and @class="{label_class_name}"]'
+    #     span_element = wait.until(EC.presence_of_element_located((By.XPATH, xpath)))
+    #     span_element_id = span_element.get_attribute('id')
+    #     return span_element_id
+
+    # @staticmethod
+    # def find_input_id(wait, label_text):
+    #     label_class_name = "FieldLayout---field_label"
+    #     xpath = f'.//div/div/label[@class="{label_class_name}" and contains(normalize-space(text()), "{label_text}")]'
+    #     label_element = wait.until(EC.presence_of_element_located((By.XPATH, xpath)))
+    #     input_element_id = label_element.get_attribute('for')
+    #     return input_element_id
+
+    # @staticmethod
+    # def set_input_value(wait, label_text, value):
+    #     input_element_id = ComponentUtils.find_input_id(wait, label_text)
+    #     input_element = ComponentUtils.set_input_value_using_id(wait, input_element_id, value)
+    #     return input_element
+
+    # @staticmethod
+    # def set_input_value_using_id(wait, input_element_id, value):
+    #     input_element = wait.until(EC.presence_of_element_located((By.ID, input_element_id)))
+    #     input_element = wait.until(EC.element_to_be_clickable((By.ID, input_element_id)))
+    #     input_element.clear()
+    #     input_element.send_keys(value)
+    #     input_element.send_keys(Keys.RETURN)
+    #     return input_element
+
+    # @staticmethod
+    # def select_search_dropdown_value(wait, label, value):
+    #     span_element_id = ComponentUtils.find_dropdown_id(wait, label)
+    #     xpath = f'.//div[@id="{span_element_id}_value"]'
+    #     combobox = wait.until(EC.presence_of_element_located((By.XPATH, xpath)))
+    #     disabled = combobox.get_attribute("aria-disabled")
+    #     if disabled == "true":
+    #         return
+    #     aria_controls = combobox.get_attribute("aria-controls")
+    #     combobox = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+    #     combobox.click()
+
+    #     input_element_id = span_element_id + "_searchInput"
+    #     ComponentUtils.set_input_value_using_id(wait, input_element_id, value)
+
+    #     xpath = f'.//ul[@id="{aria_controls}"]/li[./div[normalize-space(text())="{value}"]]'
+    #     component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+    #     component.click()
+
+    # @staticmethod
+    # def selectDropdownValue(wait, combobox, value):
+
+    #     aria_controls = combobox.get_attribute("aria-controls")
+    #     combobox.click()
+
+    #     xpath = f'.//div/ul[@id="{aria_controls}"]/li[./div[normalize-space(text())="{value}"]]'
+    #     component = wait.until(EC.presence_of_element_located((By.XPATH, xpath)))
+    #     component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+    #     component.click()
+
+    # @staticmethod
+    # def select_dropdown_value(wait, label, value):
+    #     span_element_id = ComponentUtils.find_dropdown_id(wait, label)
+
+    #     xpath = f'.//div[@id="{span_element_id}_value"]'
+    #     combobox = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+    #     disabled = combobox.get_attribute("aria-disabled")
+    #     if disabled == "true":
+    #         return
+
+    #     combobox = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+    #     ComponentUtils.selectDropdownValue(wait, combobox, value)
+
+    # @staticmethod
+    # def findButton(wait, button_text):
+    #     xpath = f'.//button[.//span/span[contains(normalize-space(text()), "{button_text}")]]'
+    #     component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+    #     return component
+
+    # @staticmethod
+    # def click_button(wait, button_text):
+    #     component = ComponentUtils.findButton(wait, button_text)
+    #     component.click()
+
+    # @staticmethod
+    # def select_tab(wait, tab_label_text):
+    #     xpath = f'.//div[@role="presentation"]/div/div/p[./span[normalize-space(text())="{tab_label_text}"]]'
+    #     component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+    #     component.click()
+
+    @staticmethod
+    def findSuccessMessage(wait: WebDriverWait, message: str):
+        """
+        Finds a success message in the UI by its text.
+        Parameters:
+            wait: Selenium WebDriverWait instance.
+            message: The text of the success message to find.
+        Returns:
+            The Selenium WebElement for the success message.
+        Example:
+            ComponentUtils.findSuccessMessage(wait, "Operation completed successfully")
+        """
+        # This method locates a success message that contains a strong tag with the specified text.
+        # The message is normalized to handle any extra spaces.
+        # It uses the presence_of_element_located condition to ensure the element is present in the DOM.
+
+        xpath = f'.//div/div/p/span/strong[normalize-space(text())="{message}"]'
+        component = wait.until(EC.presence_of_element_located((By.XPATH, xpath)))
+        return component
+
+    @staticmethod
+    def findComponentUsingXpathAndClick(wait: WebDriverWait, xpath: str):
+        """
+        Finds a component using its XPath and clicks it.
+        Parameters:
+            wait: Selenium WebDriverWait instance.
+            xpath: The XPath of the component to find and click.
+        Example:
+            ComponentUtils.findComponentUsingXpathAndClick(wait, "//button[@id='submit']")
+
+        """
+        # This method locates a component using the provided XPath and clicks it.
+        # It uses the presence_of_element_located condition to ensure the element is present in the DOM.
+        # After locating the component, it clicks it to perform the action.
+        component = ComponentUtils.findComponentUsingXpath(wait, xpath)
+        component.click()
+
+    @staticmethod
+    def findComponentUsingXpath(wait: WebDriverWait, xpath: str):
+        """
+        Finds a component using its XPath.
+        Parameters:
+            wait: Selenium WebDriverWait instance.
+            xpath: The XPath of the component to find.
+        Returns:
+            The Selenium WebElement for the component.
+        Example:
+            ComponentUtils.findComponentUsingXpath(wait, "//button[@id='submit']")
+        """
+        # This method locates a component using the provided XPath.
+        # It uses the presence_of_element_located condition to ensure the element is present in the DOM.
+        # The method returns the WebElement for further interaction.
+        component = wait.until(EC.presence_of_element_located((By.XPATH, xpath)))
+        return component
+
+    @staticmethod
+    def checkComponentExistsByXpath(wait: WebDriverWait, xpath: str):
+        """
+        Checks if a component exists using its XPath.
+        Parameters:
+            wait: Selenium WebDriverWait instance.
+            xpath: The XPath of the component to check.
+        Returns:
+            True if the component exists, False otherwise.
+        Example:
+            ComponentUtils.checkComponentExistsByXpath(wait, "//button[@id='submit']")
+        """
+        # This method checks if a component exists by attempting to find it using the provided XPath.
+        # If the component is found, it returns True; otherwise, it catches the NoSuchElementException and returns False.
+        # It uses the presence_of_element_located condition to ensure the element is present in the DOM.
+
+        status = False
+        try:
+            ComponentUtils.findComponentUsingXpath(wait, xpath)
+            status = True
+        except NoSuchElementException:
+            pass
+
+        return status
+
+    @staticmethod
+    def checkComponentExistsById(driver: WebDriver, id: str):
+        """
+        Checks if a component exists using its ID.
+        Parameters:
+            driver: Selenium WebDriver instance.
+            id: The ID of the component to check.
+        Returns:
+            True if the component exists, False otherwise.
+        Example:
+            ComponentUtils.checkComponentExistsById(driver, "submit-button")
+        """
+        # This method checks if a component exists by attempting to find it using the provided ID.
+        # If the component is found, it returns True; otherwise, it catches the NoSuchElementException and returns False.
+        # It uses the find_element method to locate the element by its ID.
+
+        status = False
+        try:
+            driver.find_element(By.ID, id)
+            status = True
+        except NoSuchElementException:
+            pass
+
+        return status
+
+    @staticmethod
+    def findCount(wait: WebDriverWait, xpath: str):
+        """
+        Finds the count of components matching the given XPath.
+        Parameters:
+            wait: Selenium WebDriverWait instance.
+            xpath: The XPath of the components to count.
+        Returns:
+            The count of components matching the XPath.
+        Example:
+            count = ComponentUtils.findCount(wait, "//div[@class='item']")
+        """
+        # This method locates all components matching the provided XPath and returns their count.
+        # It uses the presence_of_all_elements_located condition to ensure all elements are present in the DOM.
+        # If no elements are found, it catches the NoSuchElementException and returns 0.
+
+        length = 0
+
+        try:
+            component = wait.until(
+                EC.presence_of_all_elements_located((By.XPATH, xpath))
+            )
+            length = len(component)
+        except NoSuchElementException:
+            pass
+
+        return length
+
+    # @staticmethod
+    # def findComponent(wait, label):
+    #     xpath = f".//div/label[text()='{label}']"
+    #     component = wait.until(EC.element_to_be_clickable((By.XPATH, xpath)))
+    #     component_id = component.get_attribute("for")
+
+    #     component = wait.until(EC.element_to_be_clickable((By.ID, component_id)))
+    #     return component
+
+    @staticmethod
+    def tab(driver: WebDriver):
+        """
+        Simulates a TAB key press in the browser.
+
+        Parameters:
+            driver: Selenium WebDriver instance.
+        Example:
+            ComponentUtils.tab(driver)
+        """
+        # This method simulates a TAB key press in the browser using ActionChains.
+        # It creates an ActionChains instance, sends the TAB key, and performs the action.
+        # This is useful for navigating through form fields or components in the UI.
+        # It uses the ActionChains class to perform the key press action.
+
+        actions = ActionChains(driver)
+        actions.send_keys(Keys.TAB).perform()