cleanup

Woops accidently committed this, still need to review/change it before comitting.

This reverts commit e11c332808.

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+github: psy0rz
+ko_fi: psy0rz
+custom: https://paypal.me/psy0rz

README.md

@@ -22,755 +22,37 @@ An important feature thats missing from other tools is a reliable `--test` optio
 * Works across operating systems: Tested with **Linux**, **FreeBSD/FreeNAS** and **SmartOS**.
 * Low learning curve: no complex daemons or services, no additional software or networking needed. (Only read this page)   
 * Plays nicely with existing replication systems. (Like Proxmox HA)
-* Automatically selects filesystems to backup by looking at a simple ZFS property. (recursive)
+* Automatically selects filesystems to backup by looking at a simple ZFS property. 
 * Creates consistent snapshots. (takes all snapshots at once, atomicly.)
 * Multiple backups modes:
   * Backup local data on the same server.
   * "push" local data to a backup-server via SSH.
   * "pull" remote data from a server via SSH and backup it locally.
-  * Or even pull data from a server while pushing the backup to another server. (Zero trust between source and target server)
-* Can be scheduled via a simple cronjob or run directly from commandline.
-* Supports resuming of interrupted transfers.
+  * "pull+push": Zero trust between source and target.
+* Can be scheduled via simple cronjob or run directly from commandline.
 * ZFS encryption support: Can decrypt / encrypt or even re-encrypt datasets during transfer.
 * Supports sending with compression. (Using pigz, zstd etc)
 * IO buffering to speed up transfer.
 * Bandwidth rate limiting.
 * Multiple backups from and to the same datasets are no problem.
-* Creates the snapshot before doing anything else. (assuring you at least have a snapshot if all else fails)
-* Checks everything but tries continue on non-fatal errors when possible. (Reports error-count when done)
+* Resillient to errors.
 * Ability to manually 'finish' failed backups to see whats going on.
 * Easy to debug and has a test-mode. Actual unix commands are printed.
-* Uses **progressive thinning** for older snapshots.
-* Uses zfs-holds on important snapshots so they cant be accidentally destroyed.
+* Uses progressive thinning for older snapshots.
+* Uses zfs-holds on important snapshots to prevent accidental deletion.
 * Automatic resuming of failed transfers.
-* Can continue from existing common snapshots. (e.g. easy migration)
+* Easy migration from existing zfs backups.
 * Gracefully handles datasets that no longer exist on source.
-* Support for ZFS sending/receiving through custom pipes.
+* Complete and clean logging. 
 * Easy installation:
   * Just install zfs-autobackup via pip.
   * Only needs to be installed on one side.
   * Written in python and uses zfs-commands, no special 3rd party dependency's or compiled libraries needed.
-  * No separate config files or properties. Just one zfs-autobackup command you can copy/paste in your backup script.
+  * No annoying config files or properties. 
 
-## Installation
+## Getting started
 
