Run asynchronous commands in WebDrivers
Project description
Caqui
Caqui is intended to command executions against Drivers synchronously and asynchronously. Launch the Driver as a server and send requests to it. The intention is that the user does not worry about which Driver he/she is using. It can be WebDrivers like Selenium, MobileDrivers like Appium, or DesktopDrivers like Winium.
The process Caqui follows is similar of the one described in this article that experiments Drivers as servers together with Jmeter to test the Windows Calculator. However, the motivation to create Caqui was feed by the inspiration in Arsenic library.
Caqui is planned to be Driver agnostic, so the user can start any Driver as a server and just inform the server URL. Hence, the code is decoupled from the chosen Driver.
Caqui can be used in remote calls. As it needs just the server URL, the user can start the Driver as a server in any host and provide the URL to Caqui clients.
Simple start
Install the lastest version of Caqui
pip install caqui
Download the same ChromeDriver version as your installed Chrome and start the Driver as a server using the port "9999"
$ ./chromedriver --port=9999
Starting ChromeDriver 94.0.4606.61 (418b78f5838ed0b1c69bb4e51ea0252171854915-refs/branch-heads/4606@{#1204}) on port 9999
Only local connections are allowed.
Please see https://chromedriver.chromium.org/security-considerations for suggestions on keeping ChromeDriver safe.
ChromeDriver was started successfully.
Copy the HTML content to playground.html
<html>
<head>
<title>Sample page</title>
</head>
<body>
<h1>Basic page</h1>
<p> This is a sample page to be used to sanity check </p>
<input id="input">
<button id="button" onclick="myFunction(this, 'red')">test</button>
<p id="end">end</p>
<a src="http://any1.com" id="a1">any1.com</a>
<a src="http://any2.com" id="a2">any2.com</a>
<a src="http://any3.com" id="a3">any3.com</a>
<a src="http://any4.com" id="a4">any4.com</a>
<script>
function myFunction(element, color) {
element.style.color = color;
}
</script>
</body>
</html>
Copy the code to sample.py file. This file must be in the same folder of playground.html
import asyncio
import time
from caqui import synchronous, asynchronous
from os import getcwd
BASE_DIR = getcwd()
PAGE_URL = f"file:///{BASE_DIR}/playground.html"
async def get_all_links():
driver_url = "http://127.0.0.1:9999"
capabilities = {
"desiredCapabilities": {
"browserName": "firefox",
"marionette": True,
"acceptInsecureCerts": True,
}
}
session = synchronous.get_session(driver_url, capabilities)
synchronous.go_to_page(
driver_url,
session,
PAGE_URL,
)
locator_type = "xpath"
anchors = []
for i in range(4):
i += 1
locator_value = f"//a[@id='a{i}']"
anchor = synchronous.find_element(
driver_url, session, locator_type, locator_value
)
anchors.append(anchor)
assert (
await asynchronous.get_text(driver_url, session, anchors[i - 1])
== f"any{i}.com"
)
synchronous.close_session(driver_url, session)
start = time.time()
loop = asyncio.get_event_loop()
tasks = [
loop.create_task(get_all_links()),
loop.create_task(get_all_links()),
loop.create_task(get_all_links()),
loop.create_task(get_all_links()),
loop.create_task(get_all_links()),
loop.create_task(get_all_links()),
loop.create_task(get_all_links()),
loop.create_task(get_all_links()),
loop.create_task(get_all_links()),
loop.create_task(get_all_links()),
]
loop.run_until_complete(asyncio.wait(tasks))
loop.close()
end = time.time()
print(f"Time: {end-start:.2f} sec")
Run the file
python sample.py
Driver as server
To illustrate what I mean by "Driver as server", lets get chromedriver and execute it as an ordinary shell script file.
./chromedriver --port=9999
Starting ChromeDriver 94.0.4606.61 (418b78f5838ed0b1c69bb4e51ea0252171854915-refs/branch-heads/4606@{#1204}) on port 9999
Only local connections are allowed.
Please see https://chromedriver.chromium.org/security-considerations for suggestions on keeping ChromeDriver safe.
ChromeDriver was started successfully.
Notice the Driver is running and waiting for HTTP requests.
Lets open a new session against it
curl --location '127.0.0.1:9999/session' \
--header 'Content-Type: application/json' \
--data '{
"desiredCapabilities": {
"browserName": "firefox",
"marionette": true,
"acceptInsecureCerts": true
}
}'
Here is the response returned
{
"sessionId": "b6654121c4ba1e8395ded73a27b7d8f5",
"status": 0,
"value": {
"acceptInsecureCerts": true,
"acceptSslCerts": true,
"applicationCacheEnabled": false,
"browserConnectionEnabled": false,
"browserName": "chrome",
"chrome": {
"chromedriverVersion": "94.0.4606.61 (418b78f5838ed0b1c69bb4e51ea0252171854915-refs/branch-heads/4606@{#1204})",
"userDataDir": "/tmp/.com.google.Chrome.xtZUOj"
},
"cssSelectorsEnabled": true,
"databaseEnabled": false,
"goog:chromeOptions": {
"debuggerAddress": "localhost:44437"
},
"handlesAlerts": true,
"hasTouchScreen": false,
"javascriptEnabled": true,
"locationContextEnabled": true,
"mobileEmulationEnabled": false,
"nativeEvents": true,
"networkConnectionEnabled": false,
"pageLoadStrategy": "normal",
"platform": "Linux",
"proxy": {},
"rotatable": false,
"setWindowRect": true,
"strictFileInteractability": false,
"takesHeapSnapshot": true,
"takesScreenshot": true,
"timeouts": {
"implicit": 0,
"pageLoad": 300000,
"script": 30000
},
"unexpectedAlertBehaviour": "ignore",
"version": "94.0.4606.54",
"webStorageEnabled": true,
"webauthn:extension:credBlob": true,
"webauthn:extension:largeBlob": true,
"webauthn:virtualAuthenticators": true
}
}
The sessionId value can be used to perform further actions like find element, send keys or click buttons. More details can be found in Json Wire Protocol Specification. Also with the -h parameter in Drivers, for example:
./chromedriver -h
Usage: ./chromedriver [OPTIONS]
Options
--port=PORT port to listen on
--adb-port=PORT adb server port
--log-path=FILE write server log to file instead of stderr, increases log level to INFO
--log-level=LEVEL set log level: ALL, DEBUG, INFO, WARNING, SEVERE, OFF
--verbose log verbosely (equivalent to --log-level=ALL)
--silent log nothing (equivalent to --log-level=OFF)
--append-log append log file instead of rewriting
--replayable (experimental) log verbosely and don't truncate long strings so that the log can be replayed.
--version print the version number and exit
--url-base base URL path prefix for commands, e.g. wd/url
--readable-timestamp add readable timestamps to log
--enable-chrome-logs show logs from the browser (overrides other logging options)
--disable-dev-shm-usage do not use /dev/shm (add this switch if seeing errors related to shared memory)
--allowed-ips comma-separated allowlist of remote IP addresses which are allowed to connect to ChromeDriver
Contributing
Install the dependencies (Python >= 3.7)
python3 -m venv venv
pip install -e .
pip install -r test-requirements.txt
Fork this repository, make the changes into the forked repository and push a new Merge Request to 'main' branch. Open an issue in case of big MRs.
Testing
To run the tests, start a new Driver as server on port 9999, for example:
./chromedriver --port=9999
And execute the tests
python -m pytest
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
