Merge pull request #55 from douglasdcm/add-find-element

Add find element

Author: douglasdcm

caqui/asynchronous.py

@@ -37,6 +37,49 @@ async def __get(url):
         raise WebDriverError("'GET' request failed.") from error
 
 
+async def set_timeouts(driver_url, session, timeouts):
+    """Set timeouts"""
+    try:
+        url = f"{driver_url}/session/{session}/timeouts"
+        payload = {
+            "implicit": timeouts,
+        }
+        await __post(url, payload)
+        return True
+    except Exception as error:
+        raise WebDriverError(f"Failed to set timeouts.") from error
+
+
+async def find_children_elements(
+    driver_url, session, parent_element, locator_type, locator_value
+):
+    """Find the children elements by 'locator_type'"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{parent_element}/elements"
+        payload = {"using": locator_type, "value": locator_value, "id": parent_element}
+        response = await __post(url, payload)
+        return helper.get_elements(response)
+    except Exception as error:
+        raise WebDriverError(
+            f"Failed to find the children elements from '{parent_element}'."
+        ) from error
+
+
+async def find_child_element(
+    driver_url, session, parent_element, locator_type, locator_value
+):
+    """Find the child element by 'locator_type'"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{parent_element}/element"
+        payload = {"using": locator_type, "value": locator_value, "id": parent_element}
+        response = await __post(url, payload)
+        return helper.get_element(response)
+    except Exception as error:
+        raise WebDriverError(
+            f"Failed to find the child element from '{parent_element}'."
+        ) from error
+
+
 async def get_page_source(driver_url, session):
     """Get the page source (all content)"""
     try:

caqui/synchronous.py

@@ -37,6 +37,49 @@ def __delete(url):
         raise WebDriverError("'DELETE' request failed.") from error
 
 
+def set_timeouts(driver_url, session, timeouts):
+    """Set timeouts"""
+    try:
+        url = f"{driver_url}/session/{session}/timeouts"
+        payload = {
+            "implicit": timeouts,
+        }
+        __post(url, payload)
+        return True
+    except Exception as error:
+        raise WebDriverError(f"Failed to set timeouts.") from error
+
+
+def find_children_elements(
+    driver_url, session, parent_element, locator_type, locator_value
+):
+    """Find the children elements by 'locator_type'"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{parent_element}/elements"
+        payload = {"using": locator_type, "value": locator_value, "id": parent_element}
+        response = __post(url, payload)
+        return helper.get_elements(response)
+    except Exception as error:
+        raise WebDriverError(
+            f"Failed to find the children elements from '{parent_element}'."
+        ) from error
+
+
+def find_child_element(
+    driver_url, session, parent_element, locator_type, locator_value
+):
+    """Find the child element by 'locator_type'"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{parent_element}/element"
+        payload = {"using": locator_type, "value": locator_value, "id": parent_element}
+        response = __post(url, payload)
+        return helper.get_element(response)
+    except Exception as error:
+        raise WebDriverError(
+            f"Failed to find the child element from '{parent_element}'."
+        ) from error
+
+
 def get_page_source(driver_url, session):
     """Get the page source (all content)"""
     try:

pyproject.toml

@@ -8,7 +8,7 @@ exclude = ["tests*", "utils", ".vscode", ".git*", "dist"]
 
 [project]
 name = "caqui"
-version = "1.11.0"
+version = "1.12.0"
 authors = [
   { name="Douglas Cardoso", email="noemail@noemail.com" },
 ]

tests/feature/test_sync_and_async.py

@@ -25,6 +25,70 @@ def __setup():
     synchronous.close_session(driver_url, session)
 
 