-You only need to install zfs-autobackup on the side that initiates the backup. The other side doesnt need any extra configration.
-
-### Using pip
-
-The recommended way on most servers is to use [pip](https://pypi.org/project/zfs-autobackup/):
-
-```console
-[root@server ~]# pip install --upgrade zfs-autobackup
-```
-
-This can also be used to upgrade zfs-autobackup to the newest stable version.
-
-To install the latest beta version add the `--pre` option.
-
-### Using easy_install
-
-On older servers you might have to use easy_install
-
-```console
-[root@server ~]# easy_install zfs-autobackup
-```
-
-## Example
-
-In this example we're going to backup a machine called `server1` to a machine called `backup`.
-
-### Setup SSH login
-
-zfs-autobackup needs passwordless login via ssh. This means generating an ssh key and copying it to the remote server.
-
-#### Generate SSH key on `backup`
-
-On the backup-server that runs zfs-autobackup you need to create an SSH key. You only need to do this once.
-
-Use the `ssh-keygen` command and leave the passphrase empty:
-
-```console
-root@backup:~# ssh-keygen
-Generating public/private rsa key pair.
-Enter file in which to save the key (/root/.ssh/id_rsa):
-Enter passphrase (empty for no passphrase):
-Enter same passphrase again:
-Your identification has been saved in /root/.ssh/id_rsa.
-Your public key has been saved in /root/.ssh/id_rsa.pub.
-The key fingerprint is:
-SHA256:McJhCxvaxvFhO/3e8Lf5gzSrlTWew7/bwrd2U2EHymE root@backup
-The key's randomart image is:
-+---[RSA 2048]----+
-|    + =          |
-|   + X *    E .  |
-|  . = B +  o o . |
-|   .   o +  o  o.|
-|        S o   .oo|
-|         . + o= +|
-|          . ++==.|
-|            .+o**|
-|           .. +B@|
-+----[SHA256]-----+
-root@backup:~#
-```
-
-#### Copy SSH key to `server1`
-
-Now you need to copy the public part of the key to `server1`
-
-The `ssh-copy-id` command is a handy tool to automate this. It will just ask for your password.
-
-```console
-root@backup:~# ssh-copy-id root@server1.server.com
-/usr/bin/ssh-copy-id: INFO: Source of key(s) to be installed: "/root/.ssh/id_rsa.pub"
-/usr/bin/ssh-copy-id: INFO: attempting to log in with the new key(s), to filter out any that are already installed
-/usr/bin/ssh-copy-id: INFO: 1 key(s) remain to be installed -- if you are prompted now it is to install the new keys
-Password:
-
-Number of key(s) added: 1
-
-Now try logging into the machine, with:   "ssh 'root@server1.server.com'"
-and check to make sure that only the key(s) you wanted were added.
-
-root@backup:~#
-```
-This allows the backup-server to login to `server1` as root without password.
-
-### Select filesystems to backup
-
-Its important to choose a unique and consistent backup name. In this case we name our backup: `offsite1`.
-
-On the source zfs system set the ```autobackup:offsite1``` zfs property to true:
-
-```console
-[root@server1 ~]# zfs set autobackup:offsite1=true rpool
-[root@server1 ~]# zfs get -t filesystem,volume autobackup:offsite1
-NAME                                    PROPERTY             VALUE                SOURCE
-rpool                                   autobackup:offsite1  true                 local
-rpool/ROOT                              autobackup:offsite1  true                 inherited from rpool
-rpool/ROOT/server1-1                    autobackup:offsite1  true                 inherited from rpool
-rpool/data                              autobackup:offsite1  true                 inherited from rpool
-rpool/data/vm-100-disk-0                autobackup:offsite1  true                 inherited from rpool
-rpool/swap                              autobackup:offsite1  true                 inherited from rpool
-...
-```
-
-ZFS properties are ```inherited``` by child datasets. Since we've set the property on the highest dataset, we're essentially backupping the whole pool.
-
-Because we don't want to backup everything, we can exclude certain filesystem by setting the property to false:
-
-```console
-[root@server1 ~]# zfs set autobackup:offsite1=false rpool/swap
-[root@server1 ~]# zfs get -t filesystem,volume autobackup:offsite1
-NAME                                    PROPERTY             VALUE                SOURCE
-rpool                                   autobackup:offsite1  true                 local
-rpool/ROOT                              autobackup:offsite1  true                 inherited from rpool
-rpool/ROOT/server1-1                    autobackup:offsite1  true                 inherited from rpool
-rpool/data                              autobackup:offsite1  true                 inherited from rpool
-rpool/data/vm-100-disk-0                autobackup:offsite1  true                 inherited from rpool
-rpool/swap                              autobackup:offsite1  false                local
-...
-```
-
-The autobackup-property can have 3 values:
- * ```true```: Backup the dataset and all its children 
- * ```false```: Dont backup the dataset and all its children. (used to exclude certain datasets)
- * ```child```: Only backup the children off the dataset, not the dataset itself.
-
-Only use the zfs-command to set these properties, not the zpool command. 
-
-### Running zfs-autobackup
-
-Run the script on the backup server and pull the data from the server specified by --ssh-source.
-
-```console
-[root@backup ~]# zfs-autobackup --ssh-source server1.server.com offsite1 backup/server1 --progress --verbose
-
-  #### Settings summary
-  [Source] Datasets on: server1.server.com
-  [Source] Keep the last 10 snapshots.
-  [Source] Keep every 1 day, delete after 1 week.
-  [Source] Keep every 1 week, delete after 1 month.
-  [Source] Keep every 1 month, delete after 1 year.
-  [Source] Send all datasets that have 'autobackup:offsite1=true' or 'autobackup:offsite1=child'
-
-  [Target] Datasets are local
-  [Target] Keep the last 10 snapshots.
-  [Target] Keep every 1 day, delete after 1 week.
-  [Target] Keep every 1 week, delete after 1 month.
-  [Target] Keep every 1 month, delete after 1 year.
-  [Target] Receive datasets under: backup/server1
-
-  #### Selecting
-  [Source] rpool: Selected (direct selection)
-  [Source] rpool/ROOT: Selected (inherited selection)
-  [Source] rpool/ROOT/server1-1: Selected (inherited selection)
-  [Source] rpool/data: Selected (inherited selection)
-  [Source] rpool/data/vm-100-disk-0: Selected (inherited selection)
-  [Source] rpool/swap: Ignored (disabled)
-
-  #### Snapshotting
-  [Source] rpool: No changes since offsite1-20200218175435
-  [Source] rpool/ROOT: No changes since offsite1-20200218175435
-  [Source] rpool/data: No changes since offsite1-20200218175435
-  [Source] Creating snapshot offsite1-20200218180123
-
-  #### Sending and thinning
-  [Target] backup/server1/rpool/ROOT/server1-1@offsite1-20200218175435: receiving full
-  [Target] backup/server1/rpool/ROOT/server1-1@offsite1-20200218175547: receiving incremental
-  [Target] backup/server1/rpool/ROOT/server1-1@offsite1-20200218175706: receiving incremental
-  [Target] backup/server1/rpool/ROOT/server1-1@offsite1-20200218180049: receiving incremental
-  [Target] backup/server1/rpool/ROOT/server1-1@offsite1-20200218180123: receiving incremental
-  [Target] backup/server1/rpool/data@offsite1-20200218175435: receiving full
-  [Target] backup/server1/rpool/data/vm-100-disk-0@offsite1-20200218175435: receiving full
-  ...
-```
-
-Note that this is called a "pull" backup: The backup server pulls the backup from the server. This is usually the preferred way.
-
-Its also possible to let a server push its backup to the backup-server. However this has security implications. In that case you would setup the SSH keys the other way around and use the --ssh-target parameter on the server.
-
-### Automatic backups
-
-Now every time you run the command, zfs-autobackup will create a new snapshot and replicate your data.
-
-Older snapshots will eventually be deleted, depending on the `--keep-source` and `--keep-target` settings. (The defaults are shown above under the 'Settings summary')
-
-Once you've got the correct settings for your situation, you can just store the command in a cronjob.
-
-Or just create a script and run it manually when you need it.
-
-## Use as snapshot tool
-
-You can use zfs-autobackup to only make snapshots.
-
-Just dont specify the target-path:
-```console
-root@ws1:~# zfs-autobackup test --verbose
-  zfs-autobackup v3.0 - Copyright 2020 E.H.Eefting (edwin@datux.nl)
-
-  #### Source settings
-  [Source] Datasets are local
-  [Source] Keep the last 10 snapshots.
-  [Source] Keep every 1 day, delete after 1 week.
-  [Source] Keep every 1 week, delete after 1 month.
-  [Source] Keep every 1 month, delete after 1 year.
-  [Source] Selects all datasets that have property 'autobackup:test=true' (or childs of datasets that have 'autobackup:test=child')
-
-  #### Selecting
-  [Source] test_source1/fs1: Selected (direct selection)
-  [Source] test_source1/fs1/sub: Selected (inherited selection)
-  [Source] test_source2/fs2: Ignored (only childs)
-  [Source] test_source2/fs2/sub: Selected (inherited selection)
-
-  #### Snapshotting
-  [Source] Creating snapshots test-20200710125958 in pool test_source1
-  [Source] Creating snapshots test-20200710125958 in pool test_source2
-
-  #### Thinning source
-  [Source] test_source1/fs1@test-20200710125948: Destroying
-  [Source] test_source1/fs1/sub@test-20200710125948: Destroying
-  [Source] test_source2/fs2/sub@test-20200710125948: Destroying
-
-  #### All operations completed successfully
-  (No target_path specified, only operated as snapshot tool.)
-```
-
-This also allows you to make several snapshots during the day, but only backup the data at night when the server is not busy.
-
-**Note**: In this mode it doesnt take a specified target-schedule into account when thinning, it only knows a snapshot is the common snapshot by looking at the holds. So make sure your source-schedule keeps the snapshots you still want to transfer at a later point.
-
-## Thinning out obsolete snapshots
-
-The thinner is the thing that destroys old snapshots on the source and target.
-
-The thinner operates "stateless": There is nothing in the name or properties of a snapshot that indicates how long it will be kept. Everytime zfs-autobackup runs, it will look at the timestamp of all the existing snapshots. From there it will determine which snapshots are obsolete according to your schedule. The advantage of this stateless system is that you can always change the schedule.
-
-Note that the thinner will ONLY destroy snapshots that are matching the naming pattern of zfs-autobackup. If you use `--other-snapshots`, it wont destroy those snapshots after replicating them to the target.
-
-### Destroying missing datasets
-
-When a dataset has been destroyed or deselected on the source, but still exists on the target we call it a missing dataset. Missing datasets will be still thinned out according to the schedule.
-
-The final snapshot will never be destroyed, unless you specify a **deadline** with the `--destroy-missing` option:
-
-In that case it will look at the last snapshot we took and determine if is older than the deadline you specified. e.g: `--destroy-missing 30d` will start destroying things 30 days after the last snapshot.
-
-#### After the deadline
-
-When the deadline is passed, all our snapshots, except the last one will be destroyed. Irregardless of the normal thinning schedule.
-
-The dataset has to have the following properties to be finally really destroyed:
-
-* The dataset has no direct child-filesystems or volumes.
-* The only snapshot left is the last one created by zfs-autobackup.
-* The remaining snapshot has no clones.
-
-### Thinning schedule
-
-The default thinning schedule is: `10,1d1w,1w1m,1m1y`.
-
-The schedule consists of multiple rules separated by a `,`
-
-A plain number specifies how many snapshots you want to always keep, regardless of time or interval.
-
-The format of the other rules is: `<Interval><TTL>`.
-
-* Interval: The minimum interval between the snapshots. Snapshots with intervals smaller than this will be destroyed.
-* TTL: The maximum time to life time of a snapshot, after that they will be destroyed.
-* These are the time units you can use for interval and TTL:
-  * `y`: Years
-  * `m`: Months
-  * `d`: Days
-  * `h`: Hours
-  * `min`: Minutes
-  * `s`: Seconds
-
-Since this might sound very complicated, the `--verbose` option will show you what it all means:
-
-```console
-  [Source] Keep the last 10 snapshots.
-  [Source] Keep every 1 day, delete after 1 week.
-  [Source] Keep every 1 week, delete after 1 month.
-  [Source] Keep every 1 month, delete after 1 year.
-```
-
-A snapshot will only be destroyed if it not needed anymore by ANY of the rules.
-
-You can specify as many rules as you need. The order of the rules doesn't matter.
-
-Keep in mind its up to you to actually run zfs-autobackup often enough: If you want to keep hourly snapshots, you have to make sure you at least run it every hour.
-
-However, its no problem if you run it more or less often than that: The thinner will still keep an optimal set of snapshots to match your schedule as good as possible.
-
-If you want to keep as few snapshots as possible, just specify 0. (`--keep-source=0` for example)
-
-If you want to keep ALL the snapshots, just specify a very high number.
-
-### More details about the Thinner
-
-We will give a practical example of how the thinner operates.
-
-Say we want have 3 thinner rules:
-
-* We want to keep daily snapshots for 7 days.
-* We want to keep weekly snapshots for 4 weeks.
-* We want to keep monthly snapshots for 12 months.
-
-So far we have taken 4 snapshots at random moments:
-
-![thinner example](https://raw.githubusercontent.com/psy0rz/zfs_autobackup/master/doc/thinner.png)
-
-For every rule, the thinner will divide the timeline in blocks and assign each snapshot to a block.
-
-A block can only be assigned one snapshot: If multiple snapshots fall into the same block, it only assigns it to the oldest that we want to keep.
-
-The colors show to which block a snapshot belongs:
-
-* Snapshot 1: This snapshot belongs to daily block 1, weekly block 0 and monthly block 0. However the daily block is too old.
-* Snapshot 2: Since weekly block 0 and monthly block 0 already have a snapshot, it only belongs to daily block 4.
-* Snapshot 3: This snapshot belongs to daily block 8 and weekly block 1.
-* Snapshot 4: Since daily block 8 already has a snapshot, this one doesn't belong to anything and can be deleted right away. (it will be keeped for now since its the last snapshot)
-
-zfs-autobackup will re-evaluate this on every run: As soon as a snapshot doesn't belong to any block anymore it will be destroyed.
-
-Snapshots on the source that still have to be send to the target wont be destroyed off course. (If the target still wants them, according to the target schedule)
-
-## How zfs-autobackup handles encryption
-
-In normal operation datasets are transferred unaltered:
-
-* Source datasets that are encrypted will be send over as such and stay encrypted at the target side. (In ZFS this is called raw-mode) You dont need keys at the target side if you dont want to access the data.
-* Source datasets that are plain will stay that way on the target. (Even if the specified target-path IS encrypted.) 
-
-Basically you dont have to do anything or worry about anything. 
-
-### Decrypting/encrypting
-
-Things get different if you want to change the encryption-state of a dataset during transfer:
-
-* If you want to decrypt encrypted datasets before sending them, you should use the `--decrypt` option. Datasets will then be stored plain at the target.
-* If you want to encrypt plain datasets when they are received, you should use the `--encrypt` option. Datasets will then be stored encrypted at the target. (Datasets that are already encrypted will still be sent over unaltered in raw-mode.) 
-* If you also want re-encrypt encrypted datasets with the target-side encryption you can use both options. 
-
-Note 1: The --encrypt option will rely on inheriting encryption parameters from the parent datasets on the target side. You are responsible for setting those up and loading the keys. So --encrypt is no guarantee for encryption: If you dont set it up, it cant encrypt.
-
-Note 2: Decide what you want at an early stage: If you change the --encrypt or --decrypt parameter after the inital sync you might get weird and wonderfull errors. (nothing dangerous)
-
-**Some common errors while using zfs encryption:**
-
-```
-cannot receive incremental stream: kernel modules must be upgraded to receive this stream.
-```
-
-This happens if you forget to use --encrypt, while the target datasets are already encrypted. (Very strange error message indeed)
-
-
-## Transfer buffering, compression and rate limiting.
-
-If you're transferring over a slow link it might be useful to use `--compress=zstd-fast`. This will compress the data before sending, so it uses less bandwidth. An alternative to this is to use --zfs-compressed: This will transfer blocks that already have compression intact. (--compress will usually compress much better but uses much more resources. --zfs-compressed uses the least resources, but can be a disadvantage if you want to use a different compression method on the target.)
-
-You can also limit the datarate by using the `--rate` option.
-
-The `--buffer` option might also help since it acts as an IO buffer: zfs send can vary wildly between completely idle and huge bursts of data. When zfs send is idle, the buffer will continue transferring data over the slow link.
-
-It's also possible to add custom send or receive pipes with `--send-pipe` and `--recv-pipe`.
-
-These options all work together and the buffer on the receiving side is only added if appropriate. When all options are active:
-
-#### On the sending side:
-
-zfs send -> send buffer -> custom send pipes -> compression -> transfer rate limiter
-
-#### On the receiving side:
-decompression -> custom recv pipes -> buffer -> zfs recv
-
-## Running custom commands before and after snapshotting
-
-You can run commands before and after the snapshot to freeze databases to make the on for example to make the on-disk data consistent before snapshotting.
-
-The commands will be executed on the source side. Use the `--pre-snapshot-cmd` and `--post-snapshot-cmd` options for this.
-
-For example:
-
-```sh
-zfs-autobackup \
-    --pre-snapshot-cmd 'daemon -f jexec mysqljail1 mysql -s -e "set autocommit=0;flush logs;flush tables with read lock;\\! echo \$\$ > /tmp/mysql_lock.pid && sleep 60"' \
-    --pre-snapshot-cmd 'daemon -f jexec mysqljail2 mysql -s -e "set autocommit=0;flush logs;flush tables with read lock;\\! echo \$\$ > /tmp/mysql_lock.pid && sleep 60"' \
-    --post-snapshot-cmd 'pkill -F /jails/mysqljail1/tmp/mysql_lock.pid' \
-    --post-snapshot-cmd 'pkill -F /jails/mysqljail2/tmp/mysql_lock.pid' \
-    backupfs1
-```
-
-Failure handling during pre/post commands:
-
-* If a pre-command fails, zfs-autobackup will exit with an error. (after executing the post-commands)
-* All post-commands are always executed. Even if the pre-commands or actual snapshot have failed. This way you can be sure that stuff is always cleanedup and unfreezed.
-
-## Tips
-
-* Use ```--debug``` if something goes wrong and you want to see the commands that are executed. This will also stop at the first error.
-* You can split up the snapshotting and sending tasks by creating two cronjobs. Create a separate snapshotter-cronjob by just omitting target-path.
-* Set the ```readonly``` property of the target filesystem to ```on```. This prevents changes on the target side. (Normally, if there are changes the next backup will fail and will require a zfs rollback.) Note that readonly means you cant change the CONTENTS of the dataset directly. Its still possible to receive new datasets and manipulate properties etc.
-* Use ```--clear-refreservation``` to save space on your backup server.
-* Use ```--clear-mountpoint``` to prevent the target server from mounting the backupped filesystem in the wrong place during a reboot.
-
-### Performance tips
-
-If you have a large number of datasets its important to keep the following tips in mind.
-
-Also it might help to use the --buffer option to add IO buffering during the data transfer. This might speed up things since it smooths out sudden IO bursts that are frequent during a zfs send or recv.
-
-#### Some statistics
-
-To get some idea of how fast zfs-autobackup is, I did some test on my laptop, with a SKHynix_HFS512GD9TNI-L2B0B disk. I'm using zfs 2.0.2.  
-
-I created 100 empty datasets and measured the total runtime of zfs-autobackup. I used all the performance tips below. (--no-holds, --allow-empty, ssh ControlMaster)
-
-* without ssh: 15 seconds. (>6 datasets/s)
-* either ssh-target or ssh-source=localhost: 20 seconds (5 datasets/s)
-* both ssh-target and ssh-source=localhost: 24 seconds (4 datasets/s)
-
-To be bold I created 2500 datasets, but that also was no problem. So it seems it should be possible to use zfs-autobackup with thousands of datasets.
-
-If you need more performance let me know.
-
-NOTE: There is actually a performance regression in ZFS version 2: https://github.com/openzfs/zfs/issues/11560 Use --no-progress as workaround.
-
-#### Less work
-
-You can make zfs-autobackup generate less work by using --no-holds and --allow-empty.
-
-This saves a lot of extra zfs-commands per dataset.
-
-#### Speeding up SSH
-
-You can make your ssh connections persistent and greatly speed up zfs-autobackup:
-
-On the backup-server add this to your ~/.ssh/config:
-
-```console
-Host *
-    ControlPath ~/.ssh/control-master-%r@%h:%p
-    ControlMaster auto
-    ControlPersist 3600
-```
-
-Thanks @mariusvw :)
-
-### Specifying ssh port or options
-
-The correct way to do this is by creating ~/.ssh/config:
-
-```console
-Host smartos04
-    Hostname 1.2.3.4
-    Port 1234
-    user root
-    Compression yes
-```
-
-This way you can just specify "smartos04" as host.
-
-Also uses compression on slow links.
-
-Look in man ssh_config for many more options.
-
-## Usage
-
-```console
-usage: zfs-autobackup [-h] [--ssh-config CONFIG-FILE] [--ssh-source USER@HOST]
-                   [--ssh-target USER@HOST] [--keep-source SCHEDULE]
-                   [--keep-target SCHEDULE] [--pre-snapshot-cmd COMMAND]
-                   [--post-snapshot-cmd COMMAND] [--other-snapshots]
-                   [--no-snapshot] [--no-send] [--no-thinning] [--no-holds]
-                   [--min-change BYTES] [--allow-empty] [--ignore-replicated]
-                   [--strip-path N] [--clear-refreservation]
-                   [--clear-mountpoint] [--filter-properties PROPERTY,...]
-                   [--set-properties PROPERTY=VALUE,...] [--rollback]
-                   [--destroy-incompatible] [--destroy-missing SCHEDULE]
-                   [--ignore-transfer-errors] [--decrypt] [--encrypt]
-                   [--zfs-compressed] [--test] [--verbose] [--debug]
-                   [--debug-output] [--progress] [--send-pipe COMMAND]
-                   [--recv-pipe COMMAND] [--compress TYPE] [--rate DATARATE]
-                   [--buffer SIZE]
-                   backup-name [target-path]
-
-zfs-autobackup v3.1 - (c)2021 E.H.Eefting (edwin@datux.nl)
-
-positional arguments:
-  backup-name           Name of the backup (you should set the zfs property
-                        "autobackup:backup-name" to true on filesystems you
-                        want to backup
-  target-path           Target ZFS filesystem (optional: if not specified,
-                        zfs-autobackup will only operate as snapshot-tool on
-                        source)
-
-optional arguments:
-  -h, --help            show this help message and exit
-  --ssh-config CONFIG-FILE
-                        Custom ssh client config
-  --ssh-source USER@HOST
-                        Source host to get backup from.
-  --ssh-target USER@HOST
-                        Target host to push backup to.
-  --keep-source SCHEDULE
-                        Thinning schedule for old source snapshots. Default:
-                        10,1d1w,1w1m,1m1y
-  --keep-target SCHEDULE
-                        Thinning schedule for old target snapshots. Default:
-                        10,1d1w,1w1m,1m1y
-  --pre-snapshot-cmd COMMAND
-                        Run COMMAND before snapshotting (can be used multiple
-                        times.
-  --post-snapshot-cmd COMMAND
-                        Run COMMAND after snapshotting (can be used multiple
-                        times.
-  --other-snapshots     Send over other snapshots as well, not just the ones
-                        created by this tool.
-  --no-snapshot         Don't create new snapshots (useful for finishing
-                        uncompleted backups, or cleanups)
-  --no-send             Don't send snapshots (useful for cleanups, or if you
-                        want a serperate send-cronjob)
-  --no-thinning         Do not destroy any snapshots.
-  --no-holds            Don't hold snapshots. (Faster. Allows you to destroy
-                        common snapshot.)
-  --min-change BYTES    Number of bytes written after which we consider a
-                        dataset changed (default 1)
-  --allow-empty         If nothing has changed, still create empty snapshots.
-                        (same as --min-change=0)
-  --ignore-replicated   Ignore datasets that seem to be replicated some other
-                        way. (No changes since lastest snapshot. Useful for
-                        proxmox HA replication)
-  --strip-path N        Number of directories to strip from target path (use 1
-                        when cloning zones between 2 SmartOS machines)
-  --clear-refreservation
-                        Filter "refreservation" property. (recommended, safes
-                        space. same as --filter-properties refreservation)
-  --clear-mountpoint    Set property canmount=noauto for new datasets.
-                        (recommended, prevents mount conflicts. same as --set-
-                        properties canmount=noauto)
-  --filter-properties PROPERTY,...
-                        List of properties to "filter" when receiving
-                        filesystems. (you can still restore them with zfs
-                        inherit -S)
-  --set-properties PROPERTY=VALUE,...
-                        List of propererties to override when receiving
-                        filesystems. (you can still restore them with zfs
-                        inherit -S)
-  --rollback            Rollback changes to the latest target snapshot before
-                        starting. (normally you can prevent changes by setting
-                        the readonly property on the target_path to on)
-  --destroy-incompatible
-                        Destroy incompatible snapshots on target. Use with
-                        care! (implies --rollback)
-  --destroy-missing SCHEDULE
-                        Destroy datasets on target that are missing on the
-                        source. Specify the time since the last snapshot, e.g:
-                        --destroy-missing 30d
-  --ignore-transfer-errors
-                        Ignore transfer errors (still checks if received
-                        filesystem exists. useful for acltype errors)
-  --decrypt             Decrypt data before sending it over.
-  --encrypt             Encrypt data after receiving it.
-  --zfs-compressed      Transfer blocks that already have zfs-compression as-
-                        is.
-  --test                dont change anything, just show what would be done
-                        (still does all read-only operations)
-  --verbose             verbose output
-  --debug               Show zfs commands that are executed, stops after an
-                        exception.
-  --debug-output        Show zfs commands and their output/exit codes. (noisy)
-  --progress            show zfs progress output. Enabled automaticly on ttys.
-                        (use --no-progress to disable)
-  --send-pipe COMMAND   pipe zfs send output through COMMAND (can be used
-                        multiple times)
-  --recv-pipe COMMAND   pipe zfs recv input through COMMAND (can be used
-                        multiple times)
-  --compress TYPE       Use compression during transfer, defaults to zstd-adapt
-                        if TYPE is not specified. (gzip, pigz-fast, pigz-slow,
-                        zstd-fast, zstd-slow, zstd-adapt, xz, lzo, lz4)
-  --rate DATARATE       Limit data transfer rate (e.g. 128K. requires
-                        mbuffer.)
-  --buffer SIZE         Add zfs send and recv buffers to smooth out IO bursts.
-                        (e.g. 128M. requires mbuffer)
-
-Full manual at: https://github.com/psy0rz/zfs_autobackup
-
-```
-
-## Troubleshooting
-
-### It keeps asking for my SSH password
-
-You forgot to setup automatic login via SSH keys, look in the example how to do this.
-
-### It says 'cannot receive incremental stream: invalid backup stream'
-
-This usually means you've created a new snapshot on the target side during a backup. If you restart zfs-autobackup, it will automaticly abort the invalid partially received snapshot and start over.
-
-### It says 'cannot receive incremental stream: destination has been modified since most recent snapshot'
-
-This means files have been modified on the target side somehow. 
-
-You can use --rollback to automaticly rollback such changes. Also try destroying the target dataset and using --clear-mountpoint on the next run. This way it wont get mounted.
-
-### It says 'internal error: Invalid argument'
-
-In some cases (Linux -> FreeBSD) this means certain properties are not fully supported on the target system.
-
-Try using something like: --filter-properties xattr or --ignore-transfer-errors. 
-
-### zfs receive fails, but snapshot seems to be received successful.
-
-This happens if you transfer between different Operating systems/zfs versions or feature sets.
-
-Try using the --ignore-transfer-errors option. This will ignore the error. It will still check if the snapshot is actually received correctly.
-
-## Restore example
-
-Restoring can be done with simple zfs commands. For example, use this to restore a specific SmartOS disk image to a temporary restore location:
-
-```console
-root@fs1:/home/psy#  zfs send fs1/zones/backup/zfsbackups/smartos01.server.com/zones/a3abd6c8-24c6-4125-9e35-192e2eca5908-disk0@smartos01_fs1-20160110000003 | ssh root@2.2.2.2 "zfs recv zones/restore"
-```
-
-After that you can rename the disk image from the temporary location to the location of a new SmartOS machine you've created.
-
-## Monitoring with Zabbix-jobs
-
-You can monitor backups by using my zabbix-jobs script. (<https://github.com/psy0rz/stuff/tree/master/zabbix-jobs>)
-
-Put this command directly after the zfs_backup command in your cronjob:
-
-```console
-zabbix-job-status backup_smartos01_fs1 daily $?
-```
-
-This will update the zabbix server with the exit code and will also alert you if the job didn't run for more than 2 days.
-
-## Backup a proxmox cluster with HA replication
-
-Due to the nature of proxmox we had to make a few enhancements to zfs-autobackup. This will probably also benefit other systems that use their own replication in combination with zfs-autobackup.
-
-All data under rpool/data can be on multiple nodes of the cluster. The naming of those filesystem is unique over the whole cluster. Because of this we should backup rpool/data of all nodes to the same destination. This way we wont have duplicate backups of the filesystems that are replicated. Because of various options, you can even migrate hosts and zfs-autobackup will be fine. (and it will get the next backup from the new node automatically)
-
-In the example below we have 3 nodes, named pve1, pve2 and pve3.
-
-### Preparing the proxmox nodes
-
-No preparation is needed, the script will take care of everything. You only need to setup the ssh keys, so that the backup server can access the proxmox server.
-
-TIP: make sure your backup server is firewalled and cannot be reached from any production machine.
-
-### SSH config on backup server
-
-I use ~/.ssh/config to specify how to reach the various hosts.
-
-In this example we are making an offsite copy and use portforwarding to reach the proxmox machines:
-```
-Host *
-    ControlPath ~/.ssh/control-master-%r@%h:%p
-    ControlMaster auto
-    ControlPersist 3600
-    Compression yes
-
-Host pve1
-    Hostname some.host.com
-    Port 10001
-
-Host pve2
-    Hostname some.host.com
-    Port 10002
-
-Host pve3
-    Hostname some.host.com
-    Port 10003
-```
-
-### Backup script
-
-I use the following backup script on the backup server.
-
-Adjust the variables HOSTS TARGET and NAME to your needs.
-
-```shell
-#!/bin/bash
-
-HOSTS="pve1 pve2 pve3"
-TARGET=rpool/pvebackups
-NAME=prox
-
-zfs create -p $TARGET/data &>/dev/null
-for HOST in $HOSTS; do
-
-  echo "################################### RPOOL $HOST"
-
-  # enable backup
-  ssh $HOST "zfs set autobackup:rpool_$NAME=child rpool/ROOT"
-
-  #backup rpool to specific directory per host
-  zfs create -p $TARGET/rpools/$HOST &>/dev/null
-  zfs-autobackup --keep-source=1d1w,1w1m --ssh-source $HOST rpool_$NAME $TARGET/rpools/$HOST --clear-mountpoint --clear-refreservation --ignore-transfer-errors --strip-path 2 --verbose   --no-holds   $@
-
-  zabbix-job-status backup_$HOST""_rpool_$NAME daily $? >/dev/null 2>/dev/null
-
-
-  echo "################################### DATA $HOST"
-
-  # enable backup
-  ssh $HOST "zfs set autobackup:data_$NAME=child rpool/data"
-
-  #backup data filesystems to a common directory
-  zfs-autobackup --keep-source=1d1w,1w1m --ssh-source $HOST data_$NAME $TARGET/data --clear-mountpoint --clear-refreservation --ignore-transfer-errors --strip-path 2 --verbose  --ignore-replicated --min-change 300000 --no-holds   $@
-
-  zabbix-job-status backup_$HOST""_data_$NAME daily $? >/dev/null 2>/dev/null
-
-done
-```
-
-This script will also send the backup status to Zabbix. (if you've installed my zabbix-job-status script https://github.com/psy0rz/stuff/tree/master/zabbix-jobs)
+Please look at our wiki to [Get started](https://github.com/psy0rz/zfs_autobackup/wiki).
 
 # Sponsor list
 

setup.py

@@ -18,7 +18,8 @@ setuptools.setup(
     entry_points={
         'console_scripts':
             [
-                'zfs-autobackup = zfs_autobackup:cli',
+                'zfs-autobackup = zfs_autobackup.ZfsAutobackup:cli',
+                'zfs-autoverify = zfs_autobackup.ZfsAutoverify:cli',
             ]
     },
     packages=setuptools.find_packages(),

tests/basetest.py

@@ -11,6 +11,7 @@ import subprocess
 import time
 from pprint import *
 from zfs_autobackup.ZfsAutobackup import *
+from zfs_autobackup.ZfsAutoverify import *
 from mock import *
 import contextlib
 import sys
@@ -62,6 +63,7 @@ def shelltest(cmd):
     """execute and print result as nice copypastable string for unit tests (adds extra newlines on top/bottom)"""
 
     ret=(subprocess.check_output("SUDO_ASKPASS=./password.sh sudo -A "+cmd , shell=True).decode('utf-8'))
+
     print("######### result of: {}".format(cmd))
     print(ret)
     print("#########")

tests/run_test

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+#run one test. start from main directory
+
+python -m unittest discover tests $@ -vvvf

tests/test_encryption.py

@@ -32,6 +32,7 @@ class TestZfsEncryption(unittest2.TestCase):
     def prepare_encrypted_dataset(self, key, path, unload_key=False):
 
         # create encrypted source dataset
+        shelltest("rm /tmp/zfstest.key 2>/dev/null;true")
         shelltest("echo {} > /tmp/zfstest.key".format(key))
         shelltest("zfs create -o keylocation=file:///tmp/zfstest.key -o keyformat=passphrase -o encryption=on {}".format(path))
 

tests/test_log.py

@@ -1,4 +1,4 @@
-import zfs_autobackup.LogConsole
+from zfs_autobackup.LogConsole import LogConsole
 from basetest import *
 
 
@@ -8,7 +8,7 @@ class TestLog(unittest2.TestCase):
         """test with color output"""
         with OutputIO() as buf:
             with redirect_stdout(buf):
-                l=LogConsole(show_verbose=False, show_debug=False, color=True)
+                l= LogConsole(show_verbose=False, show_debug=False, color=True)
                 l.verbose("verbose")
                 l.debug("debug")
 
@@ -46,7 +46,7 @@ class TestLog(unittest2.TestCase):
             self.assertEqual(list(buf.getvalue()), [' ', ' ', 'v', 'e', 'r', 'b', 'o', 's', 'e', '\n', '#', ' ', 'd', 'e', 'b', 'u', 'g', '\n', '!', ' ', 'e', 'r', 'r', 'o', 'r', '\n'])
 
 
-        zfs_autobackup.LogConsole.colorama=False
+        # zfs_autobackup.LogConsole.colorama=False
 
 
 

tests/test_verify.py

@@ -0,0 +1,99 @@
+
+from basetest import *
+
+
+# test zfs-verify:
+# - when there is no common snapshot at all
+# - when encryption key not loaded
+# - --test mode
+# - --fs-compare methods
+# - on snapshots of datasets:
+#   - that are correct
+#   - that are different
+# - on snapshots of zvols
+#  - that are correct
+#  - that are different
+# - test all directions (local, remote/local, local/remote, remote/remote)
+#
+
+class TestZfsEncryption(unittest2.TestCase):
+
+
+    def setUp(self):
+        prepare_zpools()
+
+        #create actual test files and data
+        shelltest("zfs create test_source1/fs1/ok_filesystem")
+        shelltest("cp tests/*.py /test_source1/fs1/ok_filesystem")
+
+        shelltest("zfs create test_source1/fs1/bad_filesystem")
+        shelltest("cp tests/*.py /test_source1/fs1/bad_filesystem")
+
+        shelltest("zfs create -V 1M test_source1/fs1/ok_zvol")
+        shelltest("dd if=/dev/urandom of=/dev/zvol/test_source1/fs1/ok_zvol count=1 bs=512k")
+
+        shelltest("zfs create -V 1M test_source1/fs1/bad_zvol")
+        shelltest("dd if=/dev/urandom of=/dev/zvol/test_source1/fs1/bad_zvol count=1 bs=512k")
+
+        #create backup
+        with patch('time.strftime', return_value="test-20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-progress --no-holds".split(" ")).run())
+
+        #Do an ugly hack to create a fault in the bad filesystem
+        #In zfs-autoverify it doenst matter that the snapshot isnt actually the same snapshot, so this hack works
+        shelltest("zfs destroy test_target1/test_source1/fs1/bad_filesystem@test-20101111000000")
+        shelltest("zfs mount test_target1/test_source1/fs1/bad_filesystem")
+        shelltest("echo >> /test_target1/test_source1/fs1/bad_filesystem/test_verify.py")
+        shelltest("zfs snapshot test_target1/test_source1/fs1/bad_filesystem@test-20101111000000")
+
+        #do the same hack for the bad zvol
+        shelltest("zfs destroy test_target1/test_source1/fs1/bad_zvol@test-20101111000000")
+        shelltest("dd if=/dev/urandom of=/dev/zvol/test_target1/test_source1/fs1/bad_zvol count=1 bs=1")
+        shelltest("zfs snapshot test_target1/test_source1/fs1/bad_zvol@test-20101111000000")
+
+
+        # make sure we cant accidently compare current data
+        shelltest("zfs mount test_target1/test_source1/fs1/ok_filesystem")
+        shelltest("rm /test_source1/fs1/ok_filesystem/*")
+        shelltest("rm /test_source1/fs1/bad_filesystem/*")
+        shelltest("dd if=/dev/zero of=/dev/zvol/test_source1/fs1/ok_zvol count=1 bs=512k")
+
+
+
+    def test_verify(self):
+
+
+        with self.subTest("default --test"):
+            self.assertFalse(ZfsAutoverify("test test_target1 --verbose --test".split(" ")).run())
+
+        with self.subTest("rsync, remote source and target. (not supported, all 6 fail)"):
+            self.assertEqual(6, ZfsAutoverify("test test_target1 --ssh-source=localhost --ssh-target=localhost --verbose --exclude-received --fs-compare=rsync".split(" ")).run())
+
+        def runchecked(testname, command):
+            with self.subTest(testname):
+                with OutputIO() as buf:
+                    result=None
+                    with redirect_stderr(buf):
+                        result=ZfsAutoverify(command.split(" ")).run()
+
+                    print(buf.getvalue())
+                    self.assertEqual(2,result)
+                    self.assertRegex(buf.getvalue(), "bad_filesystem: FAILED:")
+                    self.assertRegex(buf.getvalue(), "bad_zvol: FAILED:")
+
+        runchecked("rsync, remote source", "test test_target1 --ssh-source=localhost --verbose --exclude-received --fs-compare=rsync")
+        runchecked("rsync, remote target", "test test_target1 --ssh-target=localhost --verbose --exclude-received --fs-compare=rsync")
+        runchecked("rsync, local", "test test_target1 --verbose --exclude-received --fs-compare=rsync")
+
+        runchecked("tar, remote source and remote target",
+                   "test test_target1 --ssh-source=localhost --ssh-target=localhost --verbose --exclude-received --fs-compare=tar")
+        runchecked("tar, remote source",
+                   "test test_target1 --ssh-source=localhost --verbose --exclude-received --fs-compare=tar")
+        runchecked("tar, remote target",
+                   "test test_target1 --ssh-target=localhost --verbose --exclude-received --fs-compare=tar")
+        runchecked("tar, local", "test test_target1 --verbose --exclude-received --fs-compare=tar")
+
+        with self.subTest("no common snapshot"):
+            #destroy common snapshot, now 3 should fail
+            shelltest("zfs destroy test_source1/fs1/ok_zvol@test-20101111000000")
+            self.assertEqual(3, ZfsAutoverify("test test_target1 --verbose --exclude-received".split(" ")).run())

tests/test_zfsautobackup.py

@@ -3,6 +3,8 @@ from zfs_autobackup.CmdPipe import CmdPipe
 from basetest import *
 import time
 
+from zfs_autobackup.LogConsole import  LogConsole
+
 
 class TestZfsAutobackup(unittest2.TestCase):
 
@@ -418,6 +420,33 @@ test_target1/fs2/sub
 test_target1/fs2/sub@test-20101111000000
 """)
 
+#     def test_strippath_toomuch(self):
+#         with patch('time.strftime', return_value="test-20101111000000"):
+#             self.assertFalse(
+#                 ZfsAutobackup("test test_target1 --verbose --strip-path=2 --no-progress".split(" ")).run())
+#
+#             r = shelltest("zfs list -H -o name -r -t all " + TEST_POOLS)
+#             self.assertMultiLineEqual(r, """
+# test_source1
+# test_source1/fs1
+# test_source1/fs1@test-20101111000000
+# test_source1/fs1/sub
+# test_source1/fs1/sub@test-20101111000000
+# test_source2
+# test_source2/fs2
+# test_source2/fs2/sub
+# test_source2/fs2/sub@test-20101111000000
+# test_source2/fs3
+# test_source2/fs3/sub
+# test_target1
+# test_target1/fs1
+# test_target1/fs1@test-20101111000000
+# test_target1/fs1/sub
+# test_target1/fs1/sub@test-20101111000000
+# test_target1/fs2
+# test_target1/fs2/sub
+# test_target1/fs2/sub@test-20101111000000
+# """)
 
     def  test_clearrefres(self):
 

zfs_autobackup/ExecuteNode.py

@@ -78,10 +78,11 @@ class ExecuteNode(LogStub):
         return self.ssh_to is None
 
     def run(self, cmd, inp=None, tab_split=False, valid_exitcodes=None, readonly=False, hide_errors=False,
-            return_stderr=False, pipe=False):
+            return_stderr=False, pipe=False, return_all=False):
         """run a command on the node , checks output and parses/handle output and returns it
 
-        Either uses a local shell (sh -c) or remote shell (ssh) to execute the command. Therefore the command can have stuff like actual pipes in it, if you dont want to use pipe=True to pipe stuff.
+        Either uses a local shell (sh -c) or remote shell (ssh) to execute the command.
+        Therefore the command can have stuff like actual pipes in it, if you dont want to use pipe=True to pipe stuff.
 
         :param cmd: the actual command, should be a list, where the first item is the command
                     and the rest are parameters. use ExecuteNode.PIPE to add an unescaped |
@@ -94,6 +95,7 @@ class ExecuteNode(LogStub):
         :param readonly: make this True if the command doesn't make any changes and is safe to execute in testmode
         :param hide_errors: don't show stderr output as error, instead show it as debugging output (use to hide expected errors)
         :param return_stderr: return both stdout and stderr as a tuple. (normally only returns stdout)
+        :param return_all: return both stdout and stderr and exit_code as a tuple. (normally only returns stdout)
 
         """
 
@@ -106,6 +108,7 @@ class ExecuteNode(LogStub):
 
         # stderr parser
         error_lines = []
+        returned_exit_code=None
 
         def stderr_handler(line):
             if tab_split:
@@ -155,7 +158,9 @@ class ExecuteNode(LogStub):
         if not cmd_pipe.execute(stdout_handler=stdout_handler):
             raise(ExecuteError("Last command returned error"))
 
-        if return_stderr:
+        if return_all:
+            return output_lines, error_lines, cmd_item.process and cmd_item.process.returncode
+        elif return_stderr:
             return output_lines, error_lines
         else:
             return output_lines

zfs_autobackup/ZfsAuto.py

@@ -0,0 +1,191 @@
+import argparse
+import os.path
+import sys
+
+from .LogConsole import LogConsole
+
+
+class ZfsAuto(object):
+    """Common Base class, this class is always used subclassed. Look at ZfsAutobackup and ZfsAutoverify ."""
+
+    # also used by setup.py
+    VERSION = "3.2-alpha1"
+    HEADER = "{} v{} - (c)2021 E.H.Eefting (edwin@datux.nl)".format(os.path.basename(sys.argv[0]), VERSION)
+
+    def __init__(self, argv, print_arguments=True):
+
+        self.hold_name = None
+        self.snapshot_time_format = None
+        self.property_name = None
+        self.exclude_paths = None
+
+        # helps with investigating failed regression tests:
+        if print_arguments:
+            print("ARGUMENTS: " + " ".join(argv))
+
+        self.args = self.parse_args(argv)
+
+    def parse_args(self, argv):
+        """parse common arguments, setup logging, check and adjust parameters"""
+
+        parser=self.get_parser()
+        args = parser.parse_args(argv)
+
+        if args.help:
+            parser.print_help()
+            sys.exit(255)
+
+        if args.version:
+            print(self.HEADER)
+            sys.exit(255)
+
+        # auto enable progress?
+        if sys.stderr.isatty() and not args.no_progress:
+            args.progress = True
+
+        if args.debug_output:
+            args.debug = True
+
+        if args.test:
+            args.verbose = True
+
+        if args.debug:
+            args.verbose = True
+
+        self.log = LogConsole(show_debug=args.debug, show_verbose=args.verbose, color=sys.stdout.isatty())
+
+        self.verbose(self.HEADER)
+        self.verbose("")
+
+        if args.backup_name == None:
+            parser.print_usage()
+            self.log.error("Please specify BACKUP-NAME")
+            sys.exit(255)
+
+        if args.target_path is not None and args.target_path[0] == "/":
+            self.log.error("Target should not start with a /")
+            sys.exit(255)
+
+        if args.ignore_replicated:
+            self.warning("--ignore-replicated has been renamed, using --exclude-unchanged")
+            args.exclude_unchanged = True
+
+        # Note: Before version v3.1-beta5, we always used exclude_received. This was a problem if you wanted to
+        # replicate an existing backup to another host and use the same backupname/snapshots. However, exclude_received
+        # may still need to be used to explicitly exclude a backup with the 'received' source property to avoid accidental
+        # recursive replication of a zvol that is currently being received in another session (as it will have changes).
+
+        self.exclude_paths = []
+        if args.ssh_source == args.ssh_target:
+            if args.target_path:
+                # target and source are the same, make sure to exclude target_path
+                self.verbose("NOTE: Source and target are on the same host, excluding target-path from selection.")
+                self.exclude_paths.append(args.target_path)
+            else:
+                self.verbose("NOTE: Source and target are on the same host, excluding received datasets from selection.")
+                args.exclude_received = True
+
+        if args.test:
+            self.warning("TEST MODE - SIMULATING WITHOUT MAKING ANY CHANGES")
+
+        #format all the names
+        self.property_name = args.property_format.format(args.backup_name)
+        self.snapshot_time_format = args.snapshot_format.format(args.backup_name)
+        self.hold_name = args.hold_format.format(args.backup_name)
+
+        self.verbose("")
+        self.verbose("Selecting dataset property : {}".format(self.property_name))
+        self.verbose("Snapshot format            : {}".format(self.snapshot_time_format))
+
+        return args
+
+    def get_parser(self):
+
+        parser = argparse.ArgumentParser(description=self.HEADER, add_help=False,
+                                         epilog='Full manual at: https://github.com/psy0rz/zfs_autobackup')
+
+        #positional arguments
+        parser.add_argument('backup_name', metavar='BACKUP-NAME', default=None, nargs='?',
+                            help='Name of the backup to select')
+
+        parser.add_argument('target_path', metavar='TARGET-PATH', default=None, nargs='?',
+                            help='Target ZFS filesystem (optional)')
+
+        # Basic options
+        group=parser.add_argument_group("Basic options")
+        group.add_argument('--help', '-h', action='store_true', help='show help')
+        group.add_argument('--test', '--dry-run', '-n', action='store_true',
+                            help='Dry run, dont change anything, just show what would be done (still does all read-only '
+                                 'operations)')
+        group.add_argument('--verbose', '-v', action='store_true', help='verbose output')
+        group.add_argument('--debug', '-d', action='store_true',
+                            help='Show zfs commands that are executed, stops after an exception.')
+        group.add_argument('--debug-output', action='store_true',
+                            help='Show zfs commands and their output/exit codes. (noisy)')
+        group.add_argument('--progress', action='store_true',
+                            help='show zfs progress output. Enabled automaticly on ttys. (use --no-progress to disable)')
+        group.add_argument('--no-progress', action='store_true',
+                            help=argparse.SUPPRESS)  # needed to workaround a zfs recv -v bug
+        group.add_argument('--version', action='store_true',
+                            help='Show version.')
+        group.add_argument('--strip-path', metavar='N', default=0, type=int,
+                           help='Number of directories to strip from target path (use 1 when cloning zones between 2 '
+                                'SmartOS machines)')
+
+        # SSH options
+        group=parser.add_argument_group("SSH options")
+        group.add_argument('--ssh-config', metavar='CONFIG-FILE', default=None, help='Custom ssh client config')
+        group.add_argument('--ssh-source', metavar='USER@HOST', default=None,
+                            help='Source host to get backup from.')
+        group.add_argument('--ssh-target', metavar='USER@HOST', default=None,
+                            help='Target host to push backup to.')
+
+        group=parser.add_argument_group("String formatting options")
+        group.add_argument('--property-format', metavar='FORMAT', default="autobackup:{}",
+                            help='Dataset selection string format. Default: %(default)s')
+        group.add_argument('--snapshot-format', metavar='FORMAT', default="{}-%Y%m%d%H%M%S",
+                            help='ZFS Snapshot string format. Default: %(default)s')
+        group.add_argument('--hold-format', metavar='FORMAT', default="zfs_autobackup:{}",
+                            help='ZFS hold string format. Default: %(default)s')
+
+        group=parser.add_argument_group("Selection options")
+        group.add_argument('--ignore-replicated', action='store_true', help=argparse.SUPPRESS)
+        group.add_argument('--exclude-unchanged', action='store_true',
+                            help='Exclude datasets that have no changes since any last snapshot. (Useful in combination with proxmox HA replication)')
+        group.add_argument('--exclude-received', action='store_true',
+                            help='Exclude datasets that have the origin of their autobackup: property as "received". '
+                                 'This can avoid recursive replication between two backup partners.')
+
+        return parser
+
+    def verbose(self, txt):
+        self.log.verbose(txt)
+
+    def warning(self, txt):
+        self.log.warning(txt)
+
+    def error(self, txt):
+        self.log.error(txt)
+
+    def debug(self, txt):
+        self.log.debug(txt)
+
+    def progress(self, txt):
+        self.log.progress(txt)
+
+    def clear_progress(self):
+        self.log.clear_progress()
+
+    def set_title(self, title):
+        self.log.verbose("")
+        self.log.verbose("#### " + title)
+
+    def print_error_sources(self):
+        self.error(
+            "No source filesystems selected, please do a 'zfs set autobackup:{0}=true' on the source datasets "
+            "you want to select.".format(
+                self.args.backup_name))
+
+    def make_target_name(self, source_dataset):
+        """make target_name from a source_dataset"""
+        return self.args.target_path + "/" + source_dataset.lstrip_path(self.args.strip_path)

zfs_autobackup/ZfsAutobackup.py

@@ -1,168 +1,31 @@
-import argparse
-import sys
 import time
 
+import argparse
+from .ZfsAuto import ZfsAuto
+
 from . import compressors
 from .ExecuteNode import ExecuteNode
 from .Thinner import Thinner
 from .ZfsDataset import ZfsDataset
-from .LogConsole import LogConsole
 from .ZfsNode import ZfsNode
 from .ThinnerRule import ThinnerRule
 
 
-class ZfsAutobackup:
-    """main class"""
-
-    VERSION = "3.1.1"
-    HEADER = "zfs-autobackup v{} - (c)2021 E.H.Eefting (edwin@datux.nl)".format(VERSION)
+class ZfsAutobackup(ZfsAuto):
+    """The main zfs-autobackup class. Start here, at run() :)"""
 
     def __init__(self, argv, print_arguments=True):
 
-        # helps with investigating failed regression tests:
-        if print_arguments:
-            print("ARGUMENTS: " + " ".join(argv))
+        # NOTE: common options and parameters are in ZfsAuto
+        super(ZfsAutobackup, self).__init__(argv, print_arguments)
 
-        parser = argparse.ArgumentParser(
-            description=self.HEADER,
-            epilog='Full manual at: https://github.com/psy0rz/zfs_autobackup')
-        parser.add_argument('--ssh-config', metavar='CONFIG-FILE', default=None, help='Custom ssh client config')
-        parser.add_argument('--ssh-source', metavar='USER@HOST', default=None,
-                            help='Source host to get backup from.')
-        parser.add_argument('--ssh-target', metavar='USER@HOST', default=None,
-                            help='Target host to push backup to.')
-        parser.add_argument('--keep-source', metavar='SCHEDULE', type=str, default="10,1d1w,1w1m,1m1y",
-                            help='Thinning schedule for old source snapshots. Default: %(default)s')
-        parser.add_argument('--keep-target', metavar='SCHEDULE', type=str, default="10,1d1w,1w1m,1m1y",
-                            help='Thinning schedule for old target snapshots. Default: %(default)s')
+    def parse_args(self, argv):
+        """do extra checks on common args"""
 
-        parser.add_argument('backup_name', metavar='BACKUP-NAME', default=None, nargs='?',
-                            help='Name of the backup (you should set the zfs property "autobackup:backup-name" to '
-                                 'true on filesystems you want to backup')
-        parser.add_argument('target_path', metavar='TARGET-PATH', default=None, nargs='?',
-                            help='Target ZFS filesystem (optional: if not specified, zfs-autobackup will only operate '
-                                 'as snapshot-tool on source)')
+        args = super(ZfsAutobackup, self).parse_args(argv)
 
-        parser.add_argument('--pre-snapshot-cmd', metavar="COMMAND", default=[], action='append',
-                            help='Run COMMAND before snapshotting (can be used multiple times.')
-        parser.add_argument('--post-snapshot-cmd', metavar="COMMAND", default=[], action='append',
-                            help='Run COMMAND after snapshotting (can be used multiple times.')
-        parser.add_argument('--other-snapshots', action='store_true',
-                            help='Send over other snapshots as well, not just the ones created by this tool.')
-        parser.add_argument('--no-snapshot', action='store_true',
-                            help='Don\'t create new snapshots (useful for finishing uncompleted backups, or cleanups)')
-        parser.add_argument('--no-send', action='store_true',
-                            help='Don\'t send snapshots (useful for cleanups, or if you want a serperate send-cronjob)')
-        parser.add_argument('--no-thinning', action='store_true', help="Do not destroy any snapshots.")
-        parser.add_argument('--no-holds', action='store_true',
-                            help='Don\'t hold snapshots. (Faster. Allows you to destroy common snapshot.)')
-        parser.add_argument('--min-change', metavar='BYTES', type=int, default=1,
-                            help='Number of bytes written after which we consider a dataset changed (default %('
-                                 'default)s)')
-        parser.add_argument('--allow-empty', action='store_true',
-                            help='If nothing has changed, still create empty snapshots. (same as --min-change=0)')
-
-        parser.add_argument('--ignore-replicated', action='store_true', help=argparse.SUPPRESS)
-        parser.add_argument('--exclude-unchanged', action='store_true',
-                            help='Exclude datasets that have no changes since any last snapshot. (Useful in combination with proxmox HA replication)')
-        parser.add_argument('--exclude-received', action='store_true',
-                            help='Exclude datasets that have the origin of their autobackup: property as "received". '
-                                 'This can avoid recursive replication between two backup partners.')
-        parser.add_argument('--strip-path', metavar='N', default=0, type=int,
-                            help='Number of directories to strip from target path (use 1 when cloning zones between 2 '
-                                 'SmartOS machines)')
-
-        parser.add_argument('--clear-refreservation', action='store_true',
-                            help='Filter "refreservation" property. (recommended, safes space. same as '
-                                 '--filter-properties refreservation)')
-        parser.add_argument('--clear-mountpoint', action='store_true',
-                            help='Set property canmount=noauto for new datasets. (recommended, prevents mount '
-                                 'conflicts. same as --set-properties canmount=noauto)')
-        parser.add_argument('--filter-properties', metavar='PROPERTY,...', type=str,
-                            help='List of properties to "filter" when receiving filesystems. (you can still restore '
-                                 'them with zfs inherit -S)')
-        parser.add_argument('--set-properties', metavar='PROPERTY=VALUE,...', type=str,
-                            help='List of propererties to override when receiving filesystems. (you can still restore '
-                                 'them with zfs inherit -S)')
-        parser.add_argument('--rollback', action='store_true',
-                            help='Rollback changes to the latest target snapshot before starting. (normally you can '
-                                 'prevent changes by setting the readonly property on the target_path to on)')
-        parser.add_argument('--destroy-incompatible', action='store_true',
-                            help='Destroy incompatible snapshots on target. Use with care! (implies --rollback)')
-        parser.add_argument('--destroy-missing', metavar="SCHEDULE", type=str, default=None,
-                            help='Destroy datasets on target that are missing on the source. Specify the time since '
-                                 'the last snapshot, e.g: --destroy-missing 30d')
-        parser.add_argument('--ignore-transfer-errors', action='store_true',
-                            help='Ignore transfer errors (still checks if received filesystem exists. useful for '
-                                 'acltype errors)')
-
-        parser.add_argument('--decrypt', action='store_true',
-                            help='Decrypt data before sending it over.')
-
-        parser.add_argument('--encrypt', action='store_true',
-                            help='Encrypt data after receiving it.')
-
-        parser.add_argument('--zfs-compressed', action='store_true',
-                            help='Transfer blocks that already have zfs-compression as-is.')
-
-        parser.add_argument('--test','--dry-run', '-n', action='store_true',
-                            help='Dry run, dont change anything, just show what would be done (still does all read-only '
-                                 'operations)')
-        parser.add_argument('--verbose','-v', action='store_true', help='verbose output')
-        parser.add_argument('--debug','-d', action='store_true',
-                            help='Show zfs commands that are executed, stops after an exception.')
-        parser.add_argument('--debug-output', action='store_true',
-                            help='Show zfs commands and their output/exit codes. (noisy)')
-        parser.add_argument('--progress', action='store_true',
-                            help='show zfs progress output. Enabled automaticly on ttys. (use --no-progress to disable)')
-        parser.add_argument('--no-progress', action='store_true',
-                            help=argparse.SUPPRESS)  # needed to workaround a zfs recv -v bug
-
-        parser.add_argument('--resume', action='store_true', help=argparse.SUPPRESS)
-        parser.add_argument('--raw', action='store_true', help=argparse.SUPPRESS)
-
-        # these things all do stuff by piping zfs send/recv IO
-        parser.add_argument('--send-pipe', metavar="COMMAND", default=[], action='append',
-                            help='pipe zfs send output through COMMAND (can be used multiple times)')
-        parser.add_argument('--recv-pipe', metavar="COMMAND", default=[], action='append',
-                            help='pipe zfs recv input through COMMAND (can be used multiple times)')
-        parser.add_argument('--compress', metavar='TYPE', default=None, nargs='?', const='zstd-fast',
-                            choices=compressors.choices(),
-                            help='Use compression during transfer, defaults to zstd-fast if TYPE is not specified. ({})'.format(
-                                ", ".join(compressors.choices())))
-        parser.add_argument('--rate', metavar='DATARATE', default=None,
-                            help='Limit data transfer rate (e.g. 128K. requires mbuffer.)')
-        parser.add_argument('--buffer', metavar='SIZE', default=None,
-                            help='Add zfs send and recv buffers to smooth out IO bursts. (e.g. 128M. requires mbuffer)')
-
-        parser.add_argument('--snapshot-format', metavar='FORMAT', default="{}-%Y%m%d%H%M%S",
-                            help='Snapshot naming format. Default: %(default)s')
-        parser.add_argument('--property-format', metavar='FORMAT', default="autobackup:{}",
-                            help='Select property naming format. Default: %(default)s')
-        parser.add_argument('--hold-format', metavar='FORMAT', default="zfs_autobackup:{}",
-                            help='Hold naming format. Default: %(default)s')
-
-        parser.add_argument('--version', action='store_true',
-                            help='Show version.')
-
-        # note args is the only global variable we use, since its a global readonly setting anyway
-        args = parser.parse_args(argv)
-
-        self.args = args
-
-        if args.version:
-            print(self.HEADER)
-            sys.exit(255)
-
-        # auto enable progress?
-        if sys.stderr.isatty() and not args.no_progress:
-            args.progress = True
-
-        if args.debug_output:
-            args.debug = True
-
-        if self.args.test:
-            self.args.verbose = True
+        if not args.no_holds:
+            self.verbose("Hold name                  : {}".format(self.hold_name))
 
         if args.allow_empty:
             args.min_change = 0
@@ -170,14 +33,6 @@ class ZfsAutobackup:
         if args.destroy_incompatible:
             args.rollback = True
 
-        self.log = LogConsole(show_debug=self.args.debug, show_verbose=self.args.verbose, color=sys.stdout.isatty())
-        self.verbose(self.HEADER)
-
-        if args.backup_name==None:
-            parser.print_usage()
-            self.log.error("Please specify BACKUP-NAME")
-            sys.exit(255)
-
         if args.resume:
             self.warning("The --resume option isn't needed anymore (its autodetected now)")
 
@@ -185,41 +40,97 @@ class ZfsAutobackup:
             self.warning(
                 "The --raw option isn't needed anymore (its autodetected now). Also see --encrypt and --decrypt.")
 
-        if args.target_path is not None and args.target_path[0] == "/":
-            self.log.error("Target should not start with a /")
-            sys.exit(255)
-
         if args.compress and args.ssh_source is None and args.ssh_target is None:
             self.warning("Using compression, but transfer is local.")
 
         if args.compress and args.zfs_compressed:
             self.warning("Using --compress with --zfs-compressed, might be inefficient.")
 
-        if args.ignore_replicated:
-            self.warning("--ignore-replicated has been renamed, using --exclude-unchanged")
-            args.exclude_unchanged = True
+        return args
 
-    def verbose(self, txt):
-        self.log.verbose(txt)
+    def get_parser(self):
+        """extend common parser with  extra stuff needed for zfs-autobackup"""
 
-    def warning(self, txt):
-        self.log.warning(txt)
+        parser = super(ZfsAutobackup, self).get_parser()
 
-    def error(self, txt):
-        self.log.error(txt)
+        group = parser.add_argument_group("Snapshot options")
+        group.add_argument('--no-snapshot', action='store_true',
+                           help='Don\'t create new snapshots (useful for finishing uncompleted backups, or cleanups)')
+        group.add_argument('--pre-snapshot-cmd', metavar="COMMAND", default=[], action='append',
+                           help='Run COMMAND before snapshotting (can be used multiple times.')
+        group.add_argument('--post-snapshot-cmd', metavar="COMMAND", default=[], action='append',
+                           help='Run COMMAND after snapshotting (can be used multiple times.')
+        group.add_argument('--min-change', metavar='BYTES', type=int, default=1,
+                           help='Only create snapshot if enough bytes are changed. (default %('
+                                'default)s)')
+        group.add_argument('--allow-empty', action='store_true',
+                           help='If nothing has changed, still create empty snapshots. (Faster. Same as --min-change=0)')
+        group.add_argument('--other-snapshots', action='store_true',
+                           help='Send over other snapshots as well, not just the ones created by this tool.')
 
-    def debug(self, txt):
-        self.log.debug(txt)
+        group = parser.add_argument_group("Transfer options")
+        group.add_argument('--no-send', action='store_true',
+                           help='Don\'t transfer snapshots (useful for cleanups, or if you want a serperate send-cronjob)')
+        group.add_argument('--no-holds', action='store_true',
+                           help='Don\'t hold snapshots. (Faster. Allows you to destroy common snapshot.)')
+        group.add_argument('--clear-refreservation', action='store_true',
+                           help='Filter "refreservation" property. (recommended, safes space. same as '
+                                '--filter-properties refreservation)')
+        group.add_argument('--clear-mountpoint', action='store_true',
+                           help='Set property canmount=noauto for new datasets. (recommended, prevents mount '
+                                'conflicts. same as --set-properties canmount=noauto)')
+        group.add_argument('--filter-properties', metavar='PROPERTY,...', type=str,
+                           help='List of properties to "filter" when receiving filesystems. (you can still restore '
+                                'them with zfs inherit -S)')
+        group.add_argument('--set-properties', metavar='PROPERTY=VALUE,...', type=str,
+                           help='List of propererties to override when receiving filesystems. (you can still restore '
+                                'them with zfs inherit -S)')
+        group.add_argument('--rollback', action='store_true',
+                           help='Rollback changes to the latest target snapshot before starting. (normally you can '
+                                'prevent changes by setting the readonly property on the target_path to on)')
+        group.add_argument('--destroy-incompatible', action='store_true',
+                           help='Destroy incompatible snapshots on target. Use with care! (implies --rollback)')
+        group.add_argument('--ignore-transfer-errors', action='store_true',
+                           help='Ignore transfer errors (still checks if received filesystem exists. useful for '
+                                'acltype errors)')
 
-    def set_title(self, title):
-        self.log.verbose("")
-        self.log.verbose("#### " + title)
+        group.add_argument('--decrypt', action='store_true',
+                           help='Decrypt data before sending it over.')
+        group.add_argument('--encrypt', action='store_true',
+                           help='Encrypt data after receiving it.')
 
-    def progress(self, txt):
-        self.log.progress(txt)
+        group.add_argument('--zfs-compressed', action='store_true',
+                           help='Transfer blocks that already have zfs-compression as-is.')
 
-    def clear_progress(self):
-        self.log.clear_progress()
+        group = parser.add_argument_group("ZFS send/recv pipes")
+        group.add_argument('--compress', metavar='TYPE', default=None, nargs='?', const='zstd-fast',
+                           choices=compressors.choices(),
+                           help='Use compression during transfer, defaults to zstd-fast if TYPE is not specified. ({})'.format(
+                               ", ".join(compressors.choices())))
+        group.add_argument('--rate', metavar='DATARATE', default=None,
+                           help='Limit data transfer rate (e.g. 128K. requires mbuffer.)')
+        group.add_argument('--buffer', metavar='SIZE', default=None,
+                           help='Add zfs send and recv buffers to smooth out IO bursts. (e.g. 128M. requires mbuffer)')
+        group.add_argument('--send-pipe', metavar="COMMAND", default=[], action='append',
+                           help='pipe zfs send output through COMMAND (can be used multiple times)')
+        group.add_argument('--recv-pipe', metavar="COMMAND", default=[], action='append',
+                           help='pipe zfs recv input through COMMAND (can be used multiple times)')
+
+        group = parser.add_argument_group("Thinner options")
+        group.add_argument('--no-thinning', action='store_true', help="Do not destroy any snapshots.")
+        group.add_argument('--keep-source', metavar='SCHEDULE', type=str, default="10,1d1w,1w1m,1m1y",
+                           help='Thinning schedule for old source snapshots. Default: %(default)s')
+        group.add_argument('--keep-target', metavar='SCHEDULE', type=str, default="10,1d1w,1w1m,1m1y",
+                           help='Thinning schedule for old target snapshots. Default: %(default)s')
+        group.add_argument('--destroy-missing', metavar="SCHEDULE", type=str, default=None,
+                           help='Destroy datasets on target that are missing on the source. Specify the time since '
+                                'the last snapshot, e.g: --destroy-missing 30d')
+
+        # obsolete
+        parser.add_argument('--resume', action='store_true', help=argparse.SUPPRESS)
+        parser.add_argument('--raw', action='store_true', help=argparse.SUPPRESS)
+
+        return parser
 
     # NOTE: this method also uses self.args. args that need extra processing are passed as function parameters:
     def thin_missing_targets(self, target_dataset, used_target_datasets):
@@ -303,6 +214,9 @@ class ZfsAutobackup:
                                 dataset.destroy(fail_exception=True)
 
             except Exception as e:
+                if self.args.progress:
+                    self.clear_progress()
+
                 dataset.error("Error during --destroy-missing: {}".format(str(e)))
 
         if self.args.progress:
@@ -387,8 +301,8 @@ class ZfsAutobackup:
 
             try:
                 # determine corresponding target_dataset
-                target_name = self.args.target_path + "/" + source_dataset.lstrip_path(self.args.strip_path)
-                target_dataset = ZfsDataset(target_node, target_name)
+                target_name = self.make_target_name(source_dataset)
+                target_dataset = target_node.get_dataset(target_name)
                 target_datasets.append(target_dataset)
 
                 # ensure parents exists
@@ -399,8 +313,8 @@ class ZfsAutobackup:
                     target_dataset.parent.create_filesystem(parents=True)
 
                 # determine common zpool features (cached, so no problem we call it often)
-                source_features = source_node.get_zfs_pool(source_dataset.split_path()[0]).features
-                target_features = target_node.get_zfs_pool(target_dataset.split_path()[0]).features
+                source_features = source_node.get_pool(source_dataset).features
+                target_features = target_node.get_pool(target_dataset).features
                 common_features = source_features and target_features
 
                 # sync the snapshots of this dataset
@@ -416,15 +330,19 @@ class ZfsAutobackup:
                                               decrypt=self.args.decrypt, encrypt=self.args.encrypt,
                                               zfs_compressed=self.args.zfs_compressed)
             except Exception as e:
+                if self.args.progress:
+                    self.clear_progress()
+
                 fail_count = fail_count + 1
                 source_dataset.error("FAILED: " + str(e))
                 if self.args.debug:
+                    self.verbose("Debug mode, aborting on first error")
                     raise
 
         if self.args.progress:
             self.clear_progress()
 
-        target_path_dataset = ZfsDataset(target_node, self.args.target_path)
+        target_path_dataset = target_node.get_dataset(self.args.target_path)
         if not self.args.no_thinning:
             self.thin_missing_targets(target_dataset=target_path_dataset, used_target_datasets=target_datasets)
 
@@ -468,22 +386,6 @@ class ZfsAutobackup:
 
         try:
 
-            if self.args.test:
-                self.warning("TEST MODE - SIMULATING WITHOUT MAKING ANY CHANGES")
-
-            #format all the names
-            property_name = self.args.property_format.format(self.args.backup_name)
-            snapshot_time_format = self.args.snapshot_format.format(self.args.backup_name)
-            hold_name = self.args.hold_format.format(self.args.backup_name)
-
-            self.verbose("")
-            self.verbose("Selecting dataset property : {}".format(property_name))
-            self.verbose("Snapshot format            : {}".format(snapshot_time_format))
-
-            if not self.args.no_holds:
-                self.verbose("Hold name                  : {}".format(hold_name))
-
-
             ################ create source zfsNode
             self.set_title("Source settings")
 
@@ -492,44 +394,26 @@ class ZfsAutobackup:
                 source_thinner = None
             else:
                 source_thinner = Thinner(self.args.keep_source)
-            source_node = ZfsNode(snapshot_time_format=snapshot_time_format, hold_name=hold_name, logger=self, ssh_config=self.args.ssh_config,
+            source_node = ZfsNode(snapshot_time_format=self.snapshot_time_format, hold_name=self.hold_name, logger=self,
+                                  ssh_config=self.args.ssh_config,
                                   ssh_to=self.args.ssh_source, readonly=self.args.test,
                                   debug_output=self.args.debug_output, description=description, thinner=source_thinner)
 
-
             ################# select source datasets
             self.set_title("Selecting")
-
-            # Note: Before version v3.1-beta5, we always used exclude_received. This was a problem if you wanted to
-            # replicate an existing backup to another host and use the same backupname/snapshots. However, exclude_received
-            # may still need to be used to explicitly exclude a backup with the 'received' source to avoid accidental
-            # recursive replication of a zvol that is currently being received in another session (as it will have changes).
-            exclude_paths = []
-            exclude_received = self.args.exclude_received
-            if self.args.ssh_source == self.args.ssh_target:
-                if self.args.target_path:
-                    # target and source are the same, make sure to exclude target_path
-                    self.warning("Source and target are on the same host, excluding target-path from selection.")
-                    exclude_paths.append(self.args.target_path)
-                else:
-                    self.warning("Source and target are on the same host, excluding received datasets from selection.")
-                    exclude_received = True
-
-            source_datasets = source_node.selected_datasets(property_name=property_name,exclude_received=exclude_received,
-                                                                     exclude_paths=exclude_paths,
-                                                                     exclude_unchanged=self.args.exclude_unchanged,
-                                                                     min_change=self.args.min_change)
+            source_datasets = source_node.selected_datasets(property_name=self.property_name,
+                                                            exclude_received=self.args.exclude_received,
+                                                            exclude_paths=self.exclude_paths,
+                                                            exclude_unchanged=self.args.exclude_unchanged,
+                                                            min_change=self.args.min_change)
             if not source_datasets:
-                self.error(
-                    "No source filesystems selected, please do a 'zfs set autobackup:{0}=true' on the source datasets "
-                    "you want to select.".format(
-                        self.args.backup_name))
+                self.print_error_sources()
                 return 255
 
             ################# snapshotting
             if not self.args.no_snapshot:
                 self.set_title("Snapshotting")
-                snapshot_name=time.strftime(snapshot_time_format)
+                snapshot_name = time.strftime(self.snapshot_time_format)
                 source_node.consistent_snapshot(source_datasets, snapshot_name,
                                                 min_changed_bytes=self.args.min_change,
                                                 pre_snapshot_cmds=self.args.pre_snapshot_cmd,
@@ -545,7 +429,8 @@ class ZfsAutobackup:
                     target_thinner = None
                 else:
                     target_thinner = Thinner(self.args.keep_target)
-                target_node = ZfsNode(snapshot_time_format=snapshot_time_format, hold_name=hold_name, logger=self, ssh_config=self.args.ssh_config,
+                target_node = ZfsNode(snapshot_time_format=self.snapshot_time_format, hold_name=self.hold_name,
+                                      logger=self, ssh_config=self.args.ssh_config,
                                       ssh_to=self.args.ssh_target,
                                       readonly=self.args.test, debug_output=self.args.debug_output,
                                       description="[Target]",
@@ -555,7 +440,7 @@ class ZfsAutobackup:
                 self.set_title("Synchronising")
 
                 # check if exists, to prevent vague errors
-                target_dataset = ZfsDataset(target_node, self.args.target_path)
+                target_dataset = target_node.get_dataset(self.args.target_path)
                 if not target_dataset.exists:
                     raise (Exception(
                         "Target path '{}' does not exist. Please create this dataset first.".format(target_dataset)))
@@ -599,3 +484,13 @@ class ZfsAutobackup:
         except KeyboardInterrupt:
             self.error("Aborted")
             return 255
+
+
+def cli():
+    import sys
+
+    sys.exit(ZfsAutobackup(sys.argv[1:], False).run())
+
+
+if __name__ == "__main__":
+    cli()

zfs_autobackup/ZfsAutoverify.py

@@ -0,0 +1,402 @@
+import os
+import time
+
+from .ExecuteNode import ExecuteNode
+from .ZfsAuto import ZfsAuto
+from .ZfsDataset import ZfsDataset
+from .ZfsNode import ZfsNode
+import sys
+import platform
+
+def tmp_name(suffix=""):
+    """create temporary name unique to this process and node"""
+
+    #we could use uuids but those are ugly and confusing
+    name="zfstmp_{}_{}".format(platform.node(), os.getpid())
+    name=name+suffix
+    return name
+
+def hash_tree_tar(node, path):
+    """calculate md5sum of a directory tree, using tar"""
+
+    node.debug("Hashing filesystem {} ".format(path))
+
+    cmd=[ "tar", "-cf", "-", "-C", path, ".",
+          ExecuteNode.PIPE, "md5sum"]
+
+    stdout = node.run(cmd)
+
+    if node.readonly:
+        hashed=None
+    else:
+        hashed = stdout[0].split(" ")[0]
+
+    node.debug("Hash of {} filesytem is {}".format(path, hashed))
+
+    return hashed
+
+
+def compare_trees_tar(source_node, source_path, target_node, target_path):
+    """compare two trees using tar. compatible and simple"""
+
+    source_hash= hash_tree_tar(source_node, source_path)
+    target_hash= hash_tree_tar(target_node, target_path)
+
+    if source_hash != target_hash:
+        raise Exception("md5hash difference: {} != {}".format(source_hash, target_hash))
+
+
+def compare_trees_rsync(source_node, source_path, target_node, target_path):
+    """use rsync to compare two trees.
+     Advantage is that we can see which individual files differ.
+     But requires rsync and cant do remote to remote."""
+
+    cmd = ["rsync", "-rcn", "--info=COPY,DEL,MISC,NAME,SYMSAFE", "--msgs2stderr", "--delete" ]
+
+    #local
+    if source_node.ssh_to is None and target_node.ssh_to is None:
+        cmd.append("{}/".format(source_path))
+        cmd.append("{}/".format(target_path))
+        source_node.debug("Running rsync locally, on source.")
+        stdout, stderr = source_node.run(cmd, return_stderr=True)
+
+    #source is local
+    elif source_node.ssh_to is None and target_node.ssh_to is not None:
+        cmd.append("{}/".format(source_path))
+        cmd.append("{}:{}/".format(target_node.ssh_to, target_path))
+        source_node.debug("Running rsync locally, on source.")
+        stdout, stderr = source_node.run(cmd, return_stderr=True)
+
+    #target is local
+    elif source_node.ssh_to is not None and target_node.ssh_to is None:
+        cmd.append("{}:{}/".format(source_node.ssh_to, source_path))
+        cmd.append("{}/".format(target_path))
+        source_node.debug("Running rsync locally, on target.")
+        stdout, stderr=target_node.run(cmd, return_stderr=True)
+
+    else:
+        raise Exception("Source and target cant both be remote when verifying. (rsync limitation)")
+
+    if stderr:
+        raise Exception("Dataset verify failed, see above list for differences")
+
+
+def verify_filesystem(source_snapshot, source_mnt, target_snapshot, target_mnt, method):
+    """Compare the contents of two zfs filesystem snapshots """
+
+    try:
+
+        # mount the snapshots
+        source_snapshot.mount(source_mnt)
+        target_snapshot.mount(target_mnt)
+
+        if method=='rsync':
+            compare_trees_rsync(source_snapshot.zfs_node, source_mnt, target_snapshot.zfs_node, target_mnt)
+        elif method == 'tar':
+            compare_trees_tar(source_snapshot.zfs_node, source_mnt, target_snapshot.zfs_node, target_mnt)
+        else:
+            raise(Exception("program errror, unknown method"))
+
+    finally:
+        source_snapshot.unmount()
+        target_snapshot.unmount()
+
+
+def hash_dev(node, dev):
+    """calculate md5sum of a device on a node"""
+
+    node.debug("Hashing volume {} ".format(dev))
+
+    cmd = [ "md5sum", dev ]
+
+    stdout = node.run(cmd)
+
+    if node.readonly:
+        hashed=None
+    else:
+        hashed = stdout[0].split(" ")[0]
+
+    node.debug("Hash of volume {} is {}".format(dev, hashed))
+
+    return hashed
+
+# def activate_volume_snapshot(dataset, snapshot):
+#     """enables snapdev, waits and tries to findout /dev path to the volume, in a compatible way. (linux/freebsd/smartos)"""
+#
+#     dataset.set("snapdev", "visible")
+#
+#     #NOTE: add smartos location to this list as well
+#     locations=[
+#         "/dev/zvol/" + snapshot.name
+#     ]
+#
+#     dataset.debug("Waiting for /dev entry to appear...")
+#     time.sleep(0.1)
+#
+#     start_time=time.time()
+#     while time.time()-start_time<10:
+#         for location in locations:
+#             stdout, stderr, exit_code=dataset.zfs_node.run(["test", "-e", location], return_all=True, valid_exitcodes=[0,1])
+#
+#             #fake it in testmode
+#             if dataset.zfs_node.readonly:
+#                 return location
+#
+#             if exit_code==0:
+#                 return location
+#         time.sleep(1)
+#
+#     raise(Exception("Timeout while waiting for {} entry to appear.".format(locations)))
+#
+# def deacitvate_volume_snapshot(dataset):
+#     dataset.inherit("snapdev")
+
+#NOTE: https://www.google.com/search?q=Mount+Path+Limit+freebsd
+#Freebsd has limitations regarding path length, so we cant use the above method.
+#Instead we create a temporary clone
+
+def get_tmp_clone_name(snapshot):
+    pool=snapshot.zfs_node.get_pool(snapshot)
+    return pool.name+"/"+tmp_name()
+
+def activate_volume_snapshot(snapshot):
+    """clone volume, waits and tries to findout /dev path to the volume, in a compatible way. (linux/freebsd/smartos)"""
+
+    clone_name=get_tmp_clone_name(snapshot)
+    clone=snapshot.clone(clone_name)
+
+    #NOTE: add smartos location to this list as well
+    locations=[
+        "/dev/zvol/" + clone_name
+    ]
+
+    clone.debug("Waiting for /dev entry to appear...")
+    time.sleep(0.1)
+
+    start_time=time.time()
+    while time.time()-start_time<10:
+        for location in locations:
+            stdout, stderr, exit_code=clone.zfs_node.run(["test", "-e", location], return_all=True, valid_exitcodes=[0,1])
+
+            #fake it in testmode
+            if clone.zfs_node.readonly:
+                return location
+
+            if exit_code==0:
+                return location
+        time.sleep(1)
+
+    raise(Exception("Timeout while waiting for {} entry to appear.".format(locations)))
+
+def deacitvate_volume_snapshot(snapshot):
+    clone_name=get_tmp_clone_name(snapshot)
+    clone=snapshot.zfs_node.get_dataset(clone_name)
+    clone.destroy()
+
+def verify_volume(source_dataset, source_snapshot, target_dataset, target_snapshot):
+    """compare the contents of two zfs volume snapshots"""
+
+    try:
+        source_dev= activate_volume_snapshot(source_snapshot)
+        target_dev= activate_volume_snapshot(target_snapshot)
+
+        source_hash= hash_dev(source_snapshot.zfs_node, source_dev)
+        target_hash= hash_dev(target_snapshot.zfs_node, target_dev)
+
+        if source_hash!=target_hash:
+            raise Exception("md5hash difference: {} != {}".format(source_hash, target_hash))
+
+    finally:
+        deacitvate_volume_snapshot(source_snapshot)
+        deacitvate_volume_snapshot(target_snapshot)
+
+def create_mountpoints(source_node, target_node):
+
+    # prepare mount points
+    source_node.debug("Create temporary mount point")
+    source_mnt = "/tmp/"+tmp_name("source")
+    source_node.run(["mkdir", source_mnt])
+
+    target_node.debug("Create temporary mount point")
+    target_mnt = "/tmp/"+tmp_name("target")
+    target_node.run(["mkdir", target_mnt])
+
+    return source_mnt, target_mnt
+
+
+def cleanup_mountpoint(node, mnt):
+    node.debug("Cleaning up temporary mount point")
+    node.run([ "rmdir", mnt ], hide_errors=True, valid_exitcodes=[] )
+
+
+class ZfsAutoverify(ZfsAuto):
+    """The zfs-autoverify class, default agruments and stuff come from ZfsAuto"""
+
+    def __init__(self, argv, print_arguments=True):
+
+        # NOTE: common options and parameters are in ZfsAuto
+        super(ZfsAutoverify, self).__init__(argv, print_arguments)
+
+    def parse_args(self, argv):
+        """do extra checks on common args"""
+
+        args=super(ZfsAutoverify, self).parse_args(argv)
+
+        if args.target_path == None:
+            self.log.error("Please specify TARGET-PATH")
+            sys.exit(255)
+
+        return args
+
+    def get_parser(self):
+        """extend common parser with  extra stuff needed for zfs-autobackup"""
+
+        parser=super(ZfsAutoverify, self).get_parser()
+
+        group=parser.add_argument_group("Verify options")
+        group.add_argument('--fs-compare', metavar='METHOD', default="tar", choices=["tar", "rsync"],
+                            help='Compare method to use for filesystems. (tar, rsync) Default: %(default)s ')
+
+        return parser
+
+    def verify_datasets(self, source_mnt, source_datasets, target_node, target_mnt):
+
+        fail_count=0
+        count = 0
+        for source_dataset in source_datasets:
+
+            # stats
+            if self.args.progress:
+                count = count + 1
+                self.progress("Analysing dataset {}/{} ({} failed)".format(count, len(source_datasets), fail_count))
+
+            try:
+                # determine corresponding target_dataset
+                target_name = self.make_target_name(source_dataset)
+                target_dataset = target_node.get_dataset(target_name)
+
+                # find common snapshots to  verify
+                source_snapshot = source_dataset.find_common_snapshot(target_dataset)
+                target_snapshot = target_dataset.find_snapshot(source_snapshot)
+
+                if source_snapshot is None or target_snapshot is None:
+                    raise(Exception("Cant find common snapshot"))
+
+                target_snapshot.verbose("Verifying...")
+
+                if source_dataset.properties['type']=="filesystem":
+                    verify_filesystem(source_snapshot, source_mnt, target_snapshot, target_mnt, self.args.fs_compare)
+                elif source_dataset.properties['type']=="volume":
+                    verify_volume(source_dataset, source_snapshot, target_dataset, target_snapshot)
+                else:
+                    raise(Exception("{} has unknown type {}".format(source_dataset, source_dataset.properties['type'])))
+
+
+            except Exception as e:
+                if self.args.progress:
+                    self.clear_progress()
+
+                fail_count = fail_count + 1
+                target_dataset.error("FAILED: " + str(e))
+                if self.args.debug:
+                    self.verbose("Debug mode, aborting on first error")
+                    raise
+
+        if self.args.progress:
+            self.clear_progress()
+
+        return fail_count
+
+    def run(self):
+
+        source_node=None
+        source_mnt=None
+        target_node=None
+        target_mnt=None
+
+
+        try:
+
+            ################ create source zfsNode
+            self.set_title("Source settings")
+
+            description = "[Source]"
+            source_node = ZfsNode(snapshot_time_format=self.snapshot_time_format, hold_name=self.hold_name, logger=self,
+                                  ssh_config=self.args.ssh_config,
+                                  ssh_to=self.args.ssh_source, readonly=self.args.test,
+                                  debug_output=self.args.debug_output, description=description)
+
+            ################# select source datasets
+            self.set_title("Selecting")
+            source_datasets = source_node.selected_datasets(property_name=self.property_name,
+                                                            exclude_received=self.args.exclude_received,
+                                                            exclude_paths=self.exclude_paths,
+                                                            exclude_unchanged=self.args.exclude_unchanged,
+                                                            min_change=0)
+            if not source_datasets:
+                self.print_error_sources()
+                return 255
+
+            # create target_node
+            self.set_title("Target settings")
+            target_node = ZfsNode(snapshot_time_format=self.snapshot_time_format, hold_name=self.hold_name,
+                                  logger=self, ssh_config=self.args.ssh_config,
+                                  ssh_to=self.args.ssh_target,
+                                  readonly=self.args.test, debug_output=self.args.debug_output,
+                                  description="[Target]")
+            target_node.verbose("Verify datasets under: {}".format(self.args.target_path))
+
+            self.set_title("Verifying")
+
+            source_mnt, target_mnt= create_mountpoints(source_node, target_node)
+
+            fail_count = self.verify_datasets(
+                source_mnt=source_mnt,
+                source_datasets=source_datasets,
+                target_mnt=target_mnt,
+                target_node=target_node)
+
+            if not fail_count:
+                if self.args.test:
+                    self.set_title("All tests successful.")
+                else:
+                    self.set_title("All datasets verified ok")
+
+            else:
+                if fail_count != 255:
+                    self.error("{} dataset(s) failed!".format(fail_count))
+
+            if self.args.test:
+                self.verbose("")
+                self.warning("TEST MODE - DID NOT VERIFY ANYTHING!")
+
+            return fail_count
+
+        except Exception as e:
+            self.error("Exception: " + str(e))
+            if self.args.debug:
+                raise
+            return 255
+        except KeyboardInterrupt:
+            self.error("Aborted")
+            return 255
+        finally:
+
+            # cleanup
+            if source_mnt is not None:
+                cleanup_mountpoint(source_node, source_mnt)
+
+            if target_mnt is not None:
+                cleanup_mountpoint(target_node, target_mnt)
+
+
+
+
+def cli():
+    import sys
+
+    sys.exit(ZfsAutoverify(sys.argv[1:], False).run())
+
+
+if __name__ == "__main__":
+    cli()

zfs_autobackup/ZfsDataset.py

@@ -186,9 +186,9 @@ class ZfsDataset:
         we cache this so everything in the parent that is cached also stays.
         """
         if self.is_snapshot:
-            return ZfsDataset(self.zfs_node, self.filesystem_name)
+            return self.zfs_node.get_dataset(self.filesystem_name)
         else:
-            return ZfsDataset(self.zfs_node, self.rstrip_path(1))
+            return self.zfs_node.get_dataset(self.rstrip_path(1))
 
     # NOTE: unused for now
     # def find_prev_snapshot(self, snapshot, also_other_snapshots=False):
@@ -370,7 +370,7 @@ class ZfsDataset:
         """
         ret = []
         for name in names:
-            ret.append(ZfsDataset(self.zfs_node, name))
+            ret.append(self.zfs_node.get_dataset(name))
 
         return ret
 
@@ -724,7 +724,7 @@ class ZfsDataset:
             matches = re.findall("toname = .*@(.*)", line)
             if matches:
                 snapshot_name = matches[0]
-                snapshot = ZfsDataset(self.zfs_node, self.filesystem_name + "@" + snapshot_name)
+                snapshot = self.zfs_node.get_dataset(self.filesystem_name + "@" + snapshot_name)
                 snapshot.debug("resume token belongs to this snapshot")
                 return snapshot
 
@@ -778,10 +778,6 @@ class ZfsDataset:
             # target has nothing yet
             return None
         else:
-            # snapshot=self.find_snapshot(target_dataset.snapshots[-1].snapshot_name)
-
-            # if not snapshot:
-            # try to common snapshot
             for source_snapshot in reversed(self.snapshots):
                 if target_dataset.find_snapshot(source_snapshot):
                     source_snapshot.debug("common snapshot")
@@ -871,9 +867,7 @@ class ZfsDataset:
         while snapshot:
             # create virtual target snapsho
             # NOTE: with force_exist we're telling the dataset it doesnt exist yet. (e.g. its virtual)
-            virtual_snapshot = ZfsDataset(self.zfs_node,
-                                          self.filesystem_name + "@" + snapshot.snapshot_name,
-                                          force_exists=False)
+            virtual_snapshot = self.zfs_node.get_dataset(self.filesystem_name + "@" + snapshot.snapshot_name, force_exists=False)
             self.snapshots.append(virtual_snapshot)
             snapshot = source_dataset.find_next_snapshot(snapshot, also_other_snapshots)
 
@@ -1103,3 +1097,63 @@ class ZfsDataset:
                     resume_token = None
 
             source_snapshot = self.find_next_snapshot(source_snapshot, also_other_snapshots)
+
+    def mount(self, mount_point):
+
+        self.debug("Mounting")
+
+        cmd = [
+            "mount", "-tzfs", self.name, mount_point
+        ]
+
+        self.zfs_node.run(cmd=cmd, valid_exitcodes=[0])
+
+    def unmount(self):
+
+        self.debug("Unmounting")
+
+        cmd = [
+            "umount", self.name
+        ]
+
+        self.zfs_node.run(cmd=cmd, valid_exitcodes=[0])
+
+    def clone(self, name):
+        """clones this snapshot and returns ZfsDataset of the clone"""
+
+        self.debug("Cloning to {}".format(name))
+
+        cmd = [
+            "zfs", "clone", self.name, name
+        ]
+
+        self.zfs_node.run(cmd=cmd, valid_exitcodes=[0])
+
+        return self.zfs_node.get_dataset(name, force_exists=True)
+
+    def set(self, prop, value):
+        """set a zfs property"""
+
+        self.debug("Setting {}={}".format(prop, value))
+
+        cmd = [
+            "zfs", "set", "{}={}".format(prop, value), self.name
+        ]
+
+        self.zfs_node.run(cmd=cmd, valid_exitcodes=[0])
+
+        self.invalidate()
+
+    def inherit(self, prop):
+        """inherit zfs property"""
+
+        self.debug("Inheriting property {}".format(prop))
+
+        cmd = [
+            "zfs", "inherit", prop, self.name
+        ]
+
+        self.zfs_node.run(cmd=cmd, valid_exitcodes=[0])
+
+        self.invalidate()
+

zfs_autobackup/ZfsNode.py

@@ -48,6 +48,7 @@ class ZfsNode(ExecuteNode):
 
         # list of ZfsPools
         self.__pools = {}
+        self.__datasets = {}
 
         self._progress_total_bytes = 0
         self._progress_start_time = time.time()
@@ -55,6 +56,7 @@ class ZfsNode(ExecuteNode):
         ExecuteNode.__init__(self, ssh_config=ssh_config, ssh_to=ssh_to, readonly=readonly, debug_output=debug_output)
 
     def thin(self, objects, keep_objects):
+        # NOTE: if thinning is disabled with --no-thinning, self.__thinner will be none.
         if self.__thinner is not None:
             return self.__thinner.thin(objects, keep_objects)
         else:
@@ -92,12 +94,20 @@ class ZfsNode(ExecuteNode):
 
         return True
 
-    # TODO: also create a get_zfs_dataset() function that stores all the objects in a dict. This should optimize
-    #  caching a bit and is more consistent.
-    def get_zfs_pool(self, name):
-        """get a ZfsPool() object from specified name. stores objects internally to enable caching"""
+    def get_pool(self, dataset):
+        """get a ZfsPool() object from dataset. stores objects internally to enable caching"""
 
-        return self.__pools.setdefault(name, ZfsPool(self, name))
+        if not isinstance(dataset, ZfsDataset):
+            raise (Exception("{} is not a ZfsDataset".format(dataset)))
+
+        zpool_name = dataset.name.split("/")[0]
+
+        return self.__pools.setdefault(zpool_name, ZfsPool(self, zpool_name))
+
+    def get_dataset(self, name, force_exists=None):
+        """get a ZfsDataset() object from name. stores objects internally to enable caching"""
+
+        return self.__datasets.setdefault(name, ZfsDataset(self, name))
 
     def reset_progress(self):
         """reset progress output counters"""
@@ -178,7 +188,7 @@ class ZfsNode(ExecuteNode):
                 continue
 
             # force_exist, since we're making it
-            snapshot = ZfsDataset(dataset.zfs_node, dataset.name + "@" + snapshot_name, force_exists=True)
+            snapshot = self.get_dataset(dataset.name + "@" + snapshot_name, force_exists=True)
 
             pool = dataset.split_path()[0]
             if pool not in pools:
@@ -238,7 +248,7 @@ class ZfsNode(ExecuteNode):
 
         for line in lines:
             (name, value, raw_source) = line
-            dataset = ZfsDataset(self, name)
+            dataset = self.get_dataset(name, force_exists=True)
 
             # "resolve" inherited sources
             sources[name] = raw_source

zfs_autobackup/__init__.py

@@ -1,9 +1,3 @@
 
 
 
-def cli():
-    import sys
-    from .ZfsAutobackup import ZfsAutobackup
-
-    zfs_autobackup = ZfsAutobackup(sys.argv[1:], False)
-    sys.exit(zfs_autobackup.run())

zfs_autobackup/__main__.py

@@ -4,7 +4,4 @@
 
 import sys
 
-if __name__ == "__main__":
-    from . import cli
-    cli()