Refactor logging

Author: mdmintz

examples/raw_parameter_script.py

@@ -59,7 +59,6 @@
     sb.extension_zip = None
     sb.extension_dir = None
     sb.database_env = "test"
-    sb.log_path = "latest_logs"
     sb.archive_logs = False
     sb.disable_csp = False
     sb.disable_ws = False

seleniumbase/behave/behave_sb.py

@@ -168,7 +168,7 @@ def get_configured_sb(context):
     sb.driver_version = None
     sb.page_load_strategy = None
     sb.database_env = "test"
-    sb.log_path = "latest_logs" + os.sep
+    sb.log_path = constants.Logs.LATEST + os.sep
     sb.archive_logs = False
     sb.disable_js = False
     sb.disable_csp = False
@@ -940,7 +940,9 @@ def get_configured_sb(context):
     if sb_config.dash_title:
         constants.Dashboard.TITLE = sb_config.dash_title.replace("_", " ")
 
-    log_helper.log_folder_setup("latest_logs/", sb.archive_logs)
+    log_helper.log_folder_setup(
+        constants.Logs.LATEST + "/", sb.archive_logs
+    )
     download_helper.reset_downloads_folder()
     proxy_helper.remove_proxy_zip_if_present()
     return sb
@@ -1153,7 +1155,9 @@ def _perform_behave_unconfigure_():
                 pass
         sb_config.shared_driver = None
     if hasattr(sb_config, "archive_logs"):
-        log_helper.archive_logs_if_set("latest_logs/", sb_config.archive_logs)
+        log_helper.archive_logs_if_set(
+            constants.Logs.LATEST + "/", sb_config.archive_logs
+        )
     log_helper.clear_empty_logs()
     # Dashboard post-processing: Disable time-based refresh and stamp complete
     if not hasattr(sb_config, "dashboard") or not sb_config.dashboard:
@@ -1227,7 +1231,9 @@ def do_final_driver_cleanup_as_needed():
 
 
 def _perform_behave_terminal_summary_():
-    latest_logs_dir = os.path.join(os.getcwd(), "latest_logs" + os.sep)
+    latest_logs_dir = os.path.join(
+        os.getcwd(), constants.Logs.LATEST + os.sep
+    )
     dash_path = os.path.join(os.getcwd(), "dashboard.html")
     equals_len = len("Dashboard: ") + len(dash_path)
     try:

seleniumbase/core/download_helper.py

@@ -11,8 +11,6 @@
 # The "downloads_folder" is cleaned out at the start of each pytest run,
 #     but there is an option to save existing files in "archived_files".
 DOWNLOADS_DIR = constants.Files.DOWNLOADS_FOLDER
-ARCHIVE_DIR = constants.Files.ARCHIVED_DOWNLOADS_FOLDER
-
 abs_path = os.path.abspath(".")
 downloads_path = os.path.join(abs_path, DOWNLOADS_DIR)
 
@@ -24,7 +22,19 @@ def get_downloads_folder():
 def reset_downloads_folder():
     """Clears the downloads folder.
     If settings.ARCHIVE_EXISTING_DOWNLOADS is set to True, archives it."""
-    archived_downloads_folder = os.path.join(os.getcwd(), ARCHIVE_DIR) + os.sep
+    downloads_dir = constants.Files.DOWNLOADS_FOLDER
+    archive_dir = constants.Files.ARCHIVED_DOWNLOADS_FOLDER
+    if downloads_dir.endswith("/"):
+        downloads_dir = downloads_dir[:-1]
+    if downloads_dir.startswith("/"):
+        downloads_dir = downloads_dir[1:]
+    if archive_dir.endswith("/"):
+        archive_dir = archive_dir[:-1]
+    if archive_dir.startswith("/"):
+        archive_dir = archive_dir[1:]
+    if len(downloads_dir) < 10 or len(archive_dir) < 10:
+        return  # Prevent accidental deletions if constants are renamed
+    archived_downloads_folder = os.path.join(os.getcwd(), archive_dir) + os.sep
     if os.path.exists(downloads_path) and not os.listdir(downloads_path) == []:
         reset_downloads_folder_assistant(archived_downloads_folder)
     if os.path.exists(downloads_path) and os.listdir(downloads_path) == []:

seleniumbase/core/log_helper.py

@@ -517,8 +517,8 @@ def archive_logs_if_set(log_path, archive_logs=False):
     else:
         if settings.ARCHIVE_EXISTING_LOGS or archive_logs:
             if len(os.listdir(log_path)) > 0:
