0.0.5 release

CHANGES.md

@@ -1,5 +1,12 @@
 # Changes
 
+## 0.0.5 (2020-07-24)
+
+- FEATURE: Version shown in GUI
+- FEATURE: Version exposed through `--version` option on command line
+- FEATURE: While `{zpool}{/{prefix}}` is included in all operations by default, this can be deactivated by setting the new `include_root` configuration option to `no`, see #14.
+- FIX: If a remote host is not up, provide a proper error and fail gracefully, see #15.
+
 ## 0.0.4 (2020-07-22)
 
 - FEATURE: Improved labels in wizard GUI

setup.py

@@ -35,13 +35,12 @@
 )
 import os
 
+from abgleich import __version__
+
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 # SETUP
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# Package version
-__version__ = "0.0.4"
-
 # List all versions of Python which are supported
 python_minor_min = 6
 python_minor_max = 8

src/abgleich/__init__.py

@@ -23,3 +23,9 @@
 </LICENSE_BLOCK>
 
 """
+
+# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# META
+# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+__version__ = "0.0.5"

src/abgleich/cli/_main_.py

@@ -31,9 +31,12 @@
 
 import importlib
 import os
+import sys
 
 import click
 
+from .. import __version__
+
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 # ROUTINES
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -54,9 +57,16 @@ def _add_commands(ctx):
             continue
 
 
-@click.group()
-def cli():
+@click.group(invoke_without_command=True)
+@click.option("--version", is_flag=True)
+def cli(version):
     """abgleich, zfs sync tool"""
 
+    if not version:
+        return
+
+    print(__version__)
+    sys.exit()
+
 
 _add_commands(cli)

src/abgleich/cli/backup.py

@@ -30,9 +30,11 @@
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 import click
+import sys
 
 from ..core.config import Config
 from ..core.i18n import t
+from ..core.lib import is_host_up
 from ..core.zpool import Zpool
 
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -46,6 +48,11 @@ def backup(configfile):
 
     config = Config.from_fd(configfile)
 
+    for side in ("source", "target"):
+        if not is_host_up(side, config):
+            print(f'{t("host is not up"):s}: {side:s}')
+            sys.exit(1)
+
     source_zpool = Zpool.from_config("source", config=config)
     target_zpool = Zpool.from_config("target", config=config)
 

src/abgleich/cli/cleanup.py

@@ -30,12 +30,14 @@
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 import time
+import sys
 
 import click
 
 from ..core.config import Config
 from ..core.i18n import t
 from ..core.io import humanize_size
+from ..core.lib import is_host_up
 from ..core.zpool import Zpool
 
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -49,6 +51,11 @@ def cleanup(configfile):
 
     config = Config.from_fd(configfile)
 
+    for side in ("source", "target"):
+        if not is_host_up(side, config):
+            print(f'{t("host is not up"):s}: {side:s}')
+            sys.exit(1)
+
     source_zpool = Zpool.from_config("source", config=config)
     target_zpool = Zpool.from_config("target", config=config)
     available_before = Zpool.available("source", config=config)

src/abgleich/cli/compare.py

@@ -30,8 +30,11 @@
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 import click
+import sys
 
 from ..core.config import Config
+from ..core.i18n import t
+from ..core.lib import is_host_up
 from ..core.zpool import Zpool
 
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -45,6 +48,11 @@ def compare(configfile):
 
     config = Config.from_fd(configfile)
 
+    for side in ("source", "target"):
+        if not is_host_up(side, config):
+            print(f'{t("host is not up"):s}: {side:s}')
+            sys.exit(1)
+
     source_zpool = Zpool.from_config("source", config=config)
     target_zpool = Zpool.from_config("target", config=config)
 

src/abgleich/cli/snap.py

@@ -30,9 +30,11 @@
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 import click
+import sys
 
 from ..core.config import Config
 from ..core.i18n import t
+from ..core.lib import is_host_up
 from ..core.zpool import Zpool
 
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -44,7 +46,13 @@
 @click.argument("configfile", type=click.File("r", encoding="utf-8"))
 def snap(configfile):
 
-    zpool = Zpool.from_config("source", config=Config.from_fd(configfile))
+    config = Config.from_fd(configfile)
+
+    if not is_host_up("source", config):
+        print(f'{t("host is not up"):s}: source')
+        sys.exit(1)
+
+    zpool = Zpool.from_config("source", config=config)
     transactions = zpool.get_snapshot_transactions()
 
     if len(transactions) == 0:

src/abgleich/cli/tree.py

@@ -30,8 +30,11 @@
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 import click
+import sys
 
 from ..core.config import Config
+from ..core.i18n import t
+from ..core.lib import is_host_up
 from ..core.zpool import Zpool
 
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -44,5 +47,11 @@
 @click.argument("side", default="source", type=str)
 def tree(configfile, side):
 
-    zpool = Zpool.from_config(side, config=Config.from_fd(configfile))
+    config = Config.from_fd(configfile)
+
+    if not is_host_up("source", config):
+        print(f'{t("host is not up"):s}: source')
+        sys.exit(1)
+
+    zpool = Zpool.from_config(side, config=config)
     zpool.print_table()

src/abgleich/core/command.py

@@ -50,7 +50,9 @@ def __str__(self) -> str:
 
         return " ".join([item.replace(" ", "\\ ") for item in self._cmd])
 
-    def run(self):
+    def run(
+        self, returncode: bool = False
+    ) -> typing.Union[typing.Tuple[str, str], typing.Tuple[str, str, int]]:
 
         proc = subprocess.Popen(
             self.cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE
@@ -59,6 +61,9 @@ def run(self):
         status = not bool(proc.returncode)
         output, errors = output.decode("utf-8"), errors.decode("utf-8")
 
+        if returncode:
+            return output, errors, int(proc.returncode)
+
         if not status or len(errors.strip()) > 0:
             raise SystemError("command failed", str(self), output, errors)
 

src/abgleich/core/dataset.py

@@ -90,9 +90,8 @@ def get(
 
         if isinstance(key, str):
             return self._properties.get(
-                key,
-                Property(key, None, None) if default is None else default,
-                )
+                key, Property(key, None, None) if default is None else default,
+            )
 
         assert isinstance(key, int) or isinstance(key, slice)
 

src/abgleich/core/i18n.py

@@ -85,9 +85,7 @@ def _load(self):
     def _dump(self):
 
         with open(self._path, "w") as f:
-            f.write(
-                yaml.dump(self.copy(), Dumper=Dumper, allow_unicode=True, indent=4)
-            )
+            f.write(yaml.dump(self.copy(), Dumper=Dumper, allow_unicode=True, indent=4))
 
 
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

src/abgleich/core/lib.py

@@ -33,11 +33,26 @@
 
 import typeguard
 
+from .abc import ConfigABC
+from .command import Command
+
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 # ROUTINES
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 
+@typeguard.typechecked
+def is_host_up(side: str, config: ConfigABC) -> bool:
+
+    assert side in ("source", "target")
+    if config[side]["host"] == "localhost":
+        return True
+
+    _, _, returncode = Command.on_side(["exit"], side, config).run(returncode=True)
+    assert returncode in (0, 255)
+    return returncode == 0
+
+
 @typeguard.typechecked
 def join(*args: str) -> str:
 

src/abgleich/core/zpool.py

@@ -254,7 +254,10 @@ def _get_snapshot_transactions_from_dataset(
 
         if dataset.subname in self._config["ignore"]:
             return
-        if dataset.get("mountpoint").value is None and dataset['type'].value == 'filesystem':
+        if (
+            dataset.get("mountpoint").value is None
+            and dataset["type"].value == "filesystem"
+        ):
             return
         if not dataset.changed:
             return
@@ -358,18 +361,10 @@ def available(side: str, config: ConfigABC,) -> int:
     @classmethod
     def from_config(cls, side: str, config: ConfigABC,) -> ZpoolABC:
 
+        root_dataset = root(config[side]["zpool"], config[side]["prefix"])
+
         output, _ = Command.on_side(
-            [
-                "zfs",
-                "get",
-                "all",
-                "-r",
-                "-H",
-                "-p",
-                root(config[side]["zpool"], config[side]["prefix"]),
-            ],
-            side,
-            config,
+            ["zfs", "get", "all", "-r", "-H", "-p", root_dataset,], side, config,
         ).run()
         output = [
             line.split("\t") for line in output.split("\n") if len(line.strip()) > 0
@@ -378,6 +373,15 @@ def from_config(cls, side: str, config: ConfigABC,) -> ZpoolABC:
         for line_list in output:
             entities[line_list[0]].append(line_list[1:])
 
+        if not config.get("include_root", True):
+            entities.pop(root_dataset)
+            for name in [
+                snapshot
+                for snapshot in entities.keys()
+                if snapshot.startswith(f"{root_dataset:s}@")
+            ]:
+                entities.pop(name)
+
         datasets = [
             Dataset.from_entities(
                 name,

src/abgleich/gui/wizard.py

@@ -40,6 +40,7 @@
 from ..core.transaction import TransactionList
 from ..core.i18n import t
 from ..core.zpool import Zpool
+from .. import __version__
 
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 # CLASS
@@ -56,7 +57,7 @@ def __init__(self, config: ConfigABC):
         self.setWindowIcon(
             QIcon(os.path.join(os.path.dirname(__file__), "..", "share", "icon.svg"))
         )
-        self.setWindowTitle(t("abgleich wizard"))
+        self.setWindowTitle(f'{t("abgleich wizard"):s} {__version__:s}')
 
         self._ui["button_cancel"].setEnabled(False)
         self._ui["button_continue"].setEnabled(False)

src/abgleich/share/translations.yaml

@@ -87,6 +87,8 @@ dataset_subname:
     de_SE: Datensatz-Namensfragment
     de: Name des Datensatzes
     en: Name of dataset
+host is not up:
+    de: Computer ist nicht erreichbar
 nothing to do:
     de: nichts zu tun
 snapshot: