16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156 | class WebDriverInitializer:
"""A class that initializes the web driver."""
def __init__(self) -> None:
self.session_store = SessionStore()
self.config_utils = ConfigUtils()
self.logger = CoreLogger(name=__name__).get_logger()
self.bs_obj = None
def initialize_driver(self) -> None:
"""Initialize the driver."""
try:
web_capabilities = self._get_web_capabilities()
bs_capabilities, current_browser = self._get_browserstack_capabilities(web_capabilities)
driver_obj = self._create_web_driver(web_capabilities, bs_capabilities, current_browser)
self._store_driver_in_session(driver_obj)
except Exception as error_before_scenario_browser_setup:
self.logger.error(
"Error occurred in before_scenario_browser_setup: %s",
str(error_before_scenario_browser_setup),
)
raise error_before_scenario_browser_setup
def _get_web_capabilities(self) -> dict:
web_capabilities = self.config_utils.fetch_web_browser_capabilities()
if web_capabilities and web_capabilities.get("use_caps", False):
self.logger.debug("Desired Capabilities: %s", web_capabilities)
else:
web_capabilities = {}
return web_capabilities
def _get_browserstack_capabilities(self, web_capabilities: dict) -> tuple:
run_on_browserstack = self.config_utils.base_config.get("run_on_browserstack", False)
if str(run_on_browserstack).lower() == "true":
self.bs_obj = BrowserStackDriverFactory()
bs_capabilities, current_browser = self._configure_browserstack()
else:
bs_capabilities = []
current_browser = self.config_utils.base_config.get(
"current_execution_browser", "chrome"
)
return bs_capabilities, current_browser
def _configure_browserstack(self) -> tuple:
browserstack_username = os.getenv("BROWSERSTACK_USERNAME")
browserstack_access_key = os.getenv("BROWSERSTACK_ACCESS_KEY")
if not browserstack_username or not browserstack_access_key:
self.logger.error("BROWSERSTACK_USERNAME or BROWSERSTACK_ACCESS_KEY not found.")
raise Exception("Browserstack credentials not found in environment variables.")
browserstack_config_file = self.config_utils.base_config.get(
"browserstack_config_file", "browserstack.yml"
)
bs_config = self.config_utils.read_browserstack_web_yml_file(browserstack_config_file)
if (
"use_random_browsers" in bs_config.keys()
and str(bs_config["use_random_browsers"]).lower() == "true"
):
random_browser = self._get_random_browser(
bs_config, browserstack_username, browserstack_access_key
)
bs_browser_capabilities = random_browser["bstack:options"]
current_browser = random_browser["browserName"].lower()
else:
current_browser = self.config_utils.base_config.get(
"current_execution_browser", "chrome"
)
bs_browser_capabilities = bs_config["browser"].get(current_browser, {})
if current_browser == "ie":
current_browser = "internet explorer"
bs_capabilities = {**bs_browser_capabilities, **bs_config["bstack:options"]}
return bs_capabilities, current_browser
def _get_random_browser(
self, bs_config: dict, browserstack_username: str, browserstack_access_key: str
) -> dict:
if (
"browserstack_browsers_file" in bs_config.keys()
and bs_config["browserstack_browsers_file"] is not None
):
return self.bs_obj.get_available_browsers(
bs_config["browserstack_browsers_file"],
browserstack_username,
browserstack_access_key,
)
return self.bs_obj.get_available_browsers(
"browsers.json", browserstack_username, browserstack_access_key
)
def _create_web_driver(
self, web_capabilities: dict, bs_capabilities: dict, current_browser: str
):
chrome_options = self.config_utils.base_config.get("chrome_options", [])
chrome_preferences = self.config_utils.base_config.get("chrome_preferences", {})
firefox_options = self.config_utils.base_config.get("firefox_options", [])
firefox_preferences = self.config_utils.base_config.get("firefox_preferences", {})
edge_options = self.config_utils.base_config.get("edge_options", [])
safari_options = self.config_utils.base_config.get("safari_options", [])
use_proxy = self.config_utils.base_config.get("use_proxy", False)
ie_and_edge_clear_browser_history = self.config_utils.base_config.get(
"ie_and_edge_clear_browser_history", False
)
browser_version = self.config_utils.base_config.get("browser_version", None)
proxy_options = self._get_proxy_options(use_proxy)
selenium_grid_ip = self.config_utils.fetch_selenium_grid_ip()
use_grid = self.config_utils.fetch_use_grid()
browserstack_username = os.getenv("BROWSERSTACK_USERNAME")
browserstack_access_key = os.getenv("BROWSERSTACK_ACCESS_KEY")
web_driver_factory = WebDriverFactory()
return web_driver_factory.create_driver(
current_browser,
use_grid=use_grid,
selenium_grid_ip=selenium_grid_ip,
proxies=proxy_options,
capabilities=web_capabilities,
browser_version=browser_version,
chrome_options=chrome_options,
chrome_preferences=chrome_preferences,
edge_options=edge_options,
firefox_options=firefox_options,
firefox_preferences=firefox_preferences,
safari_options=safari_options,
ie_and_edge_clear_browser_history=ie_and_edge_clear_browser_history,
browserstack_capabilities=bs_capabilities,
run_on_browserstack=str(
self.config_utils.base_config.get("run_on_browserstack", False)
).lower()
== "true",
browserstack_username=browserstack_username,
browserstack_access_key=browserstack_access_key,
)
def _get_proxy_options(self, use_proxy: bool) -> str:
if use_proxy and "proxy_options" in self.session_store.base_config.keys():
return self.session_store.base_config["proxy_options"]
return ""
def _store_driver_in_session(self, driver_obj) -> None:
self.session_store.driver = driver_obj
self.session_store.globals["obj_wdf"] = WebDriverFactory()
self.session_store.globals["obj_wca"] = WebClientActions(self.session_store.driver)
self.session_store.globals["obj_kma"] = KeyboardMouseActions(self.session_store.driver)
|