-                archived_folder = "%s/../archived_logs/" % log_path
-                archived_folder = os.path.realpath(archived_folder) + "/"
+                saved_folder = "%s/../%s/" % (log_path, constants.Logs.SAVED)
+                archived_folder = os.path.realpath(saved_folder) + "/"
                 log_path = os.path.realpath(log_path) + "/"
                 if not os.path.exists(archived_folder):
                     try:
@@ -531,17 +531,25 @@ def archive_logs_if_set(log_path, archive_logs=False):
 
 
 def log_folder_setup(log_path, archive_logs=False):
-    """Handle Logging"""
+    """Clean up logs to prepare for another run"""
     if log_path.endswith("/"):
         log_path = log_path[:-1]
+    if log_path.startswith("/"):
+        log_path = log_path[1:]
+    if constants.Logs.SAVED.endswith("/"):
+        constants.Logs.SAVED = constants.Logs.SAVED[:-1]
+    if constants.Logs.SAVED.startswith("/"):
+        constants.Logs.SAVED = constants.Logs.SAVED[1:]
+    if len(log_path) < 10 or len(constants.Logs.SAVED) < 10:
+        return  # Prevent accidental deletions if constants are renamed
     if not os.path.exists(log_path):
         try:
             os.makedirs(log_path)
         except Exception:
             pass  # Should only be reachable during multi-threaded runs
     else:
-        archived_folder = "%s/../archived_logs/" % log_path
-        archived_folder = os.path.realpath(archived_folder) + "/"
+        saved_folder = "%s/../%s/" % (log_path, constants.Logs.SAVED)
+        archived_folder = os.path.realpath(saved_folder) + "/"
         if not os.path.exists(archived_folder):
             try:
                 os.makedirs(archived_folder)
@@ -566,8 +574,8 @@ def log_folder_setup(log_path, archive_logs=False):
 
 
 def clear_empty_logs():
-    latest_logs_dir = os.path.join(os.getcwd(), "latest_logs") + os.sep
-    archived_folder = os.path.join(os.getcwd(), "archived_logs") + os.sep
+    latest_logs_dir = os.path.join(os.getcwd(), constants.Logs.LATEST) + os.sep
+    archived_folder = os.path.join(os.getcwd(), constants.Logs.SAVED) + os.sep
     if os.path.exists(latest_logs_dir) and not os.listdir(latest_logs_dir):
         try:
             os.rmdir(latest_logs_dir)

seleniumbase/fixtures/base_case.py

@@ -13776,8 +13776,9 @@ def setUp(self, masterqa_mode=False):
             return  # This test already called setUp()
         self.__called_setup = True
         self.__called_teardown = False
-        self.masterqa_mode = masterqa_mode
         self.is_pytest = None
+        self.log_path = constants.Logs.LATEST
+        self.masterqa_mode = masterqa_mode
         try:
             # This raises an exception if the test is not coming from pytest
             self.is_pytest = sb_config.is_pytest
@@ -15007,7 +15008,7 @@ def __process_dashboard(self, has_exception, init=False):
                 else:
                     status += " All tests were skipped!"
             else:
-                latest_logs_dir = "latest_logs/"
+                latest_logs_dir = constants.Logs.LATEST + "/"
                 log_msg = "See latest logs for details"
                 if num_failed == 1:
                     status += (

seleniumbase/fixtures/constants.py

@@ -72,10 +72,23 @@ class PageLoadStrategy:
 
 
 class Files:
+    # This is a special downloads folder for files downloaded by tests.
+    # The "downloaded_files" folder is DELETED when starting new tests.
+    # Add "--archive-downloads" to save a copy in "archived_files".
+    # (These folder names should NOT be changed.)
     DOWNLOADS_FOLDER = "downloaded_files"
     ARCHIVED_DOWNLOADS_FOLDER = "archived_files"
 
 
+class Logs:
+    # This is where log files from the latest run get saved.
+    # The "latest_logs" folder is DELETED when starting new tests.
+    # Add "--archive-logs" to save a copy of logs in "archived_logs".
+    # (These folder names should NOT be changed.)
+    LATEST = "latest_logs"
+    SAVED = "archived_logs"
+
+
 class Presentations:
     SAVED_FOLDER = "saved_presentations"
 

seleniumbase/plugins/base_plugin.py

@@ -132,7 +132,7 @@ def options(self, parser, env):
             "--log_path",
             "--log-path",
             dest="log_path",
-            default="latest_logs/",
+            default=constants.Logs.LATEST + "/",
             help="""(DEPRECATED) - This field is NOT EDITABLE anymore.
                     Log files are saved to the "latest_logs/" folder.""",
         )
