Add option: "--archive-downloads" to keep downloaded files

Author: mdmintz

README.md

@@ -359,7 +359,8 @@ The code above will leave your browser window open in case there's a failure. (i
 --headed  # (Run tests with a GUI on Linux OS.)
 --locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.)
 --start-page=URL  # (The starting URL for the web browser when tests begin.)
---archive-logs  # (Archive old log files instead of deleting them.)
+--archive-logs  #  (Archive existing log files instead of deleting them.)
+--archive-downloads  #  (Archive old downloads instead of deleting them.)
 --time-limit=SECONDS  # (Safely fail any test that exceeds the time limit.)
 --slow  # (Slow down the automation. Faster than using Demo Mode.)
 --demo  # (Slow down and visually see test actions as they occur.)

help_docs/customizing_test_runs.md

@@ -117,7 +117,8 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
 --headed  # (Run tests with a GUI on Linux OS.)
 --locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.)
 --start-page=URL  # (The starting URL for the web browser when tests begin.)
---archive-logs  # (Archive old log files instead of deleting them.)
+--archive-logs  #  (Archive existing log files instead of deleting them.)
+--archive-downloads  #  (Archive old downloads instead of deleting them.)
 --time-limit=SECONDS  # (Safely fail any test that exceeds the time limit.)
 --slow  # (Slow down the automation. Faster than using Demo Mode.)
 --demo  # (Slow down and visually see test actions as they occur.)

seleniumbase/core/download_helper.py

@@ -4,10 +4,12 @@
 from seleniumbase.config import settings
 from seleniumbase.fixtures import constants
 
-# Folder for saving downloaded files.
-# If initiated by WebDriver clicks, works ONLY for Chrome and Firefox.
-# Browser used doesn't matter if done with self.download_file(file_url)
-# or self.save_file_as(file_url, new_file_name)
+# The "downloads_folder" is a folder for saving downloaded files.
+# Works for downloads initiated by Chromium and Firefox WebDriver clicks.
+# Browser type doesn't matter if using self.download_file(file_url)
+#                             or self.save_file_as(file_url, new_file_name)
+# 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
 

seleniumbase/plugins/base_plugin.py

@@ -5,6 +5,7 @@
 import time
 from nose.plugins import Plugin
 from nose.exc import SkipTest
+from seleniumbase.config import settings
 from seleniumbase.core import log_helper
 from seleniumbase.core import report_helper
 from seleniumbase.fixtures import constants, errors
@@ -20,6 +21,7 @@ class Base(Plugin):
     --var3=DATA  (Extra test data. Access with "self.var3" in tests.)
     --settings-file=FILE  (Override default SeleniumBase settings.)
     --archive-logs  (Archive old log files instead of deleting them.)
+    --archive-downloads  (Archive old downloads instead of deleting.)
     --report  (Create a fancy nosetests report after tests complete.)
     --show-report   If self.report is turned on, then the report will
                     display immediately after tests complete their run.
@@ -83,6 +85,12 @@ def options(self, parser, env):
             dest='archive_logs',
             default=False,
             help="Archive old log files instead of deleting them.")
+        parser.add_option(
+            '--archive_downloads', '--archive-downloads',
+            action="store_true",
+            dest='archive_downloads',
+            default=False,
+            help="Archive old downloads instead of deleting them.")
         parser.add_option(
             '--report',
             action="store_true",
@@ -147,6 +155,8 @@ def beforeTest(self, test):
         test.test.var3 = self.options.var3
         test.test.settings_file = self.options.settings_file
         test.test.log_path = self.options.log_path
+        if self.options.archive_downloads:
+            settings.ARCHIVE_EXISTING_DOWNLOADS = True
         test.test.args = self.options
         test.test.report_on = self.report_on
         self.test_count += 1

seleniumbase/plugins/pytest_plugin.py

@@ -8,6 +8,7 @@
 import sys
 import time
 from seleniumbase import config as sb_config
+from seleniumbase.config import settings
 from seleniumbase.core import log_helper
 from seleniumbase.core import proxy_helper
 from seleniumbase.fixtures import constants
@@ -45,7 +46,8 @@ def pytest_addoption(parser):
     --headed  (Run tests with a GUI on Linux OS.)
     --locale=LOCALE_CODE  (Set the Language Locale Code for the web browser.)
     --start-page=URL  (The starting URL for the web browser when tests begin.)
-    --archive-logs  (Archive old log files instead of deleting them.)
+    --archive-logs  (Archive existing log files instead of deleting them.)
+    --archive-downloads  (Archive old downloads instead of deleting them.)
     --time-limit=SECONDS  (Safely fail any test that exceeds the time limit.)
     --slow  (Slow down the automation. Faster than using Demo Mode.)
     --demo  (Slow down and visually see test actions as they occur.)
@@ -210,6 +212,11 @@ def pytest_addoption(parser):
                      dest='archive_logs',
                      default=False,
                      help="Archive old log files instead of deleting them.")
+    parser.addoption('--archive_downloads', '--archive-downloads',
+                     action="store_true",
+                     dest='archive_downloads',
+                     default=False,
+                     help="Archive old downloads instead of deleting them.")
     parser.addoption('--with-db_reporting', '--with-db-reporting',
                      action="store_true",
                      dest='with_db_reporting',
@@ -669,6 +676,8 @@ def pytest_configure(config):
     sb_config.database_env = config.getoption('database_env')
     sb_config.log_path = 'latest_logs/'  # (No longer editable!)
     sb_config.archive_logs = config.getoption('archive_logs')
+    if config.getoption('archive_downloads'):
+        settings.ARCHIVE_EXISTING_DOWNLOADS = True
     sb_config._time_limit = config.getoption('time_limit')
     sb_config.time_limit = config.getoption('time_limit')
     sb_config.slow_mode = config.getoption('slow_mode')