robo_appian 0.0.27__py3-none-any.whl

robo_appian/controllers/ComponentDriver.py

@@ -0,0 +1,93 @@
+from robo_appian.components.ButtonUtils import ButtonUtils
+from selenium.webdriver.support.ui import WebDriverWait
+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
+from robo_appian.components.SearchDropdownUtils import SearchDropdownUtils
+
+
+class ComponentDriver:
+    """
+    Utility class for interacting with various components in Appian UI.
+    Usage Example:
+    from robo_appian.utils.controllers.ComponentDriver import ComponentDriver
+    # Set a date value
+    ComponentDriver.execute(wait, "Date", "Set Value", "Start Date", "01/01/2024")
+    """
+
+    @staticmethod
+    def execute(wait: WebDriverWait, type, action, label, value):
+        """
+        Executes an action on a specified component type.
+        Parameters:
+            wait: Selenium WebDriverWait instance.
+            type: The type of component (e.g., "Date", "Input Text", "Search Input Text", etc.).
+            action: The action to perform on the component (e.g., "Set Value", "Click", "Select").
+            label: The visible text label of the component.
+            value: The value to set in the component (if applicable).
+        Example:
+            ComponentDriver.execute(wait, "Date", "Set Value", "Start Date", "01/01/2024")
+        """
+        # This method executes an action on a specified component type based on the provided parameters.
+
+        match type:
+            case "Date":
+                match action:
+                    case "Set Value":
+                        DateUtils.setValueByLabelText(wait, label, value)
+                    case _:
+                        raise ValueError(f"Unsupported action for {type}: {action}")
+            case "Input Text":
+                match action:
+                    case "Set Value":
+                        InputUtils.setValueByLabelText(wait, label, value)
+                    case _:
+                        raise ValueError(f"Unsupported action for {type}: {action}")
+            case "Search Input Text":
+                match action:
+                    case "Select":
+                        SearchInputUtils.selectSearchDropdownByLabelText(wait, label, value)
+                    case _:
+                        raise ValueError(f"Unsupported action for {type}: {action}")
+            case "Label":
+                match action:
+                    case "Find":
+                        LabelUtils.isLabelExists(wait, label)
+                    case _:
+                        raise ValueError(f"Unsupported action for {type}: {action}")
+            case "Link":
+                match action:
+                    case "Click":
+                        LinkUtils.click(wait, label)
+                    case _:
+                        raise ValueError(f"Unsupported action for {type}: {action}")
+            case "Drop Down":
+                match action:
+                    case "Select":
+                        DropdownUtils.selectDropdownValueByLabelText(wait, label, value)
+                    case _:
+                        raise ValueError(f"Unsupported action for {type}: {action}")
+            case "Search Drop Down":
+                match action:
+                    case "Select":
+                        SearchDropdownUtils.selectSearchDropdownValueByLabelText(wait, label, value)
+                    case _:
+                        raise ValueError(f"Unsupported action for {type}: {action}")
+            case "Button":
+                match action:
+                    case "Click":
+                        ButtonUtils.clickByLabelText(wait, label)
+                    case _:
+                        raise ValueError(f"Unsupported action for {type}: {action}")
+            case "Tab":
+                match action:
+                    case "Find":
+                        TabUtils.selectTabByLabelText(wait, label)
+                    case _:
+                        raise ValueError(f"Unsupported action for {type}: {action}")
+            case _:
+                raise ValueError(f"Unsupported component type: {type}")

robo_appian/exceptions/MyCustomError.py

@@ -0,0 +1,6 @@
+class MyCustomError(Exception):
+    """A custom exception for specific error conditions."""
+
+    def __init__(self, message="This is a custom error!"):
+        self.message = message
+        super().__init__(self.message)

robo_appian/utils/BrowserUtils.py

