1 files changed, 102 insertions, 0 deletions
diff --git a/test/profiles.py b/test/profiles.py
new file mode 100755
index 0000000..1530aea
--- /dev/null
+++ b/test/profiles.py
@@ -0,0 +1,102 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+"""
+Browser profiles and Selenium driver initialization
+"""
+
+# This file is part of Haketilo.
+#
+# Copyright (C) 2021 Wojtek Kosior <koszko@koszko.org>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+# I, Wojtek Kosior, thereby promise not to sue for violation of this file's
+# license. Although I request that you do not make use this code in a
+# proprietary program, I am not going to enforce this in court.
+
+from selenium import webdriver
+from selenium.webdriver.firefox.options import Options
+import time
+
+from .misc_constants import *
+
+class HaketiloFirefox(webdriver.Firefox):
+    """
+    This wrapper class around selenium.webdriver.Firefox adds a `loaded_scripts`
+    instance property that gets resetted to an empty array every time the
+    `get()` method is called.
+    """
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.reset_loaded_scripts()
+
+    def reset_loaded_scripts(self):
+        self.loaded_scripts = []
+
+    def get(self, *args, **kwargs):
+        self.reset_loaded_scripts()
+        super().get(*args, **kwargs)
+
+def set_profile_proxy(profile, proxy_host, proxy_port):
+    """
+    Create a Firefox profile that uses the specified HTTP proxy for all
+    protocols.
+    """
+    # proxy type 1 designates "manual"
+    profile.set_preference('network.proxy.type',                 1)
+    profile.set_preference('network.proxy.no_proxies_on',        '')
+    profile.set_preference('network.proxy.share_proxy_settings', True)
+
+    for proto in ['http', 'ftp', 'socks', 'ssl']:
+        profile.set_preference(f'network.proxy.{proto}',             proxy_host)
+        profile.set_preference(f'network.proxy.{proto}_port',        proxy_port)
+        profile.set_preference(f'network.proxy.backup.{proto}',      '')
+        profile.set_preference(f'network.proxy.backup.{proto}_port', 0)
+
+def set_profile_console_logging(profile):
+    profile.set_preference('devtools.console.stdout.content', True)
+
+def firefox_safe_mode(firefox_binary=default_firefox_binary,
+                      proxy_host=default_proxy_host,
+                      proxy_port=default_proxy_port):
+    """
+    Initialize a Firefox instance controlled by selenium. The instance is
+    started in safe mode.
+    """
+    profile = webdriver.FirefoxProfile()
+    set_profile_proxy(profile, proxy_host, proxy_port)
+    set_profile_console_logging(profile)
+
+    options = Options()
+    options.add_argument('--safe-mode')
+
+    return HaketiloFirefox(options=options, firefox_profile=profile,
+                           firefox_binary=firefox_binary)
+
+def firefox_with_profile(firefox_binary=default_firefox_binary,
+                         profile_dir=default_clean_profile_dir,
+                         proxy_host=default_proxy_host,
+                         proxy_port=default_proxy_port):
+    """
+    Initialize a Firefox instance controlled by selenium. The instance is
+    started using an empty profile (either the default one or the one passed to
+    `configure` script). The empty profile is meant to make Firefox start with
+    globally-installed extensions disabled.
+    """
+    profile = webdriver.FirefoxProfile(profile_dir)
+    set_profile_proxy(profile, proxy_host, proxy_port)
+    set_profile_console_logging(profile)
+
+    return HaketiloFirefox(firefox_profile=profile,
+                           firefox_binary=firefox_binary)