remote_connection_tests.py

# 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 base64
import time

import filetype
import pytest
from urllib3.exceptions import ReadTimeoutError

from selenium import webdriver
from selenium.webdriver.common.by import By
from selenium.webdriver.remote.client_config import ClientConfig

pytestmark = pytest.mark.xfail(reason="Tests not working as intended")


def test_browser_specific_method(firefox_options, webserver, server, request):
    """Uses Firefox specific method."""
    with webdriver.Remote(options=firefox_options) as driver:
        driver.get(f"{webserver}/simpleTest.html")
        screenshot = driver.execute("FULL_PAGE_SCREENSHOT")["value"]
        result = base64.b64decode(screenshot)
        kind = filetype.guess(result)
        assert kind is not None
        assert kind.mime == "image/png"


def test_remote_webdriver_with_http_timeout(clean_options, webserver, server):
    """This test starts a remote webdriver with an http client timeout.

    It verifies the http timeout is triggered first when waiting for an element,
    with the timeout set less than the implicit wait timeout.
    """
    http_timeout = 4
    wait_timeout = 6
    server_addr = server.status_url.removesuffix("/status")
    client_config = ClientConfig(remote_server_addr=server_addr, timeout=http_timeout)
    with webdriver.Remote(options=clean_options, client_config=client_config) as driver:
        driver.get(f"{webserver.where_is('simpleTest.html')}")
        driver.implicitly_wait(wait_timeout)
        with pytest.raises(ReadTimeoutError):
            driver.find_element(By.ID, "no_element_to_be_found")


def test_remote_webdriver_with_websocket_timeout(clean_options, webserver, server):
    """This test starts a remote webdriver that uses websockets, and has a websocket client timeout.

    It verifies the websocket times out according to this value.
    """
    websocket_timeout = 2.0
    websocket_interval = 1.0

    server_addr = server.status_url.removesuffix("/status")
    client_config = ClientConfig(
        remote_server_addr=server_addr, websocket_timeout=websocket_timeout, websocket_interval=websocket_interval
    )
    assert client_config.websocket_timeout == websocket_timeout
    clean_options.enable_bidi = True
    with webdriver.Remote(options=clean_options, client_config=client_config) as driver:
        assert driver._websocket_connection.response_wait_timeout == websocket_timeout
        assert driver._websocket_connection.response_wait_interval == websocket_interval
        start = time.time()
        driver._websocket_connection.close()
        elapsed = time.time() - start
        assert elapsed >= websocket_timeout
        assert elapsed < websocket_timeout + 10