dar-backup 0.6.13__py3-none-any.whl → 0.6.14__py3-none-any.whl

dar_backup/__about__.py

@@ -1 +1 @@
-__version__ = "0.6.13"
+__version__ = "0.6.14"

dar_backup/dar_backup.py

@@ -27,11 +27,11 @@ from dar_backup.config_settings import ConfigSettings
 from dar_backup.util import list_backups
 from dar_backup.util import run_command
 from dar_backup.util import setup_logging
+from dar_backup.util import get_logger
 from dar_backup.util import BackupError
 from dar_backup.util import RestoreError
 
 
-RESULT = True
 logger = None
 
 def generic_backup(type: str, command: List[str], backup_file: str, backup_definition: str, darrc: str,  config_settings: ConfigSettings, args: argparse.Namespace):
@@ -86,30 +86,37 @@ def generic_backup(type: str, command: List[str], backup_file: str, backup_defin
  
 
 
-def find_files_with_paths(xml_root: ET.Element):
+def find_files_with_paths(xml_doc: str):
     """
-    Finds files within an XML element and returns a list of file paths with their sizes.
+    Finds files within an XML element and returns a list of tuples (file path, size).
 
     Args:
-        xml_root (Element): The root element of the XML.
+        xml_root: str  The XML generated by dar -l <archive> -Txml.
 
     Returns:
-        list: A list of tuples containing file paths and their sizes.
+        list: A list of tuples (file path, size).
     """
-    logger.debug("Generating list of tuples with file paths and sizes for File elements in dar xml output")
-    files = []
-    current_path = []
+    #get_logger().debug("Generating list of tuples with file paths and sizes for File elements in dar xml output")
+    xml_doc = re.sub(r'<!DOCTYPE[^>]*>', '', xml_doc)
+    root = ET.fromstring(xml_doc)
 
-    for elem in xml_root.iter():
-        if elem.tag == "Directory":
-            current_path.append(elem.get('name'))
-        elif elem.tag == "File":
-            file_path = ("/".join(current_path + [elem.get('name')]), elem.get('size'))
-            files.append(file_path)
-        elif elem.tag == "Directory" and elem.get('Name') in current_path:
-            current_path.pop()
+    files_list = []
 
-    return files
+    def iterate_dir(element, current_path=""):
+        for child in element:
+            if child.tag == 'Directory':
+                dir_name = child.get('name')
+                new_path = f"{current_path}/{dir_name}" if current_path else dir_name
+                iterate_dir(child, new_path)
+
+            elif child.tag == 'File':
+                file_name = child.get('name')
+                file_size = child.get('size')
+                file_path = f"{current_path}/{file_name}" if current_path else file_name
+                files_list.append((file_path, file_size))
+
+    iterate_dir(root)
+    return files_list
 
 
 def find_files_between_min_and_max_size(backed_up_files: list[(str, str)], config_settings: ConfigSettings):
@@ -226,8 +233,7 @@ def verify(args: argparse.Namespace, backup_file: str, backup_definition: str, c
             if filecmp.cmp(os.path.join(config_settings.test_restore_dir, restored_file_path.lstrip("/")), os.path.join(root_path, restored_file_path.lstrip("/")), shallow=False):
                 logger.info(f"Success: file '{restored_file_path}' matches the original")
             else:
-                logger.error(f"Failure: file '{restored_file_path}' did not match the original")
-                result = False
+                raise BackupError(f"Failure: file '{restored_file_path}' did not match the original")
         except PermissionError:
             result = False
             logger.exception(f"Permission error while comparing files, continuing....")
@@ -246,6 +252,7 @@ def restore_backup(backup_name: str, config_settings: ConfigSettings, restore_di
         restore_dir (str): The directory where the backup should be restored to.
         selection (str, optional): A selection criteria to restore specific files or directories. Defaults to None.
     """
+    results: List[tuple] = []
     try:
         backup_file = os.path.join(config_settings.backup_dir, backup_name)
         command = ['dar', '-x', backup_file, '-Q', '-D']
@@ -274,6 +281,7 @@ def restore_backup(backup_name: str, config_settings: ConfigSettings, restore_di
     except Exception as e:
         raise RestoreError(f"Unexpected error during restore: {e}") from e
 
+    return results
 
 
 def get_backed_up_files(backup_name: str, backup_dir: str):
@@ -292,15 +300,9 @@ def get_backed_up_files(backup_name: str, backup_dir: str):
     try:
         command = ['dar', '-l', backup_path, '-am', '-as', "-Txml" , '-Q']
         logger.info(f"Running command: {' '.join(map(shlex.quote, command))}")
-        process = run_command(command)
+        command_result = run_command(command)
         # Parse the XML data
-        root = ET.fromstring(process.stdout)
-        output = None  # help gc
-        # Extract full paths and file size for all <file> elements
-        file_paths = find_files_with_paths(root)
-        root = None # help gc
-        logger.trace(str(process))
-        logger.trace(file_paths)
+        file_paths = find_files_with_paths(command_result.stdout)
         return file_paths
     except subprocess.CalledProcessError as e:
         logger.error(f"Error listing backed up files from DAR archive: '{backup_name}'")
@@ -371,7 +373,7 @@ def create_backup_command(backup_type: str, backup_file: str, darrc: str, backup
 
 
 
-def perform_backup(args: argparse.Namespace, config_settings: ConfigSettings, backup_type: str):
+def perform_backup(args: argparse.Namespace, config_settings: ConfigSettings, backup_type: str) -> List[str]:
     """
     Perform backup operation.
 
@@ -379,21 +381,27 @@ def perform_backup(args: argparse.Namespace, config_settings: ConfigSettings, ba
         args: Command-line arguments.
         config_settings: An instance of the ConfigSettings class.
         backup_type: Type of backup (FULL, DIFF, INCR).
+
+    Returns:
+    List[tuples] - each tuple consists of (<str message>, <exit code>)
     """
-    logger.debug(f"perform_backup({backup_type}) started")
     backup_definitions = []
+    results: List[tuple] = []
 
     # Gather backup definitions
     if args.backup_definition:
         if '_' in args.backup_definition:
-            logger.error(f"Skipping backup definition: '{args.backup_definition}' due to '_' in name")
-            return
+            msg = f"Skipping backup definition: '{args.backup_definition}' due to '_' in name"
+            logger.error(msg)
+            return results.append((msg, 1))
         backup_definitions.append((os.path.basename(args.backup_definition).split('.')[0], os.path.join(config_settings.backup_d_dir, args.backup_definition)))
     else:
         for root, _, files in os.walk(config_settings.backup_d_dir):
             for file in files:
                 if '_' in file:
-                    logger.error(f"Skipping backup definition: '{file}' due to '_' in name")
+                    msg = f"Skipping backup definition: '{file} due to '_' in: name"
+                    logger.error(msg)
+                    results.append((msg, 1))
                     continue
                 backup_definitions.append((file.split('.')[0], os.path.join(root, file)))
 
@@ -403,7 +411,9 @@ def perform_backup(args: argparse.Namespace, config_settings: ConfigSettings, ba
             backup_file = os.path.join(config_settings.backup_dir, f"{backup_definition}_{backup_type}_{date}")
 
             if os.path.exists(backup_file + '.1.dar'):
-                logger.error(f"Backup file {backup_file}.1.dar already exists. Skipping backup.")
+                msg = f"Backup file {backup_file}.1.dar already exists. Skipping backup [1]."
+                logger.error(msg)
+                results.append((msg, 1))
                 continue
 
             latest_base_backup = None
@@ -414,15 +424,18 @@ def perform_backup(args: argparse.Namespace, config_settings: ConfigSettings, ba
                     latest_base_backup = os.path.join(config_settings.backup_dir, args.alternate_reference_archive)
                     logger.info(f"Using alternate reference archive: {latest_base_backup}")
                     if not os.path.exists(latest_base_backup + '.1.dar'):
-                        logger.error(f"Alternate reference archive: \"{latest_base_backup}.1.dar\" does not exist, exiting.")
-                        exit(1)
+                        msg = f"Alternate reference archive: \"{latest_base_backup}.1.dar\" does not exist, exiting..."
+                        logger.error(msg)
+                        results.append((msg, 1))
+                        return results
                 else:
                     base_backups = sorted(
                         [f for f in os.listdir(config_settings.backup_dir) if f.startswith(f"{backup_definition}_{base_backup_type}_") and f.endswith('.1.dar')],
                         key=lambda x: datetime.strptime(x.split('_')[-1].split('.')[0], '%Y-%m-%d')
                     )
                     if not base_backups:
-                        logger.warning(f"No {base_backup_type} backup found for {backup_definition}. Skipping {backup_type} backup.")
+                        msg = f"No {base_backup_type} backup found for {backup_definition}. Skipping {backup_type} backup."
+                        results.append((msg, 1))
                         continue
                     latest_base_backup = os.path.join(config_settings.backup_dir, base_backups[-1].rsplit('.', 2)[0])
 
@@ -437,19 +450,19 @@ def perform_backup(args: argparse.Namespace, config_settings: ConfigSettings, ba
             if verify_result:   
                 logger.info("Verification completed successfully.")
             else:
-                logger.error("Verification failed.")
-
-            
+                msg = f"Verification of '{backup_file}' failed."
+                logger.error(msg)
+                results.append((msg, 1))
             logger.info("Generate par2 redundancy files.")
             generate_par2_files(backup_file, config_settings, args)
             logger.info("par2 files completed successfully.")
 
         except Exception as e:
-            global RESULT
-            RESULT = False
+            results.aapend((repr(e), 1))
             logger.exception(f"Error during {backup_type} backup process, continuing to next backup definition.")
 
-
+    logger.trace(f"perform_backup() results[]: {results}")
+    return results
 
 def generate_par2_files(backup_file: str, config_settings: ConfigSettings, args):
     """
@@ -593,18 +606,23 @@ INCR back of a single backup definition in backup.d
 
 def requirements(type: str, config_setting: ConfigSettings):
     """
-    Perform PREREQ or POSTREQ requisites.
+    Perform PREREQ or POSTREQ requirements.
 
     Args:
         type (str): The type of prereq (PREREQ, POSTREQ).
         config_settings (ConfigSettings): An instance of the ConfigSettings class.
 
     Raises:
-        RuntimeError: If a subprocess invoked during the backup process exits with a non-zero status.
+        RuntimeError: If a subprocess  returns anything but zero.
+
+        subprocess.CalledProcessError: if CalledProcessError is raised in subprocess.run(), let it bobble up.
     """
-    if str is None or config_setting is None:
-        logger.error(f"requirements: {type} or config_setting is None, existing")
-        raise RuntimeError(f"requirements: {type} or config_setting is None, existing")
+    if type is None or config_setting is None:
+        raise RuntimeError(f"requirements: 'type' or config_setting is None")
+
+    allowed_types = ['PREREQ', 'POSTREQ'] 
+    if type not in allowed_types:
+        raise RuntimeError(f"requirements: {type} not in: {allowed_types}")
 
 
     logger.info(f"Performing  {type}")
@@ -624,7 +642,8 @@ def requirements(type: str, config_setting: ConfigSettings):
 
 
 def main():
-    global logger, RESULT 
+    global logger
+    results: List[(str,int)] = []  # a list op tuples (<msg>, <exit code>)
 
     MIN_PYTHON_VERSION = (3, 9)
     if version_info < MIN_PYTHON_VERSION:
@@ -737,26 +756,27 @@ def main():
         if args.list:
             list_backups(config_settings.backup_dir, args.backup_definition)
         elif args.full_backup and not args.differential_backup and not args.incremental_backup:
-            perform_backup(args, config_settings, "FULL")
+            results.extend(perform_backup(args, config_settings, "FULL"))
         elif args.differential_backup and not args.full_backup and not args.incremental_backup:
-            perform_backup(args, config_settings, "DIFF")
+            results.extend(perform_backup(args, config_settings, "DIFF"))
         elif args.incremental_backup  and not args.full_backup and not args.differential_backup:
-            perform_backup(args, config_settings, "INCR")
+            results.extend(perform_backup(args, config_settings, "INCR"))
+            logger.debug(f"results from perform_backup(): {results}")
         elif args.list_contents:
             list_contents(args.list_contents, config_settings.backup_dir, args.selection)
         elif args.restore:
             logger.debug(f"Restoring {args.restore} to {restore_dir}")
-            restore_backup(args.restore, config_settings, restore_dir, args.darrc, args.selection)
+            results.extend(restore_backup(args.restore, config_settings, restore_dir, args.darrc, args.selection))
         else:
             parser.print_help()
 
+        logger.debug(f"results[]: {results}")
+
         requirements('POSTREQ', config_settings)
 
     except Exception as e:
-        logger.exception("An error occurred")
         logger.error("Exception details:", exc_info=True)
-        args.verbose and print("\033[1m\033[31mErrors\033[0m encountered")
-        RESULT = False
+        results.append((repr(e), 1))
     finally:
         end_time=int(time())
         logger.info(f"END TIME: {end_time}")
@@ -767,9 +787,26 @@ def main():
                 logger.info(f"Removed filtered .darrc: {args.darrc}")
 
 
-    if RESULT:
-        exit(0)
-    else:
+    error = False
+    logger.debug(f"results[]: {results}")
+    if results:
+        i = 0
+        for result in results:
+            if isinstance(result, tuple) and len(result) == 2:
+                msg, exit_code = result
+                logger.debug(f"exit code: {exit_code}, msg: {msg}")
+                if exit_code == 1:
+                    error = True
+                    args.verbose and print(msg)
+            else:
+                logger.error(f"not correct result type: {result}, which must be a tuple (<msg>, <exit_code>)")
+            i=i+1
+    if error:
+        args.verbose and print("\033[1m\033[31mErrors\033[0m encountered")
         exit(1)
+    else:
+        args.verbose and print("\033[1m\033[32mSuccess\033[0m all backups completed") 
+        exit(0)
+    
 if __name__ == "__main__":
     main()

dar_backup/manager.py

@@ -233,7 +233,7 @@ def add_specific_archive(archive: str, config_settings: ConfigSettings, director
     database_path = os.path.realpath(os.path.join(config_settings.backup_dir, database))
     logger.info(f'Add "{archive_path}" to catalog: "{database}"')
     
-    command = ['dar_manager', '--base', database_path, "--add", archive_path, "-ai", "-Q"]
+    command = ['dar_manager', '--base', database_path, "--add", archive_path, "-Q"]
     process = run_command(command)
     stdout, stderr = process.stdout, process.stderr
 

dar_backup/util.py

@@ -195,8 +195,6 @@ def run_command(command: List[str], timeout: int = 30, no_output_log: bool = Fal
     stdout = "\n".join(stdout_lines)
     stderr = "\n".join(stderr_lines)
 
-    print(f"run_command(): stdout: {stdout}")
-
     #Build the result object
     result = CommandResult(process=process, stdout=stdout, stderr=stderr, returncode=process.returncode, timeout=timeout, command=command)
     return result

{dar_backup-0.6.13.dist-info → dar_backup-0.6.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dar-backup
-Version: 0.6.13
+Version: 0.6.14
 Summary: A script to do full, differential and incremental backups using dar.     Some files are restored from the backups during verification, after which par2 redundancy files are created.     The script also has a cleanup feature to remove old backups and par2 files.
 Project-URL: Homepage, https://github.com/per2jensen/dar-backup/tree/main/v2
 Project-URL: Changelog, https://github.com/per2jensen/dar-backup/blob/main/v2/Changelog.md
@@ -1355,6 +1355,8 @@ In order to not clutter that log file with the output of commands being run, a n
   - FULL, DIFF and INCR backups.
   - cleanup.
 
+- fix --log-stdout spams console with command output
+
 ## Reference
 
 ### dar-backup

{dar_backup-0.6.13.dist-info → dar_backup-0.6.14.dist-info}/RECORD

@@ -1,16 +1,16 @@
 dar_backup/.darrc,sha256=-aerqivZmOsW_XBCh9IfbYTUvw0GkzDSr3Vx4GcNB1g,2113
-dar_backup/__about__.py,sha256=O6utsDWOeEVfzuQL1We6GrrAngH4GD2_V-eHkb1cdoE,22
+dar_backup/__about__.py,sha256=gpxZhHkmXQLM1tz9VrFJMN82NzCMmjk_6Z0FrzPb8BE,22
 dar_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dar_backup/clean_log.py,sha256=cGhtKYnQJ2ceNQfw5XcCln_WNBasbmlfhO3kRydjDNk,5196
 dar_backup/cleanup.py,sha256=1g2si9-jPEL8T4OKaiGSKFGsF6rWh-Ke1-zQHE7HaPc,11703
 dar_backup/config_settings.py,sha256=uicCq6FnpxPFzbv7xfYSXNnQf1tfLk1Z3VIO9M71fsE,4659
 dar_backup/dar-backup.conf,sha256=-wXqP4vj5TS7cCfMJN1nbk-1Sqkq00Tg22ySQXynUF4,902
-dar_backup/dar_backup.py,sha256=yJjDqyPBWsjsMZeMbEgLzLt0N8R2y-YZGdfxvZjm8gs,35723
+dar_backup/dar_backup.py,sha256=8RcSVsqRy-BUCjJBroo0oKC8ZabZ5HXZrRFwxZV82b4,37360
 dar_backup/installer.py,sha256=ehp4KSgTc8D9Edsyve5v3NY2MuDbuTFYQQPgou8woV8,4331
-dar_backup/manager.py,sha256=VBeZEIETDL_Lxhmo-T47xSQAxbOPGU-ZLI7GFXJx-Go,21647
-dar_backup/util.py,sha256=iTQ_P4hmkraivRPd-jY1aXoesVm7puE4Ww0QLsvygpU,12325
-dar_backup-0.6.13.dist-info/METADATA,sha256=rgdWrjAgCvisWCyeaW-LrK8myBrJa4pijGaMtRH3diA,72696
-dar_backup-0.6.13.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dar_backup-0.6.13.dist-info/entry_points.txt,sha256=Z7P5BUbhtJxo8_nB9qNIMay2eGDbsMKB3Fjwv3GMa4g,202
-dar_backup-0.6.13.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-dar_backup-0.6.13.dist-info/RECORD,,
+dar_backup/manager.py,sha256=sQl0xdWwBgui11S9Ekg0hOSC4gt89nz_Z8Bt8IPXCDw,21640
+dar_backup/util.py,sha256=lfgfxC_C6x3I8f9vzyxpQE7P-7rm6tTEr3P-2uWlVtQ,12278
+dar_backup-0.6.14.dist-info/METADATA,sha256=P8yWZZJ8WDrSMmN8UCbEoKZU2y76L_-05Y2vPmubNOA,72750
+dar_backup-0.6.14.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dar_backup-0.6.14.dist-info/entry_points.txt,sha256=Z7P5BUbhtJxo8_nB9qNIMay2eGDbsMKB3Fjwv3GMa4g,202
+dar_backup-0.6.14.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+dar_backup-0.6.14.dist-info/RECORD,,