Merge pull request #18 from tcorzo/feature/include-all-volumes #minor

Add INCLUDE_ALL_VOLUMES env var and related tests

Author: lawndoc

src/restic_compose_backup/config.py

@@ -15,6 +15,7 @@ def __init__(self, check=True):
         self.swarm_mode = os.environ.get('SWARM_MODE') or False
         self.include_project_name = os.environ.get('INCLUDE_PROJECT_NAME') or False
         self.exclude_bind_mounts = os.environ.get('EXCLUDE_BIND_MOUNTS') or False
+        self.include_all_volumes = os.environ.get('INCLUDE_ALL_VOLUMES') or False
 
         # Log
         self.log_level = os.environ.get('LOG_LEVEL')

src/restic_compose_backup/containers.py

@@ -146,7 +146,11 @@ def backup_enabled(self) -> bool:
     @property
     def volume_backup_enabled(self) -> bool:
         """bool: If the ``stack-back.volumes`` label is set"""
-        return utils.is_true(self.get_label(enums.LABEL_VOLUMES_ENABLED))
+        label_value = self.get_label(enums.LABEL_VOLUMES_ENABLED)
+
+        return utils.is_true(label_value) or (
+            utils.is_true(config.include_all_volumes) and label_value is None
+        )
 
     @property
     def database_backup_enabled(self) -> bool:

src/tests/tests.py

@@ -6,15 +6,14 @@
 os.environ['RESTIC_REPOSITORY'] = "test"
 os.environ['RESTIC_PASSWORD'] = "password"
 
-from restic_compose_backup import utils
+from restic_compose_backup import utils, config
 from restic_compose_backup.containers import RunningContainers
 import fixtures
 
 list_containers_func = 'restic_compose_backup.utils.list_containers'
 
 
-class ResticBackupTests(unittest.TestCase):
-
+class BaseTestCase(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
         """Set up basic environment variables"""
@@ -31,6 +30,7 @@ def createContainers(self):
             }
         ]
 
+class ResticBackupTests(BaseTestCase):
     def test_list_containers(self):
         """Test a basic container list"""
         containers = [
@@ -201,3 +201,120 @@ def test_find_running_backup_container(self):
         with mock.patch(list_containers_func, fixtures.containers(containers=containers)):
             cnt = RunningContainers()
             self.assertTrue(cnt.backup_process_running)
+
+
+class IncludeAllVolumesTests(BaseTestCase):
+    @classmethod
+    def setUpClass(cls):
+        config.config.include_all_volumes = "true"
+
+    @classmethod
+    def tearDownClass(cls):
+        config.config = config.Config()
+
+    def test_basic_functionality(self):
+        """Test that the INCLUDE_ALL_VOLUMES flag works"""
+        containers = self.createContainers()
+        containers += [
+            {
+                "service": "web",
+                "mounts": [
+                    {
+                        "Source": "/srv/files/media",
+                        "Destination": "/srv/media",
+                        "Type": "bind",
+                    },
+                    {
+                        "Source": "/srv/files/stuff",
+                        "Destination": "/srv/stuff",
+                        "Type": "bind",
+                    },
+                ],
+            },
+        ]
+        with mock.patch(
+            list_containers_func, fixtures.containers(containers=containers)
+        ):
+            cnt = RunningContainers()
+
+        web_service = cnt.get_service("web")
+        self.assertNotEqual(web_service, None, msg="Web service not found")
+
+        mounts = web_service.filter_mounts()
+        print(mounts)
+        self.assertEqual(len(mounts), 2)
+        self.assertEqual(mounts[0].source, "/srv/files/media")
+        self.assertEqual(mounts[1].source, "/srv/files/stuff")
+
+    def test_explicit_exclude(self):
+        """Test that a container can be excluded from the backup"""
+
+        containers = self.createContainers()
+        containers += [
+            {
+                "service": "web",
+                "labels": {
+                    "stack-back.volumes": False,
+                },
+                "mounts": [
+                    {
+                        "Source": "/srv/files/media",
+                        "Destination": "/srv/media",
+                        "Type": "bind",
+                    },
+                    {
+                        "Source": "/srv/files/stuff",
+                        "Destination": "/srv/stuff",
+                        "Type": "bind",
+                    },
+                ],
+            },
+        ]
+        with mock.patch(
+            list_containers_func, fixtures.containers(containers=containers)
+        ):
+            cnt = RunningContainers()
+
+        web_service = cnt.get_service("web")
+        self.assertNotEqual(web_service, None, msg="Web service not found")
+
+        mounts = web_service.filter_mounts()
+        print(mounts)
+        self.assertEqual(len(mounts), 0)
+
+    def test_specific_volume_exclude(self):
+        """Test that a specific volume can be excluded from the backup"""
+
+        containers = self.createContainers()
+        containers += [
+            {
+                "service": "web",
+                "labels": {
+                    "stack-back.volumes.exclude": "stuff",
+                },
+                "mounts": [
+                    {
+                        "Source": "/srv/files/media",
+                        "Destination": "/srv/media",
+                        "Type": "bind",
+                    },
+                    {
+                        "Source": "/srv/files/stuff",
+                        "Destination": "/srv/stuff",
+                        "Type": "bind",
+                    },
+                ],
+            },
+        ]
+        with mock.patch(
+            list_containers_func, fixtures.containers(containers=containers)
+        ):
+            cnt = RunningContainers()
+
+        web_service = cnt.get_service("web")
+        self.assertNotEqual(web_service, None, msg="Web service not found")
+
+        mounts = web_service.filter_mounts()
+        print(mounts)
+        self.assertEqual(len(mounts), 1)
+        self.assertEqual(mounts[0].source, "/srv/files/media")