Merge pull request #45 from douglasdcm/add-functions

Add clear_element, is_element_enabled, get_css_value, is_element_selected, get_window_rectangle, get_window_handles

Author: douglasdcm

caqui/asynchronous.py

@@ -35,6 +35,67 @@ async def __get(url):
         raise WebDriverError("'GET' request failed.") from error
 
 
+async def clear_element(driver_url, session, element):
+    """Clear the element text"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/clear"
+        payload = json.dumps({"id": element})
+        await __post(url, payload)
+        return True
+    except Exception as error:
+        raise WebDriverError("Failed to clear the element text.") from error
+
+
+async def is_element_enabled(driver_url, session, element):
+    """Check if element is enabled"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/enabled"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to check if element is enabled.") from error
+
+
+async def get_css_value(driver_url, session, element, property_name):
+    """Check if element is selected"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/css/{property_name}"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to check if element is selected.") from error
+
+
+async def is_element_selected(driver_url, session, element):
+    """Check if element is selected"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/selected"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to check if element is selected.") from error
+
+
+async def get_window_rectangle(driver_url, session):
+    """Get window rectangle"""
+    try:
+        url = f"{driver_url}/session/{session}/window/rect"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to get window rectangle.") from error
+
+
+async def get_window_handles(driver_url, session):
+    """Get window handles"""
+    try:
+        url = f"{driver_url}/session/{session}/window/handles"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to get window handles.") from error
+
+
 async def close_window(driver_url, session):
     """Close active window"""
     try:
@@ -46,7 +107,7 @@ async def close_window(driver_url, session):
 
 
 async def get_window(driver_url, session):
-    """Get window handle"""
+    """Get window"""
     try:
         url = f"{driver_url}/session/{session}/window"
         response = await __get(url)

caqui/synchronous.py

@@ -32,6 +32,62 @@ def __delete(url):
         raise WebDriverError("'DELETE' request failed.") from error
 
 
+def clear_element(driver_url, session, element):
+    """Clear the element text"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/clear"
+        payload = json.dumps({"id": element})
+        __post(url, payload)
+        return True
+    except Exception as error:
+        raise WebDriverError(f"Failed to clear the element text.") from error
+
+
+def is_element_enabled(driver_url, session, element):
+    """Check if element is enabled"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/enabled"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to check if element is enabled.") from error
+
+
+def get_css_value(driver_url, session, element, property_name):
+    """Get the css property value"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/css/{property_name}"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get the css property value.") from error
+
+
+def is_element_selected(driver_url, session, element):
+    """Check if element is selected"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/selected"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to check if element is selected.") from error
+
+
+def get_window_rectangle(driver_url, session):
+    """Get window rectangle"""
+    try:
+        url = f"{driver_url}/session/{session}/window/rect"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get window rectangle.") from error
+
+
+def get_window_handles(driver_url, session):
+    """Get window handles"""
+    try:
+        url = f"{driver_url}/session/{session}/window/handles"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get window handles.") from error
+
+
 def close_window(driver_url, session):
     """Close active window"""
     try:
@@ -42,7 +98,7 @@ def close_window(driver_url, session):
 
 
 def get_window(driver_url, session):
-    """Get window handle"""
+    """Get window"""
     try:
         url = f"{driver_url}/session/{session}/window"
         return __get(url).get("value")

tests/fake_responses.py

@@ -30,9 +30,47 @@ def dict_to_json(dictionary):
 CLOSE_SESSION = DEFAULT
 GO_TO_PAGE = DEFAULT
 
+GET_WINDOW_RECTANGLE = dict_to_json(
+    {
+        "sessionId": "79e4bd950a886e0119e3760d201b059e",
+        "status": 0,
+        "value": {"height": 600, "width": 800, "x": 0, "y": 0},
+    }
+)
+
+
+CLEAR_ELEMENT = dict_to_json(
+    {"sessionId": "486fa32a9876b4519e149b39135edcb5", "status": 0, "value": None}
+)
+
+IS_ELEMENT_ENABLED = dict_to_json(
+    {"sessionId": "e0e43cd1ce532b5aa62b6df0de11e3bd", "status": 0, "value": True}
+)
+
+GET_CSS_COLOR_VALUE = dict_to_json(
+    {
+        "sessionId": "e7f659e7183778e98ce9357051e40a47",
+        "status": 0,
+        "value": "rgba(0, 0, 0, 1)",
+    }
+)
+
+IS_ELEMENT_SELECTED = dict_to_json(
+    {"sessionId": "341d21063846141d2716d300652ddd81", "status": 0, "value": False}
+)
+
+GET_WINDOW_HANDLES = dict_to_json(
+    {
+        "sessionId": "b3f92cf70d734ecc6fcddbd88671998a",
+        "status": 0,
+        "value": ["2E55CCE389196328988ED244DAA52A5D"],
+    }
+)
+
 CLOSE_WINDOW = dict_to_json(
     {"sessionId": "48399161591a0bc1dffaa2ff2d65aa0f", "status": 0, "value": []}
 )
