Migration to Python

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    groups:
+      production-dependencies:
+        dependency-type: "production"
+      development-dependencies:
+        dependency-type: "development"

.github/workflows/python-ci.yml

@@ -9,12 +9,12 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12"]
-        dependency-extras: [""]
+        dependency-extras: ["", "-E all"]
 
     steps:
       - uses: actions/checkout@v3
       - name: Install poetry
-        run: pipx install "poetry==1.5.1"
+        run: pipx install "poetry==1.8.3"
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:

.github/workflows/python-publish.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Install poetry
-      run: pipx install 'poetry==1.5.1'
+      run: pipx install 'poetry==1.8.3'
     - name: Set up Python
       uses: actions/setup-python@v4
       with:

.github/workflows/release-please.yml

@@ -13,7 +13,7 @@ jobs:
   release-please:
     runs-on: ubuntu-latest
     steps:
-      - uses: google-github-actions/release-please-action@v3
+      - uses: googleapis/release-please-action@v4
         with:
+          token: ${{ secrets.ReleasePlease }}
           release-type: python
-          package-name: release-please-action

.gitignore

@@ -1,4 +1,3 @@
-
 # Created by https://www.toptal.com/developers/gitignore/api/python
 # Edit at https://www.toptal.com/developers/gitignore?templates=python
 

CHANGELOG.md

