Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#7415 - Reformatted webdriver creation for test setup to use only one function for the creation of the webdriver #7439

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

#7415 - Reformatted webdriver creation for test setup to use only one function for the creation of the webdriver #7439

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
172 changes: 83 additions & 89 deletions securedrop/tests/functional/web_drivers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,105 +37,99 @@ class WebDriverTypeEnum(Enum):
_DRIVER_RETRY_INTERVAL = 5


def _create_torbrowser_driver(
accept_languages: Optional[str] = None,
) -> TorBrowserDriver:
logging.info("Creating TorBrowserDriver")
log_file = open(_LOGFILE_PATH, "a")
log_file.write(f"\n\n[{datetime.now()}] Running Functional Tests\n")
log_file.flush()

# Don't use Tor when reading from localhost, and turn off private
# browsing. We need to turn off private browsing because we won't be
# able to access the browser's cookies in private browsing mode. Since
# we use session cookies in SD anyway (in private browsing mode all
# cookies are set as session cookies), this should not affect session
# lifetime.
pref_dict = {
"network.proxy.no_proxies_on": "127.0.0.1",
"browser.privatebrowsing.autostart": False,
}

Path(_TBB_PATH).mkdir(parents=True, exist_ok=True)
torbrowser_driver = None
for i in range(_DRIVER_RETRY_COUNT):
try:
torbrowser_driver = TorBrowserDriver(
_TBB_PATH,
tor_cfg=cm.USE_RUNNING_TOR,
pref_dict=pref_dict,
tbb_logfile_path=_LOGFILE_PATH,
)
if accept_languages is not None:
# privacy.spoof_english per
# <https://github.com/arkenfox/user.js/issues/1827#issuecomment-2075819482>.
set_tbb_pref(torbrowser_driver, "privacy.spoof_english", 1)
set_tbb_pref(torbrowser_driver, "intl.locale.requested", accept_languages)

logging.info("Created Tor Browser web driver")
torbrowser_driver.set_window_position(0, 0)
torbrowser_driver.set_window_size(*_BROWSER_SIZE)
break
except Exception as e:
logging.error("Error creating Tor Browser web driver: %s", e)
if i < _DRIVER_RETRY_COUNT:
time.sleep(_DRIVER_RETRY_INTERVAL)

if not torbrowser_driver:
raise Exception("Could not create Tor Browser web driver")

# Add this attribute to the returned driver object so that tests using this
# fixture can know what locale it's parameterized with.
torbrowser_driver.locale = accept_languages # type: ignore[attr-defined]

return torbrowser_driver


def _create_firefox_driver(
accept_languages: Optional[str] = None,
) -> webdriver.Firefox:
logging.info("Creating Firefox web driver")

firefox_options = webdriver.FirefoxOptions()
firefox_options.binary_location = _FIREFOX_PATH
if accept_languages is not None:
firefox_options.set_preference("intl.accept_languages", accept_languages)
def _create_driver(web_driver_type: WebDriverTypeEnum, accept_languages: Optional[str] = None, **kwargs) -> WebDriver:
"""
Creates and configures a WebDriver instance based on the specified driver class.

firefox_driver = None
for i in range(_DRIVER_RETRY_COUNT):
try:
firefox_driver = webdriver.Firefox(options=firefox_options)
firefox_driver.set_window_position(0, 0)
firefox_driver.set_window_size(*_BROWSER_SIZE)
logging.info("Created Firefox web driver")
break
except Exception as e:
logging.error("Error creating Firefox web driver: %s", e)
if i < _DRIVER_RETRY_COUNT:
time.sleep(_DRIVER_RETRY_INTERVAL)

if not firefox_driver:
raise Exception("Could not create Firefox web driver")
Args:
web_driver_type: The WebDriver class to instantiate (TorBrowserDriver or Firefox)
accept_languages: Optional language preferences string
**kwargs: Additional keyword arguments

# Add this attribute to the returned driver object so that tests using this
# fixture can know what locale it's parameterized with.
firefox_driver.locale = accept_languages # type: ignore[attr-defined]
Returns:
Configured WebDriver instance

return firefox_driver
Raises:
ValueError: If an unsupported driver class is provided
Exception: If driver creation fails after retry attempts
"""
if web_driver_type not in WebDriverTypeEnum:
raise ValueError(f"Unsupported driver class: {web_driver_type}")

if web_driver_type == WebDriverTypeEnum.TOR_BROWSER:
logging.info("Creating TorBrowserDriver")
log_file = open(_LOGFILE_PATH, "a")
log_file.write(f"\n\n[{datetime.now()}] Running Functional Tests\n")
log_file.flush()

pref_dict = {
"network.proxy.no_proxies_on": "127.0.0.1",
"browser.privatebrowsing.autostart": False,
}

Path(_TBB_PATH).mkdir(parents=True, exist_ok=True)
torbrowser_driver = None
for i in range(_DRIVER_RETRY_COUNT):
try:
torbrowser_driver = TorBrowserDriver(
_TBB_PATH,
tor_cfg=cm.USE_RUNNING_TOR,
pref_dict=pref_dict,
tbb_logfile_path=_LOGFILE_PATH,
)
if accept_languages is not None:
set_tbb_pref(torbrowser_driver, "privacy.spoof_english", 1)
set_tbb_pref(torbrowser_driver, "intl.locale.requested", accept_languages)

logging.info("Created Tor Browser web driver")
torbrowser_driver.set_window_position(0, 0)
torbrowser_driver.set_window_size(*_BROWSER_SIZE)
break
except Exception as e:
logging.error("Error creating Tor Browser web driver: %s", e)
if i < _DRIVER_RETRY_COUNT:
time.sleep(_DRIVER_RETRY_INTERVAL)

if not torbrowser_driver:
raise Exception("Could not create Tor Browser web driver")

torbrowser_driver.locale = accept_languages # type: ignore[attr-defined]
return torbrowser_driver

else: # Firefox driver
logging.info("Creating Firefox web driver")
firefox_options = webdriver.FirefoxOptions()
firefox_options.binary_location = _FIREFOX_PATH
if accept_languages is not None:
firefox_options.set_preference("intl.accept_languages", accept_languages)

firefox_driver = None
for i in range(_DRIVER_RETRY_COUNT):
try:
firefox_driver = webdriver.Firefox(options=firefox_options)
firefox_driver.set_window_position(0, 0)
firefox_driver.set_window_size(*_BROWSER_SIZE)
logging.info("Created Firefox web driver")
break
except Exception as e:
logging.error("Error creating Firefox web driver: %s", e)
if i < _DRIVER_RETRY_COUNT:
time.sleep(_DRIVER_RETRY_INTERVAL)

if not firefox_driver:
raise Exception("Could not create Firefox web driver")

firefox_driver.locale = accept_languages # type: ignore[attr-defined]
return firefox_driver

@contextmanager
def get_web_driver(
web_driver_type: WebDriverTypeEnum = WebDriverTypeEnum.TOR_BROWSER,
web_driver_type: WebDriverTypeEnum,
accept_languages: Optional[str] = None,
) -> Generator[WebDriver, None, None]:
if web_driver_type == WebDriverTypeEnum.TOR_BROWSER:
web_driver = _create_torbrowser_driver(accept_languages=accept_languages)
elif web_driver_type == WebDriverTypeEnum.FIREFOX:
web_driver = _create_firefox_driver(accept_languages=accept_languages)
else:
raise ValueError(f"Unexpected value {web_driver_type}")

# Creates the webdriver based on the class inserted
web_driver = _create_driver(web_driver_type=web_driver_type, accept_languages=accept_languages)
try:
yield web_driver
finally:
Expand Down