0.0.7 release

CHANGES.md

@@ -1,5 +1,11 @@
 # Changes
 
+## 0.0.7 (2020-08-05)
+
+- FIX: `tree` now property checks if source or target is up, depending on what a user wants to see, see #20.
+- FIX: All `abgleich` commands can properly initialize (instead of crashing) if the target tree is empty, see #19.
+- FIX: `tree` shows message if there is no tree instead of crashing, see #18.
+
 ## 0.0.6 (2020-07-24)
 
 - FIX: Development installs with `make install` do no longer fail, see #17.

README.md

@@ -64,6 +64,7 @@ target:
     prefix: BACKUP_SOMEMACHINE
     host: bigdata
     user: zfsadmin
+include_root: yes
 keep_snapshots: 2
 always_changed: no
 written_threshold: 1048576
@@ -78,7 +79,7 @@ ssh:
     cipher: [email protected]
 ```
 
-The prefix can be empty on either side. If a `host` is set to `localhost`, the `user` field can be left empty. Both source and target can be remote hosts or localhost at the same time. `keep_snapshots` is an integer and must be greater or equal to `1`. It specifies the number of snapshots that are kept per dataset on the source side when a cleanup operation is triggered. `suffix` contains the name suffix for new snapshots. Setting `always_changed` to `yes` causes `abgleich` to beliefe that all datasets have always changed since the last snapshot, completely ignoring what ZFS actually reports. No diff will be produced & checked for values of `written` lower than `written_threshold`. Checking diffs can be completely deactivated by setting `check_diff` to `no`. `digits` specifies how many digits are used for a decimal number describing the n-th snapshot per dataset per day as part of the name of new snapshots. `ignore` lists stuff underneath the `prefix` which will be ignored by this tool, i.e. no snapshots, backups or cleanups. `ssh` allows to fine-tune the speed of backups. In fast local networks, it is best to set `compression` to `no` because the compression is usually slowing down the transfer. However, for low-bandwidth transmissions, it makes sense to set it to `yes`. For significantly better speed in fast local networks, make sure that both the source and the target system support a common cipher, which is accelerated by [AES-NI](https://en.wikipedia.org/wiki/AES_instruction_set) on both ends.
+The prefix can be empty on either side. If a `host` is set to `localhost`, the `user` field can be left empty. Both source and target can be remote hosts or localhost at the same time. `include_root` indicates whether `{zpool}{/{prefix}}` should be  included in all operations. `keep_snapshots` is an integer and must be greater or equal to `1`. It specifies the number of snapshots that are kept per dataset on the source side when a cleanup operation is triggered. `suffix` contains the name suffix for new snapshots. Setting `always_changed` to `yes` causes `abgleich` to beliefe that all datasets have always changed since the last snapshot, completely ignoring what ZFS actually reports. No diff will be produced & checked for values of `written` lower than `written_threshold`. Checking diffs can be completely deactivated by setting `check_diff` to `no`. `digits` specifies how many digits are used for a decimal number describing the n-th snapshot per dataset per day as part of the name of new snapshots. `ignore` lists stuff underneath the `prefix` which will be ignored by this tool, i.e. no snapshots, backups or cleanups. `ssh` allows to fine-tune the speed of backups. In fast local networks, it is best to set `compression` to `no` because the compression is usually slowing down the transfer. However, for low-bandwidth transmissions, it makes sense to set it to `yes`. For significantly better speed in fast local networks, make sure that both the source and the target system support a common cipher, which is accelerated by [AES-NI](https://en.wikipedia.org/wiki/AES_instruction_set) on both ends.
 
 ## USAGE
 

setup.py

@@ -63,10 +63,12 @@ def get_version(code):
             continue
         if len(item.targets) != 1:
             continue
-        if item.targets[0].id != '__version__':
+        if item.targets[0].id != "__version__":
             continue
         return item.value.s
-with open(os.path.join(SRC_DIR, 'abgleich', '__init__.py'), 'r', encoding = 'utf-8') as f:
+
+
+with open(os.path.join(SRC_DIR, "abgleich", "__init__.py"), "r", encoding="utf-8") as f:
     __version__ = get_version(f.read())
 
 # Requirements

src/abgleich/__init__.py

@@ -28,4 +28,4 @@
 # META
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-__version__ = "0.0.6"
+__version__ = "0.0.7"

src/abgleich/cli/tree.py

@@ -49,8 +49,8 @@ def tree(configfile, side):
 
     config = Config.from_fd(configfile)
 
-    if not is_host_up("source", config):
-        print(f'{t("host is not up"):s}: source')
+    if not is_host_up(side, config):
+        print(f'{t("host is not up"):s}: {side:s}')
         sys.exit(1)
 
     zpool = Zpool.from_config(side, config=config)

src/abgleich/core/command.py

@@ -52,7 +52,7 @@ def __str__(self) -> str:
 
     def run(
         self, returncode: bool = False
-    ) -> typing.Union[typing.Tuple[str, str], typing.Tuple[str, str, int]]:
+    ) -> typing.Union[typing.Tuple[str, str], typing.Tuple[str, str, int, Exception]]:
 
         proc = subprocess.Popen(
             self.cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE
@@ -61,11 +61,13 @@ def run(
         status = not bool(proc.returncode)
         output, errors = output.decode("utf-8"), errors.decode("utf-8")
 
+        exception = SystemError("command failed", str(self), output, errors)
+
         if returncode:
-            return output, errors, int(proc.returncode)
+            return output, errors, int(proc.returncode), exception
 
         if not status or len(errors.strip()) > 0:
-            raise SystemError("command failed", str(self), output, errors)
+            raise exception
 
         return output, errors
 

src/abgleich/core/lib.py

@@ -48,7 +48,7 @@ def is_host_up(side: str, config: ConfigABC) -> bool:
     if config[side]["host"] == "localhost":
         return True
 
-    _, _, returncode = Command.on_side(["exit"], side, config).run(returncode=True)
+    _, _, returncode, _ = Command.on_side(["exit"], side, config).run(returncode=True)
     assert returncode in (0, 255)
     return returncode == 0
 

src/abgleich/core/zpool.py

@@ -272,6 +272,10 @@ def print_table(self):
             for snapshot in dataset.snapshots:
                 table.append(self._table_row(snapshot))
 
+        if len(table) == 0:
+            print('(empty)')
+            return
+
         print(
             tabulate(
                 table,
@@ -363,9 +367,15 @@ def from_config(cls, side: str, config: ConfigABC,) -> ZpoolABC:
 
         root_dataset = root(config[side]["zpool"], config[side]["prefix"])
 
-        output, _ = Command.on_side(
+        output, errors, returncode, exception = Command.on_side(
             ["zfs", "get", "all", "-r", "-H", "-p", root_dataset,], side, config,
-        ).run()
+        ).run(returncode = True)
+
+        if returncode != 0 and 'dataset does not exist' in errors:
+            return cls(datasets=[], side=side, config=config,)
+        if returncode != 0:
+            raise exception
+
         output = [
             line.split("\t") for line in output.split("\n") if len(line.strip()) > 0
         ]