Merge pull request #72 from douglasdcm/add-rect

Add get_rect

Author: douglasdcm

caqui/asynchronous.py

@@ -47,7 +47,17 @@ async def __get(url):
         raise WebDriverError("'GET' request failed.") from error
 
 
-async def actions(driver_url, session, element, payload):
+async def get_rect(driver_url, session, element):
+    """Get the element rectangle"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/rect"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to get element rect.") from error
+
+
+async def actions(driver_url, session, payload):
     url = f"{driver_url}/session/{session}/actions"
     await __post(url, payload)
     return True
@@ -75,7 +85,7 @@ async def actions_scroll_to_element(driver_url, session, element):
                 }
             ]
         }
-        return await actions(driver_url, session, element, payload)
+        return await actions(driver_url, session, payload)
     except Exception as error:
         raise WebDriverError(f"Failed to scroll to element.") from error
 
@@ -129,7 +139,7 @@ async def actions_click(driver_url, session, element):
                 },
             ]
         }
-        return await actions(driver_url, session, element, payload)
+        return await actions(driver_url, session, payload)
     except Exception as error:
         raise WebDriverError(f"Failed to click the element.") from error
 

caqui/synchronous.py

@@ -47,10 +47,18 @@ def __delete(url):
         raise WebDriverError("'DELETE' request failed.") from error
 
 
+def get_rect(driver_url, session, element):
+    """Get the element rectangle"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/rect"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get the element rect.") from error
+
+
 def actions_scroll_to_element(driver_url, session, element):
     """Scroll to an element simulating a mouse movement"""
     try:
-        url = f"{driver_url}/session/{session}/actions"
         payload = {
             "actions": [
                 {
@@ -70,12 +78,17 @@ def actions_scroll_to_element(driver_url, session, element):
                 }
             ]
         }
-        __post(url, payload)
-        return True
+        return actions(driver_url, session, payload)
     except Exception as error:
         raise WebDriverError(f"Failed to scroll to element.") from error
 
 
+def actions(driver_url, session, payload):
+    url = f"{driver_url}/session/{session}/actions"
+    __post(url, payload)
+    return True
+
+
 def submit(driver_url, session, element):
     """Submit a form. It is similar to 'submit' funtion in Seleniu
     It is not part of W3C WebDriver. Just added for convenience
@@ -96,7 +109,6 @@ def submit(driver_url, session, element):
 def actions_click(driver_url, session, element):
     """Click an element simulating a mouse movement"""
     try:
-        url = f"{driver_url}/session/{session}/actions"
         payload = {
             "actions": [
                 {
@@ -126,8 +138,7 @@ def actions_click(driver_url, session, element):
                 },
             ]
         }
-        __post(url, payload)
-        return True
+        return actions(driver_url, session, payload)
     except Exception as error:
         raise WebDriverError(f"Failed to click the element.") from error
 

tests/fake_responses.py

@@ -43,6 +43,14 @@ def json(self):
 CLOSE_SESSION = DEFAULT
 GO_TO_PAGE = DEFAULT
 
+GET_RECT = dict_to_json(
+    {
+        "sessionId": "a9d6e77726f3eda12e92b06b5066dbb4",
+        "status": 0,
+        "value": {"height": 23, "width": 183, "x": 10, "y": 9652.12},
+    }
+)
+
 ACTIONS = dict_to_json(
     {"sessionId": "449dbd1df001e9a9e13b3bac5babe809", "status": 0, "value": "null"}
 )

tests/feature/test_sync_and_async.py

@@ -26,6 +26,20 @@ def __setup():
     synchronous.close_session(driver_url, session)
 
 
+@mark.asyncio
+async def test_get_rect(__setup):
+    driver_url, session = __setup
+    locator_type = "xpath"
+    locator_value = "//input"
+    expected = {"height": 21, "width": 185, "x": 8, "y": 100.4375}
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+
+    assert synchronous.get_rect(driver_url, session, element) == expected
+
+    assert await asynchronous.get_rect(driver_url, session, element) == expected
+
+
 @mark.asyncio
 async def test_actions_scroll_to_element(__setup):
     driver_url, session = __setup

tests/html/playground.html

@@ -16,9 +16,9 @@ <h1>Basic page</h1>
     <a href="http://any4.com" id="a4">any4.com</a><br>
     <br>
     <button id="alert-button" onclick="openAlert()">alert</button>
+    <button hidden id="hidden-button" style="display: none;" onclick="openAlert()">hidden</button>
     <br>
     <p id="end">end</p>
-
     <div class="parent">
         any0
         <div class="child1">any1</div>

tests/integration/test_sync_scenarios.py

@@ -8,6 +8,9 @@
     go_to_page,
     get_property,
     clear_element,
+    get_rect,
+    get_css_value,
+    get_attribute,
 )
 from tests.constants import PAGE_URL
 from pytest import fixture
@@ -34,6 +37,23 @@ def __setup():
     close_session(driver_url, session)
 
 
+def test_get_data_from_hidden_button(__setup):
+    driver_url, session = __setup
+    locator_type = "xpath"
+
+    hidden_button = find_element(
+        driver_url, session, locator_type, locator_value="//*[@id='hidden-button']"
+    )
+
+    assert "width" in get_rect(driver_url, session, hidden_button)
+    assert "visible" == get_css_value(driver_url, session, hidden_button, "visibility")
+    assert True == get_property(driver_url, session, hidden_button, "hidden")
+    assert ["display"] == get_property(driver_url, session, hidden_button, "style")
+    assert "display: none;" == get_attribute(
+        driver_url, session, hidden_button, "style"
+    )
+
+
 def test_add_text__click_button_and_get_properties(__setup):
     driver_url, session = __setup
     expected = "end"

tests/unit/test_async_unit.py

@@ -11,6 +11,17 @@ async def mock_request(*args):
     pass
 
 
+@mark.asyncio
+async def test_get_rect():
+    expected = {"height": 23, "width": 183, "x": 10, "y": 9652.12}
+
+    async def mock_request(*args):
+        return fake_responses.GET_RECT
+
+    with patch("caqui.asynchronous.__get", mock_request):
+        assert await asynchronous.get_rect("", "", "") == expected
+
+
 @mark.asyncio
 async def test_actions_scroll_to_element():
     async def mock_request(*args):

tests/unit/test_sync_unit.py

@@ -3,6 +3,12 @@
 from tests import fake_responses
 
 
+@patch("requests.request", return_value=fake_responses.GET_RECT)
+def test_get_rect(*args):
+    expected = {"height": 23, "width": 183, "x": 10, "y": 9652.12}
+    assert synchronous.get_rect("", "", "") == expected
+
+
 @patch("requests.request", return_value=fake_responses.ACTIONS)
 def test_actions_scroll_to_element(*args):
     assert synchronous.actions_scroll_to_element("", "", "") == True