Merge pull request #504 from seleniumbase/update-settings-parser

Update the way custom settings are parsed

Author: mdmintz

examples/custom_settings.py

@@ -52,16 +52,17 @@
 
 # MySQL DB Credentials
 # (For saving data from tests to a MySQL DB)
-# Add "--with-db_reporting" to save test data to a MySQL DB during test runs
+# Usage: "--with-db_reporting"
 DB_HOST = "127.0.0.1"
+DB_PORT = 3306
 DB_USERNAME = "root"
 DB_PASSWORD = "test"
 DB_SCHEMA = "test_db"
 
 # Amazon S3 Bucket Credentials
 # (For saving screenshots and other log files from tests)
 # (Bucket names are unique across all existing bucket names in Amazon S3)
-# Add "--with-s3_logging" to save test results to S3
+# Usage: "--with-s3_logging"
 S3_LOG_BUCKET = "[S3 BUCKET NAME]"
 S3_BUCKET_URL = "https://s3.amazonaws.com/[S3 BUCKET NAME]/"
 S3_SELENIUM_ACCESS_KEY = "[S3 ACCESS KEY]"

help_docs/method_summary.md

@@ -268,7 +268,7 @@ self.jquery_update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=None)
 
 self.set_time_limit(time_limit)
 
-self.skip_test(reason="")
+self.skip(reason="")
 
 ########
 

seleniumbase/config/settings.py

@@ -121,8 +121,10 @@
 
 
 # MySQL DB Credentials
-# (For saving data from tests)
+# (For saving data from tests to a MySQL DB)
+# Usage: "--with-db_reporting"
 DB_HOST = "127.0.0.1"
+DB_PORT = 3306
 DB_USERNAME = "root"
 DB_PASSWORD = "test"
 DB_SCHEMA = "test_db"
@@ -131,6 +133,7 @@
 # Amazon S3 Bucket Credentials
 # (For saving screenshots and other log files from tests)
 # (Bucket names are unique across all existing bucket names in Amazon S3)
+# Usage: "--with-s3_logging"
 S3_LOG_BUCKET = "[S3 BUCKET NAME]"
 S3_BUCKET_URL = "https://s3.amazonaws.com/[S3 BUCKET NAME]/"
 S3_SELENIUM_ACCESS_KEY = "[S3 ACCESS KEY]"

seleniumbase/core/mysql.py

@@ -3,7 +3,9 @@
 """
 
 import time
-from seleniumbase.core import mysql_conf as conf
+from seleniumbase import config as sb_config
+from seleniumbase.config import settings
+from seleniumbase.core import settings_parser
 
 
 class DatabaseManager():
@@ -13,17 +15,33 @@ class DatabaseManager():
 
     def __init__(self, database_env='test', conf_creds=None):
         """
-        Gets database information from mysql_conf.py and creates a connection.
+        Create a connection to the MySQL DB.
         """
         import pymysql
-        db_server, db_user, db_pass, db_schema = \
-            conf.APP_CREDS[conf.Apps.TESTCASE_REPOSITORY][database_env]
+        db_server = settings.DB_HOST
+        db_port = settings.DB_PORT
+        db_user = settings.DB_USERNAME
+        db_pass = settings.DB_PASSWORD
+        db_schema = settings.DB_SCHEMA
+        if sb_config.settings_file:
+            override = settings_parser.set_settings(sb_config.settings_file)
+            if "DB_HOST" in override.keys():
+                db_server = override['DB_HOST']
+            if "DB_PORT" in override.keys():
+                db_port = override['DB_PORT']
+            if "DB_USERNAME" in override.keys():
+                db_user = override['DB_USERNAME']
+            if "DB_PASSWORD" in override.keys():
+                db_pass = override['DB_PASSWORD']
+            if "DB_SCHEMA" in override.keys():
+                db_schema = override['DB_SCHEMA']
         retry_count = 3
         backoff = 1.2  # Time to wait (in seconds) between retries.
         count = 0
         while count < retry_count:
             try:
                 self.conn = pymysql.connect(host=db_server,
+                                            port=db_port,
                                             user=db_user,
                                             passwd=db_pass,
                                             db=db_schema)

seleniumbase/core/mysql_conf.py

@@ -1718,7 +1718,7 @@ def highlight_update_text(self, selector, new_value, by=By.CSS_SELECTOR,
         self.update_text(selector, new_value, by=by)
 
     def highlight(self, selector, by=By.CSS_SELECTOR,
-                  loops=settings.HIGHLIGHTS, scroll=True):
+                  loops=None, scroll=True):
         """ This method uses fancy JavaScript to highlight an element.
             Used during demo_mode.
             @Params
