Add a settings file parser for overriding default settings

mdmintz · mdmintz · commit 276e9ab62f10 · 2019-08-09T04:27:34.000-04:00
diff --git a/seleniumbase/core/settings_parser.py b/seleniumbase/core/settings_parser.py
@@ -0,0 +1,157 @@
+import re
+from seleniumbase.config import settings
+
+
+def set_settings(settings_file):
+    if not settings_file.endswith('.py'):
+        raise Exception("\n\n`%s` is not a Python file!\n\n" % settings_file)
+
+    f = open(settings_file, 'r')
+    all_code = f.read()
+    f.close()
+
+    override_settings = {}
+    num_settings = 0
+
+    code_lines = all_code.split('\n')
+    for line in code_lines:
+
+        # KEY = "VALUE"
+        data = re.match(r'^\s*([\S]+)\s*=\s*"([\S\s]+)"\s*$', line)
+        if data:
+            key = data.group(1)
+            value = data.group(2)
+            override_settings[key] = value
+            num_settings += 1
+            continue
+
+        # KEY = 'VALUE'
+        data = re.match(r"^\s*([\S]+)\s*=\s*'([\S\s]+)'\s*$", line)
+        if data:
+            key = data.group(1)
+            value = data.group(2)
+            override_settings[key] = value
+            num_settings += 1
+            continue
+
+        # KEY = VALUE
+        data = re.match(r'^\s*([\S]+)\s*=\s*([\S]+)\s*$', line)
+        if data:
+            key = data.group(1)
+            value = data.group(2)
+            override_settings[key] = value
+            num_settings += 1
+            continue
+
+    for key in override_settings.keys():
+        value = override_settings[key]
+        if value.replace('.', '1').isdigit():
+            if value.count('.') == 1:
+                override_settings[key] = float(value)
+            elif value.count('.') == 0:
+                override_settings[key] = int(value)
+            else:
+                continue
+        elif value == "True":
+            override_settings[key] = True
+        elif value == "False":
+            override_settings[key] = False
+        else:
+            override_settings[key] = value
+
+        if key == "MINI_TIMEOUT":
+            settings.MINI_TIMEOUT = override_settings[key]
+        elif key == "SMALL_TIMEOUT":
+            settings.SMALL_TIMEOUT = override_settings[key]
+        elif key == "LARGE_TIMEOUT":
+            settings.LARGE_TIMEOUT = override_settings[key]
+        elif key == "EXTREME_TIMEOUT":
+            settings.EXTREME_TIMEOUT = override_settings[key]
+        elif key == "ARCHIVE_EXISTING_LOGS":
+            settings.ARCHIVE_EXISTING_LOGS = override_settings[key]
+        elif key == "ARCHIVE_EXISTING_DOWNLOADS":
+            settings.ARCHIVE_EXISTING_DOWNLOADS = override_settings[key]
+        elif key == "SCREENSHOT_NAME":
+            settings.SCREENSHOT_NAME = override_settings[key]
+        elif key == "BASIC_INFO_NAME":
+            settings.BASIC_INFO_NAME = override_settings[key]
+        elif key == "PAGE_SOURCE_NAME":
+            settings.PAGE_SOURCE_NAME = override_settings[key]
+        elif key == "LATEST_REPORT_DIR":
+            settings.LATEST_REPORT_DIR = override_settings[key]
+        elif key == "REPORT_ARCHIVE_DIR":
+            settings.REPORT_ARCHIVE_DIR = override_settings[key]
+        elif key == "HTML_REPORT":
+            settings.HTML_REPORT = override_settings[key]
+        elif key == "RESULTS_TABLE":
+            settings.RESULTS_TABLE = override_settings[key]
+        elif key == "WAIT_FOR_RSC_ON_PAGE_LOADS":
+            settings.WAIT_FOR_RSC_ON_PAGE_LOADS = override_settings[key]
+        elif key == "WAIT_FOR_RSC_ON_CLICKS":
+            settings.WAIT_FOR_RSC_ON_CLICKS = override_settings[key]
+        elif key == "WAIT_FOR_ANGULARJS":
+            settings.WAIT_FOR_ANGULARJS = override_settings[key]
+        elif key == "DEFAULT_DEMO_MODE_TIMEOUT":
+            settings.DEFAULT_DEMO_MODE_TIMEOUT = override_settings[key]
+        elif key == "HIGHLIGHTS":
+            settings.HIGHLIGHTS = override_settings[key]
+        elif key == "DEFAULT_MESSAGE_DURATION":
+            settings.DEFAULT_MESSAGE_DURATION = override_settings[key]
+        elif key == "DISABLE_CSP_ON_FIREFOX":
+            settings.DISABLE_CSP_ON_FIREFOX = override_settings[key]
+        elif key == "DISABLE_CSP_ON_CHROME":
+            settings.DISABLE_CSP_ON_CHROME = override_settings[key]
+        elif key == "RAISE_INVALID_PROXY_STRING_EXCEPTION":
+            settings.RAISE_INVALID_PROXY_STRING_EXCEPTION = (
+                override_settings[key])
+        elif key == "MASTERQA_DEFAULT_VALIDATION_MESSAGE":
+            settings.MASTERQA_DEFAULT_VALIDATION_MESSAGE = (
+                override_settings[key])
+        elif key == "MASTERQA_WAIT_TIME_BEFORE_VERIFY":
+            settings.MASTERQA_WAIT_TIME_BEFORE_VERIFY = (
+                override_settings[key])
+        elif key == "MASTERQA_START_IN_FULL_SCREEN_MODE":
+            settings.MASTERQA_START_IN_FULL_SCREEN_MODE = (
+                override_settings[key])
+        elif key == "MASTERQA_MAX_IDLE_TIME_BEFORE_QUIT":
+            settings.MASTERQA_MAX_IDLE_TIME_BEFORE_QUIT = (
+                override_settings[key])
+        elif key == "TOTP_KEY":
+            settings.TOTP_KEY = override_settings[key]
+        elif key == "DB_HOST":
+            settings.DB_HOST = override_settings[key]
+        elif key == "DB_USERNAME":
+            settings.DB_USERNAME = override_settings[key]
+        elif key == "DB_PASSWORD":
+            settings.DB_PASSWORD = override_settings[key]
+        elif key == "DB_SCHEMA":
+            settings.DB_SCHEMA = override_settings[key]
+        elif key == "S3_LOG_BUCKET":
+            settings.S3_LOG_BUCKET = override_settings[key]
+        elif key == "S3_BUCKET_URL":
+            settings.S3_BUCKET_URL = override_settings[key]
+        elif key == "S3_SELENIUM_ACCESS_KEY":
+            settings.S3_SELENIUM_ACCESS_KEY = override_settings[key]
+        elif key == "S3_SELENIUM_SECRET_KEY":
+            settings.S3_SELENIUM_SECRET_KEY = override_settings[key]
+        elif key == "ENCRYPTION_KEY":
+            settings.ENCRYPTION_KEY = override_settings[key]
+        elif key == "OBFUSCATION_START_TOKEN":
+            settings.OBFUSCATION_START_TOKEN = override_settings[key]
+        elif key == "OBFUSCATION_END_TOKEN":
+            settings.OBFUSCATION_END_TOKEN = override_settings[key]
+        elif key == "EMAIL_USERNAME":
+            settings.EMAIL_USERNAME = override_settings[key]
+        elif key == "EMAIL_PASSWORD":
+            settings.EMAIL_PASSWORD = override_settings[key]
+        elif key == "EMAIL_IMAP_STRING":
+            settings.EMAIL_IMAP_STRING = override_settings[key]
+        elif key == "EMAIL_IMAP_PORT":
+            settings.EMAIL_IMAP_PORT = override_settings[key]
+        else:
+            continue
+
+    if num_settings == 0:
+        raise Exception("Unable to parse the settings file!")
+
+    return override_settings
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -47,6 +47,7 @@ def test_anything(self):
 from seleniumbase.core.testcase_manager import TestcaseManager
 from seleniumbase.core import download_helper
 from seleniumbase.core import log_helper
