Merge pull request #73 from douglasdcm/add-gets

Add gets

Author: douglasdcm

caqui/asynchronous.py

@@ -47,6 +47,82 @@ async def __get(url):
         raise WebDriverError("'GET' request failed.") from error
 
 
+async def take_screenshot_element(
+    driver_url, session, element, path="/tmp", file_name="caqui"
+):
+    """Take screenshot of element"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/screenshot"
+        response = await __get(url)
+        picture = response.get("value")
+        helper.save_picture(session, path, file_name, picture)
+        return True
+    except Exception as error:
+        raise WebDriverError(f"Failed to take screenshot.") from error
+
+
+async def take_screenshot(driver_url, session, path="/tmp", file_name="caqui"):
+    """Take screenshot"""
+    try:
+        url = f"{driver_url}/session/{session}/screenshot"
+        response = await __get(url)
+        picture = response.get("value")
+        helper.save_picture(session, path, file_name, picture)
+        return True
+    except Exception as error:
+        raise WebDriverError(f"Failed to take screenshot.") from error
+
+
+async def get_named_cookie(driver_url, session, name):
+    """Get cookie by name"""
+    try:
+        url = f"{driver_url}/session/{session}/cookie/{name}"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get cookie '{name}'.") from error
+
+
+async def get_computed_label(driver_url, session, element):
+    """Get the element tag computed label. Get the accessibility name"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/computedlabel"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to get element computed label.") from error
+
+
+async def get_computed_role(driver_url, session, element):
+    """Get the element tag computed role (the element role)"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/computedrole"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to get element computed role.") from error
+
+
+async def get_tag_name(driver_url, session, element):
+    """Get the element tag name"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/name"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to get element name.") from error
+
+
+async def get_shadow_root(driver_url, session, element):
+    """Get the shadow root element"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/shadow"
+        response = await __get(url)
+        return response.get("value")
+    except Exception as error:
+        raise WebDriverError("Failed to get element shadow.") from error
+
+
 async def get_rect(driver_url, session, element):
     """Get the element rectangle"""
     try:

caqui/helper.py

@@ -1,3 +1,11 @@
+import base64
+
+
+def save_picture(session, path, file_name, response):
+    with open(f"{path}/{file_name}-{session}.png", "wb") as f:
+        f.write(base64.b64decode((response)))
+
+
 def get_elements(response):
     values = response.get("value")
     return [list(value.values())[0] for value in values]

caqui/synchronous.py

@@ -47,6 +47,86 @@ def __delete(url):
         raise WebDriverError("'DELETE' request failed.") from error
 
 
+# def add_cookie(driver_url, session, name, value):
+#     """Add cookie by name"""
+#     try:
+#         url = f"{driver_url}/session/{session}/cookie"
+#         payload = {"cookie": {"name": name, "value": value}}
+#         __post(url, payload)
+#         return True
+#     except Exception as error:
+#         raise WebDriverError(f"Failed to add cookie '{name}'.") from error
+
+
+def take_screenshot_element(
+    driver_url, session, element, path="/tmp", file_name="caqui"
+):
+    """Take screenshot of element."""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/screenshot"
+        response = __get(url).get("value")
+        helper.save_picture(session, path, file_name, response)
+        return True
+    except Exception as error:
+        raise WebDriverError(f"Failed to take screeshot.") from error
+
+
+def take_screenshot(driver_url, session, path="/tmp", file_name="caqui"):
+    """Take screenshot."""
+    try:
+        url = f"{driver_url}/session/{session}/screenshot"
+        response = __get(url).get("value")
+        helper.save_picture(session, path, file_name, response)
+        return True
+    except Exception as error:
+        raise WebDriverError(f"Failed to take screeshot.") from error
+
+
+def get_named_cookie(driver_url, session, name):
+    """Get cookie by name."""
+    try:
+        url = f"{driver_url}/session/{session}/cookie/{name}"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get the cookie '{name}'.") from error
+
+
+def get_computed_label(driver_url, session, element):
+    """Get the element computed label. Get the accessibility name."""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/computedlabel"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get the element computed label.") from error
+
+
+def get_computed_role(driver_url, session, element):
+    """Get the element computed role (the element role)"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/computedrole"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get the element computed role.") from error
+
+
+def get_tag_name(driver_url, session, element):
+    """Get the element tag name"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/name"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get the element name.") from error
+
+
+def get_shadow_root(driver_url, session, element):
+    """Get the shadow root element"""
+    try:
+        url = f"{driver_url}/session/{session}/element/{element}/shadow"
+        return __get(url).get("value")
+    except Exception as error:
+        raise WebDriverError(f"Failed to get the element shadow.") from error
+
+
 def get_rect(driver_url, session, element):
     """Get the element rectangle"""
     try:

pyproject.toml

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

tests/fake_responses.py

@@ -43,6 +43,20 @@ def json(self):
 CLOSE_SESSION = DEFAULT
 GO_TO_PAGE = DEFAULT
 
+GET_NAMED_COOKIE = dict_to_json(
+    {
+        "value": {
+            "name": "username",
+            "value": "John Doe",
+            "path": "//home/user/fullpath",
+            "domain": "",
+            "secure": False,
+            "httpOnly": False,
+            "sameSite": "None",
+        }
+    }
+)
+
 GET_RECT = dict_to_json(
     {
         "sessionId": "a9d6e77726f3eda12e92b06b5066dbb4",

tests/feature/test_sync_and_async.py

@@ -11,7 +11,7 @@ def __setup():
         "desiredCapabilities": {
             "name": "webdriver",
             "browserName": "chrome",
-            "marionette": True,
+            "marionette": False,
             "acceptInsecureCerts": True,
             "goog:chromeOptions": {"extensions": [], "args": ["--headless"]},
         }
@@ -26,6 +26,106 @@ def __setup():
     synchronous.close_session(driver_url, session)
 
 
+@mark.asyncio
+async def test_take_screenshot_element(__setup):
+    driver_url, session = __setup
+    locator_type = "css selector"
+    locator_value = "#alert-button"
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+
+    assert synchronous.take_screenshot_element(driver_url, session, element) is True
+    assert (
+        await asynchronous.take_screenshot_element(driver_url, session, element) is True
+    )
+
+
+@mark.asyncio
+async def test_take_screenshot(__setup):
+    driver_url, session = __setup
+
+    assert synchronous.take_screenshot(driver_url, session) is True
+    assert await asynchronous.take_screenshot(driver_url, session) is True
+
+
+@mark.skip(reason="works just with Firefox")
+@mark.asyncio
+async def test_get_named_cookie(__setup):
+    driver_url, session = __setup
+    name = "username"  # cookie created on page load
+    expected = "John Doe"
+
+    assert (
+        synchronous.get_named_cookie(driver_url, session, name).get("value") == expected
+    )
+    response = await asynchronous.get_named_cookie(driver_url, session, name)
+    assert response.get("value") == expected
+
+
+@mark.asyncio
+async def test_get_computed_label(__setup):
+    driver_url, session = __setup
+    locator_type = "css selector"
+    locator_value = "#alert-button"
+    expected = "alert"
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+
+    assert synchronous.get_computed_label(driver_url, session, element) == expected
+
+    assert (
+        await asynchronous.get_computed_label(driver_url, session, element) == expected
+    )
+
+
+@mark.asyncio
+async def test_get_computed_role(__setup):
+    driver_url, session = __setup
+    locator_type = "xpath"
+    locator_value = "//input"
+    expected = "textbox"
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+
+    assert synchronous.get_computed_role(driver_url, session, element) == expected
+
+    assert (
+        await asynchronous.get_computed_role(driver_url, session, element) == expected
+    )
+
+
+@mark.asyncio
+async def test_get_tag_name(__setup):
+    driver_url, session = __setup
+    locator_type = "xpath"
+    locator_value = "//input"
+    expected = "input"
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+
+    assert synchronous.get_tag_name(driver_url, session, element) == expected
+
+    assert await asynchronous.get_tag_name(driver_url, session, element) == expected
+
+
+@mark.asyncio
+async def test_get_shadow_root(__setup):
+    driver_url, session = __setup
+    locator_type = "id"
+    locator_value = "shadow-root"
+    root_element = "shadow-6066-11e4-a52e-4f735466cecf"
+
+    element = synchronous.find_element(driver_url, session, locator_type, locator_value)
+
+    assert (
+        synchronous.get_shadow_root(driver_url, session, element).get(root_element)
+        is not None
+    )
+
+    response = await asynchronous.get_shadow_root(driver_url, session, element)
+    assert response.get(root_element) is not None
+
+
 @mark.asyncio
 async def test_get_rect(__setup):
     driver_url, session = __setup
@@ -111,7 +211,7 @@ async def test_set_timeouts(__setup):
 @mark.asyncio
 async def test_find_children_elements(__setup):
     driver_url, session = __setup
-    expected = 5  # parent inclusive
+    expected = 1  # parent inclusive
     locator_type = "xpath"
     locator_value = "//div"
 
@@ -123,13 +223,13 @@ async def test_find_children_elements(__setup):
         driver_url, session, parent_element, locator_type, locator_value
     )
 
-    assert len(children_elements) == expected
+    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
+    assert len(children_elements) > expected
 
 
 @mark.asyncio
@@ -354,7 +454,6 @@ async def test_get_attribute(__setup):
 @mark.asyncio
 async def test_get_cookies(__setup):
     driver_url, session = __setup
-
     assert isinstance(synchronous.get_cookies(driver_url, session), list)
     cookies = await asynchronous.get_cookies(driver_url, session)
     assert isinstance(cookies, list)