+@mark.asyncio
+async def test_set_timeouts(__setup):
+    driver_url, session = __setup
+    timeouts_1 = 5000  # milliseconds
+    timeouts_2 = 3000  # milliseconds
+
+    synchronous.set_timeouts(driver_url, session, timeouts_1)
+
+    assert synchronous.get_timeouts(driver_url, session).get("implicit") == timeouts_1
+
+    await asynchronous.set_timeouts(driver_url, session, timeouts_2)
+
+    assert synchronous.get_timeouts(driver_url, session).get("implicit") == timeouts_2
+
+
+@mark.asyncio
+async def test_find_children_elements(__setup):
+    driver_url, session = __setup
+    expected = 5  # parent inclusive
+    locator_type = "xpath"
+    locator_value = "//div"
+
+    parent_element = synchronous.find_element(
+        driver_url, session, locator_type, '//div[@class="parent"]'
+    )
+
+    children_elements = synchronous.find_children_elements(
+        driver_url, session, parent_element, locator_type, locator_value
+    )
+
+    assert len(children_elements) == expected
+
+    children_elements = await asynchronous.find_children_elements(
+        driver_url, session, parent_element, locator_type, locator_value
+    )
+
+    assert len(children_elements) == expected
+
+
+@mark.asyncio
+async def test_find_child_element(__setup):
+    driver_url, session = __setup
+    expected = "any4"
+    locator_type = "xpath"
+    locator_value = '//div[@class="child4"]'
+
+    parent_element = synchronous.find_element(
+        driver_url, session, locator_type, '//div[@class="parent"]'
+    )
+
+    child_element = synchronous.find_child_element(
+        driver_url, session, parent_element, locator_type, locator_value
+    )
+
+    text = synchronous.get_text(driver_url, session, child_element)
+
+    assert text == expected
+    child_element = await asynchronous.find_child_element(
+        driver_url, session, parent_element, locator_type, locator_value
+    )
+    text = synchronous.get_text(driver_url, session, child_element)
+    assert text == expected
+
+
 @mark.asyncio
 async def test_get_page_source(__setup):
     driver_url, session = __setup

tests/html/playground.html

@@ -18,6 +18,14 @@ <h1>Basic page</h1>
     <br>
     <p id="end">end</p>
 
+    <div class="parent">
+        any0
+        <div class="child1">any1</div>
+        <div class="child2">any2</div>
+        <div class="child3">any3</div>
+        <div class="child4">any4</div>
+    </div>
+
     <script>
         function myFunction(element, color) {
             element.style.color = color;

tests/test_sniffer.py

@@ -3,6 +3,7 @@
 from selenium import webdriver
 from pytest import fixture, mark
 from tests.constants import PAGE_URL
+from selenium.webdriver.common.by import By
 
 
 @fixture
@@ -26,11 +27,21 @@ def setup():
     driver.quit()
 
 
+@mark.skip("used just to discover request data")
+def test_sniffer_find_children_elements(setup):
+    driver = setup
+    element = driver.find_element(By.XPATH, '//div[@class="parent"]')
+    elements = element.find_elements(By.XPATH, "//div")
+    for e in elements:
+        print("element_text:", e.text)
+
+
 @mark.skip("used just to discover request data")
 def test_exec_script(setup):
     driver = setup
     assert driver.execute_script("return document.body.scrollHeight") == "any"
 
+
 @mark.skip("used just to discover request data")
 def test_clear(setup):
     driver = setup

tests/unit/test_async_unit.py

@@ -11,6 +11,37 @@ async def mock_request(*args):
     pass
 
 
+@mark.asyncio
+async def test_set_timeouts():
+    async def mock_request(*args):
+        return fake_responses.GET_TIMEOUTS
+
+    with patch("caqui.asynchronous.__post", mock_request):
+        assert await asynchronous.set_timeouts("", "", "") == True
+
+
+@mark.asyncio
+async def test_find_children_elements():
+    element = "C230605181E69CB2C4C36B8E83FE1245_element_2"
+
+    async def mock_request(*args):
+        return fake_responses.FIND_ELEMENTS
+
+    with patch("caqui.asynchronous.__post", mock_request):
+        assert element in await asynchronous.find_children_elements("", "", "", "", "")
+
+
+@mark.asyncio
+async def test_find_child_element():
+    element = "0.8851292311864847-1"
+
+    async def mock_request(*args):
+        return fake_responses.FIND_ELEMENT
+
+    with patch("caqui.asynchronous.__post", mock_request):
+        assert await asynchronous.find_child_element("", "", "", "", "") == element
+
+
 @mark.asyncio
 async def test_execute_script():
     expected = "any"

tests/unit/test_sync_unit.py

@@ -3,6 +3,28 @@
 from tests import fake_responses
 
 
+@patch("requests.request", return_value=fake_responses.GET_TIMEOUTS)
+def test_set_timeouts(*args):
+    assert synchronous.set_timeouts("", "", "") == True
+
+
+@patch("requests.request", return_value=fake_responses.FIND_ELEMENTS)
+def test_find_children_elements(*args):
+    element = "C230605181E69CB2C4C36B8E83FE1245_element_2"
+
+    elements = synchronous.find_children_elements("", "", "", "", "")
+
+    assert element in elements
+    assert len(elements) == 3
+
+
+@patch("requests.request", return_value=fake_responses.FIND_ELEMENT)
+def test_find_child_element(*args):
+    expected = "0.8851292311864847-1"
+
+    assert synchronous.find_child_element("", "", "", "", "") == expected
+
+
 @patch("requests.request", return_value=fake_responses.EXECUTE_SCRIPT)
 def test_execute_script(*args):
     expected = "any"