Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

Source code for galaxy.selenium.driver_factory

import os

try:
    from pyvirtualdisplay import Display
except ImportError:
    Display = None

from selenium import webdriver
from selenium.webdriver.chrome.options import Options as ChromeOptions
from selenium.webdriver.common.desired_capabilities import DesiredCapabilities


DEFAULT_BROWSER = "auto"
LOGGING_PREFS = {
    "browser": "ALL",
}


def get_local_browser(browser):
    if browser == "auto":
        if _which("chromedriver"):
            return "CHROME"
        elif _which("geckodriver"):
            return "FIREFOX"
        else:
            raise Exception("Selenium browser is 'auto' but neither geckodriver or chromedriver are found on PATH.")


[docs]def get_local_driver(browser=DEFAULT_BROWSER, headless=False): browser = get_local_browser(browser) assert browser in ["CHROME", "FIREFOX", "OPERA", "PHANTOMJS"] driver_to_class = { "CHROME": webdriver.Chrome, "FIREFOX": webdriver.Firefox, "OPERA": webdriver.Opera, "PHANTOMJS": webdriver.PhantomJS, } driver_class = driver_to_class[browser] if browser == 'CHROME' and headless: options = ChromeOptions() options.add_argument('--headless') return driver_class(desired_capabilities={"loggingPrefs": LOGGING_PREFS}, chrome_options=options) else: return driver_class(desired_capabilities={"loggingPrefs": LOGGING_PREFS})
[docs]def get_remote_driver( host, port, browser=DEFAULT_BROWSER ): # docker run -d -p 4444:4444 -v /dev/shm:/dev/shm selenium/standalone-chrome:3.0.1-aluminum if browser == "auto": browser = "CHROME" assert browser in ["CHROME", "EDGE", "ANDROID", "FIREFOX", "INTERNETEXPLORER", "IPAD", "IPHONE", "OPERA", "PHANTOMJS", "SAFARI"] desired_capabilities = getattr(DesiredCapabilities, browser) desired_capabilities["loggingPrefs"] = LOGGING_PREFS executor = 'http://%s:%s/wd/hub' % (host, port) driver = webdriver.Remote( command_executor=executor, desired_capabilities=desired_capabilities, ) return driver
[docs]def is_virtual_display_available(): return Display is not None
[docs]def virtual_display_if_enabled(enabled): if enabled: display = Display(visible=0, size=(800, 600)) display.start() return display else: return NoopDisplay()
class NoopDisplay(object): def stop(self): """No-op stop for consistent use with pyvirtualdisplay Display class.""" # Purposely copied from galaxy.util - just use galaxy.util if we decide # galaxy_selenium should definitely depend on Galaxy/galaxy-lib. def _which(file): # http://stackoverflow.com/questions/5226958/which-equivalent-function-in-python for path in os.environ["PATH"].split(":"): if os.path.exists(path + "/" + file): return path + "/" + file return None __all__ = ( 'get_local_driver', 'get_remote_driver', 'is_virtual_display_available', 'virtual_display_if_enabled', )