@@ -193,7 +193,7 @@ def configure(self, options, conf):
         self.page_results_list = []
         self.test_count = 0
         self.import_error = False
-        log_path = "latest_logs/"
+        log_path = constants.Logs.LATEST + "/"
         archive_logs = options.archive_logs
         log_helper.log_folder_setup(log_path, archive_logs)
         download_helper.reset_downloads_folder()

seleniumbase/plugins/pytest_plugin.py

@@ -323,7 +323,7 @@ def pytest_addoption(parser):
         "--log_path",
         "--log-path",
         dest="log_path",
-        default="latest_logs/",
+        default=constants.Logs.LATEST + "/",
         help="""(DEPRECATED) - This value is NOT EDITABLE anymore.
                 Log files are saved to the "latest_logs/" folder.""",
     )
@@ -1487,7 +1487,7 @@ def pytest_configure(config):
     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 = "latest_logs/"  # (No longer editable!)
+    sb_config.log_path = constants.Logs.LATEST + "/"
     sb_config.archive_logs = config.getoption("archive_logs")
     if config.getoption("archive_downloads"):
         settings.ARCHIVE_EXISTING_DOWNLOADS = True
@@ -1708,7 +1708,9 @@ def pytest_configure(config):
         from seleniumbase.core import download_helper
         from seleniumbase.core import proxy_helper
 
-        log_helper.log_folder_setup("latest_logs/", sb_config.archive_logs)
+        log_helper.log_folder_setup(
+            constants.Logs.LATEST + "/", sb_config.archive_logs
+        )
         download_helper.reset_downloads_folder()
         proxy_helper.remove_proxy_zip_if_present()
 
@@ -1810,7 +1812,9 @@ def pytest_collection_finish(session):
         from seleniumbase.core import download_helper
         from seleniumbase.core import proxy_helper
 
-        log_helper.log_folder_setup("latest_logs/", sb_config.archive_logs)
+        log_helper.log_folder_setup(
+            constants.Logs.LATEST + "/", sb_config.archive_logs
+        )
         download_helper.reset_downloads_folder()
         proxy_helper.remove_proxy_zip_if_present()
     if sb_config.dashboard and len(session.items) > 0:
@@ -1958,7 +1962,7 @@ def pytest_terminal_summary(terminalreporter):
         return
     if not sb_config._multithreaded and not sb_config._sbase_detected:
         return
-    latest_logs_dir = os.path.join(os.getcwd(), "latest_logs") + os.sep
+    latest_logs_dir = os.path.join(os.getcwd(), constants.Logs.LATEST) + os.sep
     if (
         "failed" in terminalreporter.stats.keys()
         and os.path.exists(latest_logs_dir)
@@ -2016,7 +2020,9 @@ def _perform_pytest_unconfigure_():
                 pass
         sb_config.shared_driver = None
     if hasattr(sb_config, "log_path") and sb_config.item_count > 0:
-        log_helper.archive_logs_if_set("latest_logs/", sb_config.archive_logs)
+        log_helper.archive_logs_if_set(
+            constants.Logs.LATEST + "/", sb_config.archive_logs
+        )
     log_helper.clear_empty_logs()
     # Dashboard post-processing: Disable time-based refresh and stamp complete
     if not hasattr(sb_config, "dashboard") or not sb_config.dashboard:

seleniumbase/plugins/sb_manager.py

@@ -636,7 +636,7 @@ def SB(
     sb_config.extension_zip = extension_zip
     sb_config.extension_dir = extension_dir
     sb_config.database_env = "test"
-    sb_config.log_path = "latest_logs"
+    sb_config.log_path = constants.Logs.LATEST
     sb_config.archive_logs = archive_logs
     sb_config.disable_csp = disable_csp
     sb_config.disable_ws = disable_ws
@@ -834,7 +834,7 @@ def SB(
         from seleniumbase.core import download_helper
         from seleniumbase.core import proxy_helper
 
-        log_helper.log_folder_setup("latest_logs/")
+        log_helper.log_folder_setup(constants.Logs.LATEST + "/")
         log_helper.clear_empty_logs()
         download_helper.reset_downloads_folder()
         if not sb_config.multi_proxy: