def open_browser(browser_id=None):
"""Open a browser.
When opening more than one browser instance per test
provide a browser_id to switch between browsers later on
:Raises:
- InvalidBrowserIdError: The browser Id is already in use
:Returns:
the opened browser
"""
@contextmanager
def validate_exec_path(browser_name, exec_path_setting, settings):
executable_path = settings[exec_path_setting]
if executable_path:
matched_executable_path = utils.match_latest_executable_path(
executable_path)
if matched_executable_path:
try:
yield matched_executable_path
except:
msg = ('Could not start {} driver using the path \'{}\'\n'
'verify that the {} setting points to a valid webdriver executable.'
.format(browser_name, executable_path, exec_path_setting))
execution.logger.error(msg)
execution.logger.info(traceback.format_exc())
raise Exception(msg)
else:
msg = 'No executable file found using path {}'.format(
executable_path)
execution.logger.error(msg)
raise Exception(msg)
else:
msg = '{} setting is not defined'.format(exec_path_setting)
execution.logger.error(msg)
raise Exception(msg)
@contextmanager
def validate_remote_url(remote_url):
if remote_url:
yield remote_url
else:
msg = 'remote_url setting is required'
execution.logger.error(msg)
raise Exception(msg)
driver = None
if not browser_id:
if len(execution.browsers) == 0:
browser_id = 'main'
else:
browser_id = 'browser{}'.format(len(execution.browsers))
if browser_id in execution.browsers:
raise InvalidBrowserIdError(
"browser id '{}' is already in use".format(browser_id))
browser_definition = execution.browser_definition
settings = execution.settings
# remote
if browser_definition['remote']:
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(command_executor=remote_url,
desired_capabilities=browser_definition['capabilities'])
# Chrome
elif browser_definition['name'] == 'chrome':
with validate_exec_path('chrome', 'chromedriver_path', settings) as ex_path:
chrome_options = webdriver.ChromeOptions()
print(settings['additional_browser_options'])
for i in range(len(settings['additional_browser_options'])):
chrome_options.add_argument(
settings['additional_browser_options'][i])
if settings['start_maximized']:
chrome_options.add_argument('start-maximized')
driver = GolemChromeDriver(executable_path=ex_path,
chrome_options=chrome_options)
# Chrome headless
elif browser_definition['name'] == 'chrome-headless':
with validate_exec_path('chrome', 'chromedriver_path', settings) as ex_path:
chrome_options = webdriver.ChromeOptions()
for i in range(len(settings['additional_browser_options'])):
chrome_options.add_argument(
settings['additional_browser_options'][i])
chrome_options.add_argument('headless')
chrome_options.add_argument('--window-size=1600,1600')
driver = GolemChromeDriver(executable_path=ex_path,
chrome_options=chrome_options)
# Chrome remote
elif browser_definition['name'] == 'chrome-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(command_executor=remote_url,
desired_capabilities=DesiredCapabilities.CHROME)
# Chrome remote headless
elif browser_definition['name'] == 'chrome-remote-headless':
with validate_remote_url(settings['remote_url']) as remote_url:
chrome_options = webdriver.ChromeOptions()
for i in range(len(settings['additional_browser_options'])):
chrome_options.add_argument(
settings['additional_browser_options'][i])
chrome_options.add_argument('headless')
desired_capabilities = chrome_options.to_capabilities()
driver = GolemRemoteDriver(command_executor=remote_url,
desired_capabilities=desired_capabilities)
# Edge
elif browser_definition['name'] == 'edge':
with validate_exec_path('edge', 'edgedriver_path', settings) as ex_path:
driver = GolemEdgeDriver(executable_path=ex_path)
# Edge remote
elif browser_definition['name'] == 'edge-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(command_executor=remote_url,
desired_capabilities=DesiredCapabilities.EDGE)
# Firefox
elif browser_definition['name'] == 'firefox':
with validate_exec_path('firefox', 'geckodriver_path', settings) as ex_path:
firefox_options = webdriver.FirefoxOptions()
for i in range(len(settings['additional_browser_options'])):
firefox_options.add_argument(
settings['additional_browser_options'][i])
driver = GolemGeckoDriver(
executable_path=ex_path, firefox_options=firefox_options)
# Firefox headless
elif browser_definition['name'] == 'firefox-headless':
with validate_exec_path('firefox', 'geckodriver_path', settings) as ex_path:
firefox_options = webdriver.FirefoxOptions()
for i in range(len(settings['additional_browser_options'])):
firefox_options.add_argument(
settings['additional_browser_options'][i])
firefox_options.headless = True
driver = GolemGeckoDriver(
executable_path=ex_path, firefox_options=firefox_options)
# Firefox remote
elif browser_definition['name'] == 'firefox-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(command_executor=remote_url,
desired_capabilities=DesiredCapabilities.FIREFOX)
# Firefox remote headless
elif browser_definition['name'] == 'firefox-remote-headless':
with validate_remote_url(settings['remote_url']) as remote_url:
firefox_options = webdriver.FirefoxOptions()
for i in range(len(settings['additional_browser_options'])):
firefox_options.add_argument(
settings['additional_browser_options'][i])
firefox_options.headless = True
desired_capabilities = firefox_options.to_capabilities()
driver = GolemRemoteDriver(command_executor=remote_url,
desired_capabilities=desired_capabilities)
# IE
elif browser_definition['name'] == 'ie':
with validate_exec_path('internet explorer', 'iedriver_path', settings) as ex_path:
driver = GolemIeDriver(executable_path=ex_path)
# IE remote
elif browser_definition['name'] == 'ie-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(command_executor=remote_url,
desired_capabilities=DesiredCapabilities.INTERNETEXPLORER)
# Opera
elif browser_definition['name'] == 'opera':
with validate_exec_path('opera', 'operadriver_path', settings) as ex_path:
opera_options = webdriver.ChromeOptions()
for i in range(len(settings['additional_browser_options'])):
opera_options.add_argument(
settings['additional_browser_options'][i])
if 'opera_binary_path' in settings:
opera_options.binary_location = settings['opera_binary_path']
driver = GolemOperaDriver(
executable_path=ex_path, options=opera_options)
# Opera remote
elif browser_definition['name'] == 'opera-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(command_executor=remote_url,
desired_capabilities=DesiredCapabilities.OPERA)
else:
raise Exception('Error: {} is not a valid driver'.format(
browser_definition['name']))
if settings['start_maximized']:
# currently there is no way to maximize chrome window on OSX (chromedriver 2.43), adding workaround
# https://bugs.chromium.org/p/chromedriver/issues/detail?id=2389
# https://bugs.chromium.org/p/chromedriver/issues/detail?id=2522
# TODO: assess if this work-around is still needed when chromedriver 2.44 is released
is_mac = 'mac' in driver.capabilities.get('platform', '').lower()
if not ('chrome' in browser_definition['name'] and is_mac):
driver.maximize_window()
execution.browsers[browser_id] = driver
# Set the new browser as the active browser
execution.browser = driver
return execution.browser
def open_browser(browser_id=None):
"""Open a browser.
When opening more than one browser instance per test
provide a browser_id to switch between browsers later on
"""
@contextmanager
def validate_exec_path(browser_name, exec_path_setting, settings):
executable_path = settings[exec_path_setting]
if executable_path:
matched_executable_path = utils.match_latest_executable_path(
executable_path)
if matched_executable_path:
try:
yield matched_executable_path
except:
msg = (
'Could not start {} driver using the path \'{}\'\n'
'verify that the {} setting points to a valid webdriver executable.'
.format(browser_name, executable_path,
exec_path_setting))
execution.logger.error(msg)
execution.logger.info(traceback.format_exc())
raise Exception(msg)
else:
msg = 'No executable file found using path {}'.format(
executable_path)
execution.logger.error(msg)
raise Exception(msg)
else:
msg = '{} setting is not defined'.format(exec_path_setting)
execution.logger.error(msg)
raise Exception(msg)
@contextmanager
def validate_remote_url(remote_url):
if remote_url:
yield remote_url
else:
msg = 'remote_url setting is required'
execution.logger.error(msg)
raise Exception(msg)
driver = None
browser_definition = execution.browser_definition
settings = execution.settings
# remote
if browser_definition['remote']:
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=browser_definition['capabilities'])
# Chrome
elif browser_definition['name'] == 'chrome':
with validate_exec_path('chrome', 'chromedriver_path',
settings) as ex_path:
chrome_options = webdriver.ChromeOptions()
if settings['start_maximized']:
chrome_options.add_argument('start-maximized')
driver = GolemChromeDriver(executable_path=ex_path,
chrome_options=chrome_options)
# Chrome remote
elif browser_definition['name'] == 'chrome-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.CHROME)
# Chrome headless
elif browser_definition['name'] == 'chrome-headless':
with validate_exec_path('chrome', 'chromedriver_path',
settings) as ex_path:
chrome_options = webdriver.ChromeOptions()
chrome_options.add_argument('headless')
chrome_options.add_argument('--window-size=1600,1600')
driver = GolemChromeDriver(executable_path=ex_path,
chrome_options=chrome_options)
# Chrome remote headless
elif browser_definition['name'] == 'chrome-remote-headless':
with validate_remote_url(settings) as remote_url:
chrome_options = webdriver.ChromeOptions()
chrome_options.add_argument('headless')
desired_capabilities = chrome_options.to_capabilities()
driver = GolemChromeDriver(
command_executor=remote_url,
desired_capabilities=desired_capabilities)
# Edge
elif browser_definition['name'] == 'edge':
with validate_exec_path('edge', 'edgedriver_path',
settings) as ex_path:
driver = GolemEdgeDriver(executable_path=ex_path)
# Edge remote
elif browser_definition['name'] == 'edge-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.EDGE)
# Firefox
elif browser_definition['name'] == 'firefox':
with validate_exec_path('firefox', 'geckodriver_path',
settings) as ex_path:
driver = GolemGeckoDriver(executable_path=ex_path)
# Firefox remote
elif browser_definition['name'] == 'firefox-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.FIREFOX)
# IE
elif browser_definition['name'] == 'ie':
with validate_exec_path('internet explorer', 'iedriver_path',
settings) as ex_path:
driver = GolemIeDriver(executable_path=ex_path)
# IE remote
elif browser_definition['name'] == 'ie-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.INTERNETEXPLORER)
# Opera
elif browser_definition['name'] == 'opera':
with validate_exec_path('opera', 'operadriver_path',
settings) as ex_path:
opera_options = webdriver.ChromeOptions()
if 'opera_binary_path' in settings:
opera_options.binary_location = settings['opera_binary_path']
driver = GolemOperaDriver(executable_path=ex_path,
options=opera_options)
# Opera remote
elif browser_definition['name'] == 'opera-remote':
with validate_remote_url(settings['remote_url']) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.OPERA)
else:
raise Exception('Error: {} is not a valid driver'.format(
browser_definition['name']))
if settings['start_maximized']:
# currently there is no way to maximize chrome window on OSX, adding workaround
# https://bugs.chromium.org/p/chromedriver/issues/detail?id=2389
if not ('headless' in browser_definition['name'] or
('chrome' in browser_definition['name'] and
(platform.system() == 'Darwin'))):
driver.maximize_window()
if not browser_id:
if len(execution.browsers) == 0:
browser_id = 'main'
else:
browser_id = 'browser{}'.format(len(execution.browsers))
execution.browsers[browser_id] = driver
if not execution.browser:
execution.browser = driver
def open_browser(browser_name=None,
capabilities=None,
remote_url=None,
browser_id=None):
"""Open a browser.
When no arguments are provided the browser is selected from
the CLI -b|--browsers argument, the suite `browsers` list,
or the `default_browser` setting.
This can be overridden in two ways:
- a local webdriver instance or
- a remote Selenium Grid driver instance.
To open a local Webdriver instance pass browser_name with a valid value:
chrome, chrome-remote, chrome-headless, chrome-remote-headless, edge,
edge-remote, firefox, firefox-headless, firefox-remote,
firefox-remote-headless, ie, ie-remote, opera, opera-remote
To open a remote Selenium Grid driver pass a capabilities dictionary and
a remote_url.
The minimum capabilities required is: {
browserName: 'chrome'
version: ''
platform: ''
}
More info here: https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
If remote_url is None it will be taken from the `remote_url` setting.
When opening more than one browser instance per test
provide a browser_id to switch between browsers later on
:Raises:
- InvalidBrowserIdError: The browser Id is already in use
:Returns:
the opened browser
"""
@contextmanager
def validate_exec_path(browser_name, exec_path_setting, settings):
executable_path = settings[exec_path_setting]
if executable_path:
matched_executable_path = utils.match_latest_executable_path(
executable_path, execution.testdir)
if matched_executable_path:
try:
yield matched_executable_path
except:
msg = f"Could not start {browser_name} driver using the path '{executable_path}'\n" \
f"verify that the {exec_path_setting} setting points to a valid webdriver executable."
execution.logger.error(msg)
execution.logger.info(traceback.format_exc())
raise Exception(msg)
else:
msg = f'No executable file found using path {executable_path}'
execution.logger.error(msg)
raise Exception(msg)
else:
msg = f'{exec_path_setting} setting is not defined'
execution.logger.error(msg)
raise Exception(msg)
@contextmanager
def validate_remote_url(remote_url):
if remote_url:
yield remote_url
else:
msg = 'remote_url setting is required'
execution.logger.error(msg)
raise Exception(msg)
project = Project(execution.project_name)
browser_definition = execution.browser_definition
settings = execution.settings
if browser_name is None:
browser_name = browser_definition['name']
if capabilities is None:
capabilities = browser_definition['capabilities']
if remote_url is None:
remote_url = settings['remote_url']
is_custom = False
if not browser_id:
if len(execution.browsers) == 0:
browser_id = 'main'
else:
browser_id = f'browser{len(execution.browsers)}'
if browser_id in execution.browsers:
raise InvalidBrowserIdError(
f"browser id '{browser_id}' is already in use")
# remote
if capabilities:
with validate_remote_url(remote_url) as remote_url:
driver = GolemRemoteDriver(command_executor=remote_url,
desired_capabilities=capabilities)
# Chrome
elif browser_name == 'chrome':
with validate_exec_path('chrome', 'chromedriver_path',
settings) as ex_path:
chrome_options = webdriver.ChromeOptions()
if settings['start_maximized']:
chrome_options.add_argument('start-maximized')
driver = GolemChromeDriver(executable_path=ex_path,
chrome_options=chrome_options)
# Chrome headless
elif browser_name == 'chrome-headless':
with validate_exec_path('chrome', 'chromedriver_path',
settings) as ex_path:
chrome_options = webdriver.ChromeOptions()
chrome_options.add_argument('headless')
chrome_options.add_argument('--window-size=1600,1600')
driver = GolemChromeDriver(executable_path=ex_path,
chrome_options=chrome_options)
# Chrome remote
elif browser_name == 'chrome-remote':
with validate_remote_url(remote_url) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.CHROME)
# Chrome remote headless
elif browser_name == 'chrome-remote-headless':
with validate_remote_url(remote_url) as remote_url:
chrome_options = webdriver.ChromeOptions()
chrome_options.add_argument('headless')
desired_capabilities = chrome_options.to_capabilities()
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=desired_capabilities)
# Edge
elif browser_name == 'edge':
with validate_exec_path('edge', 'edgedriver_path',
settings) as ex_path:
driver = GolemEdgeDriver(executable_path=ex_path)
# Edge remote
elif browser_name == 'edge-remote':
with validate_remote_url(remote_url) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.EDGE)
# Firefox
elif browser_name == 'firefox':
with validate_exec_path('firefox', 'geckodriver_path',
settings) as ex_path:
driver = GolemGeckoDriver(executable_path=ex_path)
# Firefox headless
elif browser_name == 'firefox-headless':
with validate_exec_path('firefox', 'geckodriver_path',
settings) as ex_path:
firefox_options = webdriver.FirefoxOptions()
firefox_options.headless = True
driver = GolemGeckoDriver(executable_path=ex_path,
firefox_options=firefox_options)
# Firefox remote
elif browser_name == 'firefox-remote':
with validate_remote_url(remote_url) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.FIREFOX)
# Firefox remote headless
elif browser_name == 'firefox-remote-headless':
with validate_remote_url(remote_url) as remote_url:
firefox_options = webdriver.FirefoxOptions()
firefox_options.headless = True
desired_capabilities = firefox_options.to_capabilities()
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=desired_capabilities)
# IE
elif browser_name == 'ie':
with validate_exec_path('internet explorer', 'iedriver_path',
settings) as ex_path:
driver = GolemIeDriver(executable_path=ex_path)
# IE remote
elif browser_name == 'ie-remote':
with validate_remote_url(remote_url) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.INTERNETEXPLORER)
# Opera
elif browser_name == 'opera':
with validate_exec_path('opera', 'operadriver_path',
settings) as ex_path:
opera_options = webdriver.ChromeOptions()
if 'opera_binary_path' in settings:
opera_options.binary_location = settings['opera_binary_path']
driver = GolemOperaDriver(executable_path=ex_path,
options=opera_options)
# Opera remote
elif browser_name == 'opera-remote':
with validate_remote_url(remote_url) as remote_url:
driver = GolemRemoteDriver(
command_executor=remote_url,
desired_capabilities=DesiredCapabilities.OPERA)
elif browser_name in project.custom_browsers():
is_custom = True
module, _ = project.custom_browser_module()
custom_browser_func = getattr(module, browser_name)
driver = custom_browser_func(settings)
else:
raise Exception(
f"Error: {browser_definition['name']} is not a valid driver")
if settings['start_maximized'] and not is_custom:
# currently there is no way to maximize chrome window on OSX (chromedriver 2.43), adding workaround
# https://bugs.chromium.org/p/chromedriver/issues/detail?id=2389
# https://bugs.chromium.org/p/chromedriver/issues/detail?id=2522
# TODO: assess if this work-around is still needed when chromedriver 2.44 is released
is_mac = 'mac' in driver.capabilities.get('platform', '').lower()
if not ('chrome' in browser_definition['name'] and is_mac):
driver.maximize_window()
execution.browsers[browser_id] = driver
# Set the new browser as the active browser
execution.browser = driver
return execution.browser