@@ -1731,6 +1731,8 @@ def highlight(self, selector, by=By.CSS_SELECTOR,
         selector, by = self.__recalculate_selector(selector, by)
         element = self.wait_for_element_visible(
             selector, by=by, timeout=settings.SMALL_TIMEOUT)
+        if not loops:
+            loops = settings.HIGHLIGHTS
         if scroll:
             try:
                 self.__slow_scroll_to_element(element)
@@ -2503,7 +2505,7 @@ def set_time_limit(self, time_limit):
             sb_config.time_limit = None
             sb_config.time_limit_ms = None
 
-    def skip_test(self, reason=""):
+    def skip(self, reason=""):
         """ Mark the test as Skipped. """
         self.skipTest(reason)
 

seleniumbase/fixtures/base_case.py

@@ -9,15 +9,6 @@
 from seleniumbase.config import settings
 from seleniumbase.fixtures import js_utils
 
-LATEST_REPORT_DIR = settings.LATEST_REPORT_DIR
-ARCHIVE_DIR = settings.REPORT_ARCHIVE_DIR
-RESULTS_PAGE = settings.HTML_REPORT
-BAD_PAGE_LOG = settings.RESULTS_TABLE
-DEFAULT_VALIDATION_MESSAGE = settings.MASTERQA_DEFAULT_VALIDATION_MESSAGE
-WAIT_TIME_BEFORE_VERIFY = settings.MASTERQA_WAIT_TIME_BEFORE_VERIFY
-START_IN_FULL_SCREEN_MODE = settings.MASTERQA_START_IN_FULL_SCREEN_MODE
-MAX_IDLE_TIME_BEFORE_QUIT = settings.MASTERQA_MAX_IDLE_TIME_BEFORE_QUIT
-
 # This tool allows testers to quickly verify pages while assisted by automation
 
 
@@ -27,10 +18,22 @@ def setUp(self):
         self.check_count = 0
         self.auto_close_results_page = False
         super(MasterQA, self).setUp(masterqa_mode=True)
+        self.LATEST_REPORT_DIR = settings.LATEST_REPORT_DIR
+        self.ARCHIVE_DIR = settings.REPORT_ARCHIVE_DIR
+        self.RESULTS_PAGE = settings.HTML_REPORT
+        self.BAD_PAGE_LOG = settings.RESULTS_TABLE
+        self.DEFAULT_VALIDATION_MESSAGE = (
+            settings.MASTERQA_DEFAULT_VALIDATION_MESSAGE)
+        self.WAIT_TIME_BEFORE_VERIFY = (
+            settings.MASTERQA_WAIT_TIME_BEFORE_VERIFY)
+        self.START_IN_FULL_SCREEN_MODE = (
+            settings.MASTERQA_START_IN_FULL_SCREEN_MODE)
+        self.MAX_IDLE_TIME_BEFORE_QUIT = (
+            settings.MASTERQA_MAX_IDLE_TIME_BEFORE_QUIT)
         self.__manual_check_setup()
         if self.headless:
             self.auto_close_results_page = True
-        if START_IN_FULL_SCREEN_MODE:
+        if self.START_IN_FULL_SCREEN_MODE:
             self.maximize_window()
 
     def verify(self, *args):
@@ -73,26 +76,28 @@ def __manual_check_setup(self):
     def __clear_out_old_logs(
             self, archive_past_runs=True, get_log_folder=False):
         abs_path = os.path.abspath('.')
-        file_path = abs_path + "/%s" % LATEST_REPORT_DIR
+        file_path = abs_path + "/%s" % self.LATEST_REPORT_DIR
         if not os.path.exists(file_path):
             os.makedirs(file_path)
 
         if archive_past_runs:
             archive_timestamp = int(time.time())
-            if not os.path.exists("%s/../%s/" % (file_path, ARCHIVE_DIR)):
-                os.makedirs("%s/../%s/" % (file_path, ARCHIVE_DIR))
+            if not os.path.exists("%s/../%s/" % (file_path, self.ARCHIVE_DIR)):
+                os.makedirs("%s/../%s/" % (file_path, self.ARCHIVE_DIR))
             archive_dir = "%s/../%s/log_%s" % (
-                file_path, ARCHIVE_DIR, archive_timestamp)
+                file_path, self.ARCHIVE_DIR, archive_timestamp)
             shutil.move(file_path, archive_dir)
             os.makedirs(file_path)
             if get_log_folder:
                 return archive_dir
         else:
             # Just delete bad pages to make room for the latest run.
             filelist = [f for f in os.listdir(
-                "./%s" % LATEST_REPORT_DIR) if f.startswith("failed_") or (
-                f == RESULTS_PAGE) or (f.startswith("automation_failure")) or (
-                f == BAD_PAGE_LOG)]
+                "./%s" % self.LATEST_REPORT_DIR) if (
+                f.startswith("failed_")) or (
+                f == self.RESULTS_PAGE) or (
+                f.startswith("automation_failure")) or (
+                f == self.BAD_PAGE_LOG)]
             for f in filelist:
                 os.remove("%s/%s" % (file_path, f))
 
