From d17b2c74dbf8dba351b9664955901ea33c8c34b5 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <divyanshanandsingh@gmail.com>
Date: Sat, 18 Mar 2023 04:35:55 +0530
Subject: [PATCH] feat: add optional check for existence of source directories

---
 borgmatic/borg/create.py     | 18 ++++++++++++++++++
 borgmatic/config/schema.yaml |  6 ++++++
 2 files changed, 24 insertions(+)

diff --git a/borgmatic/borg/create.py b/borgmatic/borg/create.py
index 0889c3d..f3c3c69 100644
--- a/borgmatic/borg/create.py
+++ b/borgmatic/borg/create.py
@@ -306,6 +306,22 @@ def collect_special_file_paths(
     )
 
 
+def check_all_source_directories_exist(source_directories):
+    '''
+    Given a sequence of source directories, check that they all exist. If any do not, raise an
+    exception.
+    '''
+    missing_directories = [
+        source_directory
+        for source_directory in source_directories
+        if not os.path.exists(source_directory)
+    ]
+    if missing_directories:
+        raise ValueError(
+            'Source directories do not exist: {}'.format(', '.join(missing_directories))
+        )
+
+
 def create_archive(
     dry_run,
     repository,
@@ -331,6 +347,8 @@ def create_archive(
     borgmatic_source_directories = expand_directories(
         collect_borgmatic_source_directories(location_config.get('borgmatic_source_directory'))
     )
+    if location_config.get('source_directories_must_exist', False):
+        check_all_source_directories_exist(location_config.get('source_directories'))
     sources = deduplicate_directories(
         map_directories_to_devices(
             expand_directories(
diff --git a/borgmatic/config/schema.yaml b/borgmatic/config/schema.yaml
index 2f873b7..0135299 100644
--- a/borgmatic/config/schema.yaml
+++ b/borgmatic/config/schema.yaml
@@ -202,6 +202,12 @@ properties:
                     path prevents "borgmatic restore" from finding any database
                     dumps created before the change. Defaults to ~/.borgmatic
                 example: /tmp/borgmatic
+            source_directories_must_exist:
+                type: boolean
+                description: |
+                    If true, then source directories must exist, otherwise an
+                    error is raised. Defaults to false.
+                example: true
     storage:
         type: object
         description: |