# 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.
from typing import Any, Dict, Type
from selenium.common.exceptions import (
DetachedShadowRootException,
ElementClickInterceptedException,
ElementNotInteractableException,
ElementNotSelectableException,
ElementNotVisibleException,
ImeActivationFailedException,
ImeNotAvailableException,
InsecureCertificateException,
InvalidArgumentException,
InvalidCookieDomainException,
InvalidCoordinatesException,
InvalidElementStateException,
InvalidSelectorException,
InvalidSessionIdException,
JavascriptException,
MoveTargetOutOfBoundsException,
NoAlertPresentException,
NoSuchCookieException,
NoSuchElementException,
NoSuchFrameException,
NoSuchShadowRootException,
NoSuchWindowException,
ScreenshotException,
SessionNotCreatedException,
StaleElementReferenceException,
TimeoutException,
UnableToSetCookieException,
UnexpectedAlertPresentException,
UnknownMethodException,
WebDriverException,
)
[docs]
class ExceptionMapping:
"""
:Maps each errorcode in ErrorCode object to corresponding exception
Please refer to https://www.w3.org/TR/webdriver2/#errors for w3c specification
"""
NO_SUCH_ELEMENT = NoSuchElementException
NO_SUCH_FRAME = NoSuchFrameException
NO_SUCH_SHADOW_ROOT = NoSuchShadowRootException
STALE_ELEMENT_REFERENCE = StaleElementReferenceException
ELEMENT_NOT_VISIBLE = ElementNotVisibleException
INVALID_ELEMENT_STATE = InvalidElementStateException
UNKNOWN_ERROR = WebDriverException
ELEMENT_IS_NOT_SELECTABLE = ElementNotSelectableException
JAVASCRIPT_ERROR = JavascriptException
TIMEOUT = TimeoutException
NO_SUCH_WINDOW = NoSuchWindowException
INVALID_COOKIE_DOMAIN = InvalidCookieDomainException
UNABLE_TO_SET_COOKIE = UnableToSetCookieException
UNEXPECTED_ALERT_OPEN = UnexpectedAlertPresentException
NO_ALERT_OPEN = NoAlertPresentException
SCRIPT_TIMEOUT = TimeoutException
IME_NOT_AVAILABLE = ImeNotAvailableException
IME_ENGINE_ACTIVATION_FAILED = ImeActivationFailedException
INVALID_SELECTOR = InvalidSelectorException
SESSION_NOT_CREATED = SessionNotCreatedException
MOVE_TARGET_OUT_OF_BOUNDS = MoveTargetOutOfBoundsException
INVALID_XPATH_SELECTOR = InvalidSelectorException
INVALID_XPATH_SELECTOR_RETURN_TYPER = InvalidSelectorException
ELEMENT_NOT_INTERACTABLE = ElementNotInteractableException
INSECURE_CERTIFICATE = InsecureCertificateException
INVALID_ARGUMENT = InvalidArgumentException
INVALID_COORDINATES = InvalidCoordinatesException
INVALID_SESSION_ID = InvalidSessionIdException
NO_SUCH_COOKIE = NoSuchCookieException
UNABLE_TO_CAPTURE_SCREEN = ScreenshotException
ELEMENT_CLICK_INTERCEPTED = ElementClickInterceptedException
UNKNOWN_METHOD = UnknownMethodException
DETACHED_SHADOW_ROOT = DetachedShadowRootException
[docs]
class ErrorCode:
"""Error codes defined in the WebDriver wire protocol."""
# Keep in sync with org.openqa.selenium.remote.ErrorCodes and errorcodes.h
SUCCESS = 0
NO_SUCH_ELEMENT = [7, "no such element"]
NO_SUCH_FRAME = [8, "no such frame"]
NO_SUCH_SHADOW_ROOT = ["no such shadow root"]
UNKNOWN_COMMAND = [9, "unknown command"]
STALE_ELEMENT_REFERENCE = [10, "stale element reference"]
ELEMENT_NOT_VISIBLE = [11, "element not visible"]
INVALID_ELEMENT_STATE = [12, "invalid element state"]
UNKNOWN_ERROR = [13, "unknown error"]
ELEMENT_IS_NOT_SELECTABLE = [15, "element not selectable"]
JAVASCRIPT_ERROR = [17, "javascript error"]
XPATH_LOOKUP_ERROR = [19, "invalid selector"]
TIMEOUT = [21, "timeout"]
NO_SUCH_WINDOW = [23, "no such window"]
INVALID_COOKIE_DOMAIN = [24, "invalid cookie domain"]
UNABLE_TO_SET_COOKIE = [25, "unable to set cookie"]
UNEXPECTED_ALERT_OPEN = [26, "unexpected alert open"]
NO_ALERT_OPEN = [27, "no such alert"]
SCRIPT_TIMEOUT = [28, "script timeout"]
INVALID_ELEMENT_COORDINATES = [29, "invalid element coordinates"]
IME_NOT_AVAILABLE = [30, "ime not available"]
IME_ENGINE_ACTIVATION_FAILED = [31, "ime engine activation failed"]
INVALID_SELECTOR = [32, "invalid selector"]
SESSION_NOT_CREATED = [33, "session not created"]
MOVE_TARGET_OUT_OF_BOUNDS = [34, "move target out of bounds"]
INVALID_XPATH_SELECTOR = [51, "invalid selector"]
INVALID_XPATH_SELECTOR_RETURN_TYPER = [52, "invalid selector"]
ELEMENT_NOT_INTERACTABLE = [60, "element not interactable"]
INSECURE_CERTIFICATE = ["insecure certificate"]
INVALID_ARGUMENT = [61, "invalid argument"]
INVALID_COORDINATES = ["invalid coordinates"]
INVALID_SESSION_ID = ["invalid session id"]
NO_SUCH_COOKIE = [62, "no such cookie"]
UNABLE_TO_CAPTURE_SCREEN = [63, "unable to capture screen"]
ELEMENT_CLICK_INTERCEPTED = [64, "element click intercepted"]
UNKNOWN_METHOD = ["unknown method exception"]
DETACHED_SHADOW_ROOT = [65, "detached shadow root"]
METHOD_NOT_ALLOWED = [405, "unsupported operation"]
[docs]
class ErrorHandler:
"""Handles errors returned by the WebDriver server."""
[docs]
def check_response(self, response: Dict[str, Any]) -> None:
"""Checks that a JSON response from the WebDriver does not have an
error.
:Args:
- response - The JSON response from the WebDriver server as a dictionary
object.
:Raises: If the response contains an error message.
"""
status = response.get("status", None)
if not status or status == ErrorCode.SUCCESS:
return
value = None
message = response.get("message", "")
screen: str = response.get("screen", "")
stacktrace = None
if isinstance(status, int):
value_json = response.get("value", None)
if value_json and isinstance(value_json, str):
import json
try:
value = json.loads(value_json)
if len(value) == 1:
value = value["value"]
status = value.get("error", None)
if not status:
status = value.get("status", ErrorCode.UNKNOWN_ERROR)
message = value.get("value") or value.get("message")
if not isinstance(message, str):
value = message
message = message.get("message")
else:
message = value.get("message", None)
except ValueError:
pass
exception_class: Type[WebDriverException]
e = ErrorCode()
error_codes = [item for item in dir(e) if not item.startswith("__")]
for error_code in error_codes:
error_info = getattr(ErrorCode, error_code)
if isinstance(error_info, list) and status in error_info:
exception_class = getattr(ExceptionMapping, error_code, WebDriverException)
break
else:
exception_class = WebDriverException
if not value:
value = response["value"]
if isinstance(value, str):
raise exception_class(value)
if message == "" and "message" in value:
message = value["message"]
screen = None # type: ignore[assignment]
if "screen" in value:
screen = value["screen"]
stacktrace = None
st_value = value.get("stackTrace") or value.get("stacktrace")
if st_value:
if isinstance(st_value, str):
stacktrace = st_value.split("\n")
else:
stacktrace = []
try:
for frame in st_value:
line = frame.get("lineNumber", "")
file = frame.get("fileName", "<anonymous>")
if line:
file = f"{file}:{line}"
meth = frame.get("methodName", "<anonymous>")
if "className" in frame:
meth = f"{frame['className']}.{meth}"
msg = " at %s (%s)"
msg = msg % (meth, file)
stacktrace.append(msg)
except TypeError:
pass
if exception_class == UnexpectedAlertPresentException:
alert_text = None
if "data" in value:
alert_text = value["data"].get("text")
elif "alert" in value:
alert_text = value["alert"].get("text")
raise exception_class(message, screen, stacktrace, alert_text) # type: ignore[call-arg] # mypy is not smart enough here
raise exception_class(message, screen, stacktrace)