@@ -0,0 +1,52 @@
+from selenium.webdriver.support.ui import WebDriverWait
+
+
+class BrowserUtils:
+    @staticmethod
+    def switch_to_Tab(wait: WebDriverWait, tab_number):
+        """
+        Switches to the specified browser tab.
+
+        :param wait: WebDriverWait instance
+        :param tab_number: The index of the tab to switch to
+        :return: None
+        Example usage:
+            BrowserUtils.switch_to_Tab(wait, 1)
+        """
+
+        # Switch to the specified browser tab
+        handler = wait._driver.window_handles[tab_number]
+        wait._driver.switch_to.window(handler)
+
+    @staticmethod
+    def switch_to_next_tab(wait: WebDriverWait):
+        """
+        Switches to the next browser tab.
+
+        :param wait: WebDriverWait instance
+        :return: None
+        Example usage:
+            BrowserUtils.switch_to_next_tab(wait)
+        """
+        current_tab_index = wait._driver.window_handles.index(
+            wait._driver.current_window_handle
+        )
+        next_tab_index = (current_tab_index + 1) % len(wait._driver.window_handles)
+        BrowserUtils.switch_to_Tab(wait, next_tab_index)
+
+    @staticmethod
+    def close_current_tab_and_switch_back(wait: WebDriverWait):
+        """
+        Closes the current browser tab and switches back to the original tab.
+
+        :param wait: WebDriverWait instance
+        :return: None
+        Example usage:
+            BrowserUtils.close_current_tab_and_switch_back(wait)
+        """
+        current_tab_index = wait._driver.window_handles.index(
+            wait._driver.current_window_handle
+        )
+        wait._driver.close()
+        original_tab_index = (current_tab_index - 1) % len(wait._driver.window_handles)
+        BrowserUtils.switch_to_Tab(wait, original_tab_index)

robo_appian/utils/ComponentUtils.py

