Merge pull request #116 from douglasdcm/migrate-to-cdp-prortocol

Add support to Chrome Devtools Protocol

Author: douglasdcm

.github/workflows/python-app.yml

@@ -40,4 +40,4 @@ jobs:
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest
       run: |
-        python -m pytest -n auto
+        python -m pytest -k unit

Makefile

@@ -5,14 +5,16 @@ build:
 	python setup.py bdist_wheel
 
 setenv:
+	# Get the list of envs and run on all of them
 	python3.7 -m venv venv
 	. venv/bin/activate
 	pip install --upgrade pip setuptools wheel
 	pip install -r test-requirements.txt
 	pip install -r dev-requirements.txt
 
+PARAMS ?= ''
 test:
-	pytest -n auto
+	pytest $(PARAMS)
 
 linter:
 	black -l 100 .
@@ -21,7 +23,7 @@ linter:
 	mypy caqui tests --config=pyproject.toml    
 
 coverage:
-	coverage run --source='caqui' -m pytest -n auto
+	coverage run --source='caqui' -m pytest
 	coverage report
 	coverage html
 

README.md

@@ -3,10 +3,11 @@
 [![Python application](https://github.com/douglasdcm/caqui/actions/workflows/python-app.yml/badge.svg)](https://github.com/douglasdcm/caqui/actions/workflows/python-app.yml)
 [![PyPI Downloads](https://static.pepy.tech/badge/caqui)](https://pepy.tech/projects/caqui)
 
-**Caqui** is a Python library for browser, mobile, and desktop automation that works with any driver that exposes a WebDriver-style REST API. It lets you send commands **synchronously or asynchronously**, and you don’t need to think about which underlying driver you’re using.
+**Caqui** is a Python library for browser, mobile, and desktop automation that works with any driver that exposes a WebDriver-style REST API or Chrome Devtools Protocol. It lets you send commands **synchronously or asynchronously**, and you don’t need to think about which underlying driver you’re using.
 
 Caqui is designed for developers who want a unified automation API that can run:
 
+* Chrome Devtools Protocol ((Chrome, Opera, Edge))
 * WebDriver (Chrome, Firefox, Opera, Edge)
 * Appium (Android, iOS)
 * Winium / WinAppDriver (Windows desktop applications)
@@ -16,7 +17,7 @@ Caqui runs seamlessly on a local machine or across remote hosts, and supports bo
 
 ---
 
-# Supported Drivers
+# Supported Web Drivers
 
 | WebDriver             | Version | Remote* | If remote                                                       |
 | --------------------- | ------- | ------- | ------------------------------------------------------------- |
@@ -44,15 +45,49 @@ pip install caqui
 From version **2.0.0+**, Caqui includes a high-level API that mirrors Selenium’s object model and exposes async methods for browser, mobile, and desktop automation.
 [Full documentation:](https://caqui.readthedocs.io/en/latest/caqui.html)
 
-Example:
+Chrome Devtools Protocol example:
+```python
+import time
+from pytest import raises
+from caqui.cdp.by import By
+from caqui.cdp.synchronous.drivers import SyncDriverCDP
+from caqui.exceptions import WebDriverError
+from tests.constants import OTHER_URL
+from caqui.cdp.server import LocalServerCDP, get_ws_url
+
+@fixture(autouse=True, scope="session")
+def launch_browser():
+    server = LocalServerCDP()
+    server.start_chrome()
+    yield server
+    server.dispose()
+
+@fixture
+def setup_sync_cdp_playground():
+    with SyncCDPConnection(get_ws_url()) as conn:
+        driver = SyncDriverCDP(conn)
+        driver.get(PAGE_URL)
+        driver.set_window_size(1000, 1000)
+        yield driver
+
+class TestSyncCDPElement:
+    def test_cdp_is_element_enabled(self, setup_sync_cdp_playground: SyncDriverCDP):
+        driver = setup_sync_cdp_playground
+        locator_type = By.XPATH
+        locator_value = "//input"
+        element = driver.find_element(locator_type, locator_value)
+        assert element.is_enabled() is True
+```
+
+Web Driver example:
 
 ```python
 from os import getcwd
 from pytest import mark, fixture
-from caqui.easy.drivers import AsyncDriver
-from caqui.easy.capabilities import ChromeCapabilitiesBuilder
+from caqui.webdriver.drivers import AsyncDriver
+from caqui.webdriver.capabilities import ChromeCapabilitiesBuilder
 from caqui.by import By
-from caqui.easy.server import LocalServer
+from caqui.webdriver.server import LocalServer
 
 BASE_DIR = getcwd()
 PAGE_URL = f"file:///{BASE_DIR}/html/playground.html"

caqui/bidi/__init__.py

@@ -0,0 +1,6 @@
+# Copyright (C) 2023 Caqui - All Rights Reserved
+# You may use, distribute and modify this code under the
+# terms of the MIT license.
+# Visit: https://github.com/douglasdcm/caqui
+
+from caqui.by import By  # noqa F401

caqui/bidi/by.py

@@ -15,3 +15,4 @@ class By:
     CLASS_NAME: str = "class name"
     LINK_TEXT: str = "link text"
     PARTIAL_LINK_TEXT: str = "partial link text"
+    # TODO add TEXT and expose to CDP

caqui/bidi/engine/__init__.py

@@ -0,0 +1,4 @@
+# Copyright (C) 2023 Caqui - All Rights Reserved
+# You may use, distribute and modify this code under the
+# terms of the MIT license.
+# Visit: https://github.com/douglasdcm/caqui

caqui/by.py

@@ -0,0 +1,55 @@
+# Copyright (C) 2023 Caqui - All Rights Reserved
+# You may use, distribute and modify this code under the
+# terms of the MIT license.
+# Visit: https://github.com/douglasdcm/caqui
+
+from typing import TYPE_CHECKING, Coroutine, List, Union
+
+from caqui.cdp.engine import asynchronous
+
+if TYPE_CHECKING:
+    from caqui.cdp.asynchronous.drivers import AsyncDriverCDP
+    from caqui.cdp.asynchronous.element import Element
+
+
+class ActionChains:
+    def __init__(self, driver: "AsyncDriverCDP") -> None:
+        self._conn = driver.conn
+        self._coroutines: List[Coroutine] = []
+        self._element = Union["Element", None]
+
+    def click(self, element: "Element") -> "ActionChains":
+        """
+        Clicks on the element `element`
+        """
+        self._element = element
+        coroutine = asynchronous.click(
+            self._conn,
+            element.element_id,
+        )
+        self._coroutines.append(coroutine)
+        return self
+
+    def move_to_element(self, element: "Element") -> "ActionChains":
+        """Move the mouse to the element `element`"""
+        self._element = element
+        coroutine = asynchronous.actions_move_to_element(
+            self._conn,
+            element.element_id,
+        )
+        self._coroutines.append(coroutine)
+        return self
+
+    def scroll_to_element(self, element: "Element", delta_y: int = 1000) -> "ActionChains":
+        """Scrolls the screen to the element `element`"""
+        self._element = element
+        coroutine = asynchronous.actions_scroll_to_element(
+            self._conn,
+            element.element_id,
+        )
+        self._coroutines.append(coroutine)
+        return self
+
+    async def perform(self) -> None:
+        """Executes the chain of Coroutines"""
+        [await coroutine for coroutine in self._coroutines]