@@ -24,7 +24,6 @@
 
 * **cicd:** Use correct project type in release-please ([2e5f5ce](https://github.com/MaxG87/root-subvol-snapshot/commit/2e5f5cea76d10758e2b3c85c2231206a04268a87))
 
-
 ### Documentation
 
 * Add initial Changelog file ([8026b67](https://github.com/MaxG87/root-subvol-snapshot/commit/8026b6757a3f5984b679ec09742e356196b79b79))

example.cfg

@@ -0,0 +1,29 @@
+[
+    {
+        "BackupRepositoryFolder": "ButterBackupRepository",
+        "Compression": "zstd:15",
+        "UUID": "UUID der Festplatte wie in /dev/disk/by-uuid/ angegeben.",
+        "DevicePassCmd": "gpg --decrypt /pfad/zu/mein-kostbares-password",
+        "Folders": {
+            "/home/mmustermann/Downloads": "Downloads",
+            "/home/mmustermann/Videos/Privat": "Private-Videos",
+            "/shared/Bilder": "Bilder"
+        },
+        "Files": ["/etc/fstab"],
+        "FilesDest": "Einzeldateien"
+    },
+    {
+        "BackupRepositoryFolder": "ResticBackupRepository",
+        "ExcludePatternsFile": "~/.config/backup-exclude-patterns",
+        "UUID": "Noch eine UUID wie in /dev/disk/by-uuid/.",
+        "DevicePassCmd": "gpg --decrypt /pfad/zu/supersicheres-pwt",
+        "RepositoryPassCmd": "gpg --decrypt /pfad/zu/supersicheres-pwt-repo",
+        "FilesAndFolders": [
+          "/home/mmustermann/Downloads",
+          "/home/mmustermann/Videos/Privat",
+          "/shared/Bilder",
+          "/etc/fstab",
+          "~/.config/butter-backup.cfg"
+        ]
+    }
+]

pyproject.toml

@@ -8,20 +8,76 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = ">=3.9,<3.13"
+loguru = "^0.7.2"
+pydantic = "^2.8.2"
+rich = {version = "^13.7.1", optional = true}
 shell-interface = "^0.13.0"
 storage-device-managers = "^0.14.0"
-typer = "^0.9.0"
+typer = "^0.12.3"
+
+[tool.poetry.extras]
+# In fact, `typer[all]` would be preferred, but Poetry does not support to have
+# optional extras of dependencies.
+all = ["rich"]
 
 [tool.poetry.group.dev.dependencies]
-mypy = "^1.8.0"
-ruff = "^0.2.0"
-pytest = "^8.0.0"
-pytest-cov = "^4.1.0"
+black = "^24.4.2"
 depr = "^0.2.1"
-pynvim = "^0.5.0"
-black = "^24.1.1"
+hypothesis = "^6.108.4"
+mypy = "^1.11.0"
 pdbpp = "^0.10.3"
+pynvim = "^0.5.0"
+pytest = "^8.3.1"
+pytest-cov = "^5.0.0"
+pytest-xdist = "^3.6.1"
+ruff = "^0.5.4"
+
+[tool.poetry.scripts]
+snapshots = "root_subvol_snapshot.cli:cli"
+
+
+[tool.mypy]
+plugins = [
+  "pydantic.mypy"
+]
+allow_any_unimported = false
+warn_unreachable = true
+enable_error_code = [
+    "possibly-undefined"
+]
+strict = true
+allow_incomplete_defs = true
+allow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disable_error_code = [
+    "possibly-undefined"
+]
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+warn_untyped_fields = true
+
+[tool.pytest.ini_options]
+addopts = [
+    "--cov", "src",
+    "--cov-branch",
+    "--cov-fail-under", "85"
+]
+testpaths = ["tests"]
+
+[tool.ruff]
+src = [".", "src/"]
+
+[tool.ruff.lint]
+select = ["A", "B", "C", "F", "I", "ISC", "PIE", "PL", "Q", "RUF", "SIM", "TID", "W", "YTT"]
+ignore = ["E", "PLC1901", "SIM117"]
+mccabe.max-complexity = 6
+
 
 [build-system]
-requires = ["poetry-core"]
+requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

src/root_subvol_snapshot/__init__.py

@@ -0,0 +1,3 @@
+from importlib import metadata
+
+__version__ = metadata.version(__name__)

src/root_subvol_snapshot/backup_backends.py

@@ -0,0 +1,146 @@
+from __future__ import annotations
+
+import abc
+import datetime as dt
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Optional, Union, overload
+
+import shell_interface as sh
+from loguru import logger
+
+from . import config_parser as cp
+
+
+class BackupBackend(abc.ABC):
+    @abc.abstractmethod
+    def do_backup(self, mount_dir: Path) -> None: ...
+
+    @overload
+    @staticmethod
+    def from_config(config: cp.BtrFSRsyncConfig) -> BtrFSRsyncBackend: ...
+
+    @overload
+    @staticmethod
+    def from_config(config: cp.ResticConfig) -> ResticBackend: ...
+
+    @staticmethod
+    def from_config(
+        config: Union[cp.BtrFSRsyncConfig, cp.ResticConfig]
+    ) -> Union[BtrFSRsyncBackend, ResticBackend]:
+        # Getestet durch Tests der Backuplogik
+        if isinstance(config, cp.BtrFSRsyncConfig):
+            return BtrFSRsyncBackend(config=config)
+        return ResticBackend(config=config)
+
+
+@dataclass(frozen=True)
+class BtrFSRsyncBackend(BackupBackend):
+    config: cp.BtrFSRsyncConfig
+
+    def do_backup(self, mount_dir: Path) -> None:
+        logger.info(f"Beginne mit BtrFS-Backup für Speichermedium {self.config.UUID}.")
+        backup_repository = mount_dir / self.config.BackupRepositoryFolder
+        src_snapshot = self.get_source_snapshot(backup_repository)
+        backup_root = self.snapshot(
+            src=src_snapshot, backup_repository=backup_repository
+        )
+        for src, dest_name in self.config.Folders.items():
+            dest = backup_root / dest_name
+            self.rsync_folder(src, dest, self.config.ExcludePatternsFile)
+
+        files_dest = backup_root / self.config.FilesDest
+        for src in self.config.Files:
+            self.rsync_file(src, files_dest)
+
+    @staticmethod
+    def get_source_snapshot(root: Path) -> Path:
+        return max(root.glob("202?-*"))
+
+    def snapshot(self, *, src: Path, backup_repository: Path) -> Path:
+        timestamp = dt.datetime.now()
+        date_fmt = self.config.SubvolTimestampFmt
+        while True:
+            # In order to get rid of sleeps in the tests, snapshot name
+            # collisions must be handled gracefully. Incrementing the timestamp
+            # by a few seconds seems to be acceptable both in test and real
+            # world scenarios.
+            # There is still the possibility of race conditions, where another
+            # process would create the target folder before a snapshot can be
+            # created. This possibility is believed to be negligible, so
+            # nothing is done to prevent it.
+            backup_root = backup_repository / timestamp.strftime(date_fmt)
+            if backup_root.exists():
+                timestamp += dt.timedelta(seconds=1)
+            else:
+                break
+        cmd: sh.StrPathList = [
+            "sudo",
+            "btrfs",
+            "subvolume",
+            "snapshot",
+            src,
+            backup_root,
+        ]
+        sh.run_cmd(cmd=cmd)
+        return backup_root
+
+    @staticmethod
+    def rsync_file(src: Path, dest: Path) -> None:
+        cmd: sh.StrPathList = ["sudo", "rsync", "-ax", "--inplace", src, dest]
+        sh.run_cmd(cmd=cmd)
+
+    @staticmethod
+    def rsync_folder(
+        src: Path, dest: Path, maybe_exclude_patterns: Optional[Path]
+    ) -> None:
+        cmd: sh.StrPathList = [
+            "sudo",
+            "rsync",
+            "-ax",
+            "--delete",
+            "--delete-excluded",
+            "--inplace",
+        ]
+        if maybe_exclude_patterns is not None:
+            cmd.extend(["--exclude-from", maybe_exclude_patterns])
+        cmd.extend([f"{src}/", dest])
+        sh.run_cmd(cmd=cmd)
+
+
+@dataclass(frozen=True)
+class ResticBackend(BackupBackend):
+    config: cp.ResticConfig
+
+    def do_backup(self, mount_dir: Path) -> None:
+        logger.info(f"Beginne mit Restic-Backup für Speichermedium {self.config.UUID}.")
+        backup_repository = mount_dir / self.config.BackupRepositoryFolder
+        self.copy_files(backup_repository)
+        self.adapt_ownership(backup_repository)
+
+    @staticmethod
+    def adapt_ownership(backup_repository: Path) -> None:
+        user = sh.get_user()
+        group = sh.get_group(user)
+        chown_cmd: sh.StrPathList = [
+            "sudo",
+            "chown",
+            "-R",
+            f"{user}:{group}",
+            backup_repository,
+        ]
+        sh.run_cmd(cmd=chown_cmd)
+
+    def copy_files(self, backup_repository: Path) -> None:
+        restic_cmd: sh.StrPathList = [
+            "sudo",
+            "restic",
+            "backup",
+            "--one-file-system",
+            "--repo",
+            backup_repository,
+        ]
+        if self.config.ExcludePatternsFile is not None:
+            restic_cmd.extend(["--exclude-file", self.config.ExcludePatternsFile])
+        restic_cmd.extend(list(self.config.FilesAndFolders))
+        sh.pipe_pass_cmd_to_real_cmd(self.config.RepositoryPassCmd, restic_cmd)