+from seleniumbase.core import settings_parser
 from seleniumbase.core import tour_helper
 from seleniumbase.core import visual_helper
 from seleniumbase.fixtures import constants
@@ -3195,6 +3196,7 @@ def setUp(self, masterqa_mode=False):
             self.proxy_string = sb_config.proxy_string
             self.user_agent = sb_config.user_agent
             self.cap_file = sb_config.cap_file
+            self.settings_file = sb_config.settings_file
             self.database_env = sb_config.database_env
             self.message_duration = sb_config.message_duration
             self.js_checking_on = sb_config.js_checking_on
@@ -3266,11 +3268,16 @@ def setUp(self, masterqa_mode=False):
                     # Chrome and Firefox now have built-in headless displays
                     pass
 
-        # Launch WebDriver for both Pytest and Nosetests
+        # Verify that SeleniumBase is installed successfully
         if not hasattr(self, "browser"):
             raise Exception("""SeleniumBase plugins did not load! """
                             """Please reinstall using:\n"""
-                            """ >>> "python setup.py install" <<< """)
+                            """ >>> "pip install -r requirements.txt" <<<\n"""
+                            """ >>> "python setup.py develop" <<< """)
+        if self.settings_file:
+            settings_parser.set_settings(self.settings_file)
+
+        # Launch WebDriver for both Pytest and Nosetests
         self.driver = self.get_new_driver(browser=self.browser,
                                           headless=self.headless,
                                           servername=self.servername,
diff --git a/seleniumbase/plugins/base_plugin.py b/seleniumbase/plugins/base_plugin.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-""" This is the Nose plugin for saving logs and setting a test environment. """
+""" This is the Nose plugin for setting a test environment and saving logs. """
 
 import os
 import sys
@@ -16,6 +16,7 @@ class Base(Plugin):
     This parser plugin includes the following command-line options for Nose:
     --env=ENV  (Set a test environment. Use "self.env" to use this in tests.)
     --data=DATA  (Extra data to pass to tests. Use "self.data" in tests.)
+    --settings_file=FILE  (Overrides SeleniumBase settings.py values.)
     --log_path=LOG_PATH  (The directory where log files get saved to.)
     --archive_logs  (Archive old log files instead of deleting them.)
     --report  (The option to create a fancy report after tests complete.)
@@ -45,6 +46,13 @@ def options(self, parser, env):
             '--data', dest='data',
             default=None,
             help='Extra data to pass from the command line.')
