From 53bb5cc4e20080e16146e5ebcd49b67a653a28cd Mon Sep 17 00:00:00 2001
From: Houkime <>
Date: Wed, 5 Jul 2023 13:13:30 +0000
Subject: [PATCH] feature(backups): forgetting snapshots

---
 selfprivacy_api/backup/__init__.py            |  5 ++++
 selfprivacy_api/backup/backuppers/__init__.py |  4 +++
 .../backup/backuppers/none_backupper.py       |  3 +++
 .../backup/backuppers/restic_backupper.py     | 26 +++++++++++++++++++
 tests/test_graphql/test_backup.py             | 26 +++++++++++++++++++
 5 files changed, 64 insertions(+)

diff --git a/selfprivacy_api/backup/__init__.py b/selfprivacy_api/backup/__init__.py
index 7a60ecb..216cf65 100644
--- a/selfprivacy_api/backup/__init__.py
+++ b/selfprivacy_api/backup/__init__.py
@@ -305,6 +305,11 @@ class Backups:
 
         return snap
 
+    @staticmethod
+    def forget_snapshot(snapshot: Snapshot):
+        Backups.provider().backupper.forget_snapshot(snapshot.id)
+        Storage.delete_cached_snapshot(snapshot)
+
     @staticmethod
     def force_snapshot_cache_reload():
         upstream_snapshots = Backups.provider().backupper.get_snapshots()
diff --git a/selfprivacy_api/backup/backuppers/__init__.py b/selfprivacy_api/backup/backuppers/__init__.py
index 16cde07..335cdfd 100644
--- a/selfprivacy_api/backup/backuppers/__init__.py
+++ b/selfprivacy_api/backup/backuppers/__init__.py
@@ -37,3 +37,7 @@ class AbstractBackupper(ABC):
     @abstractmethod
     def restored_size(self, snapshot_id: str) -> int:
         raise NotImplementedError
+
+    @abstractmethod
+    def forget_snapshot(self, snapshot_id):
+        raise NotImplementedError
diff --git a/selfprivacy_api/backup/backuppers/none_backupper.py b/selfprivacy_api/backup/backuppers/none_backupper.py
index 014f755..2ac2035 100644
--- a/selfprivacy_api/backup/backuppers/none_backupper.py
+++ b/selfprivacy_api/backup/backuppers/none_backupper.py
@@ -27,3 +27,6 @@ class NoneBackupper(AbstractBackupper):
 
     def restored_size(self, snapshot_id: str) -> int:
         raise NotImplementedError
+
+    def forget_snapshot(self, snapshot_id):
+        raise NotImplementedError
diff --git a/selfprivacy_api/backup/backuppers/restic_backupper.py b/selfprivacy_api/backup/backuppers/restic_backupper.py
index ae86efc..7f16a91 100644
--- a/selfprivacy_api/backup/backuppers/restic_backupper.py
+++ b/selfprivacy_api/backup/backuppers/restic_backupper.py
@@ -257,6 +257,32 @@ class ResticBackupper(AbstractBackupper):
                     "restore exited with errorcode", returncode, ":", output
                 )
 
+    def forget_snapshot(self, snapshot_id):
+        """either removes snapshot or marks it for deletion later depending on server settings"""
+        forget_command = self.restic_command(
+            "forget",
+            snapshot_id,
+        )
+
+        with subprocess.Popen(
+            forget_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=False
+        ) as handle:
+            # for some reason restore does not support nice reporting of progress via json
+            output, err = [string.decode("utf-8") for string in handle.communicate()]
+
+            if "no matching ID found" in err:
+                raise ValueError(
+                    "trying to delete, but no such snapshot: ", snapshot_id
+                )
+
+            assert (
+                handle.returncode is not None
+            )  # none should be impossible after communicate
+            if handle.returncode != 0:
+                raise ValueError(
+                    "forget exited with errorcode", returncode, ":", output
+                )
+
     def _load_snapshots(self) -> object:
         """
         Load list of snapshots from repository
diff --git a/tests/test_graphql/test_backup.py b/tests/test_graphql/test_backup.py
index 872b6ad..928c1b7 100644
--- a/tests/test_graphql/test_backup.py
+++ b/tests/test_graphql/test_backup.py
@@ -15,6 +15,8 @@ from selfprivacy_api.services.test_service import DummyService
 from selfprivacy_api.graphql.queries.providers import BackupProvider
 from selfprivacy_api.jobs import Jobs, JobStatus
 
+from selfprivacy_api.models.backup.snapshot import Snapshot
+
 from selfprivacy_api.backup import Backups
 import selfprivacy_api.backup.providers as providers
 from selfprivacy_api.backup.providers import AbstractBackupProvider
@@ -314,6 +316,30 @@ def test_backup_service_task(backups, dummy_service):
     assert_job_had_progress(job_type_id)
 
 
+def test_forget_snapshot(backups, dummy_service):
+    snap1 = Backups.back_up(dummy_service)
+    snap2 = Backups.back_up(dummy_service)
+    assert len(Backups.get_snapshots(dummy_service)) == 2
+
+    Backups.forget_snapshot(snap2)
+    assert len(Backups.get_snapshots(dummy_service)) == 1
+    Backups.force_snapshot_cache_reload()
+    assert len(Backups.get_snapshots(dummy_service)) == 1
+
+    assert Backups.get_snapshots(dummy_service)[0].id == snap1.id
+
+    Backups.forget_snapshot(snap1)
+    assert len(Backups.get_snapshots(dummy_service)) == 0
+
+
+def test_forget_nonexistent_snapshot(backups, dummy_service):
+    bogus = Snapshot(
+        id="gibberjibber", service_name="nohoho", created_at=datetime.now(timezone.utc)
+    )
+    with pytest.raises(ValueError):
+        Backups.forget_snapshot(bogus)
+
+
 def test_backup_larger_file(backups, dummy_service):
     dir = path.join(dummy_service.get_folders()[0], "LARGEFILE")
     mega = 2**20