@@ -137,7 +142,7 @@ def __jq_confirm_dialog(self, question):
 
     def __manual_page_check(self, *args):
         if not args:
-            instructions = DEFAULT_VALIDATION_MESSAGE  # self.verify()
+            instructions = self.DEFAULT_VALIDATION_MESSAGE  # self.verify()
         else:
             instructions = str(args[0])
             if len(args) > 1:
@@ -149,7 +154,7 @@ def __manual_page_check(self, *args):
         elif instructions and "?" in instructions:
             question = instructions
 
-        wait_time_before_verify = WAIT_TIME_BEFORE_VERIFY
+        wait_time_before_verify = self.WAIT_TIME_BEFORE_VERIFY
         if self.verify_delay:
             wait_time_before_verify = float(self.verify_delay)
         # Allow a moment to see the full page before the dialog box pops up
@@ -237,7 +242,7 @@ def __manual_page_check(self, *args):
             return 1
         else:
             bad_page_name = "failed_check_%s.png" % self.manual_check_count
-            self.save_screenshot(bad_page_name, folder=LATEST_REPORT_DIR)
+            self.save_screenshot(bad_page_name, folder=self.LATEST_REPORT_DIR)
             self.page_results_list.append(
                 '"%s","%s","%s","%s","%s","%s","%s","%s"' % (
                     self.manual_check_count,
@@ -250,8 +255,8 @@ def __manual_page_check(self, *args):
                     "*"))
             return 0
 
-    def __wait_for_special_alert_absent(
-            self, timeout=MAX_IDLE_TIME_BEFORE_QUIT):
+    def __wait_for_special_alert_absent(self):
+        timeout = self.MAX_IDLE_TIME_BEFORE_QUIT
         for x in range(int(timeout * 20)):
             try:
                 alert = self.driver.switch_to.alert
@@ -277,7 +282,7 @@ def __add_failure(self, exception=None):
 
         self.incomplete_runs += 1
         error_page = "automation_failure_%s.png" % self.incomplete_runs
