Merge pull request #19 from lawndoc/add-tests #none

chore: update tests and documentation

Author: lawndoc

docs/guide/configuration.rst

@@ -188,6 +188,16 @@ connecting to the Docker host. Combined with ``DOCKER_TLS_VERIFY``
 this can be used to talk to docker through TLS in cases
 were we cannot map in the docker socket.
 
+INCLUDE_ALL_VOLUMES
+~~~~~~~~~~~~~~~~~~~
+
+If defined, all volumes will be included in the backup.
+This is useful when you want to back up all volumes
+in a project without having to add labels to each service.
+
+Volumes can be excluded by adding the ``stack-back.volumes.exclude``
+label to the service.
+
 INCLUDE_PROJECT_NAME
 ~~~~~~~~~~~~~~~~~~~~
 
@@ -272,6 +282,30 @@ Their path in restic will be:
 - /volumes/myservice/srv/files
 - /volumes/myservice/srv/data
 
+In situations where the files in the volume are at risk of being
+corrupted during the backup process (such as SQLite databases), 
+the `stack-back.volumes.stop-during-backup` label can be added to 
+the service. This will stop the service during the backup process 
+and start it again when the backup is done.
+
+Example:
+
+.. code:: yaml
+  
+    myservice:
+      image: some_image
+      labels:
+        stack-back.volumes: true
+        stack-back.volumes.stop-during-backup: true
+      volumes:
+        - uploaded_media:/srv/media
+        - uploaded_files:/srv/files
+        - /srv/data:/srv/data
+
+    volumes:
+      media:
+      files:
+
 A simple `include` and `exclude` filter for what volumes
 should be backed up is also available. Note that this
 includes or excludes entire volumes and are not include/exclude
@@ -333,16 +367,16 @@ when using the official mariadb_ image.
 
 .. code::
 
-    MYSQL_USER
-    MYSQL_PASSWORD
+    MARIADB_USER
+    MARIADB_PASSWORD
 
 Backups are done by dumping all databases directly into
 restic through stdin using ``mysqldump``. It will appear
 in restic as a separate snapshot with path
 ``/databases/<service_name>/all_databases.sql``.
 
 .. warning: This will only back up the databases the
-            ``MYSQL_USER` has access to. If you have multiple
+            ``MARIADB_USER` has access to. If you have multiple
             databases this must be taken into consideration.
 
 Example:

src/tests/tests.py

@@ -245,6 +245,46 @@ def test_basic_functionality(self):
         self.assertEqual(len(mounts), 2)
         self.assertEqual(mounts[0].source, "/srv/files/media")
         self.assertEqual(mounts[1].source, "/srv/files/stuff")
+        
+    def test_redundant_label(self):
+        """Test that a container has a redundant label and should be backed up"""
+
+        containers = self.createContainers()
+        containers += [
+            {
+                "service": "web",
+                "labels": {
+                    "stack-back.volumes": True,
+                },
+                "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"""