@@ -0,0 +1,292 @@
+
+import tomllib
+from pathlib import Path
+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.remote.webelement import WebElement
+from selenium.webdriver.support.ui import WebDriverWait
+
+
+class ComponentUtils:
+    
+    @staticmethod
+    def get_version():
+        try:
+            toml_path = Path(__file__).parent.parent / "pyproject.toml"
+            with open(toml_path, "rb") as f:
+                data = tomllib.load(f)
+                return data.get("project", {}).get("version", "0.0.0")
+        except Exception:
+            return "0.0.0"
+    
+    @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 findChildComponentByXpath(
+        wait: WebDriverWait, component: WebElement, xpath: str
+    ):
+        """Finds a child component using the given XPath within a parent component.
+
+        :param wait: WebDriverWait instance to wait for elements
+        :param component: Parent WebElement to search within
+        :param xpath: XPath string to locate the child component
+        :return: WebElement if found, raises NoSuchElementException otherwise
+        Example usage:
+        from selenium.webdriver.support.ui import WebDriverWait
+        from selenium import webdriver
+
+        driver = webdriver.Chrome()
+        wait = WebDriverWait(driver, 10)
+        parent_component = driver.find_element(By.ID, "parent")
+        xpath = ".//button[@class='child']"
+        child_component = ComponentUtils.findChildComponentByXpath(wait, parent_component, xpath)
+        """
+        try:
+            component = wait.until(lambda comp: component.find_element(By.XPATH, xpath))
+        except Exception:
+            raise Exception(
+                f"Child component with XPath '{xpath}' not found within the given parent component."
+            )
+        return component
+
+    @staticmethod
+    def findComponentById(wait: WebDriverWait, id: str):
+        try:
+            component = wait.until(EC.presence_of_element_located((By.ID, id)))
+        except Exception:
+            raise Exception(f"Component with ID '{id}' not found.")
+        return component
+
+    @staticmethod
+    def waitForComponentToBeVisibleByXpath(wait: WebDriverWait, xpath: str):
+        try:
+            component = wait.until(EC.visibility_of_element_located((By.XPATH, xpath)))
+        except Exception:
+            raise Exception(f"Component with XPath '{xpath}' not visible.")
+        return component
+
+    # @staticmethod
+    # def waitForComponentToBeVisibleByXpath(wait: WebDriverWait, xpath: str):
+    #     """
+    #     Finds a component using the given XPath in the current WebDriver instance.
+
+    #         :param wait: WebDriverWait instance to wait for elements
+    #         :param xpath: XPath string to locate the component
+    #         :return: WebElement if found, raises NoSuchElementException otherwise
+
+    #     Example usage:
+    #         component = ComponentUtils.waitForComponentToBeVisibleByXpath(wait, "//button[@id='submit']")
+    #         component.click()
+    #     """
+    #     try:
+    #         component = wait.until(EC.visibility_of_element_located((By.XPATH, xpath)))
+    #     except Exception:
+    #         raise Exception(f"Component with XPath '{xpath}' not visible.")
+    #     return component
+
+    @staticmethod
+    def checkComponentExistsByXpath(wait: WebDriverWait, xpath: str):
+        """Checks if a component with the given XPath exists in the current WebDriver instance."""
+        status = False
+        try:
+            ComponentUtils.waitForComponentToBeVisibleByXpath(wait, xpath)
+            status = True
+        except NoSuchElementException:
+            pass
+
+        return status
+
+    @staticmethod
+    def checkComponentExistsById(driver: WebDriver, id: str):
+        """Checks if a component with the given ID exists in the current WebDriver instance.
+
+        :param driver: WebDriver instance to check for the component
+        :param id: ID of the component to check
+        :return: True if the component exists, False otherwise
+        Example usage:
+        exists = ComponentUtils.checkComponentExistsById(driver, "submit-button")
+        print(f"Component exists: {exists}")
+        """
+        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.
+
+        :param wait: WebDriverWait instance to wait for elements
+        :param xpath: XPath string to locate components
+        :return: Count of components matching the XPath
+        Example usage:
+        count = ComponentUtils.findCount(wait, "//div[@class='item']")
+        print(f"Number of items found: {count}")
+        """
+
+        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 tab(wait: WebDriverWait):
+        """Simulates a tab key press in the current WebDriver instance.
+
+        :param wait: WebDriverWait instance to wait for elements
+        :return: None
+        Example usage:
+        ComponentUtils.tab(wait)
+        """
+        driver = wait._driver
+        actions = ActionChains(driver)
+        actions.send_keys(Keys.TAB).perform()
+
+    @staticmethod
+    def findComponentsByXPath(wait: WebDriverWait, xpath: str):
+        """Finds all components matching the given XPath and returns a list of valid components
+        that are clickable and displayed.
+
+        :param wait: WebDriverWait instance to wait for elements
+        :param xpath: XPath string to locate components
+        :return: List of valid WebElement components
+        Example usage:
+        components = ComponentUtils.findComponentsByXPath(wait, "//button[@class='submit']")
+        for component in components:
+            component.click()
+        """
+        # Wait for the presence of elements matching the XPath
+        wait.until(EC.presence_of_element_located((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 len(valid_components) > 0:
+            return valid_components
+
+        raise Exception(f"No valid components found for XPath: {xpath}")
+
+    @staticmethod
+    def findComponentByXPath(wait: WebDriverWait, xpath: str):
+        # component = wait.until(EC.presence_of_element_located((By.XPATH, xpath)))
+        component = wait._driver.find_element(By.XPATH, xpath)
+        return component
+
+    @staticmethod
+    def findComponentUsingXpathAndClick(wait: WebDriverWait, xpath: str):
+        """Finds a component using the given XPath and clicks it.
+
+        :param wait: WebDriverWait instance to wait for elements
+        :param xpath: XPath string to locate the component
+        :return: None
+        Example usage:
+        from selenium.webdriver.support.ui import WebDriverWait
+        from selenium import webdriver
+
+        driver = webdriver.Chrome()
+        wait = WebDriverWait(driver, 10)
+        xpath = "//button[@id='submit']"
+        ComponentUtils.findComponentUsingXpathAndClick(wait, xpath)
+        """
+
+        component = ComponentUtils.waitForComponentToBeVisibleByXpath(wait, xpath)
+        ComponentUtils.click(wait, component)
+
+    @staticmethod
+    def click(wait: WebDriverWait, component: WebElement):
+        """
+        Clicks the given component after waiting for it to be clickable.
+
+            :param wait: WebDriverWait instance to wait for elements
+            :param component: WebElement representing the component to click
+            :return: None
+        Example usage:
+            ComponentUtils.click(wait, component)
+        """
+        wait.until(EC.element_to_be_clickable(component))
+        component.click()
+
+    @staticmethod
+    def waitForComponentToBeInVisible(wait: WebDriverWait, component: WebElement):
+        try:
+            wait.until(EC.staleness_of(component))
+        except Exception:
+            raise Exception(
+                "Component did not become invisible (stale) within the timeout period."
+            )
+
+    @staticmethod
+    def isComponentPresentByXpath(wait: WebDriverWait, xpath: str):
+        status = False
+        try:
+            wait.until(EC.presence_of_element_located((By.XPATH, xpath)))
+            status = True
+        except NoSuchElementException:
+            pass
+
+        return status
+
+    @staticmethod
+    def waitForElementToBeVisibleById(wait: WebDriverWait, id: str):
+        return wait.until(EC.visibility_of_element_located((By.ID, id)))
+
+    @staticmethod
+    def waitForElementNotToBeVisibleById(wait: WebDriverWait, id: str):
+        return wait.until(EC.invisibility_of_element_located((By.ID, id)))
+
+    @staticmethod
+    def waitForElementToBeVisibleByText(wait: WebDriverWait, text: str):
+        xpath = f'//*[normalize-space(translate(., "\u00a0", " "))="{text}" and not(*[normalize-space(translate(., "\u00a0", " "))="{text}"]) and not(ancestor-or-self::*[contains(@class, "---hidden")])]'
+        return wait.until(EC.visibility_of_element_located((By.XPATH, xpath)))
+
+    @staticmethod
+    def waitForElementNotToBeVisibleByText(wait: WebDriverWait, text: str):
+        xpath = f'//*[normalize-space(translate(., "\u00a0", " "))="{text}" and not(*[normalize-space(translate(., "\u00a0", " "))="{text}"]) and not(ancestor-or-self::*[contains(@class, "---hidden")])]'
+        return wait.until(EC.invisibility_of_element_located((By.XPATH, xpath)))

robo_appian-0.0.27.dist-info/METADATA

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: robo_appian
+Version: 0.0.27
+Summary: Automate your Appian code testing with Python. Boost quality, save time.
+License-File: LICENSE
+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
+Classifier: Programming Language :: Python :: 3.14
+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
+
+Robo Appian is a Python library for automated UI testing of Appian applications. It provides user-friendly utilities and best practices to help you write robust, maintainable, and business-focused test automation.
+
+## Features
+- Simple, readable API for Appian UI automation
+- Utilities for buttons, inputs, dropdowns, tables, tabs, and more
+- Data-driven and workflow testing support
+- Error handling and debugging helpers
+- Designed for both technical and business users
+
+## Documentation
+Full documentation, guides, and API reference are available at:
+
+➡️ [Robo Appian Documentation](https://dinilmithra.github.io/robo_appian/)
+
+## Quick Start
+1. Install Robo Appian:
+   ```bash
+   pip install robo_appian
+   ```
+2. See the [Getting Started Guide](docs/getting-started/installation.md) for setup and your first test.
+
+## Example Usage
+```python
+from robo_appian.components import InputUtils, ButtonUtils
+
+# Set value in a text field by label
+InputUtils.setValueByLabelText(wait, "Username", "testuser")
+
+# Click a button by label
+ButtonUtils.clickByLabelText(wait, "Sign In")
+```
+
+## Project Structure
+- `robo_appian/` - Library source code
+- `docs/` - Documentation and guides
+
+## Contributing
+Contributions are welcome! Please see the [contributing guidelines](CONTRIBUTING.md) or open an issue to get started.
+
+## License
+MIT License. See [LICENSE](LICENSE) for details.
+
+---
+
+For questions or support, contact [Dinil Mithra](mailto:dinilmithra.mailme@gmail.com) or connect on [LinkedIn](https://www.linkedin.com/in/dinilmithra).
+

robo_appian-0.0.27.dist-info/RECORD

@@ -0,0 +1,23 @@
+robo_appian/__init__.py,sha256=29XO60v2ci41N1dsWjsIXHdiLPbg7K34ckyHjceTVOc,1011
+robo_appian/components/ButtonUtils.py,sha256=SmvpqLUjk728b3Xp2ydw56hZEB4HE_P0WGaS5iwUWXI,4931
+robo_appian/components/DateUtils.py,sha256=N9XseKlgnCyOVowO9lQ_C7Nhv7xhAForoBa7D3MhhVo,2476
+robo_appian/components/DropdownUtils.py,sha256=hi3gJuWjwKLEc5qQiIf70ffv6ouacawV9HLxTuQU78w,16184
+robo_appian/components/InputUtils.py,sha256=EqAECJ-8VKRJKI6sJ8e5pYI9lTAuXHDQEYZKIW8ls5I,6071
+robo_appian/components/LabelUtils.py,sha256=pC7odt10hgBG8Td8zu71IqJQ0h7YHN9O-sLbtnqE-tk,2430
+robo_appian/components/LinkUtils.py,sha256=32_0mW-j624Be9xlFZAkZsLjJ2OaORfp-ePSRyFwTfs,1549
+robo_appian/components/SearchDropdownUtils.py,sha256=sX9b__Rir7feH1SkCd53EeLJXO7OTLkeA1FMbZU_CNs,4504
+robo_appian/components/SearchInputUtils.py,sha256=2mg1QkEZGVJ-rLTvB0pMNSKvNhiqOU9QrUH0CNr4la4,3260
+robo_appian/components/TabUtils.py,sha256=k-HkIK8ca-KnHXSDTXDV4190jT5P84tZ3frWSCndn5I,2257
+robo_appian/components/TableUtils.py,sha256=_NBytGtP0EzBkjzrffpQ-pm3PoRPUykUvEwTcXu0xPk,6322
+robo_appian/components/__init__.py,sha256=BW-fDKwq9Ntq-F7qAt-kDUudowOJBHr4sLiPV9Rjo_M,718
+robo_appian/controllers/ComponentDriver.py,sha256=4zKn6Jy71cFsGWqOh7EgQ6NYfRIVvi5l5Pn31tLLM9s,4350
+robo_appian/controllers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+robo_appian/exceptions/MyCustomError.py,sha256=DVAkytXNNQNjqyTyCjk6FFd6fr3AsBe57Y19erDSqVs,222
+robo_appian/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+robo_appian/utils/BrowserUtils.py,sha256=Lp0yeHjqstdyA5POqFv4TxGY1TKixApMT6G_nnWadXs,1747
+robo_appian/utils/ComponentUtils.py,sha256=NBdqfpetJBmorLWEiOgc3fJWhun4d8aIkUcERf0_vIg,10873
+robo_appian/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+robo_appian-0.0.27.dist-info/METADATA,sha256=XocLA7aAC_1jjPF26UHnye_ZHoxmYGQxp_gFrjNRzz8,2334
+robo_appian-0.0.27.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+robo_appian-0.0.27.dist-info/licenses/LICENSE,sha256=g-xR4dRa9_4iFkMoJmED-wE-J5hoxbk3105Knhfpjm0,1068
+robo_appian-0.0.27.dist-info/RECORD,,

robo_appian-0.0.27.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.2.1
+Root-Is-Purelib: true
+Tag: py3-none-any

robo_appian-0.0.27.dist-info/licenses/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.