+
 GET_WINDOW = dict_to_json(
     {
         "sessionId": "ce68162d420e9cb2b1617c2d1a800f85",

tests/feature/test_sync_and_async.py

@@ -25,6 +25,84 @@ def __setup():
     synchronous.close_session(driver_url, session)
 
 
+@mark.asyncio
+async def test_clear_element(__setup):
+    driver_url, session = __setup
+    locator_type = "xpath"
+    locator_value = "//input"
+    text = "any"
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+    synchronous.send_keys(driver_url, session, element, text)
+    assert synchronous.clear_element(driver_url, session, element) is True
+
+    synchronous.send_keys(driver_url, session, element, text)
+    assert await asynchronous.clear_element(driver_url, session, element) is True
+
+
+@mark.asyncio
+async def test_is_element_enabled(__setup):
+    driver_url, session = __setup
+    locator_type = "xpath"
+    locator_value = "//input"
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+
+    assert synchronous.is_element_enabled(driver_url, session, element) is True
+    assert await asynchronous.is_element_enabled(driver_url, session, element) is True
+
+
+@mark.asyncio
+async def test_get_css_value(__setup):
+    driver_url, session = __setup
+    locator_type = "xpath"
+    locator_value = "//input"
+    property_name = "color"
+    expected = "rgba(0, 0, 0, 1)"
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+
+    assert (
+        synchronous.get_css_value(driver_url, session, element, property_name)
+        == expected
+    )
+    assert (
+        await asynchronous.get_css_value(driver_url, session, element, property_name)
+        == expected
+    )
+
+
+@mark.asyncio
+async def test_is_element_selected(__setup):
+    driver_url, session = __setup
+    locator_type = "xpath"
+    locator_value = "//input"
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+
+    assert synchronous.is_element_selected(driver_url, session, element) is False
+    assert await asynchronous.is_element_selected(driver_url, session, element) is False
+
+
+@mark.asyncio
+async def test_get_window_rectangle(__setup):
+    driver_url, session = __setup
+    expected = "height"
+
+    assert expected in synchronous.get_window_rectangle(driver_url, session)
+    rectangle = await asynchronous.get_window_rectangle(driver_url, session)
+    assert expected in rectangle
+
+
+@mark.asyncio
+async def test_get_window_handles(__setup):
+    driver_url, session = __setup
+
+    assert isinstance(synchronous.get_window_handles(driver_url, session), list)
+    handles = await asynchronous.get_window_handles(driver_url, session)
+    assert isinstance(handles, list)
+
+
 def test_close_window_sync(__setup):
     driver_url, session = __setup
     assert isinstance(synchronous.close_window(driver_url, session), list)

tests/integration/test_sync_scenarios.py

@@ -1,4 +1,3 @@
-import json
 from caqui.synchronous import (
     find_element,
     get_session,
@@ -8,6 +7,7 @@
     close_session,
     go_to_page,
     get_property,
+    clear_element,
 )
 from tests.constants import PAGE_URL
 from pytest import fixture
@@ -18,7 +18,7 @@ def __setup():
     driver_url = "http://127.0.0.1:9999"
     capabilities = {
         "desiredCapabilities": {
-            "browserName": "firefox",
+            "browserName": "chrome",
             "marionette": True,
             "acceptInsecureCerts": True,
             "goog:chromeOptions": {"extensions": [], "args": ["--headless"]},
@@ -42,6 +42,8 @@ def test_add_text__click_button_and_get_properties(__setup):
     input = find_element(driver_url, session, locator_type, locator_value="//input")
     send_keys(driver_url, session, input, "any")
     assert get_property(driver_url, session, input, property="value") == "any"
+    clear_element(driver_url, session, input)
+    assert get_property(driver_url, session, input, property="value") == ""
 
     anchor = find_element(driver_url, session, locator_type, locator_value="//a")
     assert (

tests/test_sniffer.py

@@ -26,6 +26,13 @@ def setup():
     driver.quit()
 
 
+@mark.skip("used just to discover request data")
+def test_clear(setup):
+    driver = setup
+    element = driver.find_element("xpath", "//input")
+    assert element.clear() == "any"
+
+
 @mark.skip("used just to discover request data")
 def test_back(setup):
     assert setup.back() == "any"