-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migration to Python #9
Open
MaxG87
wants to merge
636
commits into
main
Choose a base branch
from
from-butter-backup
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Wenn `cryptsetup` mit der Option `--uuid` auf einen Symlink angewandt wird, entfernt es diesen. Es scheint, als könnte dieses Verhalten nicht abgestellt werden. Unglücklicherweise verließen sich einige Tests darauf, dass der entsprechende Symlink dauerhaft vorhanden ist. Dadurch waren sie inkompatibel zu der angestrebten Anpassung, die UUID beim verschlüsseln zu setzen. Insgesamt scheint es aber durchaus so, als gehören die Vorgänge des Entschlüsselns und Mountens gar nicht nach `backup_logic.py`. Immerhin ist dort die Logik zum Erstellen von Backups aufgehoben, nicht die Entpackung der Festplatte. Indem nun die beiden genannten Vorgänge nach `cli.py` verschoben wurde, ist der Code vermutlich ein bisschen besser organisiert und die angestrebte UUID-Änderung kann umgesetzt werden ohne Tests kaputt zu machen.
Die Konzeption der prepare_* Funktionen war falsch. Anders als gedacht haben unformatierte Geräte keine UUID. Damit können sie auch nicht über UUID identifiziert werden. Stattdessen wird nun ein Pfad zum Gerät angegeben, typischerweise etwas wie `/dev/sda1`. Die für die Konfiguration benötigte UUID wird direkt generiert und an `cryptsetup` übergeben.
Die Konzeption der prepare_* Funktionen war falsch. Anders als gedacht haben unformatierte Geräte keine UUID. Damit können sie auch nicht über UUID identifiziert werden. Stattdessen wird nun ein Pfad zum Gerät angegeben, typischerweise etwas wie `/dev/sda1`. Die für die Konfiguration benötigte UUID wird direkt generiert und an `cryptsetup` übergeben.
Der vorhergehende Commit hat zwar das Unterkommando schon fertig implementiert, aber die Tests haben dies noch nicht widergespiegelt. Um nicht einen vollständigen Backup-Test aufsetzen zu müssen, wird nur ein open-close-Rundtrip getestet.
Was momentan die BackupLogik ist, soll später in den Backends aufgehoben sein. Mehr Informationen wird die Beschreibung des Mergecommits geben.
Dieses neue Unterkommando ermöglicht, neue Speichermedien vollautomatisch für die Verwendung mit ButterBackup einzurichten.
Die Logik, die aus einem Konfigurationsobjekt eine geparste Konfiguration macht, ist nun nicht mehr für das Einlesen der Datei verantwortlich. Da nun direkt in den CLI-Funktionen die Konfigurationsdatei eingelesen wird, ist es möglich, sich auf die Garantien des CLI-Parsers zu verlassen und die Konfigurationsdatei als existent anzunehmen. Dies ermöglicht es, einige Tests ersatzlos zu streichen. Außerdem wird das Parsen der Liste nun vollständig an `pydantic` übergeben. Dies ermöglicht es, viel Komplexität ersatzlos zu streichen. Die schon existierenden Tests wurden angepasst, aber beibehalten, um die korrekte Funktion der Hilfsfunktion sicherzustellen.
Die in diesem Branch umgesetzten BackupBackends kommen dem, was im entfernten Punkt gefordert wurde, am nächsten.
Der Fehler wurde gefunden, kann aber nicht behoben werden.
Es wird eine neue Klassenhierarchie eingeführt, welche die verschiedenen Arten, ein Backup durchzuführen, besser gruppiert. Es ergeben sich zwei Vorteile. Erstens wird der Code dadurch etwas besser gruppiert. Anstatt vieler eigenständiger Funktionen in einem großen Modul gibt es nun eine relativ brauchbare Gruppierung nach Zweck. Das ist zwar nur ein kosmetischer Vorteil, aber im gegebenen Modul nicht zu unterschätzen. Zweitens kann dank der BackupBackends nun Laufzeitpolymorphismus ausgenutzt werden. Vor der Änderung musste auf eine Hilfsfunktion vertraut werden, welche durch Introspektion des Typs der Konfiguration die korrekte nächste Hilfsfunktion bestimmt und aufruft. Nun wird das korrekte Backend mittels einer Factory erstellt und dann dort die Methode `do_backup()` aufgerufen. Dies macht den Kontrollfluss ein wenig eleganter. Viel bedeutender ist jedoch, dass nun ein illegaler Zustand verunmöglicht wurde, da Konfiguration und Logik viel enger gekoppelt sind.
Für alle CLI-Kommandos wurde ein Docstring geschrieben. Da Typer diesen in die Hilfetexten des CLI übernimmt, wurde so auch die CLI-Dokumentation verbessert.
* neues Kommando `format-device` * neues Kommando `version` * erhebliche interne Verbesserungen mit `parse_raw_as` und `BackupBackend` * Dokumentation für CLI-Texte erstellt * Angaben von Verzeichnissen und unlesbaren Dateien als Konfiguration werden nun schon vom CLI-Parser abgelehnt
Es hat sowieso genervt, Python 3.7 zu unterstützen, da dadurch die TypeHints komplizierter geworden sind. Jetzt, da `importlib.metadata` in Python 3.7 nicht unterstützt wird, existiert auch ein handfester Grund dafür, Python 3.7 loszuwerden.
Der Standardwert ist `True`. Daher ist das gesetzte `True` redundant, während es in `butter-backup format-device` fehlt.
Bumps the production-dependencies group with 1 update in the / directory: [typer](https://github.com/tiangolo/typer). Updates `typer` from 0.9.4 to 0.12.3 - [Release notes](https://github.com/tiangolo/typer/releases) - [Changelog](https://github.com/tiangolo/typer/blob/master/docs/release-notes.md) - [Commits](fastapi/typer@0.9.4...0.12.3) --- updated-dependencies: - dependency-name: typer dependency-type: direct:production update-type: version-update:semver-minor dependency-group: production-dependencies ... Signed-off-by: dependabot[bot] <[email protected]>
This dependency is provided as a Vim plugin.
ButterBackup provides most of what is required here. Of course, much of it not be used, but the basic setup and some of its CLI commands can be reused conveniently. Merge remote-tracking branch 'local/main' into from-butter-backup
This changeset will resolve all deprecation warnings regarding Pydantic v2. Additionally, some unrelated updates of version numbers have been performed.
This changeset will resolve all deprecation warnings regarding Pydantic v2. Additionally, some unrelated updates of version numbers have been performed.
This changeset will resolve all deprecation warnings regarding Pydantic v2. Additionally, some unrelated updates of version numbers have been performed.
Some occasions were missed.
Some places were missed.
This provides a fully functional root_subvol_snapshot that can be pruned to the intended functionality.
Everything dealing with configuration files will be removed, so something testing XDG_* becomes obsolete.
MaxG87
force-pushed
the
from-butter-backup
branch
from
July 23, 2024 13:49
fdaf1d5
to
8a84819
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.