You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
162 lines
5.9 KiB
162 lines
5.9 KiB
5 years ago
|
# Licensed to the Software Freedom Conservancy (SFC) under one
|
||
|
# or more contributor license agreements. See the NOTICE file
|
||
|
# distributed with this work for additional information
|
||
|
# regarding copyright ownership. The SFC licenses this file
|
||
|
# to you under the Apache License, Version 2.0 (the
|
||
|
# "License"); you may not use this file except in compliance
|
||
|
# with the License. You may obtain a copy of the License at
|
||
|
#
|
||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||
|
#
|
||
|
# Unless required by applicable law or agreed to in writing,
|
||
|
# software distributed under the License is distributed on an
|
||
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||
|
# KIND, either express or implied. See the License for the
|
||
|
# specific language governing permissions and limitations
|
||
|
# under the License.
|
||
|
import warnings
|
||
|
|
||
|
from selenium.webdriver.remote.webdriver import WebDriver as RemoteWebDriver
|
||
|
from .remote_connection import ChromeRemoteConnection
|
||
|
from .service import Service
|
||
|
from .options import Options
|
||
|
|
||
|
|
||
|
class WebDriver(RemoteWebDriver):
|
||
|
"""
|
||
|
Controls the ChromeDriver and allows you to drive the browser.
|
||
|
|
||
|
You will need to download the ChromeDriver executable from
|
||
|
http://chromedriver.storage.googleapis.com/index.html
|
||
|
"""
|
||
|
|
||
|
def __init__(self, executable_path="chromedriver", port=0,
|
||
|
options=None, service_args=None,
|
||
|
desired_capabilities=None, service_log_path=None,
|
||
|
chrome_options=None, keep_alive=True):
|
||
|
"""
|
||
|
Creates a new instance of the chrome driver.
|
||
|
|
||
|
Starts the service and then creates new instance of chrome driver.
|
||
|
|
||
|
:Args:
|
||
|
- executable_path - path to the executable. If the default is used it assumes the executable is in the $PATH
|
||
|
- port - port you would like the service to run, if left as 0, a free port will be found.
|
||
|
- options - this takes an instance of ChromeOptions
|
||
|
- service_args - List of args to pass to the driver service
|
||
|
- desired_capabilities - Dictionary object with non-browser specific
|
||
|
capabilities only, such as "proxy" or "loggingPref".
|
||
|
- service_log_path - Where to log information from the driver.
|
||
|
- chrome_options - Deprecated argument for options
|
||
|
- keep_alive - Whether to configure ChromeRemoteConnection to use HTTP keep-alive.
|
||
|
"""
|
||
|
if chrome_options:
|
||
|
warnings.warn('use options instead of chrome_options',
|
||
|
DeprecationWarning, stacklevel=2)
|
||
|
options = chrome_options
|
||
|
|
||
|
if options is None:
|
||
|
# desired_capabilities stays as passed in
|
||
|
if desired_capabilities is None:
|
||
|
desired_capabilities = self.create_options().to_capabilities()
|
||
|
else:
|
||
|
if desired_capabilities is None:
|
||
|
desired_capabilities = options.to_capabilities()
|
||
|
else:
|
||
|
desired_capabilities.update(options.to_capabilities())
|
||
|
|
||
|
self.service = Service(
|
||
|
executable_path,
|
||
|
port=port,
|
||
|
service_args=service_args,
|
||
|
log_path=service_log_path)
|
||
|
self.service.start()
|
||
|
|
||
|
try:
|
||
|
RemoteWebDriver.__init__(
|
||
|
self,
|
||
|
command_executor=ChromeRemoteConnection(
|
||
|
remote_server_addr=self.service.service_url,
|
||
|
keep_alive=keep_alive),
|
||
|
desired_capabilities=desired_capabilities)
|
||
|
except Exception:
|
||
|
self.quit()
|
||
|
raise
|
||
|
self._is_remote = False
|
||
|
|
||
|
def launch_app(self, id):
|
||
|
"""Launches Chrome app specified by id."""
|
||
|
return self.execute("launchApp", {'id': id})
|
||
|
|
||
|
def get_network_conditions(self):
|
||
|
"""
|
||
|
Gets Chrome network emulation settings.
|
||
|
|
||
|
:Returns:
|
||
|
A dict. For example:
|
||
|
|
||
|
{'latency': 4, 'download_throughput': 2, 'upload_throughput': 2,
|
||
|
'offline': False}
|
||
|
|
||
|
"""
|
||
|
return self.execute("getNetworkConditions")['value']
|
||
|
|
||
|
def set_network_conditions(self, **network_conditions):
|
||
|
"""
|
||
|
Sets Chrome network emulation settings.
|
||
|
|
||
|
:Args:
|
||
|
- network_conditions: A dict with conditions specification.
|
||
|
|
||
|
:Usage:
|
||
|
driver.set_network_conditions(
|
||
|
offline=False,
|
||
|
latency=5, # additional latency (ms)
|
||
|
download_throughput=500 * 1024, # maximal throughput
|
||
|
upload_throughput=500 * 1024) # maximal throughput
|
||
|
|
||
|
Note: 'throughput' can be used to set both (for download and upload).
|
||
|
"""
|
||
|
self.execute("setNetworkConditions", {
|
||
|
'network_conditions': network_conditions
|
||
|
})
|
||
|
|
||
|
def execute_cdp_cmd(self, cmd, cmd_args):
|
||
|
"""
|
||
|
Execute Chrome Devtools Protocol command and get returned result
|
||
|
|
||
|
The command and command args should follow chrome devtools protocol domains/commands, refer to link
|
||
|
https://chromedevtools.github.io/devtools-protocol/
|
||
|
|
||
|
:Args:
|
||
|
- cmd: A str, command name
|
||
|
- cmd_args: A dict, command args. empty dict {} if there is no command args
|
||
|
|
||
|
:Usage:
|
||
|
driver.execute_cdp_cmd('Network.getResponseBody', {'requestId': requestId})
|
||
|
|
||
|
:Returns:
|
||
|
A dict, empty dict {} if there is no result to return.
|
||
|
For example to getResponseBody:
|
||
|
|
||
|
{'base64Encoded': False, 'body': 'response body string'}
|
||
|
|
||
|
"""
|
||
|
return self.execute("executeCdpCommand", {'cmd': cmd, 'params': cmd_args})['value']
|
||
|
|
||
|
def quit(self):
|
||
|
"""
|
||
|
Closes the browser and shuts down the ChromeDriver executable
|
||
|
that is started when starting the ChromeDriver
|
||
|
"""
|
||
|
try:
|
||
|
RemoteWebDriver.quit(self)
|
||
|
except Exception:
|
||
|
# We don't care about the message because something probably has gone wrong
|
||
|
pass
|
||
|
finally:
|
||
|
self.service.stop()
|
||
|
|
||
|
def create_options(self):
|
||
|
return Options()
|