fill form function added (#18)

* fill form function added
* Added test case to verify select_dropdown function
* table parser added
* input,textarea,fileupload,checkbox,radiobutton added
* form filling method added
* testcases added for dropdown and table
* Added firefox tests

Co-authored-by: ravishankar <ravishankar@advarisk.com>

Author: chavarera

s_tool/driver.py

@@ -9,6 +9,7 @@
 from s_tool.utils import (
     click,
     current_url,
+    fill,
     get_cookies,
     get_element,
     get_session,
@@ -82,14 +83,15 @@ def _load_driver(self):
 
     def _load_methods(self):
         self.session = partial(get_session, self.driver)
-        self.visit = partial(visit, self.driver)
+        self.get = partial(visit, self.driver)
         self.text = partial(page_source, self.driver)
         self.url = partial(current_url, self.driver)
         self.element = partial(get_element, self.driver)
         self.click = partial(click, self.driver)
         self.cookies = partial(get_cookies, self.driver)
         self.screenshot = partial(take_screenshot, self.driver)
         self.hide = partial(hide_show_elements, self.driver)
+        self.fill = partial(fill, self.driver)
 
 
 if __name__ == "__main__":

s_tool/parser.py

@@ -1,3 +1,4 @@
+from s_tool.exceptions import SToolException
 from s_tool.utils import get_element
 
 
@@ -14,7 +15,7 @@ def select_options(element, swap=None, text_exclude=[]):
     """
     option_dict = dict()
     if element and hasattr(element, "tag_name") and element.tag_name == "select":
-        options = get_element(element, "tag_name", "option", many=True)
+        options = get_element(element, "option", "tag_name", many=True)
         for option in options:
             func = option.get_attribute
             text, value = func("text"), func("value")
@@ -24,3 +25,31 @@ def select_options(element, swap=None, text_exclude=[]):
                 option_dict[value] = text
 
     return option_dict
+
+
+def get_table(table):
+    """Return list of rows including header and footer of given table
+
+    Args:
+        A selenium table element
+
+    Returns:
+        return list of row list,
+        return [] if table not valid
+
+    """
+    results = []
+    if table and hasattr(table, "tag_name") and table.tag_name == "table":
+        for rows in table.find_elements_by_tag_name("tr"):
+            cell_data = []
+            for cell in rows.find_elements_by_xpath("td | th"):
+                colspan = cell.get_attribute("colspan")
+                cell_text = cell.text
+                if colspan:
+                    cell_data.extend([cell_text] + [""] * (int(colspan) - 1))
+                else:
+                    cell_data.append(cell_text)
+            results.append(cell_data)
+    else:
+        raise SToolException("INVALIDTABLE")
+    return results

s_tool/utils.py

@@ -3,8 +3,9 @@
 from selenium import webdriver
 from selenium.common.exceptions import NoSuchElementException, TimeoutException
 from selenium.webdriver.common.by import By
+from selenium.webdriver.firefox.webdriver import WebDriver
 from selenium.webdriver.support import expected_conditions as EC
-from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support.ui import Select, WebDriverWait
 
 from s_tool.exceptions import SToolException
 
@@ -44,7 +45,7 @@ def get_locator(locator_type: str, locator_text: str) -> tuple:
 
 
 def get_element(
-    driver: webdriver, locator_type: str, locator_text: str, many: bool = None
+    driver: webdriver, locator_text: str, locator_type: str = "id", many: bool = None
 ):
     """Get element using locator type and locator text
 
@@ -139,7 +140,7 @@ def take_screenshot(driver: webdriver, element: tuple = None) -> Union[bytes, No
     """
     if element and isinstance(element, tuple):
         locator_type, locator_text = element
-        ele = get_element(driver, locator_type, locator_text)
+        ele = get_element(driver, locator_text, locator_type)
         if ele:
             return ele.screenshot_as_png
         return None
@@ -181,7 +182,70 @@ def hide_show_elements(driver: webdriver, elements: list, hide: bool = None) ->
     """
     for element_locator in elements:
         locator_type, locator_value = element_locator
-        element_list = get_element(driver, locator_type, locator_value, many=True)
+        element_list = get_element(driver, locator_value, locator_type, many=True)
         if element_list:
             for element in element_list:
                 display_element(driver, element, hide)
+
+
+def select_option(element, _value, _by=0):
+    """Select Dropdown option
+
+    Args:
+        element : selenium element
+        _value  : str,value,text
+        _by     : an int value from range(3)
+
+                    0: default select option using by value
+                    1: select using visible text
+                    2: select using index but also provide _value as int
+    Returns:
+        None
+    """
+
+    if not element and element.tag_name != "select":
+        raise SToolException("INVALIDELEMENT")
+
+    elif _by not in [0, 1, 2]:
+        raise SToolException("INVALIDSELECTOR")
+
+    elif _by == 2 and type(_value) is not int:
+        raise SToolException("INVALIDVALUE")
+
+    else:
+        select = Select(element)
+        select_type = {
+            0: getattr(select, "select_by_value"),
+            1: getattr(select, "select_by_visible_text"),
+            2: getattr(select, "select_by_index"),
+        }
+
+        select_type[_by](_value)
+
+
+def fill(driver: WebDriver, kwargs: dict) -> None:
+    """Fill information in html element using name attribute
+
+    Args:
+        driver : selenium Webdriver
+        kwargs : dict,{name:value_to_select_or_enter}
+
+        _by    : default 0 , used for select dropdown
+
+    """
+
+    for name, value in kwargs.items():
+        element = get_element(driver, name, "name")
+        if element.tag_name == "select":
+            # Select Dropdown value
+            select_option(element, value, _by=0)
+        elif element.get_attribute("type") == "radio":
+            # Click on radio element using value
+            radio_element = get_element(driver, f'//input[@value="{value}"]', "xpath")
+            radio_element.click()
+        elif element.tag_name == "input":
+            # input,textarea add values
+            element.clear()
+            element.send_keys(value)
+        else:
+            raise SToolException("NOTIMPLEMENTED")

tests/__init__.py

@@ -0,0 +1,4 @@
+from os.path import abspath
+
+index_file = "tests/index.html"
+TEST_URL = f"file://{abspath(index_file)}"