-        self.save_screenshot(error_page, folder=LATEST_REPORT_DIR)
+        self.save_screenshot(error_page, folder=self.LATEST_REPORT_DIR)
         self.page_results_list.append(
             '"%s","%s","%s","%s","%s","%s","%s","%s"' % (
                 "ERR",
@@ -298,8 +303,8 @@ def __add_failure(self, exception=None):
 
     def __add_bad_page_log_file(self):
         abs_path = os.path.abspath('.')
-        file_path = abs_path + "/%s" % LATEST_REPORT_DIR
-        log_file = "%s/%s" % (file_path, BAD_PAGE_LOG)
+        file_path = abs_path + "/%s" % self.LATEST_REPORT_DIR
+        log_file = "%s/%s" % (file_path, self.BAD_PAGE_LOG)
         f = open(log_file, 'w')
         h_p1 = '''"Num","Result","Screenshot","URL","Browser","Epoch Time",'''
         h_p2 = '''"Verification Instructions","Additional Info"\n'''
@@ -311,8 +316,8 @@ def __add_bad_page_log_file(self):
 
     def __add_results_page(self, html):
         abs_path = os.path.abspath('.')
-        file_path = abs_path + "/%s" % LATEST_REPORT_DIR
-        results_file_name = RESULTS_PAGE
+        file_path = abs_path + "/%s" % self.LATEST_REPORT_DIR
+        results_file_name = self.RESULTS_PAGE
         results_file = "%s/%s" % (file_path, results_file_name)
         f = open(results_file, 'w')
         f.write(html)
@@ -345,7 +350,7 @@ def __process_manual_check_results(self, auto_close_results_page=False):
         log_string = self.__clear_out_old_logs(get_log_folder=True)
         log_folder = log_string.split('/')[-1]
         abs_path = os.path.abspath('.')
-        file_path = abs_path + "/%s" % ARCHIVE_DIR
+        file_path = abs_path + "/%s" % self.ARCHIVE_DIR
         log_path = "%s/%s" % (file_path, log_folder)
         web_log_path = "file://%s" % log_path
 
@@ -376,9 +381,9 @@ def __process_manual_check_results(self, auto_close_results_page=False):
                      %s</h1>''' % summary_table
 
         log_link_shown = '../%s%s/' % (
-            ARCHIVE_DIR, web_log_path.split(ARCHIVE_DIR)[1])
-        csv_link = '%s/%s' % (web_log_path, BAD_PAGE_LOG)
-        csv_link_shown = '%s' % BAD_PAGE_LOG
+            self.ARCHIVE_DIR, web_log_path.split(self.ARCHIVE_DIR)[1])
+        csv_link = '%s/%s' % (web_log_path, self.BAD_PAGE_LOG)
+        csv_link_shown = '%s' % self.BAD_PAGE_LOG
         log_table = '''<p><p><p><p><h2><table><tbody>
             <tr><td>LOG FILES LINK:&nbsp;&nbsp;<td><a href="%s">%s</a></tr>
             <tr><td>RESULTS TABLE:&nbsp;&nbsp;<td><a href="%s">%s</a></tr>
@@ -411,7 +416,7 @@ def __process_manual_check_results(self, auto_close_results_page=False):
         report_html = '<html><head>%s</head><body>%s</body></html>' % (
             style, table_view)
         results_file = self.__add_results_page(report_html)
-        archived_results_file = log_path + '/' + RESULTS_PAGE
+        archived_results_file = log_path + '/' + self.RESULTS_PAGE
         shutil.copyfile(results_file, archived_results_file)
         print(
             "\n*** The results html page is located at: ***\n" + results_file)

seleniumbase/masterqa/master_qa.py

@@ -45,7 +45,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.35.4',
+    version='1.35.5',
     description='Fast, Easy, and Reliable Browser Automation & Testing.',
     long_description=long_description,
     long_description_content_type='text/markdown',