+        parser.add_option(
+            '--settings_file', '--settings-file', '--settings',
+            action='store',
+            dest='settings_file',
+            default=None,
+            help="""The file that stores key/value pairs for overriding
+                    values in the SeleniumBase settings.py file.""")
         parser.add_option(
             '--log_path', dest='log_path',
             default='latest_logs/',
@@ -100,6 +108,7 @@ def beforeTest(self, test):
         test.test.environment = self.options.environment
         test.test.env = self.options.environment  # Add a shortened version
         test.test.data = self.options.data
+        test.test.settings_file = self.options.settings_file
         test.test.log_path = self.options.log_path
         test.test.args = self.options
         test.test.report_on = self.report_on
diff --git a/seleniumbase/plugins/pytest_plugin.py b/seleniumbase/plugins/pytest_plugin.py
@@ -15,6 +15,7 @@ def pytest_addoption(parser):
     This parser plugin includes the following command-line options for pytest:
     --browser=BROWSER  (The web browser to use.)
     --cap_file=FILE  (The web browser's desired capabilities to use.)
+    --settings_file=FILE  (Overrides SeleniumBase settings.py values.)
     --env=ENV  (Set a test environment. Use "self.env" to use this in tests.)
     --data=DATA  (Extra data to pass to tests. Use "self.data" in tests.)
     --user_data_dir=DIR  (Set the Chrome user data directory to use.)
@@ -82,6 +83,12 @@ def pytest_addoption(parser):
                      default=None,
                      help="""The file that stores browser desired capabilities
                           for BrowserStack or Sauce Labs web drivers.""")
+    parser.addoption('--settings_file', '--settings-file', '--settings',
+                     action='store',
+                     dest='settings_file',
+                     default=None,
+                     help="""The file that stores key/value pairs for overriding
+                          values in the SeleniumBase settings.py file.""")
     parser.addoption('--user_data_dir', '--user-data-dir',
                      dest='user_data_dir',
                      default=None,
@@ -320,6 +327,7 @@ def pytest_configure(config):
     sb_config.port = config.getoption('port')
     sb_config.proxy_string = config.getoption('proxy_string')
     sb_config.cap_file = config.getoption('cap_file')
+    sb_config.settings_file = config.getoption('settings_file')
     sb_config.user_data_dir = config.getoption('user_data_dir')
     sb_config.database_env = config.getoption('database_env')
     sb_config.log_path = config.getoption('log_path')
