update version

Whitespace corrections

.github/workflows/python-publish.yml

@@ -0,0 +1,46 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python 3.x
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Set up Python 2.x
+      uses: actions/setup-python@v2
+      with:
+        python-version: '2.x'
+
+    - name: Install dependencies 3.x
+      run: |
+        python -m pip install --upgrade pip
+        pip3 install setuptools wheel twine
+
+    - name: Install dependencies 2.x
+      run: |
+        python2 -m pip install --upgrade pip
+        pip2 install setuptools wheel twine
+
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+      run: |
+        python3 setup.py sdist bdist_wheel
+        python2 setup.py sdist bdist_wheel
+        twine check dist/*
+        twine upload dist/*

.github/workflows/regression.yml

@@ -0,0 +1,76 @@
+name: Regression tests
+
+
+on: ["push", "pull_request"]
+
+
+
+jobs:
+
+  ubuntu20:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.4
+
+
+
+      - name: Prepare
+        run: sudo apt update && sudo apt install zfsutils-linux && sudo -H pip3 install coverage unittest2 mock==3.0.5 coveralls
+
+
+      - name: Regression test
+        run: sudo -E ./tests/run_tests
+
+
+      - name: Coveralls
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: coveralls --service=github
+
+  ubuntu18:
+    runs-on: ubuntu-18.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.4
+
+
+
+      - name: Prepare
+        run: sudo apt update && sudo apt install zfsutils-linux python3-setuptools && sudo -H pip3 install coverage unittest2 mock==3.0.5 coveralls
+
+
+      - name: Regression test
+        run: sudo -E ./tests/run_tests
+
+
+      - name: Coveralls
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: coveralls --service=github
+
+  ubuntu18_python2:
+    runs-on: ubuntu-18.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.4
+
+      - name: Set up Python 2.x
+        uses: actions/setup-python@v2
+        with:
+          python-version: '2.x'
+
+      - name: Prepare
+        run: sudo apt update && sudo apt install zfsutils-linux python-setuptools && sudo -H pip install coverage unittest2 mock==3.0.5 coveralls
+
+      - name: Regression test
+        run: sudo -E ./tests/run_tests
+
+      - name: Coveralls
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: coveralls --service=github

.gitignore

@@ -0,0 +1,13 @@
+.vscode/settings.json
+token
+tokentest
+dist/
+build/
+zfs_autobackup.egg-info
+.eggs/
+__pycache__
+.coverage
+*.pyc
+python2.env
+venv
+.idea

LICENSE

@@ -1,281 +1,622 @@
                     GNU GENERAL PUBLIC LICENSE
-                       Version 2, June 1991
+                       Version 3, 29 June 2007
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
                             Preamble
 
-  The licenses for most software are designed to take away your
+  The GNU General Public License is a free, copyleft license for
-freedom to share and change it.  By contrast, the GNU General Public
+software and other kinds of works.
-License is intended to guarantee your freedom to share and change free
+
-software--to make sure the software is free for all its users.  This
+  The licenses for most software and other practical works are designed
-General Public License applies to most of the Free Software
+to take away your freedom to share and change the works.  By contrast,
-Foundation's software and to any other program whose authors commit to
+the GNU General Public License is intended to guarantee your freedom to
-using it.  (Some other Free Software Foundation software is covered by
+share and change all versions of a program--to make sure it remains free
-the GNU Lesser General Public License instead.)  You can apply it to
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
 your programs, too.
 
   When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
 have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
+them if you wish), that you receive source code or can get it if you
-if you want it, that you can change the software or use pieces of it
+want it, that you can change the software or use pieces of it in new
-in new free programs; and that you know you can do these things.
+free programs, and that you know you can do these things.
 
-  To protect your rights, we need to make restrictions that forbid
+  To protect your rights, we need to prevent others from denying you
-anyone to deny you these rights or to ask you to surrender the rights.
+these rights or asking you to surrender the rights.  Therefore, you have
-These restrictions translate to certain responsibilities for you if you
+certain responsibilities if you distribute copies of the software, or if
-distribute copies of the software, or if you modify it.
+you modify it: responsibilities to respect the freedom of others.
 
   For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
+gratis or for a fee, you must pass on to the recipients the same
-you have.  You must make sure that they, too, receive or can get the
+freedoms that you received.  You must make sure that they, too, receive
-source code.  And you must show them these terms so they know their
+or can get the source code.  And you must show them these terms so they
-rights.
+know their rights.
 
-  We protect your rights with two steps: (1) copyright the software, and
+  Developers that use the GNU GPL protect your rights with two steps:
-(2) offer you this license which gives you legal permission to copy,
+(1) assert copyright on the software, and (2) offer you this License
-distribute and/or modify the software.
+giving you legal permission to copy, distribute and/or modify it.
 
-  Also, for each author's protection and ours, we want to make certain
+  For the developers' and authors' protection, the GPL clearly explains
-that everyone understands that there is no warranty for this free
+that there is no warranty for this free software.  For both users' and
-software.  If the software is modified by someone else and passed on, we
+authors' sake, the GPL requires that modified versions be marked as
-want its recipients to know that what they have is not the original, so
+changed, so that their problems will not be attributed erroneously to
-that any problems introduced by others will not reflect on the original
+authors of previous versions.
-authors' reputations.
 
-  Finally, any free program is threatened constantly by software
+  Some devices are designed to deny users access to install or run
-patents.  We wish to avoid the danger that redistributors of a free
+modified versions of the software inside them, although the manufacturer
-program will individually obtain patent licenses, in effect making the
+can do so.  This is fundamentally incompatible with the aim of
-program proprietary.  To prevent this, we have made it clear that any
+protecting users' freedom to change the software.  The systematic
-patent must be licensed for everyone's free use or not licensed at all.
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
 
-                    GNU GENERAL PUBLIC LICENSE
+                       TERMS AND CONDITIONS
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
-  0. This License applies to any program or other work which contains
+  0. Definitions.
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License.  The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language.  (Hereinafter, translation is included without limitation in
-the term "modification".)  Each licensee is addressed as "you".
 
-Activities other than copying, distribution and modification are not
+  "This License" refers to version 3 of the GNU General Public License.
-covered by this License; they are outside its scope.  The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
 
-  1. You may copy and distribute verbatim copies of the Program's
+  "Copyright" also means copyright-like laws that apply to other kinds of
-source code as you receive it, in any medium, provided that you
+works, such as semiconductor masks.
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
 
-You may charge a fee for the physical act of transferring a copy, and
+  "The Program" refers to any copyrightable work licensed under this
-you may at your option offer warranty protection in exchange for a fee.
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
 
-  2. You may modify your copy or copies of the Program or any portion
+  To "modify" a work means to copy from or adapt all or part of the work
-of it, thus forming a work based on the Program, and copy and
+in a fashion requiring copyright permission, other than the making of an
-distribute such modifications or work under the terms of Section 1
+exact copy.  The resulting work is called a "modified version" of the
-above, provided that you also meet all of these conditions:
+earlier work or a work "based on" the earlier work.
 
-    a) You must cause the modified files to carry prominent notices
+  A "covered work" means either the unmodified Program or a work based
-    stating that you changed the files and the date of any change.
+on the Program.
 
-    b) You must cause any work that you distribute or publish, that in
+  To "propagate" a work means to do anything with it that, without
-    whole or in part contains or is derived from the Program or any
+permission, would make you directly or secondarily liable for
-    part thereof, to be licensed as a whole at no charge to all third
+infringement under applicable copyright law, except executing it on a
-    parties under the terms of this License.
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
 
-    c) If the modified program normally reads commands interactively
+  To "convey" a work means any kind of propagation that enables other
-    when run, you must cause it, when started running for such
+parties to make or receive copies.  Mere interaction with a user through
-    interactive use in the most ordinary way, to print or display an
+a computer network, with no transfer of a copy, is not conveying.
-    announcement including an appropriate copyright notice and a
-    notice that there is no warranty (or else, saying that you provide
-    a warranty) and that users may redistribute the program under
-    these conditions, and telling the user how to view a copy of this
-    License.  (Exception: if the Program itself is interactive but
-    does not normally print such an announcement, your work based on
-    the Program is not required to print an announcement.)
 
-These requirements apply to the modified work as a whole.  If
+  An interactive user interface displays "Appropriate Legal Notices"
-identifiable sections of that work are not derived from the Program,
+to the extent that it includes a convenient and prominently visible
-and can be reasonably considered independent and separate works in
+feature that (1) displays an appropriate copyright notice, and (2)
-themselves, then this License, and its terms, do not apply to those
+tells the user that there is no warranty for the work (except to the
-sections when you distribute them as separate works.  But when you
+extent that warranties are provided), that licensees may convey the
-distribute the same sections as part of a whole which is a work based
+work under this License, and how to view a copy of this License.  If
-on the Program, the distribution of the whole must be on the terms of
+the interface presents a list of user commands or options, such as a
-this License, whose permissions for other licensees extend to the
+menu, a prominent item in the list meets this criterion.
-entire whole, and thus to each and every part regardless of who wrote it.
 
-Thus, it is not the intent of this section to claim rights or contest
+  1. Source Code.
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
 
-In addition, mere aggregation of another work not based on the Program
+  The "source code" for a work means the preferred form of the work
-with the Program (or with a work based on the Program) on a volume of
+for making modifications to it.  "Object code" means any non-source
-a storage or distribution medium does not bring the other work under
+form of a work.
-the scope of this License.
 
-  3. You may copy and distribute the Program (or a work based on it,
+  A "Standard Interface" means an interface that either is an official
-under Section 2) in object code or executable form under the terms of
+standard defined by a recognized standards body, or, in the case of
-Sections 1 and 2 above provided that you also do one of the following:
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
 
-    a) Accompany it with the complete corresponding machine-readable
+  The "System Libraries" of an executable work include anything, other
-    source code, which must be distributed under the terms of Sections
+than the work as a whole, that (a) is included in the normal form of
-    1 and 2 above on a medium customarily used for software interchange; or,
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
 
-    b) Accompany it with a written offer, valid for at least three
+  The "Corresponding Source" for a work in object code form means all
-    years, to give any third party, for a charge no more than your
+the source code needed to generate, install, and (for an executable
-    cost of physically performing source distribution, a complete
+work) run the object code and to modify the work, including scripts to
-    machine-readable copy of the corresponding source code, to be
+control those activities.  However, it does not include the work's
-    distributed under the terms of Sections 1 and 2 above on a medium
+System Libraries, or general-purpose tools or generally available free
-    customarily used for software interchange; or,
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
 
-    c) Accompany it with the information you received as to the offer
+  The Corresponding Source need not include anything that users
-    to distribute corresponding source code.  (This alternative is
+can regenerate automatically from other parts of the Corresponding
-    allowed only for noncommercial distribution and only if you
+Source.
-    received the program in object code or executable form with such
-    an offer, in accord with Subsection b above.)
 
-The source code for a work means the preferred form of the work for
+  The Corresponding Source for a work in source code form is that
-making modifications to it.  For an executable work, complete source
+same work.
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable.  However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
 
-If distribution of executable or object code is made by offering
+  2. Basic Permissions.
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
 
-  4. You may not copy, modify, sublicense, or distribute the Program
+  All rights granted under this License are granted for the term of
-except as expressly provided under this License.  Any attempt
+copyright on the Program, and are irrevocable provided the stated
-otherwise to copy, modify, sublicense or distribute the Program is
+conditions are met.  This License explicitly affirms your unlimited
-void, and will automatically terminate your rights under this License.
+permission to run the unmodified Program.  The output from running a
-However, parties who have received copies, or rights, from you under
+covered work is covered by this License only if the output, given its
-this License will not have their licenses terminated so long as such
+content, constitutes a covered work.  This License acknowledges your
-parties remain in full compliance.
+rights of fair use or other equivalent, as provided by copyright law.
 
-  5. You are not required to accept this License, since you have not
+  You may make, run and propagate covered works that you do not
-signed it.  However, nothing else grants you permission to modify or
+convey, without conditions so long as your license otherwise remains
-distribute the Program or its derivative works.  These actions are
+in force.  You may convey covered works to others for the sole purpose
-prohibited by law if you do not accept this License.  Therefore, by
+of having them make modifications exclusively for you, or provide you
-modifying or distributing the Program (or any work based on the
+with facilities for running those works, provided that you comply with
-Program), you indicate your acceptance of this License to do so, and
+the terms of this License in conveying all material for which you do
-all its terms and conditions for copying, distributing or modifying
+not control copyright.  Those thus making or running the covered works
-the Program or works based on it.
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
 
-  6. Each time you redistribute the Program (or any work based on the
+  Conveying under any other circumstances is permitted solely under
-Program), the recipient automatically receives a license from the
+the conditions stated below.  Sublicensing is not allowed; section 10
-original licensor to copy, distribute or modify the Program subject to
+makes it unnecessary.
-these terms and conditions.  You may not impose any further
+
-restrictions on the recipients' exercise of the rights granted herein.
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-You are not responsible for enforcing compliance by third parties to
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
 this License.
 
-  7. If, as a consequence of a court judgment or allegation of patent
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
-infringement or for any other reason (not limited to patent issues),
+patent license under the contributor's essential patent claims, to
-conditions are imposed on you (whether by court order, agreement or
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
 otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
+excuse you from the conditions of this License.  If you cannot convey a
-distribute so as to satisfy simultaneously your obligations under this
+covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
+License and any other pertinent obligations, then as a consequence you may
-may not distribute the Program at all.  For example, if a patent
+not convey it at all.  For example, if you agree to terms that obligate you
-license would not permit royalty-free redistribution of the Program by
+to collect a royalty for further conveying from those to whom you convey
-all those who receive copies directly or indirectly through you, then
+the Program, the only way you could satisfy both those terms and this
-the only way you could satisfy both it and this License would be to
+License would be to refrain entirely from conveying the Program.
-refrain entirely from distribution of the Program.
 
-If any portion of this section is held invalid or unenforceable under
+  13. Use with the GNU Affero General Public License.
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
 
-It is not the purpose of this section to induce you to infringe any
+  Notwithstanding any other provision of this License, you have
-patents or other property right claims or to contest validity of any
+permission to link or combine any covered work with a work licensed
-such claims; this section has the sole purpose of protecting the
+under version 3 of the GNU Affero General Public License into a single
-integrity of the free software distribution system, which is
+combined work, and to convey the resulting work.  The terms of this
-implemented by public license practices.  Many people have made
+License will continue to apply to the part which is the covered work,
-generous contributions to the wide range of software distributed
+but the special requirements of the GNU Affero General Public License,
-through that system in reliance on consistent application of that
+section 13, concerning interaction through a network will apply to the
-system; it is up to the author/donor to decide if he or she is willing
+combination as such.
-to distribute software through any other system and a licensee cannot
-impose that choice.
 
-This section is intended to make thoroughly clear what is believed to
+  14. Revised Versions of this License.
-be a consequence of the rest of this License.
 
-  8. If the distribution and/or use of the Program is restricted in
+  The Free Software Foundation may publish revised and/or new versions of
-certain countries either by patents or by copyrighted interfaces, the
+the GNU General Public License from time to time.  Such new versions will
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded.  In such case, this License incorporates
-the limitation as if written in the body of this License.
-
-  9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time.  Such new versions will
 be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
-Each version is given a distinguishing version number.  If the Program
+  Each version is given a distinguishing version number.  If the
-specifies a version number of this License which applies to it and "any
+Program specifies that a certain numbered version of the GNU General
-later version", you have the option of following the terms and conditions
+Public License "or any later version" applies to it, you have the
-either of that version or of any later version published by the Free
+option of following the terms and conditions either of that numbered
-Software Foundation.  If the Program does not specify a version number of
+version or of any later version published by the Free Software
-this License, you may choose any version ever published by the Free Software
+Foundation.  If the Program does not specify a version number of the
-Foundation.
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
 
-  10. If you wish to incorporate parts of the Program into other free
+  If the Program specifies that a proxy can decide which future
-programs whose distribution conditions are different, write to the author
+versions of the GNU General Public License can be used, that proxy's
-to ask for permission.  For software which is copyrighted by the Free
+public statement of acceptance of a version permanently authorizes you
-Software Foundation, write to the Free Software Foundation; we sometimes
+to choose that version for the Program.
-make exceptions for this.  Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
 
-                            NO WARRANTY
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
 
-  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+  15. Disclaimer of Warranty.
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
 
-  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-POSSIBILITY OF SUCH DAMAGES.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
 
                      END OF TERMS AND CONDITIONS
 
@@ -287,15 +628,15 @@ free software which everyone can redistribute and change under these terms.
 
   To do so, attach the following notices to the program.  It is safest
 to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
+state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    {description}
+    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) {year}  {fullname}
+    Copyright (C) <year>  <name of author>
 
-    This program is free software; you can redistribute it and/or modify
+    This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
+    the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
@@ -303,38 +644,31 @@ the "copyright" line and a pointer to where the full notice is found.
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
-    You should have received a copy of the GNU General Public License along
+    You should have received a copy of the GNU General Public License
-    with this program; if not, write to the Free Software Foundation, Inc.,
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 Also add information on how to contact you by electronic and paper mail.
 
-If the program is interactive, make it output a short notice like this
+  If the program does terminal interaction, make it output a short
-when it starts in an interactive mode:
+notice like this when it starts in an interactive mode:
 
-    Gnomovision version 69, Copyright (C) year name of author
+    <program>  Copyright (C) <year>  <name of author>
-    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
 
 The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, the commands you use may
+parts of the General Public License.  Of course, your program's commands
-be called something other than `show w' and `show c'; they could even be
+might be different; for a GUI interface, you would use an "about box".
-mouse-clicks or menu items--whatever suits your program.
 
-You should also get your employer (if you work as a programmer) or your
+  You should also get your employer (if you work as a programmer) or school,
-school, if any, to sign a "copyright disclaimer" for the program, if
+if any, to sign a "copyright disclaimer" for the program, if necessary.
-necessary.  Here is a sample; alter the names:
+For more information on this, and how to apply and follow the GNU GPL, see
-
+<https://www.gnu.org/licenses/>.
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
-  `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
-  {signature of Ty Coon}, 1 April 1989
-  Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs.  If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.
 
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,222 +1,417 @@
+
 # ZFS autobackup
 
-(checkout v3.0-beta for the new cool stuff: https://github.com/psy0rz/zfs_autobackup/blob/v3/README.md)
+[![Tests](https://github.com/psy0rz/zfs_autobackup/workflows/Regression%20tests/badge.svg)](https://github.com/psy0rz/zfs_autobackup/actions?query=workflow%3A%22Regression+tests%22) [![Coverage Status](https://coveralls.io/repos/github/psy0rz/zfs_autobackup/badge.svg)](https://coveralls.io/github/psy0rz/zfs_autobackup)  [![Python Package](https://github.com/psy0rz/zfs_autobackup/workflows/Upload%20Python%20Package/badge.svg)](https://pypi.org/project/zfs-autobackup/)
 
-Official releases: https://github.com/psy0rz/zfs_autobackup/releases
+## Introduction
 
-Introduction
+This is a tool I wrote to make replicating ZFS datasets easy and reliable.
-============
 
-ZFS autobackup is used to periodicly backup ZFS filesystems to other locations. This is done using the very effcient zfs send and receive commands.
+You can either use it as a **backup** tool, **replication** tool or **snapshot** tool.
 
-It has the following features:
+You can select what to backup by setting a custom `ZFS property`. This makes it easy to add/remove specific datasets, or just backup your whole pool.
-* Works across operating systems: Tested with Linux, FreeBSD/FreeNAS and SmartOS.
+
-* Works in combination with existing replication systems. (Like Proxmox HA)
+Other settings are just specified on the commandline: Simply setup and test your zfs-autobackup command and  fix all the issues you might encounter. When you're done you can just copy/paste your command to a cron or script.
+
+Since its using ZFS commands, you can see what its actually doing by specifying `--debug`. This also helps a lot if you run into some strange problem or error. You can just copy-paste the command that fails and play around with it on the commandline. (something I missed in other tools)
+
+An important feature thats missing from other tools is a reliable `--test` option: This allows you to see what zfs-autobackup will do and tune your parameters. It will do everything, except make changes to your system.
+
+zfs-autobackup tries to be the easiest to use backup tool for zfs.
+
+## Features
+
+* 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)
-* Creates consistent snapshots. (takes all snapshots at once, atomic.)
+* 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.
-  * Backup local data on the same server.
+  * 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. (via the zfs extensible_dataset feature)
+* Supports resuming of interrupted transfers. 
-* Backups and snapshots can be named to prevent conflicts. (multiple backups from and to the same filesystems are no problem)
+* Multiple backups from and to the same datasets are no problem.
-* Always creates a new snapshot before starting.
+* 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)
-* Ability to 'finish' aborted backups to see what goes wrong.
+* Ability to manually 'finish' failed backups to see whats going on.
 * Easy to debug and has a test-mode. Actual unix commands are printed.
-* Keeps latest X snapshots remote and locally. (default 30, configurable)
+* Uses **progressive thinning** for older snapshots.
 * Uses zfs-holds on important snapshots so they cant be accidentally destroyed.
+* Automatic resuming of failed transfers.
+* Can continue from existing common snapshots. (e.g. easy migration)
+* Gracefully handles destroyed datasets on source.
 * Easy installation:
-  * Only one host needs the zfs_autobackup script. The other host just needs ssh and the zfs command.
+  * Just install zfs-autobackup via pip, or download it manually.
-  * Written in python and uses zfs-commands, no 3rd party dependency's or libraries.
+  * Written in python and uses zfs-commands, no 3rd party dependency's or libraries needed.
-  * No separate config files or properties. Just one command you can copy/paste in your backup script.
+  * No separate config files or properties. Just one zfs-autobackup command you can copy/paste in your backup script.
 
-Usage
+## Installation
-====
-```
-usage: zfs_autobackup [-h] [--ssh-source SSH_SOURCE] [--ssh-target SSH_TARGET]
-                      [--keep-source KEEP_SOURCE] [--keep-target KEEP_TARGET]
-                      [--no-snapshot] [--no-send] [--allow-empty]
-                      [--ignore-replicated] [--no-holds] [--ignore-new]
-                      [--resume] [--strip-path STRIP_PATH] [--buffer BUFFER]
-                      [--clear-refreservation] [--clear-mountpoint]
-                      [--filter-properties FILTER_PROPERTIES] [--rollback]
-                      [--ignore-transfer-errors] [--test] [--verbose]
-                      [--debug]
-                      backup_name target_path
 
-ZFS autobackup v2.4
+### Using pip
 
-positional arguments:
+The recommended way on most servers is to use [pip](https://pypi.org/project/zfs-autobackup/):
-  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 path
 
-optional arguments:
+```console
-  -h, --help            show this help message and exit
+[root@server ~]# pip install --upgrade zfs-autobackup
-  --ssh-source SSH_SOURCE
-                        Source host to get backup from. (user@hostname)
-                        Default local.
-  --ssh-target SSH_TARGET
-                        Target host to push backup to. (user@hostname) Default
-                        local.
-  --keep-source KEEP_SOURCE
-                        Number of days to keep old snapshots on source.
-                        Default 30.
-  --keep-target KEEP_TARGET
-                        Number of days to keep old snapshots on target.
-                        Default 30.
-  --no-snapshot         dont create new snapshot (usefull for finishing
-                        uncompleted backups, or cleanups)
-  --no-send             dont send snapshots (usefull to only do a cleanup)
-  --allow-empty         if nothing has changed, still create empty snapshots.
-  --ignore-replicated   Ignore datasets that seem to be replicated some other
-                        way. (No changes since lastest snapshot. Usefull for
-                        proxmox HA replication)
-  --no-holds            Dont lock snapshots on the source. (Usefull to allow
-                        proxmox HA replication to switches nodes)
-  --ignore-new          Ignore filesystem if there are already newer snapshots
-                        for it on the target (use with caution)
-  --resume              support resuming of interrupted transfers by using the
-                        zfs extensible_dataset feature (both zpools should
-                        have it enabled) Disadvantage is that you need to use
-                        zfs recv -A if another snapshot is created on the
-                        target during a receive. Otherwise it will keep
-                        failing.
-  --strip-path STRIP_PATH
-                        number of directory to strip from path (use 1 when
-                        cloning zones between 2 SmartOS machines)
-  --buffer BUFFER       Use mbuffer with specified size to speedup zfs
-                        transfer. (e.g. --buffer 1G) Will also show nice
-                        progress output.
-  --clear-refreservation
-                        Set refreservation property to none for new
-                        filesystems. Usefull when backupping SmartOS volumes.
-                        (recommended)
-  --clear-mountpoint    Sets canmount=noauto property, to prevent the received
-                        filesystem from mounting over existing filesystems.
-                        (recommended)
-  --filter-properties FILTER_PROPERTIES
-                        Filter properties when receiving filesystems. Can be
-                        specified multiple times. (Example: If you send data
-                        from Linux to FreeNAS, you should filter xattr)
-  --rollback            Rollback changes on the target before starting a
-                        backup. (normally you can prevent changes by setting
-                        the readonly property on the target_path to on)
-  --ignore-transfer-errors
-                        Ignore transfer errors (still checks if received
-                        filesystem exists. usefull for acltype errors)
-  --test                dont change anything, just show what would be done
-                        (still does all read-only operations)
-  --verbose             verbose output
-  --debug               debug output (shows commands that are executed)
-
-When a filesystem fails, zfs_backup will continue and report the number of
-failures at that end. Also the exit code will indicate the number of failures.
 ```
 
-Backup example
+This can also be used to upgrade zfs-autobackup to the newest stable version.
-==============
 
-In this example we're going to backup a SmartOS machine called `smartos01` to our fileserver called `fs1`.
+### Using easy_install
 
-Its important to choose a unique and consistent backup name. In this case we name our backup: `smartos01_fs1`.
+On older servers you might have to use easy_install
 
-Select filesystems to backup
+```console
-----------------------------
+[root@server ~]# easy_install zfs-autobackup
-
-On the source zfs system set the ```autobackup:smartos01_fs1``` zfs property to true:
 ```
-[root@smartos01 ~]# zfs set autobackup:smartos01_fs1=true zones
+
-[root@smartos01 ~]# zfs get -t filesystem autobackup:smartos01_fs1
+## Example
-NAME                                                PROPERTY                  VALUE                     SOURCE
+
-zones                                               autobackup:smartos01_fs1  true                      local
+In this example we're going to backup a machine called `server1` to a machine called `backup`.
-zones/1eb33958-72c1-11e4-af42-ff0790f603dd          autobackup:smartos01_fs1  true                      inherited from zones
+
-zones/3c71a6cd-6857-407c-880c-09225ce4208e          autobackup:smartos01_fs1  true                      inherited from zones
+### Setup SSH login
-zones/3c905e49-81c0-4a5a-91c3-fc7996f97d47          autobackup:smartos01_fs1  true                      inherited from zones
+
+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
 ...
 ```
 
-Because we dont want to backup everything, we can exclude certain filesystem by setting the property to false:
+Because we don't want to backup everything, we can exclude certain filesystem by setting the property to false:
-```
+
-[root@smartos01 ~]# zfs set autobackup:smartos01_fs1=false zones/backup
+```console
-[root@smartos01 ~]# zfs get -t filesystem autobackup:smartos01_fs1
+[root@server1 ~]# zfs set autobackup:offsite1=false rpool/swap
-NAME                                                PROPERTY                  VALUE                     SOURCE
+[root@server1 ~]# zfs get -t filesystem,volume autobackup:offsite1
-zones                                               autobackup:smartos01_fs1  true                      local
+NAME                                    PROPERTY             VALUE                SOURCE
-zones/1eb33958-72c1-11e4-af42-ff0790f603dd          autobackup:smartos01_fs1  true                      inherited from zones
+rpool                                   autobackup:offsite1  true                 local
-...
+rpool/ROOT                              autobackup:offsite1  true                 inherited from rpool
-zones/backup                                        autobackup:smartos01_fs1  false                     local
+rpool/ROOT/server1-1                    autobackup:offsite1  true                 inherited from rpool
-zones/backup/fs1                                    autobackup:smartos01_fs1  false                     inherited from zones/backup
+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
 ...
 ```
 
+### Running zfs-autobackup
 
-Running zfs_autobackup
+Run the script on the backup server and pull the data from the server specified by --ssh-source.
-----------------------
-There are 2 ways to run the backup, but the endresult is always the same. Its just a matter of security (trust relations between the servers) and preference.
 
-First install the ssh-key on the server that you specify with --ssh-source or --ssh-target.
+```console
+[root@backup ~]# zfs-autobackup --ssh-source server1.server.com offsite1 backup/server1 --progress --verbose
 
-Method 1: Run the script on the backup server and pull the data from the server specfied by --ssh-source. This is usually the preferred way and prevents a hacked server from accesing the backup-data:
+  #### Settings summary
-```
+  [Source] Datasets on: server1.server.com
-root@fs1:/home/psy# ./zfs_autobackup --ssh-source root@1.2.3.4 smartos01_fs1 fs1/zones/backup/zfsbackups/smartos01.server.com --verbose
+  [Source] Keep the last 10 snapshots.
-Getting selected source filesystems for backup smartos01_fs1 on root@1.2.3.4
+  [Source] Keep every 1 day, delete after 1 week.
-Selected: zones (direct selection)
+  [Source] Keep every 1 week, delete after 1 month.
-Selected: zones/1eb33958-72c1-11e4-af42-ff0790f603dd (inherited selection)
+  [Source] Keep every 1 month, delete after 1 year.
-Selected: zones/325dbc5e-2b90-11e3-8a3e-bfdcb1582a8d (inherited selection)
+  [Source] Send all datasets that have 'autobackup:offsite1=true' or 'autobackup:offsite1=child'
-...
+
-Ignoring: zones/backup (disabled)
+  [Target] Datasets are local
-Ignoring: zones/backup/fs1 (disabled)
+  [Target] Keep the last 10 snapshots.
-...
+  [Target] Keep every 1 day, delete after 1 week.
-Creating source snapshot smartos01_fs1-20151030203738 on root@1.2.3.4
+  [Target] Keep every 1 week, delete after 1 month.
-Getting source snapshot-list from root@1.2.3.4
+  [Target] Keep every 1 month, delete after 1 year.
-Getting target snapshot-list from local
+  [Target] Receive datasets under: backup/server1
-Tranferring zones incremental backup between snapshots smartos01_fs1-20151030175345...smartos01_fs1-20151030203738
+
-...
+  #### Selecting
-received 1.09MB stream in 1 seconds (1.09MB/sec)
+  [Source] rpool: Selected (direct selection)
-Destroying old snapshots on source
+  [Source] rpool/ROOT: Selected (inherited selection)
-Destroying old snapshots on target
+  [Source] rpool/ROOT/server1-1: Selected (inherited selection)
-All done
+  [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
+  ...
 ```
 
-Method 2: Run the script on the server and push the data to the backup server specified by --ssh-target:
+Note that this is called a "pull" backup: The backup server pulls the backup from the server. This is usually the preferred way.
-```
-./zfs_autobackup --ssh-target root@2.2.2.2 smartos01_fs1 fs1/zones/backup/zfsbackups/smartos01.server.com --verbose  --compress
-...
-All done
 
+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.)
 ```
 
-Tips
+This also allows you to make several snapshots during the day, but only backup the data at night when the server is not busy.
-====
 
- * Set the ```readonly``` property of the target filesystem to ```on```. This prevents changes on the target side. If there are changes the next backup will fail and will require a zfs rollback. (by using the --rollback option for example)
+## Thinning out obsolete snapshots
- * 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. If this happens on systems like SmartOS or Openindia, svc://filesystem/local wont be able to mount some stuff and you need to resolve these issues on the console.
 
-Speeding up SSH and prevent connection flooding
+The thinner is the thing that destroys old snapshots on the source and target.
------------------------------------------------
 
-Add this to your ~/.ssh/config:
+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)
+
+## 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.
+
+#### 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
 ```
 
-This will make all your ssh connections persistent and greatly speed up zfs_autobackup for jobs with short intervals.
-
 Thanks @mariusvw :)
 
-
+### Specifying ssh port or options
-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
@@ -230,96 +425,239 @@ Also uses compression on slow links.
 
 Look in man ssh_config for many more options.
 
-Troubleshooting
+## Usage
-===============
 
-`cannot receive incremental stream: invalid backup stream`
+Here you find all the options:
 
-This usually means you've created a new snapshot on the target side during a backup.
+```console
- * Solution 1: Restart zfs_autobackup and make sure you dont use --resume. If you did use --resume, be sure to "abort" the recveive on the target side with zfs recv -A.
+[root@server ~]# zfs-autobackup --help
- * Solution 2: Destroy the newly created snapshot and restart zfs_autobackup.
+usage: zfs-autobackup [-h] [--ssh-config SSH_CONFIG] [--ssh-source SSH_SOURCE]
+                      [--ssh-target SSH_TARGET] [--keep-source KEEP_SOURCE]
+                      [--keep-target KEEP_TARGET] [--other-snapshots]
+                      [--no-snapshot] [--no-send] [--min-change MIN_CHANGE]
+                      [--allow-empty] [--ignore-replicated] [--no-holds]
+                      [--strip-path STRIP_PATH] [--clear-refreservation]
+                      [--clear-mountpoint]
+                      [--filter-properties FILTER_PROPERTIES]
+                      [--set-properties SET_PROPERTIES] [--rollback]
+                      [--destroy-incompatible] [--ignore-transfer-errors]
+                      [--raw] [--test] [--verbose] [--debug] [--debug-output]
+                      [--progress]
+                      backup-name [target-path]
 
+zfs-autobackup v3.0-rc12 - Copyright 2020 E.H.Eefting (edwin@datux.nl)
 
-`internal error: Invalid argument`
+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 SSH_CONFIG
+                        Custom ssh client config
+  --ssh-source SSH_SOURCE
+                        Source host to get backup from. (user@hostname)
+                        Default None.
+  --ssh-target SSH_TARGET
+                        Target host to push backup to. (user@hostname) Default
+                        None.
+  --keep-source KEEP_SOURCE
+                        Thinning schedule for old source snapshots. Default:
+                        10,1d1w,1w1m,1m1y
+  --keep-target KEEP_TARGET
+                        Thinning schedule for old target snapshots. Default:
+                        10,1d1w,1w1m,1m1y
+  --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)
+  --min-change MIN_CHANGE
+                        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)
+  --no-holds            Don't lock snapshots on the source. (Useful to allow
+                        proxmox HA replication to switches nodes)
+  --strip-path STRIP_PATH
+                        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 FILTER_PROPERTIES
+                        List of properties to "filter" when receiving
+                        filesystems. (you can still restore them with zfs
+                        inherit -S)
+  --set-properties SET_PROPERTIES
+                        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)
+  --ignore-transfer-errors
+                        Ignore transfer errors (still checks if received
+                        filesystem exists. useful for acltype errors)
+  --raw                 For encrypted datasets, send data exactly as it exists
+                        on disk.
+  --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 (to stderr). Enabled by
+                        default on ttys.
+
+When a filesystem fails, zfs_backup will continue and report the number of
+failures at that end. Also the exit code will indicate the number of failures.
+```
+
+## 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.
+
+Note: This usually happens if the source-side has a non-standard mountpoint for a dataset, and you're using --clear-mountpoint. In this case the target side creates a mountpoint in the parent dataset, causing the change. 
+
+### 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
 
-
+## Restore example
-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
 
-Monitoring with Zabbix-jobs
+You can monitor backups by using my zabbix-jobs script. (<https://github.com/psy0rz/stuff/tree/master/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 exitcode and will also alert you if the job didnt run for more than 2 days.
+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
 
-Backuping up 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.
-==================================================
 
-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)
 
-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 automaticly)
+In the example below we have 3 nodes, named pve1, pve2 and pve3.
 
+### Preparing the proxmox nodes
 
-In the example below we have 3 nodes, named h4, h5 and h6.
+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.
 
-The backup will go to a machine named smartos03.
+TIP: make sure your backup server is firewalled and cannot be reached from any production machine.
 
-Preparing the proxmox nodes
+### SSH config on backup server
----------------------------
 
-On each node select the filesystems as following:
+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:
 ```
-root@h4:~# zfs set autobackup:h4_smartos03=true rpool
+Host *
-root@h4:~# zfs set autobackup:h4_smartos03=false rpool/data
+    ControlPath ~/.ssh/control-master-%r@%h:%p
-root@h4:~# zfs set autobackup:data_smartos03=child rpool/data
+    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
 ```
 
-* rpool will be backuped the usual way, and is named h4_smartos03. (each node will have a unique name)
+### Backup script
-* rpool/data will be excluded from the usual backup
+
-* The CHILDREN of rpool/data be selected for a cluster wide backup named data_smartos03. (each node uses the same backup name)
+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
 
 
-Preparing the backup server
+  echo "################################### DATA $HOST"
----------------------------
 
-Extra options needed for proxmox with HA:
+  # enable backup
-* --no-holds: To allow proxmox to destroy our snapshots if a VM migrates to another node.
+  ssh $HOST "zfs set autobackup:data_$NAME=child rpool/data"
-* --ignore-replicated: To ignore the replicated filesystems of proxmox on the receiving proxmox nodes. (e.g: only backup from the node where the VM is active)
 
+  #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 200000 --no-holds   $@
 
-I use the following backup script on the backup server:
+  zabbix-job-status backup_$HOST""_data_$NAME daily $? >/dev/null 2>/dev/null
-```
-for H in h4 h5 h6; do
-  echo "################################### DATA $H"
-  #backup data filesystems to a common place
-  ./zfs_autobackup --ssh-source root@$H data_smartos03 zones/backup/zfsbackups/pxe1_data --clear-refreservation --clear-mountpoint  --ignore-transfer-errors --strip-path 2 --verbose --resume --ignore-replicated --no-holds $@
-  zabbix-job-status backup_$H""_data_smartos03 daily $? >/dev/null 2>/dev/null
 
-  echo "################################### RPOOL $H"
-  #backup rpool to own place
-  ./zfs_autobackup --ssh-source root@$H $H""_smartos03 zones/backup/zfsbackups/$H --verbose --clear-refreservation --clear-mountpoint  --resume --ignore-transfer-errors $@
-  zabbix-job-status backup_$H""_smartos03 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)
+
+# Sponsor list
+
+This project was sponsorred by:
+
+* (None so far)

requirements.txt

@@ -0,0 +1,6 @@
+colorama
+argparse
+coverage==4.5.4
+python-coveralls
+unittest2
+mock

scripts/release

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -e
+
+
+rm -rf dist
+python3 setup.py sdist bdist_wheel
+# python2 setup.py sdist bdist_wheel
+
+
+gnome-keyring-daemon
+source token
+
+
+python3 -m twine check dist/*
+python3 -m twine upload dist/*
+
+git push --tags

scripts/releasetest

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -e
+
+
+rm -rf dist
+python3 setup.py sdist bdist_wheel
+# python2 setup.py sdist bdist_wheel
+
+
+gnome-keyring-daemon
+source tokentest
+
+
+python3 -m twine check dist/*
+python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose

setup.py

@@ -0,0 +1,37 @@
+import setuptools
+from zfs_autobackup.ZfsAutobackup import ZfsAutobackup
+import os
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="zfs_autobackup",
+    version=ZfsAutobackup.VERSION,
+    author="Edwin Eefting",
+    author_email="edwin@datux.nl",
+    description="ZFS autobackup is used to periodicly backup ZFS filesystems to other locations. It tries to be the most friendly to use and easy to debug ZFS backup tool.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+
+    url="https://github.com/psy0rz/zfs_autobackup",
+    entry_points={
+        'console_scripts':
+            [
+                'zfs-autobackup = zfs_autobackup:cli',
+            ]
+    },
+    packages=setuptools.find_packages(),
+
+    classifiers=[
+        "Programming Language :: Python :: 2",
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=2.7',
+    install_requires=[
+        "colorama",
+        "argparse"
+    ]
+)

tests/basetest.py

@@ -0,0 +1,91 @@
+
+
+import subprocess
+import random
+
+#default test stuff
+import unittest2
+import subprocess
+import time
+from pprint import *
+from zfs_autobackup.ZfsAutobackup import *
+from mock import *
+import contextlib
+import sys
+import io
+
+TEST_POOLS="test_source1 test_source2 test_target1"
+ZFS_USERSPACE=  subprocess.check_output("dpkg-query -W zfsutils-linux |cut -f2", shell=True).decode('utf-8').rstrip()
+ZFS_KERNEL=     subprocess.check_output("modinfo zfs|grep ^version |sed 's/.* //'", shell=True).decode('utf-8').rstrip()
+
+print("###########################################")
+print("#### Unit testing against:")
+print("#### Python                :"+sys.version.replace("\n", " "))
+print("#### ZFS userspace         :"+ZFS_USERSPACE)
+print("#### ZFS kernel            :"+ZFS_KERNEL)
+print("#############################################")
+
+
+
+# for python2 compatibility
+if sys.version_info.major==2:
+    OutputIO=io.BytesIO
+else:
+    OutputIO=io.StringIO
+
+
+# for python2 compatibility (python 3 has this already)
+@contextlib.contextmanager
+def redirect_stdout(target):
+    original = sys.stdout
+    try:
+        sys.stdout = target
+        yield
+    finally:
+        sys.stdout = original
+
+# for python2 compatibility (python 3 has this already)
+@contextlib.contextmanager
+def redirect_stderr(target):
+    original = sys.stderr
+    try:
+        sys.stderr = target
+        yield
+    finally:
+        sys.stderr = original
+
+
+
+def shelltest(cmd):
+    """execute and print result as nice copypastable string for unit tests (adds extra newlines on top/bottom)"""
+    ret=(subprocess.check_output(cmd , shell=True).decode('utf-8'))
+    print("######### result of: {}".format(cmd))
+    print(ret)
+    print("#########")
+    ret='\n'+ret
+    return(ret)
+
+def prepare_zpools():
+    print("Preparing zfs filesystems...")
+
+    #need ram blockdevice
+    subprocess.check_call("modprobe brd rd_size=512000", shell=True)
+
+    #remove old stuff
+    subprocess.call("zpool destroy test_source1 2>/dev/null", shell=True)
+    subprocess.call("zpool destroy test_source2 2>/dev/null", shell=True)
+    subprocess.call("zpool destroy test_target1 2>/dev/null", shell=True)
+
+    #create pools
+    subprocess.check_call("zpool create test_source1 /dev/ram0", shell=True)
+    subprocess.check_call("zpool create test_source2 /dev/ram1", shell=True)
+    subprocess.check_call("zpool create test_target1 /dev/ram2", shell=True)
+
+    #create test structure
+    subprocess.check_call("zfs create -p test_source1/fs1/sub", shell=True)
+    subprocess.check_call("zfs create -p test_source2/fs2/sub", shell=True)
+    subprocess.check_call("zfs create -p test_source2/fs3/sub", shell=True)
+    subprocess.check_call("zfs set autobackup:test=true test_source1/fs1", shell=True)
+    subprocess.check_call("zfs set autobackup:test=child test_source2/fs2", shell=True)
+
+    print("Prepare done")

tests/run_tests

@@ -0,0 +1,28 @@
+#!/bin/bash 
+
+SCRIPTDIR=`dirname $0`
+
+#cd $SCRIPTDIR || exit 1
+
+
+if [ "$USER" != "root" ]; then
+    echo "Need root to do proper zfs testing"
+    exit 1
+fi
+
+
+# test needs ssh access to localhost for testing
+if ! [ -e /root/.ssh/id_rsa ]; then
+    ssh-keygen -t rsa -f /root/.ssh/id_rsa -P '' || exit 1
+    cat /root/.ssh/id_rsa.pub  >> /root/.ssh/authorized_keys || exit 1
+    ssh -oStrictHostKeyChecking=no localhost true || exit 1
+fi
+
+
+coverage run --source zfs_autobackup -m unittest discover -vvvvf $SCRIPTDIR $@ 2>&1
+EXIT=$?
+
+echo
+coverage report
+
+exit $EXIT

tests/test_destroymissing.py

@@ -0,0 +1,135 @@
+
+from basetest import *
+
+
+class TestZfsNode(unittest2.TestCase):
+
+    def setUp(self):
+        prepare_zpools()
+        self.longMessage=True
+
+
+
+    def  test_destroymissing(self):
+
+        #initial backup
+        with patch('time.strftime', return_value="10101111000000"): #1000 years in past
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-holds".split(" ")).run())
+
+        with patch('time.strftime', return_value="20101111000000"): #far in past
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-holds --allow-empty".split(" ")).run())
+
+
+        with self.subTest("Should do nothing yet"):
+            with OutputIO() as buf:
+                with redirect_stdout(buf):
+                    self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-snapshot --destroy-missing 0s".split(" ")).run())
+
+                print(buf.getvalue())
+                self.assertNotIn(": Destroy missing", buf.getvalue())
+
+
+        with self.subTest("missing dataset of us that still has children"):
+
+            #just deselect it so it counts as 'missing'
+            shelltest("zfs set autobackup:test=child test_source1/fs1")
+
+            with OutputIO() as buf:
+                with redirect_stdout(buf), redirect_stderr(buf):
+                        self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-snapshot --destroy-missing 0s".split(" ")).run())
+
+                print(buf.getvalue())
+                #should have done the snapshot cleanup for destoy missing:
+                self.assertIn("fs1@test-10101111000000: Destroying", buf.getvalue())
+
+                self.assertIn("fs1: Destroy missing: Still has children here.", buf.getvalue())
+
+            shelltest("zfs inherit autobackup:test test_source1/fs1")
+
+
+        with self.subTest("Normal destroyed leaf"):
+            shelltest("zfs destroy -r test_source1/fs1/sub")
+
+            #wait for deadline of last snapshot
+            with OutputIO() as buf:
+                with redirect_stdout(buf):
+                    #100y: lastest should not be old enough, while second to latest snapshot IS old enough:
+                    self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-snapshot --destroy-missing 100y".split(" ")).run())
+
+                print(buf.getvalue())
+                self.assertIn(": Waiting for deadline", buf.getvalue())
+
+            #past deadline, destroy
+            with OutputIO() as buf:
+                with redirect_stdout(buf):
+                    self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-snapshot --destroy-missing 1y".split(" ")).run())
+
+                print(buf.getvalue())
+                self.assertIn("sub: Destroying", buf.getvalue())
+
+
+        with self.subTest("Leaf with other snapshot still using it"):
+            shelltest("zfs destroy -r test_source1/fs1")
+            shelltest("zfs snapshot -r test_target1/test_source1/fs1@other1")
+
+
+            with OutputIO() as buf:
+                with redirect_stdout(buf):
+                    self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-snapshot --destroy-missing 0s".split(" ")).run())
+
+                print(buf.getvalue())
+
+                #cant finish because still in use:
+                self.assertIn("fs1: Destroy missing: Still in use", buf.getvalue())
+
+            shelltest("zfs destroy test_target1/test_source1/fs1@other1")
+
+
+        with self.subTest("In use by clone"):
+            shelltest("zfs clone test_target1/test_source1/fs1@test-20101111000000 test_target1/clone1")
+
+            with OutputIO() as buf:
+                with redirect_stdout(buf), redirect_stderr(buf):
+                        self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-snapshot --destroy-missing 0s".split(" ")).run())
+
+                print(buf.getvalue())
+                #now tries to destroy our own last snapshot (before the final destroy of the dataset)
+                self.assertIn("fs1@test-20101111000000: Destroying", buf.getvalue())
+                #but cant finish because still in use:
+                self.assertIn("fs1: Error during destoy missing", buf.getvalue())
+
+            shelltest("zfs destroy test_target1/clone1")
+
+
+        with self.subTest("Should leave test_source1 parent"):
+
+            with OutputIO() as buf:
+                with redirect_stdout(buf), redirect_stderr(buf):
+                        self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-snapshot --destroy-missing 0s".split(" ")).run())
+
+                print(buf.getvalue())
+                #should have done the snapshot cleanup for destoy missing:
+                self.assertIn("fs1: Destroying", buf.getvalue())
+
+            with OutputIO() as buf:
+                with redirect_stdout(buf), redirect_stderr(buf):
+                        self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-snapshot --destroy-missing 0s".split(" ")).run())
+
+                print(buf.getvalue())
+                #on second run it sees the dangling ex-parent but doesnt know what to do with it (since it has no own snapshot)
+                self.assertIn("test_source1: Destroy missing: has no snapshots made by us.", buf.getvalue())
+
+
+
+
+        #end result
+        r=shelltest("zfs list -H -o name -r -t all test_target1")
+        self.assertMultiLineEqual(r,"""
+test_target1
+test_target1/test_source1
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-10101111000000
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")

tests/test_executenode.py

@@ -0,0 +1,135 @@
+from basetest import *
+from zfs_autobackup.ExecuteNode import ExecuteNode
+
+print("THIS TEST REQUIRES SSH TO LOCALHOST")
+
+class TestExecuteNode(unittest2.TestCase):
+
+    # def setUp(self):
+
+    #     return super().setUp()
+
+    def basics(self, node ):
+
+        with self.subTest("simple echo"):
+            self.assertEqual(node.run(["echo","test"]), ["test"])
+
+        with self.subTest("error exit code"):
+            with self.assertRaises(subprocess.CalledProcessError):
+                node.run(["false"])
+
+        #
+        with self.subTest("multiline without tabsplit"):
+            self.assertEqual(node.run(["echo","l1c1\tl1c2\nl2c1\tl2c2"], tab_split=False), ["l1c1\tl1c2", "l2c1\tl2c2"])
+
+        #multiline tabsplit
+        with self.subTest("multiline tabsplit"):
+            self.assertEqual(node.run(["echo","l1c1\tl1c2\nl2c1\tl2c2"], tab_split=True), [['l1c1', 'l1c2'], ['l2c1', 'l2c2']])
+
+        #escaping test (shouldnt be a problem locally, single quotes can be a problem remote via ssh)
+        with self.subTest("escape test"):
+            s="><`'\"@&$()$bla\\/.*!#test _+-={}[]|"
+            self.assertEqual(node.run(["echo",s]), [s])
+
+        #return std err as well, trigger stderr by listing something non existing
+        with self.subTest("stderr return"):
+            (stdout, stderr)=node.run(["ls", "nonexistingfile"], return_stderr=True, valid_exitcodes=[2])
+            self.assertEqual(stdout,[])
+            self.assertRegex(stderr[0],"nonexistingfile")
+
+        #slow command, make sure things dont exit too early
+        with self.subTest("early exit test"):
+            start_time=time.time()
+            self.assertEqual(node.run(["sleep","1"]), [])
+            self.assertGreaterEqual(time.time()-start_time,1)
+
+        #input a string and check it via cat
+        with self.subTest("stdin input string"):
+            self.assertEqual(node.run(["cat"], inp="test"), ["test"])
+
+        #command that wants input, while we dont have input, shouldnt hang forever.
+        with self.subTest("stdin process with inp=None (shouldn't hang)"):
+            self.assertEqual(node.run(["cat"]), [])
+
+    def test_basics_local(self):
+        node=ExecuteNode(debug_output=True)
+        self.basics(node)
+
+    def test_basics_remote(self):
+        node=ExecuteNode(ssh_to="localhost", debug_output=True)
+        self.basics(node)
+
+    ################
+
+    def test_readonly(self):
+        node=ExecuteNode(debug_output=True, readonly=True)
+
+        self.assertEqual(node.run(["echo","test"], readonly=False), None)
+        self.assertEqual(node.run(["echo","test"], readonly=True), ["test"])
+
+
+    ################
+
+    def pipe(self, nodea, nodeb):
+
+        with self.subTest("pipe data"):
+            output=nodea.run(["dd", "if=/dev/zero", "count=1000"], pipe=True)
+            self.assertEqual(nodeb.run(["md5sum"], inp=output), ["816df6f64deba63b029ca19d880ee10a  -"])
+
+        with self.subTest("exit code both ends of pipe ok"):
+            output=nodea.run(["true"], pipe=True)
+            nodeb.run(["true"], inp=output)
+
+        with self.subTest("error on pipe input side"):
+            with self.assertRaises(subprocess.CalledProcessError):
+                output=nodea.run(["false"], pipe=True)
+                nodeb.run(["true"], inp=output)
+
+        with self.subTest("error on pipe output side "):
+            with self.assertRaises(subprocess.CalledProcessError):
+                output=nodea.run(["true"], pipe=True)
+                nodeb.run(["false"], inp=output)
+
+        with self.subTest("error on both sides of pipe"):
+            with self.assertRaises(subprocess.CalledProcessError):
+                output=nodea.run(["false"], pipe=True)
+                nodeb.run(["false"], inp=output)
+
+        with self.subTest("check stderr on pipe output side"):
+            output=nodea.run(["true"], pipe=True)
+            (stdout, stderr)=nodeb.run(["ls", "nonexistingfile"], inp=output, return_stderr=True, valid_exitcodes=[0,2])
+            self.assertEqual(stdout,[])
+            self.assertRegex(stderr[0], "nonexistingfile" )
+
+        with self.subTest("check stderr on pipe input side (should be only printed)"):
+            output=nodea.run(["ls", "nonexistingfile"], pipe=True)
+            (stdout, stderr)=nodeb.run(["true"], inp=output, return_stderr=True, valid_exitcodes=[0,2])
+            self.assertEqual(stdout,[])
+            self.assertEqual(stderr,[] )
+
+
+
+
+    def test_pipe_local_local(self):
+        nodea=ExecuteNode(debug_output=True)
+        nodeb=ExecuteNode(debug_output=True)
+        self.pipe(nodea, nodeb)
+
+    def test_pipe_remote_remote(self):
+        nodea=ExecuteNode(ssh_to="localhost", debug_output=True)
+        nodeb=ExecuteNode(ssh_to="localhost", debug_output=True)
+        self.pipe(nodea, nodeb)
+
+    def test_pipe_local_remote(self):
+        nodea=ExecuteNode(debug_output=True)
+        nodeb=ExecuteNode(ssh_to="localhost", debug_output=True)
+        self.pipe(nodea, nodeb)
+
+    def test_pipe_remote_local(self):
+        nodea=ExecuteNode(ssh_to="localhost", debug_output=True)
+        nodeb=ExecuteNode(debug_output=True)
+        self.pipe(nodea, nodeb)
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/test_externalfailures.py

@@ -0,0 +1,266 @@
+from basetest import *
+
+
+class TestZfsNode(unittest2.TestCase):
+
+    def setUp(self):
+        prepare_zpools()
+        self.longMessage = True
+
+    # generate a resumable state
+    # NOTE: this generates two resumable test_target1/test_source1/fs1 and test_target1/test_source1/fs1/sub
+    def generate_resume(self):
+
+        r = shelltest("zfs set compress=off test_source1 test_target1")
+
+        # big change on source
+        r = shelltest("dd if=/dev/zero of=/test_source1/fs1/data bs=250M count=1")
+
+        # waste space on target
+        r = shelltest("dd if=/dev/zero of=/test_target1/waste bs=250M count=1")
+
+        # should fail and leave resume token (if supported)
+        self.assertTrue(ZfsAutobackup("test test_target1 --verbose".split(" ")).run())
+
+        # free up space
+        r = shelltest("rm /test_target1/waste")
+        # sync
+        r = shelltest("zfs umount test_target1")
+        r = shelltest("zfs mount test_target1")
+
+    # resume initial backup
+    def test_initial_resume(self):
+
+        # inital backup, leaves resume token
+        with patch('time.strftime', return_value="20101111000000"):
+            self.generate_resume()
+
+        # --test should resume and succeed
+        with OutputIO() as buf:
+            with redirect_stdout(buf):
+                self.assertFalse(ZfsAutobackup("test test_target1 --verbose --test".split(" ")).run())
+
+            print(buf.getvalue())
+
+            # did we really resume?
+            if "0.6.5" in ZFS_USERSPACE:
+                # abort this late, for beter coverage
+                self.skipTest("Resume not supported in this ZFS userspace version")
+            else:
+                self.assertIn(": resuming", buf.getvalue())
+
+        # should resume and succeed
+        with OutputIO() as buf:
+            with redirect_stdout(buf):
+                self.assertFalse(ZfsAutobackup("test test_target1 --verbose".split(" ")).run())
+
+            print(buf.getvalue())
+
+            # did we really resume?
+            if "0.6.5" in ZFS_USERSPACE:
+                # abort this late, for beter coverage
+                self.skipTest("Resume not supported in this ZFS userspace version")
+            else:
+                self.assertIn(": resuming", buf.getvalue())
+
+        r = shelltest("zfs list -H -o name -r -t all test_target1")
+        self.assertMultiLineEqual(r, """
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+    # resume incremental backup
+    def test_incremental_resume(self):
+
+        # initial backup
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty".split(" ")).run())
+
+        # incremental backup leaves resume token
+        with patch('time.strftime', return_value="20101111000001"):
+            self.generate_resume()
+
+        # --test should resume and succeed
+        with OutputIO() as buf:
+            with redirect_stdout(buf):
+                self.assertFalse(ZfsAutobackup("test test_target1 --verbose --test".split(" ")).run())
+
+            print(buf.getvalue())
+
+            # did we really resume?
+            if "0.6.5" in ZFS_USERSPACE:
+                # abort this late, for beter coverage
+                self.skipTest("Resume not supported in this ZFS userspace version")
+            else:
+                self.assertIn(": resuming", buf.getvalue())
+
+        # should resume and succeed
+        with OutputIO() as buf:
+            with redirect_stdout(buf):
+                self.assertFalse(ZfsAutobackup("test test_target1 --verbose".split(" ")).run())
+
+            print(buf.getvalue())
+
+            # did we really resume?
+            if "0.6.5" in ZFS_USERSPACE:
+                # abort this late, for beter coverage
+                self.skipTest("Resume not supported in this ZFS userspace version")
+            else:
+                self.assertIn(": resuming", buf.getvalue())
+
+        r = shelltest("zfs list -H -o name -r -t all test_target1")
+        self.assertMultiLineEqual(r, """
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1@test-20101111000001
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+    # generate an invalid resume token, and verify if its aborted automaticly
+    def test_initial_resumeabort(self):
+
+        if "0.6.5" in ZFS_USERSPACE:
+            self.skipTest("Resume not supported in this ZFS userspace version")
+
+        # inital backup, leaves resume token
+        with patch('time.strftime', return_value="20101111000000"):
+            self.generate_resume()
+
+        # remove corresponding source snapshot, so it becomes invalid
+        shelltest("zfs destroy test_source1/fs1@test-20101111000000")
+
+        # NOTE: it can only abort the initial dataset if it has no subs
+        shelltest("zfs destroy test_target1/test_source1/fs1/sub; true")
+
+        # --test try again, should abort old resume
+        with patch('time.strftime', return_value="20101111000001"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --test".split(" ")).run())
+
+        # try again, should abort old resume
+        with patch('time.strftime', return_value="20101111000001"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose".split(" ")).run())
+
+        r = shelltest("zfs list -H -o name -r -t all test_target1")
+        self.assertMultiLineEqual(r, """
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000001
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+    # generate an invalid resume token, and verify if its aborted automaticly
+    def test_incremental_resumeabort(self):
+
+        if "0.6.5" in ZFS_USERSPACE:
+            self.skipTest("Resume not supported in this ZFS userspace version")
+
+        # initial backup
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty".split(" ")).run())
+
+        # icremental backup, leaves resume token
+        with patch('time.strftime', return_value="20101111000001"):
+            self.generate_resume()
+
+        # remove corresponding source snapshot, so it becomes invalid
+        shelltest("zfs destroy test_source1/fs1@test-20101111000001")
+
+        # --test try again, should abort old resume
+        with patch('time.strftime', return_value="20101111000002"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --test".split(" ")).run())
+
+        # try again, should abort old resume
+        with patch('time.strftime', return_value="20101111000002"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose".split(" ")).run())
+
+        r = shelltest("zfs list -H -o name -r -t all test_target1")
+        self.assertMultiLineEqual(r, """
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1@test-20101111000002
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+    # create a resume situation, where the other side doesnt want the snapshot anymore ( should abort resume )
+    def test_abort_unwanted_resume(self):
+
+        if "0.6.5" in ZFS_USERSPACE:
+            self.skipTest("Resume not supported in this ZFS userspace version")
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose".split(" ")).run())
+
+        # generate resume
+        with patch('time.strftime', return_value="20101111000001"):
+            self.generate_resume()
+
+        with OutputIO() as buf:
+            with redirect_stdout(buf):
+                # incremental, doesnt want previous anymore
+                with patch('time.strftime', return_value="20101111000002"):
+                    self.assertFalse(ZfsAutobackup(
+                        "test test_target1 --verbose --keep-target=0 --debug --allow-empty".split(" ")).run())
+
+            print(buf.getvalue())
+
+            self.assertIn(": aborting resume, since", buf.getvalue())
+
+        r = shelltest("zfs list -H -o name -r -t all test_target1")
+        self.assertMultiLineEqual(r, """
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000002
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000002
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000002
+""")
+
+    def test_missing_common(self):
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty".split(" ")).run())
+
+        # remove common snapshot and leave nothing
+        shelltest("zfs release zfs_autobackup:test test_source1/fs1@test-20101111000000")
+        shelltest("zfs destroy test_source1/fs1@test-20101111000000")
+
+        with patch('time.strftime', return_value="20101111000001"):
+            self.assertTrue(ZfsAutobackup("test test_target1 --verbose --allow-empty".split(" ")).run())
+
+    ############# TODO:
+    def test_ignoretransfererrors(self):
+
+        self.skipTest(
+            "todo: create some kind of situation where zfs recv exits with an error but transfer is still ok (happens in practice with acltype)")

tests/test_regressions.py

@@ -0,0 +1,19 @@
+
+from basetest import *
+
+
+class TestZfsNode(unittest2.TestCase):
+
+    def setUp(self):
+        prepare_zpools()
+        self.longMessage=True
+
+    # #resume initial backup
+    # def test_keepsource0(self):
+
+    #     #somehow only specifying --allow-empty --keep-source 0 failed:
+    #     with patch('time.strftime', return_value="20101111000000"):
+    #         self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty --keep-source 0".split(" ")).run())
+
+    #     with patch('time.strftime', return_value="20101111000001"):
+    #         self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty --keep-source 0".split(" ")).run())

tests/test_scaling.py

@@ -0,0 +1,95 @@
+from basetest import *
+
+from zfs_autobackup.ExecuteNode import ExecuteNode
+
+run_orig=ExecuteNode.run
+run_counter=0
+
+def run_count(*args, **kwargs):
+    global run_counter
+    run_counter=run_counter+1
+    return (run_orig(*args, **kwargs))
+
+class TestZfsScaling(unittest2.TestCase):
+
+    def setUp(self):
+        prepare_zpools()
+        self.longMessage = True
+
+    def test_manysnapshots(self):
+        """count the number of commands when there are many snapshots."""
+
+        snapshot_count=100
+
+        print("Creating many snapshots...")
+        s=""
+        for i in range(1970,1970+snapshot_count):
+            s=s+"zfs snapshot test_source1/fs1@test-{:04}1111000000;".format(i)
+
+        shelltest(s)
+
+        global run_counter
+
+        run_counter=0
+        with patch.object(ExecuteNode,'run', run_count) as p:
+
+            with patch('time.strftime', return_value="20101112000000"):
+                self.assertFalse(ZfsAutobackup("test test_target1 --verbose --keep-source=10000 --keep-target=10000 --no-holds --allow-empty".split(" ")).run())
+
+
+            #this triggers if you make a change with an impact of more than O(snapshot_count/2)
+            expected_runs=343
+            print("ACTUAL RUNS: {}".format(run_counter))
+            self.assertLess(abs(run_counter-expected_runs), snapshot_count/2)
+
+
+        run_counter=0
+        with patch.object(ExecuteNode,'run', run_count) as p:
+
+            with patch('time.strftime', return_value="20101112000001"):
+                self.assertFalse(ZfsAutobackup("test test_target1 --verbose --keep-source=10000 --keep-target=10000 --no-holds --allow-empty".split(" ")).run())
+
+
+            #this triggers if you make a change with a performance impact of more than O(snapshot_count/2)
+            expected_runs=47
+            print("ACTUAL RUNS: {}".format(run_counter))
+            self.assertLess(abs(run_counter-expected_runs), snapshot_count/2)
+
+    def test_manydatasets(self):
+        """count the number of commands when when there are many datasets"""
+
+        dataset_count=100
+
+        print("Creating many datasets...")
+        s=""
+        for i in range(0,dataset_count):
+            s=s+"zfs create test_source1/fs1/{};".format(i)
+
+        shelltest(s)
+
+        global run_counter
+
+        run_counter=0
+        with patch.object(ExecuteNode,'run', run_count) as p:
+
+            with patch('time.strftime', return_value="20101112000000"):
+                self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-holds --allow-empty".split(" ")).run())
+
+
+            #this triggers if you make a change with an impact of more than O(snapshot_count/2)
+            expected_runs=743
+            print("ACTUAL RUNS: {}".format(run_counter))
+            self.assertLess(abs(run_counter-expected_runs), dataset_count/2)
+
+
+        run_counter=0
+        with patch.object(ExecuteNode,'run', run_count) as p:
+
+            with patch('time.strftime', return_value="20101112000001"):
+                self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-holds --allow-empty".split(" ")).run())
+
+
+            #this triggers if you make a change with a performance impact of more than O(snapshot_count/2)
+            expected_runs=947
+            print("ACTUAL RUNS: {}".format(run_counter))
+            self.assertLess(abs(run_counter-expected_runs), dataset_count/2)

tests/test_thinner.py

@@ -0,0 +1,142 @@
+from basetest import *
+import pprint
+
+from zfs_autobackup.Thinner import Thinner
+
+#randint is different in python 2 vs 3
+randint_compat = lambda lo, hi: lo + int(random.random() * (hi + 1 - lo))
+
+
+class Thing:
+    def __init__(self, timestamp):
+        self.timestamp=timestamp
+
+    def __str__(self):
+        # age=now-self.timestamp
+        struct=time.gmtime(self.timestamp)
+        return("{}".format(time.strftime("%Y-%m-%d %H:%M:%S",struct)))
+
+
+class TestThinner(unittest2.TestCase):
+
+    # def setUp(self):
+
+        # return super().setUp()
+
+    def test_incremental(self):
+        ok=['2023-01-03 10:53:16',
+            '2024-01-02 15:43:29',
+            '2025-01-01 06:15:32',
+            '2026-01-01 02:48:23',
+            '2026-04-07 20:07:36',
+            '2026-05-07 02:30:29',
+            '2026-06-06 01:19:46',
+            '2026-07-06 06:38:09',
+            '2026-08-05 05:08:53',
+            '2026-09-04 03:33:04',
+            '2026-10-04 05:27:09',
+            '2026-11-04 04:01:17',
+            '2026-12-03 13:49:56',
+            '2027-01-01 17:02:00',
+            '2027-01-03 04:26:42',
+            '2027-02-01 14:16:02',
+            '2027-02-12 03:31:02',
+            '2027-02-18 00:33:10',
+            '2027-02-26 21:09:54',
+            '2027-03-02 08:05:18',
+            '2027-03-03 16:46:09',
+            '2027-03-04 06:39:14',
+            '2027-03-06 03:35:41',
+            '2027-03-08 12:24:42',
+            '2027-03-08 20:34:57']
+
+
+
+
+        #some arbitrary date
+        now=1589229252
+        #we want deterministic results
+        random.seed(1337)
+        thinner=Thinner("5,10s1min,1d1w,1w1m,1m12m,1y5y")
+        things=[]
+
+        #thin incrementally while adding
+        for i in range(0,5000):
+
+            #increase random amount of time and maybe add a thing
+            now=now+randint_compat(0,3600*24)
+            if random.random()>=0.5:
+                things.append(Thing(now))
+
+            (keeps, removes)=thinner.thin(things, now=now)
+            things=keeps
+
+
+        result=[]
+        for thing in things:
+            result.append(str(thing))
+
+        print("Thinner result incremental:")
+        pprint.pprint(result)
+
+        self.assertEqual(result, ok)
+
+
+    def test_full(self):
+        ok=['2022-03-09 01:56:23',
+            '2023-01-03 10:53:16',
+            '2024-01-02 15:43:29',
+            '2025-01-01 06:15:32',
+            '2026-01-01 02:48:23',
+            '2026-03-14 09:08:04',
+            '2026-04-07 20:07:36',
+            '2026-05-07 02:30:29',
+            '2026-06-06 01:19:46',
+            '2026-07-06 06:38:09',
+            '2026-08-05 05:08:53',
+            '2026-09-04 03:33:04',
+            '2026-10-04 05:27:09',
+            '2026-11-04 04:01:17',
+            '2026-12-03 13:49:56',
+            '2027-01-01 17:02:00',
+            '2027-01-03 04:26:42',
+            '2027-02-01 14:16:02',
+            '2027-02-08 02:41:14',
+            '2027-02-12 03:31:02',
+            '2027-02-18 00:33:10',
+            '2027-02-26 21:09:54',
+            '2027-03-02 08:05:18',
+            '2027-03-03 16:46:09',
+            '2027-03-04 06:39:14',
+            '2027-03-06 03:35:41',
+            '2027-03-08 12:24:42',
+            '2027-03-08 20:34:57']
+
+        #some arbitrary date
+        now=1589229252
+        #we want deterministic results
+        random.seed(1337)
+        thinner=Thinner("5,10s1min,1d1w,1w1m,1m12m,1y5y")
+        things=[]
+
+        for i in range(0,5000):
+
+            #increase random amount of time and maybe add a thing
+            now=now+randint_compat(0,3600*24)
+            if random.random()>=0.5:
+                things.append(Thing(now))
+
+        (things, removes)=thinner.thin(things, now=now)
+
+        result=[]
+        for thing in things:
+            result.append(str(thing))
+
+        print("Thinner result full:")
+        pprint.pprint(result)
+
+        self.assertEqual(result, ok)
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/test_zfsautobackup.py

@@ -0,0 +1,850 @@
+from basetest import *
+import time
+
+
+
+class TestZfsAutobackup(unittest2.TestCase):
+
+    def setUp(self):
+        prepare_zpools()
+        self.longMessage=True
+
+    def test_invalidpars(self):
+
+        self.assertEqual(ZfsAutobackup("test test_target1 --keep-source -1".split(" ")).run(), 255)
+
+    def  test_snapshotmode(self):
+        """test snapshot tool mode"""
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test --verbose".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
+""")
+
+
+
+    def  test_defaults(self):
+
+        with self.subTest("no datasets selected"):
+            with OutputIO() as buf:
+                with redirect_stderr(buf):
+                    with patch('time.strftime', return_value="20101111000000"):
+                        self.assertTrue(ZfsAutobackup("nonexisting test_target1 --verbose --debug".split(" ")).run())
+
+                print(buf.getvalue())
+                #correct message?
+                self.assertIn("No source filesystems selected", buf.getvalue())
+
+
+        with self.subTest("defaults with full verbose and debug"):
+
+            with patch('time.strftime', return_value="20101111000000"):
+                self.assertFalse(ZfsAutobackup("test test_target1 --verbose --debug".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/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+        with self.subTest("bare defaults, allow empty"):
+            with patch('time.strftime', return_value="20101111000001"):
+                self.assertFalse(ZfsAutobackup("test test_target1 --allow-empty".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@test-20101111000001
+test_source1/fs1/sub
+test_source1/fs1/sub@test-20101111000000
+test_source1/fs1/sub@test-20101111000001
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-20101111000000
+test_source2/fs2/sub@test-20101111000001
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1@test-20101111000001
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source1/fs1/sub@test-20101111000001
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+test_target1/test_source2/fs2/sub@test-20101111000001
+""")
+
+        with self.subTest("verify holds"):
+
+            r=shelltest("zfs get -r userrefs test_source1 test_source2 test_target1")
+            self.assertMultiLineEqual(r,"""
+NAME                                                   PROPERTY  VALUE     SOURCE
+test_source1                                           userrefs  -         -
+test_source1/fs1                                       userrefs  -         -
+test_source1/fs1@test-20101111000000                   userrefs  0         -
+test_source1/fs1@test-20101111000001                   userrefs  1         -
+test_source1/fs1/sub                                   userrefs  -         -
+test_source1/fs1/sub@test-20101111000000               userrefs  0         -
+test_source1/fs1/sub@test-20101111000001               userrefs  1         -
+test_source2                                           userrefs  -         -
+test_source2/fs2                                       userrefs  -         -
+test_source2/fs2/sub                                   userrefs  -         -
+test_source2/fs2/sub@test-20101111000000               userrefs  0         -
+test_source2/fs2/sub@test-20101111000001               userrefs  1         -
+test_source2/fs3                                       userrefs  -         -
+test_source2/fs3/sub                                   userrefs  -         -
+test_target1                                           userrefs  -         -
+test_target1/test_source1                              userrefs  -         -
+test_target1/test_source1/fs1                          userrefs  -         -
+test_target1/test_source1/fs1@test-20101111000000      userrefs  0         -
+test_target1/test_source1/fs1@test-20101111000001      userrefs  1         -
+test_target1/test_source1/fs1/sub                      userrefs  -         -
+test_target1/test_source1/fs1/sub@test-20101111000000  userrefs  0         -
+test_target1/test_source1/fs1/sub@test-20101111000001  userrefs  1         -
+test_target1/test_source2                              userrefs  -         -
+test_target1/test_source2/fs2                          userrefs  -         -
+test_target1/test_source2/fs2/sub                      userrefs  -         -
+test_target1/test_source2/fs2/sub@test-20101111000000  userrefs  0         -
+test_target1/test_source2/fs2/sub@test-20101111000001  userrefs  1         -
+""")
+
+        #make sure time handling is correctly. try to make snapshots a year appart and verify that only snapshots mostly 1y old are kept
+        with self.subTest("test time checking"):
+            with patch('time.strftime', return_value="20111111000000"):
+                self.assertFalse(ZfsAutobackup("test test_target1 --allow-empty --verbose".split(" ")).run())
+
+
+            time_str="20111112000000" #month in the "future"
+            future_timestamp=time_secs=time.mktime(time.strptime(time_str,"%Y%m%d%H%M%S"))
+            with patch('time.time', return_value=future_timestamp):
+                with patch('time.strftime', return_value="20111111000001"):
+                    self.assertFalse(ZfsAutobackup("test test_target1 --allow-empty --verbose --keep-source 1y1y --keep-target 1d1y".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-20111111000000
+test_source1/fs1@test-20111111000001
+test_source1/fs1/sub
+test_source1/fs1/sub@test-20111111000000
+test_source1/fs1/sub@test-20111111000001
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-20111111000000
+test_source2/fs2/sub@test-20111111000001
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20111111000000
+test_target1/test_source1/fs1@test-20111111000001
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20111111000000
+test_target1/test_source1/fs1/sub@test-20111111000001
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20111111000000
+test_target1/test_source2/fs2/sub@test-20111111000001
+""")
+
+
+    def  test_ignore_othersnaphots(self):
+
+        r=shelltest("zfs snapshot test_source1/fs1@othersimple")
+        r=shelltest("zfs snapshot test_source1/fs1@otherdate-20001111000000")
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose".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@othersimple
+test_source1/fs1@otherdate-20001111000000
+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/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+    def  test_othersnaphots(self):
+
+        r=shelltest("zfs snapshot test_source1/fs1@othersimple")
+        r=shelltest("zfs snapshot test_source1/fs1@otherdate-20001111000000")
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --other-snapshots".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@othersimple
+test_source1/fs1@otherdate-20001111000000
+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/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@othersimple
+test_target1/test_source1/fs1@otherdate-20001111000000
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+
+    def  test_nosnapshot(self):
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-snapshot".split(" ")).run())
+
+            r=shelltest("zfs list -H -o name -r -t all "+TEST_POOLS)
+            #(only parents are created )
+            #TODO: it probably shouldn't create these
+            self.assertMultiLineEqual(r,"""
+test_source1
+test_source1/fs1
+test_source1/fs1/sub
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+test_target1/test_source1
+test_target1/test_source2
+test_target1/test_source2/fs2
+""")
+
+
+    def  test_nosend(self):
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-send".split(" ")).run())
+
+            r=shelltest("zfs list -H -o name -r -t all "+TEST_POOLS)
+            #(only parents are created )
+            #TODO: it probably shouldn't create these
+            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
+""")
+
+
+    def  test_ignorereplicated(self):
+        r=shelltest("zfs snapshot test_source1/fs1@otherreplication")
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --ignore-replicated".split(" ")).run())
+
+            r=shelltest("zfs list -H -o name -r -t all "+TEST_POOLS)
+            #(only parents are created )
+            #TODO: it probably shouldn't create these
+            self.assertMultiLineEqual(r,"""
+test_source1
+test_source1/fs1
+test_source1/fs1@otherreplication
+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/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+    def  test_noholds(self):
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --no-holds".split(" ")).run())
+
+            r=shelltest("zfs get -r userrefs test_source1 test_source2 test_target1")
+            self.assertMultiLineEqual(r,"""
+NAME                                                   PROPERTY  VALUE     SOURCE
+test_source1                                           userrefs  -         -
+test_source1/fs1                                       userrefs  -         -
+test_source1/fs1@test-20101111000000                   userrefs  0         -
+test_source1/fs1/sub                                   userrefs  -         -
+test_source1/fs1/sub@test-20101111000000               userrefs  0         -
+test_source2                                           userrefs  -         -
+test_source2/fs2                                       userrefs  -         -
+test_source2/fs2/sub                                   userrefs  -         -
+test_source2/fs2/sub@test-20101111000000               userrefs  0         -
+test_source2/fs3                                       userrefs  -         -
+test_source2/fs3/sub                                   userrefs  -         -
+test_target1                                           userrefs  -         -
+test_target1/test_source1                              userrefs  -         -
+test_target1/test_source1/fs1                          userrefs  -         -
+test_target1/test_source1/fs1@test-20101111000000      userrefs  0         -
+test_target1/test_source1/fs1/sub                      userrefs  -         -
+test_target1/test_source1/fs1/sub@test-20101111000000  userrefs  0         -
+test_target1/test_source2                              userrefs  -         -
+test_target1/test_source2/fs2                          userrefs  -         -
+test_target1/test_source2/fs2/sub                      userrefs  -         -
+test_target1/test_source2/fs2/sub@test-20101111000000  userrefs  0         -
+""")
+
+
+    def  test_strippath(self):
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --strip-path=1".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):
+
+        #on zfs utils 0.6.x -x isnt supported
+        r=shelltest("zfs recv -x bla test >/dev/null </dev/zero; echo $?")
+        if r=="\n2\n":
+            self.skipTest("This zfs-userspace version doesnt support -x")
+
+        r=shelltest("zfs set refreservation=1M test_source1/fs1")
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --clear-refreservation".split(" ")).run())
+
+            r=shelltest("zfs get refreservation -r test_source1 test_source2 test_target1")
+            self.assertMultiLineEqual(r,"""
+NAME                                                   PROPERTY        VALUE      SOURCE
+test_source1                                           refreservation  none       default
+test_source1/fs1                                       refreservation  1M         local
+test_source1/fs1@test-20101111000000                   refreservation  -          -
+test_source1/fs1/sub                                   refreservation  none       default
+test_source1/fs1/sub@test-20101111000000               refreservation  -          -
+test_source2                                           refreservation  none       default
+test_source2/fs2                                       refreservation  none       default
+test_source2/fs2/sub                                   refreservation  none       default
+test_source2/fs2/sub@test-20101111000000               refreservation  -          -
+test_source2/fs3                                       refreservation  none       default
+test_source2/fs3/sub                                   refreservation  none       default
+test_target1                                           refreservation  none       default
+test_target1/test_source1                              refreservation  none       default
+test_target1/test_source1/fs1                          refreservation  none       default
+test_target1/test_source1/fs1@test-20101111000000      refreservation  -          -
+test_target1/test_source1/fs1/sub                      refreservation  none       default
+test_target1/test_source1/fs1/sub@test-20101111000000  refreservation  -          -
+test_target1/test_source2                              refreservation  none       default
+test_target1/test_source2/fs2                          refreservation  none       default
+test_target1/test_source2/fs2/sub                      refreservation  none       default
+test_target1/test_source2/fs2/sub@test-20101111000000  refreservation  -          -
+""")
+
+
+    def  test_clearmount(self):
+
+        #on zfs utils 0.6.x -o isnt supported
+        r=shelltest("zfs recv -o bla=1 test >/dev/null </dev/zero; echo $?")
+        if r=="\n2\n":
+            self.skipTest("This zfs-userspace version doesnt support -o")
+
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --clear-mountpoint --debug".split(" ")).run())
+
+            r=shelltest("zfs get canmount -r test_source1 test_source2 test_target1")
+            self.assertMultiLineEqual(r,"""
+NAME                                                   PROPERTY  VALUE     SOURCE
+test_source1                                           canmount  on        default
+test_source1/fs1                                       canmount  on        default
+test_source1/fs1@test-20101111000000                   canmount  -         -
+test_source1/fs1/sub                                   canmount  on        default
+test_source1/fs1/sub@test-20101111000000               canmount  -         -
+test_source2                                           canmount  on        default
+test_source2/fs2                                       canmount  on        default
+test_source2/fs2/sub                                   canmount  on        default
+test_source2/fs2/sub@test-20101111000000               canmount  -         -
+test_source2/fs3                                       canmount  on        default
+test_source2/fs3/sub                                   canmount  on        default
+test_target1                                           canmount  on        default
+test_target1/test_source1                              canmount  on        default
+test_target1/test_source1/fs1                          canmount  noauto    local
+test_target1/test_source1/fs1@test-20101111000000      canmount  -         -
+test_target1/test_source1/fs1/sub                      canmount  noauto    local
+test_target1/test_source1/fs1/sub@test-20101111000000  canmount  -         -
+test_target1/test_source2                              canmount  on        default
+test_target1/test_source2/fs2                          canmount  on        default
+test_target1/test_source2/fs2/sub                      canmount  noauto    local
+test_target1/test_source2/fs2/sub@test-20101111000000  canmount  -         -
+""")
+
+
+    def  test_rollback(self):
+
+        #initial backup
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose".split(" ")).run())
+
+        #make change
+        r=shelltest("zfs mount test_target1/test_source1/fs1")
+        r=shelltest("touch /test_target1/test_source1/fs1/change.txt")
+
+        with patch('time.strftime', return_value="20101111000001"):
+            #should fail (busy)
+            self.assertTrue(ZfsAutobackup("test test_target1 --verbose --allow-empty".split(" ")).run())
+
+        with patch('time.strftime', return_value="20101111000002"):
+            #rollback, should succeed
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty --rollback".split(" ")).run())
+
+
+    def  test_destroyincompat(self):
+
+        #initial backup
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose".split(" ")).run())
+
+        #add multiple compatible snapshot (written is still 0)
+        r=shelltest("zfs snapshot test_target1/test_source1/fs1@compatible1")
+        r=shelltest("zfs snapshot test_target1/test_source1/fs1@compatible2")
+
+        with patch('time.strftime', return_value="20101111000001"):
+            #should be ok, is compatible
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty".split(" ")).run())
+
+        #add incompatible snapshot by changing and snapshotting
+        r=shelltest("zfs mount test_target1/test_source1/fs1")
+        r=shelltest("touch /test_target1/test_source1/fs1/change.txt")
+        r=shelltest("zfs snapshot test_target1/test_source1/fs1@incompatible1")
+
+
+        with patch('time.strftime', return_value="20101111000002"):
+            #--test should fail, now incompatible
+            self.assertTrue(ZfsAutobackup("test test_target1 --verbose --allow-empty --test".split(" ")).run())
+
+        with patch('time.strftime', return_value="20101111000002"):
+            #should fail, now incompatible
+            self.assertTrue(ZfsAutobackup("test test_target1 --verbose --allow-empty".split(" ")).run())
+
+        with patch('time.strftime', return_value="20101111000003"):
+            #--test should succeed by destroying incompatibles
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty --destroy-incompatible --test".split(" ")).run())
+
+        with patch('time.strftime', return_value="20101111000003"):
+            #should succeed by destroying incompatibles
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty --destroy-incompatible".split(" ")).run())
+
+
+
+
+
+
+
+    def test_ssh(self):
+
+        #test all ssh directions
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty --ssh-source localhost".split(" ")).run())
+
+        with patch('time.strftime', return_value="20101111000001"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty --ssh-target localhost".split(" ")).run())
+
+        with patch('time.strftime', return_value="20101111000002"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --allow-empty --ssh-source localhost --ssh-target localhost".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@test-20101111000001
+test_source1/fs1@test-20101111000002
+test_source1/fs1/sub
+test_source1/fs1/sub@test-20101111000000
+test_source1/fs1/sub@test-20101111000001
+test_source1/fs1/sub@test-20101111000002
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-20101111000000
+test_source2/fs2/sub@test-20101111000001
+test_source2/fs2/sub@test-20101111000002
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1@test-20101111000001
+test_target1/test_source1/fs1@test-20101111000002
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source1/fs1/sub@test-20101111000001
+test_target1/test_source1/fs1/sub@test-20101111000002
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+test_target1/test_source2/fs2/sub@test-20101111000001
+test_target1/test_source2/fs2/sub@test-20101111000002
+""")
+
+
+    def  test_minchange(self):
+
+        #initial
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --min-change 100000".split(" ")).run())
+
+        #make small change, use umount to reflect the changes immediately
+        r=shelltest("zfs set compress=off test_source1")
+        r=shelltest("touch /test_source1/fs1/change.txt")
+        r=shelltest("zfs umount test_source1/fs1; zfs mount test_source1/fs1")
+
+
+        #too small change, takes no snapshots
+        with patch('time.strftime', return_value="20101111000001"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --min-change 100000".split(" ")).run())
+
+        #make big change
+        r=shelltest("dd if=/dev/zero of=/test_source1/fs1/change.txt bs=200000 count=1")
+        r=shelltest("zfs umount test_source1/fs1; zfs mount test_source1/fs1")
+
+        #bigger change, should take snapshot
+        with patch('time.strftime', return_value="20101111000002"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --min-change 100000".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@test-20101111000002
+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/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1@test-20101111000002
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+    def  test_test(self):
+
+        #initial
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --test".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/sub
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+""")
+
+        #actual make initial backup
+        with patch('time.strftime', return_value="20101111000001"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose".split(" ")).run())
+
+
+        #test incremental
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --test".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-20101111000001
+test_source1/fs1/sub
+test_source1/fs1/sub@test-20101111000001
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-20101111000001
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000001
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000001
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000001
+""")
+
+
+    def test_migrate(self):
+        """test migration from other snapshotting systems. zfs-autobackup should be able to continue from any common snapshot, not just its own."""
+
+        shelltest("zfs snapshot test_source1/fs1@migrate1")
+        shelltest("zfs create test_target1/test_source1")
+        shelltest("zfs send  test_source1/fs1@migrate1| zfs recv test_target1/test_source1/fs1")
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose".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@migrate1
+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/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@migrate1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+    def test_keep0(self):
+        """test if keep-source=0 and keep-target=0 dont delete common snapshot and break backup"""
+
+        with patch('time.strftime', return_value="20101111000000"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --keep-source=0 --keep-target=0".split(" ")).run())
+
+        #make snapshot, shouldnt delete 0
+        with patch('time.strftime', return_value="20101111000001"):
+            self.assertFalse(ZfsAutobackup("test --verbose --keep-source=0 --keep-target=0 --allow-empty".split(" ")).run())
+
+        #make snapshot 2, shouldnt delete 0 since it has holds, but will delete 1 since it has no holds
+        with patch('time.strftime', return_value="20101111000002"):
+            self.assertFalse(ZfsAutobackup("test --verbose --keep-source=0 --keep-target=0 --allow-empty".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@test-20101111000002
+test_source1/fs1/sub
+test_source1/fs1/sub@test-20101111000000
+test_source1/fs1/sub@test-20101111000002
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-20101111000000
+test_source2/fs2/sub@test-20101111000002
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000000
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000000
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000000
+""")
+
+        #make another backup but with no-holds. we should naturally endup with only number 3
+        with patch('time.strftime', return_value="20101111000003"):
+            self.assertFalse(ZfsAutobackup("test test_target1 --verbose --keep-source=0 --keep-target=0 --no-holds --allow-empty".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-20101111000003
+test_source1/fs1/sub
+test_source1/fs1/sub@test-20101111000003
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-20101111000003
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000003
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000003
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000003
+""")
+
+
+        # make snapshot 4, since we used no-holds, it will delete 3 on the source, breaking the backup
+        with patch('time.strftime', return_value="20101111000004"):
+            self.assertFalse(ZfsAutobackup("test --verbose --keep-source=0 --keep-target=0 --allow-empty".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-20101111000004
+test_source1/fs1/sub
+test_source1/fs1/sub@test-20101111000004
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-20101111000004
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+test_target1/test_source1
+test_target1/test_source1/fs1
+test_target1/test_source1/fs1@test-20101111000003
+test_target1/test_source1/fs1/sub
+test_target1/test_source1/fs1/sub@test-20101111000003
+test_target1/test_source2
+test_target1/test_source2/fs2
+test_target1/test_source2/fs2/sub
+test_target1/test_source2/fs2/sub@test-20101111000003
+""")
+
+    ###########################
+# TODO:
+
+    def  test_raw(self):
+
+        self.skipTest("todo: later when travis supports zfs 0.8")

tests/test_zfsnode.py

@@ -0,0 +1,125 @@
+from basetest import *
+from zfs_autobackup.LogStub import LogStub
+
+
+
+class TestZfsNode(unittest2.TestCase):
+
+    def setUp(self):
+        prepare_zpools()
+        # return super().setUp()
+
+
+    def test_consistent_snapshot(self):
+        logger=LogStub()
+        description="[Source]"
+        node=ZfsNode("test", logger, description=description)
+
+        with self.subTest("first snapshot"):
+            node.consistent_snapshot(node.selected_datasets, "test-1",100000)
+            r=shelltest("zfs list -H -o name -r -t all "+TEST_POOLS)
+            self.assertEqual(r,"""
+test_source1
+test_source1/fs1
+test_source1/fs1@test-1
+test_source1/fs1/sub
+test_source1/fs1/sub@test-1
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-1
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+""")
+
+
+        with self.subTest("second snapshot, no changes, no snapshot"):
+            node.consistent_snapshot(node.selected_datasets, "test-2",1)
+            r=shelltest("zfs list -H -o name -r -t all "+TEST_POOLS)
+            self.assertEqual(r,"""
+test_source1
+test_source1/fs1
+test_source1/fs1@test-1
+test_source1/fs1/sub
+test_source1/fs1/sub@test-1
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-1
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+""")
+
+        with self.subTest("second snapshot, no changes, empty snapshot"):
+            node.consistent_snapshot(node.selected_datasets, "test-2",0)
+            r=shelltest("zfs list -H -o name -r -t all "+TEST_POOLS)
+            self.assertEqual(r,"""
+test_source1
+test_source1/fs1
+test_source1/fs1@test-1
+test_source1/fs1@test-2
+test_source1/fs1/sub
+test_source1/fs1/sub@test-1
+test_source1/fs1/sub@test-2
+test_source2
+test_source2/fs2
+test_source2/fs2/sub
+test_source2/fs2/sub@test-1
+test_source2/fs2/sub@test-2
+test_source2/fs3
+test_source2/fs3/sub
+test_target1
+""")
+
+
+    def test_getselected(self):
+        logger=LogStub()
+        description="[Source]"
+        node=ZfsNode("test", logger, description=description)
+        s=pformat(node.selected_datasets)
+        print(s)
+
+        #basics
+        self.assertEqual (s, """[(local): test_source1/fs1,
+ (local): test_source1/fs1/sub,
+ (local): test_source2/fs2/sub]""")
+
+        #caching, so expect same result after changing it
+        subprocess.check_call("zfs set autobackup:test=true test_source2/fs3", shell=True)
+        self.assertEqual (s, """[(local): test_source1/fs1,
+ (local): test_source1/fs1/sub,
+ (local): test_source2/fs2/sub]""")
+
+
+    def test_validcommand(self):
+        logger=LogStub()
+        description="[Source]"
+        node=ZfsNode("test", logger, description=description)
+
+
+        with self.subTest("test invalid option"):
+            self.assertFalse(node.valid_command(["zfs", "send", "--invalid-option", "nonexisting"]))
+        with self.subTest("test valid option"):
+            self.assertTrue(node.valid_command(["zfs", "send", "-v", "nonexisting"]))
+
+    def test_supportedsendoptions(self):
+        logger=LogStub()
+        description="[Source]"
+        node=ZfsNode("test", logger, description=description)
+        # -D propably always supported
+        self.assertGreater(len(node.supported_send_options),0)
+
+
+    def test_supportedrecvoptions(self):
+        logger=LogStub()
+        description="[Source]"
+        #NOTE: this couldnt hang via ssh if we dont close filehandles properly. (which was a previous bug)
+        node=ZfsNode("test", logger, description=description, ssh_to='localhost')
+        self.assertIsInstance(node.supported_recv_options, list)
+
+
+
+if __name__ == '__main__':
+    unittest.main()

zfs_autobackup

@@ -1,828 +0,0 @@
-#!/usr/bin/env python2
-# -*- coding: utf8 -*-
-
-#(C)edwin@datux.nl -- Edwin Eefting
-#Release under GPL.
-
-from __future__ import print_function
-import os
-import sys
-import re
-import traceback
-import subprocess
-import pprint
-import time
-
-
-def error(txt):
-    print(txt, file=sys.stderr)
-
-def verbose(txt):
-    if args.verbose:
-        print(txt)
-
-def debug(txt):
-    if args.debug:
-        print(txt)
-
-#fatal abort execution, exit code 255
-def abort(txt):
-    error(txt)
-    sys.exit(255)
-
-
-
-"""run a command. specifiy ssh user@host to run remotely"""
-def run(cmd, input=None, ssh_to="local", tab_split=False, valid_exitcodes=[ 0 ], test=False):
-
-    encoded_cmd=[]
-
-
-    #use ssh?
-    if ssh_to != "local":
-        encoded_cmd.extend(["ssh", ssh_to])
-
-
-        #make sure the command gets all the data in utf8 format:
-        #(this is neccesary if LC_ALL=en_US.utf8 is not set in the environment)
-        for arg in cmd:
-            #add single quotes for remote commands to support spaces and other wierd stuff (remote commands are executed in a shell)
-            encoded_cmd.append( ("'"+arg+"'").encode('utf-8'))
-
-    else:
-        for arg in cmd:
-            encoded_cmd.append(arg.encode('utf-8'))
-
-
-    #the accurate way of displaying it whould be: print encoded_cmd
-    #However, we use the more human-readable way, but this is not always properly escaped!
-    #(most of the time it should be copypastable however.)
-    debug_txt="# "+" ".join(encoded_cmd)
-
-    if test:
-        debug("[TEST] "+debug_txt)
-    else:
-        debug(debug_txt)
-
-    if input:
-        debug("INPUT:\n"+input.rstrip())
-        stdin=subprocess.PIPE
-    else:
-        stdin=None
-
-    if test:
-        return
-
-    p=subprocess.Popen(encoded_cmd, env=os.environ, stdout=subprocess.PIPE, stdin=stdin)
-    output=p.communicate(input=input)[0]
-    if p.returncode not in valid_exitcodes:
-        raise(subprocess.CalledProcessError(p.returncode, encoded_cmd))
-
-    lines=output.splitlines()
-    if not tab_split:
-        return(lines)
-    else:
-        ret=[]
-        for line in lines:
-            ret.append(line.split("\t"))
-        return(ret)
-
-
-"""determine filesystems that should be backupped by looking at the special autobackup-property"""
-def zfs_get_selected_filesystems(ssh_to, backup_name):
-    #get all source filesystems that have the backup property
-    source_filesystems=run(ssh_to=ssh_to, tab_split=True, cmd=[
-        "zfs", "get", "-t",  "volume,filesystem", "-o", "name,value,source", "-s", "local,inherited", "-H", "autobackup:"+backup_name
-    ])
-
-    #determine filesystems that should be actually backupped
-    selected_filesystems=[]
-    direct_filesystems=[]
-    for source_filesystem in source_filesystems:
-        (name,value,source)=source_filesystem
-        if value=="false":
-            verbose("* Ignored : {0} (disabled)".format(name))
-
-        else:
-            if source=="local" and ( value=="true" or value=="child"):
-                direct_filesystems.append(name)
-
-            if source=="local" and value=="true":
-                selected_filesystems.append(name)
-                verbose("* Selected: {0} (direct selection)".format(name))
-            elif source.find("inherited from ")==0 and (value=="true" or value=="child"):
-                inherited_from=re.sub("^inherited from ", "", source)
-                if inherited_from in direct_filesystems:
-                    selected_filesystems.append(name)
-                    verbose("* Selected: {0} (inherited selection)".format(name))
-                else:
-                    verbose("* Ignored : {0} (already a backup)".format(name))
-            else:
-                verbose("* Ignored : {0} (only childs)".format(name))
-
-    return(selected_filesystems)
-
-
-"""determine filesystems that can be resumed via receive_resume_token"""
-def zfs_get_resumable_filesystems(ssh_to, filesystems):
-
-    cmd=[ "zfs", "get", "-t",  "volume,filesystem", "-o", "name,value", "-H", "receive_resume_token" ]
-    cmd.extend(filesystems)
-
-    resumable_filesystems=run(ssh_to=ssh_to, tab_split=True, cmd=cmd, valid_exitcodes= [ 0,1 ] )
-
-    ret={}
-
-    for (resumable_filesystem,token) in resumable_filesystems:
-        if token!='-':
-            ret[resumable_filesystem]=token
-
-    return(ret)
-
-
-"""deferred destroy list of snapshots (in @format). """
-def zfs_destroy_snapshots(ssh_to, snapshots):
-
-    #zfs can only destroy one filesystem at once so we use xargs and stdin
-    run(ssh_to=ssh_to, test=args.test, input="\0".join(snapshots), cmd=
-        [ "xargs", "-0", "-n", "1", "zfs", "destroy", "-d" ]
-    )
-
-"""destroy list of filesystems """
-def zfs_destroy(ssh_to, filesystems, recursive=False):
-
-    cmd=[ "xargs", "-0", "-n", "1", "zfs", "destroy" ]
-
-    if recursive:
-        cmd.append("-r")
-
-    #zfs can only destroy one filesystem at once so we use xargs and stdin
-    run(ssh_to=ssh_to, test=args.test, input="\0".join(filesystems), cmd=cmd)
-
-#simulate snapshots for --test option
-test_snapshots={}
-
-
-
-"""create snapshot on multiple filesystems at once (atomicly per pool)"""
-def zfs_create_snapshot(ssh_to, filesystems, snapshot):
-
-
-    #collect per pool, zfs can only take atomic snapshots per pool
-    pools={}
-    for filesystem in filesystems:
-        pool=filesystem.split('/')[0]
-        if pool not in pools:
-            pools[pool]=[]
-        pools[pool].append(filesystem)
-
-    for pool in pools:
-        cmd=[ "zfs", "snapshot" ]
-        for filesystem in pools[pool]:
-            cmd.append(filesystem+"@"+snapshot)
-
-            #in testmode we dont actually make changes, so keep them in a list to simulate
-            # if args.test:
-            #     if not ssh_to in test_snapshots:
-            #         test_snapshots[ssh_to]={}
-            #     if not filesystem in test_snapshots[ssh_to]:
-            #         test_snapshots[ssh_to][filesystem]=[]
-            #     test_snapshots[ssh_to][filesystem].append(snapshot)
-
-        run(ssh_to=ssh_to, tab_split=False, cmd=cmd, test=args.test)
-
-
-"""get names of all snapshots for specified filesystems belonging to backup_name
-
-return[filesystem_name]=[ "snashot1", "snapshot2", ... ]
-"""
-def zfs_get_snapshots(ssh_to, filesystems, backup_name):
-
-    ret={}
-
-    if filesystems:
-        cmd=[
-            "zfs", "list", "-d", "1", "-r", "-t" ,"snapshot", "-H", "-o", "name"
-        ]
-        cmd.extend(filesystems)
-
-        snapshots=run(ssh_to=ssh_to, tab_split=False, cmd=cmd, valid_exitcodes=[ 0 ])
-
-
-        for snapshot in snapshots:
-            (filesystem, snapshot_name)=snapshot.split("@")
-            if re.match("^"+backup_name+"-[0-9]*$", snapshot_name):
-                if not filesystem in ret:
-                    ret[filesystem]=[]
-                ret[filesystem].append(snapshot_name)
-
-        #also add any test-snapshots that where created with --test mode
-        # if args.test:
-        #     if ssh_to in test_snapshots:
-        #         for filesystem in filesystems:
-        #             if filesystem in test_snapshots[ssh_to]:
-        #                 if not filesystem in ret:
-        #                     ret[filesystem]=[]
-        #                 ret[filesystem].extend(test_snapshots[ssh_to][filesystem])
-
-    return(ret)
-
-
-def default_tag():
-    return("zfs_autobackup:"+args.backup_name)
-
-"""hold a snapshot so it cant be destroyed accidently by admin or other processes"""
-def zfs_hold_snapshot(ssh_to, snapshot, tag=None):
-    cmd=[
-        "zfs", "hold", tag or default_tag(), snapshot
-    ]
-
-    run(ssh_to=ssh_to, test=args.test, tab_split=False, cmd=cmd, valid_exitcodes=[ 0, 1 ])
-
-
-"""release a snapshot"""
-def zfs_release_snapshot(ssh_to, snapshot, tag=None):
-    cmd=[
-        "zfs", "release", tag or default_tag(), snapshot
-    ]
-
-    run(ssh_to=ssh_to, test=args.test, tab_split=False, cmd=cmd, valid_exitcodes=[ 0, 1 ])
-
-
-
-"""transfer a zfs snapshot from source to target. both can be either local or via ssh.
-
-
-TODO:
-
-(parially implemented, local buffer is a bit more annoying to do)
-
-buffering: specify buffer_size to use mbuffer (or alike) to apply buffering where neccesary
-
-local to local:
-local send -> local buffer -> local receive
-
-local to remote and remote to local:
-local send -> local buffer -> ssh -> remote buffer -> remote receive
-remote send -> remote buffer -> ssh -> local buffer -> local receive
-
-remote to remote:
-remote send -> remote buffer -> ssh -> local buffer -> ssh -> remote buffer -> remote receive
-
-
-
-
-"""
-def zfs_transfer(ssh_source, source_filesystem, first_snapshot, second_snapshot,
-                 ssh_target, target_filesystem, resume_token=None, buffer_size=None):
-
-    #### build source command
-    source_cmd=[]
-
-    if ssh_source != "local":
-        source_cmd.extend([ "ssh", ssh_source ])
-
-    source_cmd.extend(["zfs", "send",  ])
-
-    #all kind of performance options:
-    source_cmd.append("-L") # large block support
-    source_cmd.append("-e") # WRITE_EMBEDDED, more compact stream
-    source_cmd.append("-c") # use compressed WRITE records
-    if not args.resume:
-        source_cmd.append("-D") # dedupped stream, sends less duplicate data
-
-
-
-    #only verbose in debug mode, lots of output
-    if args.debug :
-        source_cmd.append("-v")
-
-
-    if not first_snapshot:
-        txt=">>> Transfer: "+source_filesystem+"@"+second_snapshot
-    else:
-        txt=">>> Transfer: "+source_filesystem+"@"+first_snapshot+"...@"+second_snapshot
-
-    if resume_token:
-        source_cmd.extend([ "-t", resume_token ])
-        txt=txt+" [RESUMED]"
-
-    else:
-        source_cmd.append("-p")
-
-        if first_snapshot:
-            source_cmd.extend([ "-i", first_snapshot ])
-
-        if ssh_source != "local":
-            source_cmd.append("'" + source_filesystem + "@" + second_snapshot + "'")
-        else:
-            source_cmd.append(source_filesystem + "@" + second_snapshot)
-
-    verbose(txt)
-
-    if args.buffer and args.ssh_source!="local":
-        source_cmd.append("|mbuffer -m {}".format(args.buffer))
-
-
-    #### build target command
-    target_cmd=[]
-
-    if ssh_target != "local":
-        target_cmd.extend([ "ssh", ssh_target ])
-
-    target_cmd.extend(["zfs", "recv", "-u" ])
-
-    # filter certain properties on receive (usefull for linux->freebsd in some cases)
-    if args.filter_properties:
-        for filter_property in args.filter_properties:
-            target_cmd.extend([ "-x" , filter_property ])
-
-    if args.debug:
-        target_cmd.append("-v")
-
-    if args.resume:
-        target_cmd.append("-s")
-
-
-    if ssh_target!="local":
-        target_cmd.append("'" + target_filesystem + "'")
-    else:
-        target_cmd.append(target_filesystem)
-
-    if args.buffer and  args.ssh_target!="local":
-        target_cmd.append("|mbuffer -m {}".format(args.buffer))
-
-
-    #### make sure parent on target exists
-    parent_filesystem= "/".join(target_filesystem.split("/")[:-1])
-    run(ssh_to=ssh_target, cmd=[ "zfs", "create" ,"-p", parent_filesystem ], test=args.test)
-
-    ### execute pipe
-    debug_txt="# "+source_cmd[0]+" '"+("' '".join(source_cmd[1:]))+"'" + " | " + target_cmd[0]+" '"+("' '".join(target_cmd[1:]))+"'"
-
-    if args.test:
-        debug("[TEST] "+debug_txt)
-        return
-    else:
-        debug(debug_txt)
-
-    source_proc=subprocess.Popen(source_cmd, env=os.environ, stdout=subprocess.PIPE)
-    target_proc=subprocess.Popen(target_cmd, env=os.environ, stdin=source_proc.stdout)
-    source_proc.stdout.close() # Allow p1 to receive a SIGPIPE if p2 exits.
-    target_proc.communicate()
-
-    if not args.ignore_transfer_errors:
-        if source_proc.returncode:
-            raise(subprocess.CalledProcessError(source_proc.returncode, source_cmd))
-
-        #zfs recv sometimes gives an exitcode 1 while the transfer was succesfull, therefore we ignore exit 1's and do an extra check to see if the snapshot is there.
-        if target_proc.returncode and target_proc.returncode!=1:
-            raise(subprocess.CalledProcessError(target_proc.returncode, target_cmd))
-
-    debug("Verifying if snapshot exists on target")
-    run(ssh_to=ssh_target, cmd=["zfs", "list", target_filesystem+"@"+second_snapshot ])
-
-
-
-#NOTE: unreliable when using with autobackup:bla=child
-# """get filesystems that where already backupped to a target. """
-# def zfs_get_backupped_filesystems(ssh_to, backup_name, target_path):
-#     #get all target filesystems that have received or inherited the backup propert, under the target_path tree
-#     ret=run(ssh_to=ssh_to, tab_split=False, valid_exitcodes=[ 0,1 ], cmd=[
-#         "zfs", "get", "-r", "-t",  "volume,filesystem", "-o", "name", "-s", "received,inherited", "-H", "autobackup:"+backup_name, target_path
-#     ])
-#
-#     return(ret)
-
-"""get existing filesystems """
-def zfs_get_existing_filesystems(ssh_to, target_path):
-    #get all target filesystems that have received or inherited the backup propert, under the target_path tree
-    ret=run(ssh_to=ssh_to, tab_split=False, valid_exitcodes=[ 0,1 ], cmd=[
-        "zfs", "list", "-r", "-t",  "volume,filesystem", "-o", "name", "-H", target_path
-    ])
-
-    return(ret)
-
-
-"""get filesystems that where once backupped to target but are no longer selected on source
-
-these are filesystems that are not in the list in target_filesystems.
-
-this happens when filesystems are destroyed or unselected on the source.
-"""
-def get_stale_backupped_filesystems(backup_name, target_path, target_filesystems, existing_target_filesystems):
-
-
-
-    #determine backupped filesystems that are not in target_filesystems anymore
-    stale_backupped_filesystems=[]
-    for existing_target_filesystem in existing_target_filesystems:
-        if existing_target_filesystem not in target_filesystems:
-            stale_backupped_filesystems.append(existing_target_filesystem)
-
-    return(stale_backupped_filesystems)
-
-
-now=time.time()
-"""determine list of snapshot (in @format) to destroy, according to age"""
-def determine_destroy_list(snapshots, days):
-    ret=[]
-    for filesystem in snapshots:
-        for snapshot in snapshots[filesystem]:
-            time_str=re.findall("^.*-([0-9]*)$", snapshot)[0]
-            if len(time_str)==14:
-                #new format:
-                time_secs=time.mktime(time.strptime(time_str,"%Y%m%d%H%M%S"))
-            else:
-                time_secs=int(time_str)
-                # verbose("time_secs"+time_str)
-            if (now-time_secs) > (24 * 3600 * days):
-                ret.append(filesystem+"@"+snapshot)
-
-    return(ret)
-
-
-def lstrip_path(path, count):
-    return("/".join(path.split("/")[count:]))
-
-
-"""get list of filesystems that are changed, compared to specified latest snapshot. """
-def zfs_get_unchanged_snapshots(ssh_to, snapshots):
-
-    ret=[]
-    for ( filesystem, snapshot_list ) in snapshots.items():
-        latest_snapshot=snapshot_list[-1]
-
-        cmd=[ "zfs", "get","-H" ,"-ovalue", "written@"+latest_snapshot, filesystem ]
-
-
-        output=run(ssh_to=ssh_to, tab_split=False, cmd=cmd, valid_exitcodes=[ 0 ])
-
-        if output[0]=="0B" or output[0]=="0":
-            ret.append(filesystem)
-
-    return(ret)
-
-"""get filesytems that are have changed since any snapshot."""
-def zfs_get_unchanged_filesystems(ssh_to, filesystems):
-
-    ret=[]
-    cmd=[ "zfs", "get","-H" ,"-oname,value", "written" ]
-    cmd.extend(filesystems)
-    output=run(ssh_to=ssh_to, tab_split=True, cmd=cmd, valid_exitcodes=[ 0 ])
-
-    for ( filesystem , written ) in output:
-        if written=="0B" or written=="0":
-            ret.append(filesystem)
-
-    return(ret)
-
-
-
-#fugly..
-failures=0
-#something failed, but we try to continue with the rest
-def failed(txt):
-    global failures
-    failures=failures+1
-    error("FAILURE: "+txt+"\n")
-
-
-def zfs_autobackup():
-
-    ############## data gathering section
-
-    if args.test:
-        args.verbose=True
-        verbose("RUNNING IN TEST-MODE, NOT MAKING ACTUAL BACKUP!")
-
-
-    ### getting and determinging source/target filesystems
-
-    # get selected filesystems on backup source
-    verbose("Getting selected source filesystems for backup {0} on {1}".format(args.backup_name,args.ssh_source))
-    source_filesystems=zfs_get_selected_filesystems(args.ssh_source, args.backup_name)
-
-    #nothing todo
-    if not source_filesystems:
-        abort("No source filesystems selected, please do a 'zfs set autobackup:{0}=true' on {1}".format(args.backup_name,args.ssh_source))
-
-    if args.ignore_replicated:
-        replicated_filesystems=zfs_get_unchanged_filesystems(args.ssh_source, source_filesystems)
-        for replicated_filesystem in replicated_filesystems:
-            if replicated_filesystem in source_filesystems:
-                source_filesystems.remove(replicated_filesystem)
-                verbose("* Already replicated: {}".format(replicated_filesystem))
-
-    if not source_filesystems:
-        verbose("Nothing to do, all filesystems are already replicated.")
-        sys.exit(0)
-
-    # determine target filesystems
-    target_filesystems=[]
-    for source_filesystem in source_filesystems:
-        #append args.target_path prefix and strip args.strip_path paths from source_filesystem
-        target_filesystems.append(args.target_path + "/" + lstrip_path(source_filesystem, args.strip_path))
-    debug("Wanted target filesystems:\n"+str(pprint.pformat(target_filesystems)))
-
-    # get actual existing target filesystems. (including ones that might not be in the backupset anymore)
-    verbose("Getting existing target filesystems")
-    existing_target_filesystems=zfs_get_existing_filesystems(ssh_to=args.ssh_target, target_path=args.target_path)
-    debug("Existing target filesystems:\n"+str(pprint.pformat(existing_target_filesystems)))
-    common_target_filesystems=list(set(target_filesystems) & set(existing_target_filesystems))
-    debug("Common target filesystems (target filesystems that also exist on source):\n"+str(pprint.pformat(common_target_filesystems)))
-
-
-    ### get resumable transfers from target
-    resumable_target_filesystems={}
-    if args.resume:
-        verbose("Checking for aborted transfers that can be resumed")
-        #Important: use target_filesystem, not existing_target_filesystems (during initial transfer its resumable but doesnt exsit yet)
-        resumable_target_filesystems=zfs_get_resumable_filesystems(args.ssh_target, target_filesystems)
-        debug("Resumable filesystems:\n"+str(pprint.pformat(resumable_target_filesystems)))
-
-
-    ### get existing target snapshots
-    target_snapshots={}
-    if common_target_filesystems:
-        verbose("Getting target snapshot-list from {0}".format(args.ssh_target))
-        target_snapshots=zfs_get_snapshots(args.ssh_target, common_target_filesystems, args.backup_name)
-        # except subprocess.CalledProcessError:
-        #     verbose("(ignoring errors, probably initial backup for this filesystem)")
-        #     pass
-        debug("Target snapshots:\n" + str(pprint.pformat(target_snapshots)))
-
-
-    ### get eixsting source snapshots
-    verbose("Getting source snapshot-list from {0}".format(args.ssh_source))
-    source_snapshots=zfs_get_snapshots(args.ssh_source, source_filesystems, args.backup_name)
-    debug("Source snapshots:\n" + str(pprint.pformat(source_snapshots)))
-
-
-    ### create new snapshots on source
-    if not args.no_snapshot:
-        #determine which filesystems changed since last snapshot
-        if not args.allow_empty and not args.ignore_replicated:
-            #determine which filesystemn are unchanged since OUR snapshots. (not since ANY snapshot)
-            unchanged_filesystems=zfs_get_unchanged_snapshots(args.ssh_source, source_snapshots)
-
-        else:
-            unchanged_filesystems=[]
-
-        snapshot_filesystems=[]
-        for source_filesystem in source_filesystems:
-            if source_filesystem not in unchanged_filesystems:
-                snapshot_filesystems.append(source_filesystem)
-            else:
-                verbose("* Not snapshotting {}, no changes found.".format(source_filesystem))
-
-        #create snapshots
-        if snapshot_filesystems:
-            new_snapshot_name=args.backup_name+"-"+time.strftime("%Y%m%d%H%M%S")
-            verbose("Creating source snapshots {0} on {1} ".format(new_snapshot_name, args.ssh_source))
-            zfs_create_snapshot(args.ssh_source, snapshot_filesystems, new_snapshot_name)
-        else:
-            verbose("No changes at all, not creating snapshot.")
-
-        #add it to the list of source filesystems
-        for snapshot_filesystem in snapshot_filesystems:
-            source_snapshots.setdefault(snapshot_filesystem,[]).append(new_snapshot_name)
-
-
-
-
-    #obsolete snapshots that may be removed
-    source_obsolete_snapshots={}
-    target_obsolete_snapshots={}
-
-
-
-    ############## backup section
-
-    #determine which snapshots to send for each filesystem
-    for source_filesystem in source_filesystems:
-        try:
-            target_filesystem=args.target_path + "/" + lstrip_path(source_filesystem, args.strip_path)
-
-            if source_filesystem not in source_snapshots:
-                #this happens if you use --no-snapshot and there are new filesystems without snapshots
-                verbose("* Skipping source filesystem {0}, no snapshots found".format(source_filesystem))
-            else:
-
-                #incremental or initial send?
-                if target_filesystem in target_snapshots and target_snapshots[target_filesystem]:
-                    #incremental mode, determine what to send and what is obsolete
-
-                    #latest succesfully send snapshot, should be common on both source and target
-                    latest_target_snapshot=target_snapshots[target_filesystem][-1]
-
-                    if latest_target_snapshot not in source_snapshots[source_filesystem]:
-                        #cant find latest target anymore. find first common snapshot and inform user
-                        error_msg="Cant find latest target snapshot on source for '{}', did you destroy/rename it?".format(source_filesystem)
-                        error_msg=error_msg+"\nLatest on target : "+target_filesystem+"@"+latest_target_snapshot
-                        error_msg=error_msg+"\nMissing on source: "+source_filesystem+"@"+latest_target_snapshot
-                        found=False
-                        for latest_target_snapshot in reversed(target_snapshots[target_filesystem]):
-                            if latest_target_snapshot in source_snapshots[source_filesystem]:
-                                error_msg=error_msg+"\nYou could solve this by rolling back to this common snapshot on target: "+target_filesystem+"@"+latest_target_snapshot
-                                found=True
-                                break
-                        if not found:
-                            error_msg=error_msg+"\nAlso could not find an earlier common snapshot to rollback to."
-                        else:
-                            if args.ignore_new:
-                                verbose("* Skipping source filesystem '{0}', target already has newer snapshots.".format(source_filesystem))
-                                continue
-
-                        raise(Exception(error_msg))
-
-                    #send all new source snapshots that come AFTER the last target snapshot
-                    latest_source_index=source_snapshots[source_filesystem].index(latest_target_snapshot)
-                    send_snapshots=source_snapshots[source_filesystem][latest_source_index+1:]
-
-                    #source snapshots that come BEFORE last target snapshot are obsolete
-                    source_obsolete_snapshots[source_filesystem]=source_snapshots[source_filesystem][0:latest_source_index]
-
-                    #target snapshots that come BEFORE last target snapshot are obsolete
-                    latest_target_index=target_snapshots[target_filesystem].index(latest_target_snapshot)
-                    target_obsolete_snapshots[target_filesystem]=target_snapshots[target_filesystem][0:latest_target_index]
-                else:
-                    #initial mode, send all snapshots, nothing is obsolete:
-                    latest_target_snapshot=None
-                    send_snapshots=source_snapshots[source_filesystem]
-                    target_obsolete_snapshots[target_filesystem]=[]
-                    source_obsolete_snapshots[source_filesystem]=[]
-
-                #now actually send the snapshots
-                if not args.no_send:
-
-                    if send_snapshots and args.rollback and latest_target_snapshot:
-                        #roll back any changes on target
-                        debug("Rolling back target to latest snapshot.")
-                        run(ssh_to=args.ssh_target, test=args.test, cmd=["zfs", "rollback", target_filesystem+"@"+latest_target_snapshot ])
-
-
-                    for send_snapshot in send_snapshots:
-
-                        #resumable?
-                        if target_filesystem in resumable_target_filesystems:
-                            resume_token=resumable_target_filesystems.pop(target_filesystem)
-                        else:
-                            resume_token=None
-
-                        #hold the snapshot we're sending on the source
-                        if not args.no_holds:
-                            zfs_hold_snapshot(ssh_to=args.ssh_source, snapshot=source_filesystem+"@"+send_snapshot)
-
-                        zfs_transfer(
-                            ssh_source=args.ssh_source, source_filesystem=source_filesystem,
-                            first_snapshot=latest_target_snapshot, second_snapshot=send_snapshot,
-                            ssh_target=args.ssh_target, target_filesystem=target_filesystem,
-                            resume_token=resume_token
-                        )
-
-                        #hold the snapshot we just send to the target
-                        zfs_hold_snapshot(ssh_to=args.ssh_target, snapshot=target_filesystem+"@"+send_snapshot)
-
-
-
-                        #now that we succesfully transferred this snapshot, the previous snapshot is obsolete:
-                        if latest_target_snapshot:
-                            zfs_release_snapshot(ssh_to=args.ssh_target, snapshot=target_filesystem+"@"+latest_target_snapshot)
-                            target_obsolete_snapshots[target_filesystem].append(latest_target_snapshot)
-
-                            if not args.no_holds:
-                                zfs_release_snapshot(ssh_to=args.ssh_source, snapshot=source_filesystem+"@"+latest_target_snapshot)
-                                source_obsolete_snapshots[source_filesystem].append(latest_target_snapshot)
-                        #we just received a new filesytem?
-                        else:
-                            if args.clear_refreservation:
-                                debug("Clearing refreservation to save space.")
-
-                                run(ssh_to=args.ssh_target, test=args.test, cmd=["zfs", "set", "refreservation=none", target_filesystem ])
-
-
-                            if args.clear_mountpoint:
-                                debug("Setting canmount=noauto to prevent auto-mounting in the wrong place. (ignoring errors)")
-
-                                run(ssh_to=args.ssh_target, test=args.test, cmd=["zfs", "set", "canmount=noauto", target_filesystem ], valid_exitcodes= [0, 1] )
-
-
-                        latest_target_snapshot=send_snapshot
-        # failed, skip this source_filesystem
-        except Exception as e:
-            failed(str(e))
-
-
-    ############## cleanup section
-    #we only do cleanups after everything is complete, to keep everything consistent (same snapshots everywhere)
-
-
-    if not args.ignore_replicated:
-        #find stale backups on target that have become obsolete
-
-        stale_target_filesystems=get_stale_backupped_filesystems(backup_name=args.backup_name, target_path=args.target_path, target_filesystems=target_filesystems, existing_target_filesystems=existing_target_filesystems)
-        debug("Stale target filesystems: {0}".format("\n".join(stale_target_filesystems)))
-
-        stale_target_snapshots=zfs_get_snapshots(args.ssh_target, stale_target_filesystems, args.backup_name)
-        debug("Stale target snapshots: " + str(pprint.pformat(stale_target_snapshots)))
-        target_obsolete_snapshots.update(stale_target_snapshots)
-
-        #determine stale filesystems that have no snapshots left (the can be destroyed)
-        stale_target_destroys=[]
-        for stale_target_filesystem in stale_target_filesystems:
-            if stale_target_filesystem not in stale_target_snapshots:
-                stale_target_destroys.append(stale_target_filesystem)
-
-        if stale_target_destroys:
-            #NOTE: dont destroy automaticly..not safe enough.
-            # if args.destroy_stale:
-            #     verbose("Destroying stale filesystems on target {0}:\n{1}".format(args.ssh_target, "\n".join(stale_target_destroys)))
-            #     zfs_destroy(ssh_to=args.ssh_target, filesystems=stale_target_destroys, recursive=True)
-            # else:
-            verbose("Stale filesystems on {0}:\n{1}".format(args.ssh_target, "\n".join(stale_target_destroys)))
-    else:
-        verbose("NOTE: Cant determine stale target filesystems while using ignore_replicated.")
-
-
-
-    #now actually destroy the old snapshots
-    source_destroys=determine_destroy_list(source_obsolete_snapshots, args.keep_source)
-    if source_destroys:
-        verbose("Destroying old snapshots on source {0}:\n{1}".format(args.ssh_source, "\n".join(source_destroys)))
-        try:
-            zfs_destroy_snapshots(ssh_to=args.ssh_source, snapshots=source_destroys)
-        except Exception as e:
-            failed(str(e))
-
-
-    target_destroys=determine_destroy_list(target_obsolete_snapshots, args.keep_target)
-    if target_destroys:
-        verbose("Destroying old snapshots on target {0}:\n{1}".format(args.ssh_target, "\n".join(target_destroys)))
-        try:
-            zfs_destroy_snapshots(ssh_to=args.ssh_target, snapshots=target_destroys)
-        except Exception as e:
-            failed(str(e))
-
-
-################################################################## ENTRY POINT
-
-# parse arguments
-import argparse
-parser = argparse.ArgumentParser(
-    description='ZFS autobackup v2.4',
-    epilog='When a filesystem fails, zfs_backup will continue and report the number of failures at that end. Also the exit code will indicate the number of failures.')
-parser.add_argument('--ssh-source', default="local", help='Source host to get backup from. (user@hostname) Default %(default)s.')
-parser.add_argument('--ssh-target', default="local", help='Target host to push backup to. (user@hostname) Default  %(default)s.')
-parser.add_argument('--keep-source', type=int, default=30, help='Number of days to keep old snapshots on source. Default %(default)s.')
-parser.add_argument('--keep-target', type=int, default=30, help='Number of days to keep old snapshots on target. Default %(default)s.')
-parser.add_argument('backup_name',    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',    help='Target path')
-
-parser.add_argument('--no-snapshot', action='store_true', help='dont create new snapshot (usefull for finishing uncompleted backups, or cleanups)')
-parser.add_argument('--no-send', action='store_true', help='dont send snapshots (usefull to only do a cleanup)')
-parser.add_argument('--allow-empty', action='store_true', help='if nothing has changed, still create empty snapshots.')
-parser.add_argument('--ignore-replicated', action='store_true',  help='Ignore datasets that seem to be replicated some other way. (No changes since lastest snapshot. Usefull for proxmox HA replication)')
-parser.add_argument('--no-holds', action='store_true',  help='Dont lock snapshots on the source. (Usefull to allow proxmox HA replication to switches nodes)')
-parser.add_argument('--ignore-new', action='store_true',  help='Ignore filesystem if there are already newer snapshots for it on the target (use with caution)')
-
-parser.add_argument('--resume', action='store_true', help='support resuming of interrupted transfers by using the zfs extensible_dataset feature (both zpools should have it enabled) Disadvantage is that you need to use zfs recv -A if another snapshot is created on the target during a receive. Otherwise it will keep failing.')
-parser.add_argument('--strip-path', default=0, type=int, help='number of directory to strip from path (use 1 when cloning zones between 2 SmartOS machines)')
-parser.add_argument('--buffer', default="",  help='Use mbuffer with specified size to speedup zfs transfer. (e.g. --buffer 1G) Will also show nice progress output.')
-
-
-# parser.add_argument('--destroy-stale', action='store_true', help='Destroy stale backups that have no more snapshots. Be sure to verify the output before using this! ')
-parser.add_argument('--clear-refreservation', action='store_true', help='Set refreservation property to none for new filesystems. Usefull when backupping SmartOS volumes. (recommended)')
-parser.add_argument('--clear-mountpoint', action='store_true', help='Sets canmount=noauto property, to prevent the received filesystem from mounting over existing filesystems. (recommended)')
-parser.add_argument('--filter-properties', action='append', help='Filter properties when receiving filesystems. Can be specified multiple times. (Example: If you send data from Linux to FreeNAS, you should filter xattr)')
-parser.add_argument('--rollback', action='store_true', help='Rollback changes on the target before starting a backup. (normally you can prevent changes by setting the readonly property on the target_path to on)')
-parser.add_argument('--ignore-transfer-errors', action='store_true', help='Ignore transfer errors (still checks if received filesystem exists. usefull for acltype errors)')
-
-
-parser.add_argument('--test', action='store_true', help='dont change anything, just show what would be done (still does all read-only operations)')
-parser.add_argument('--verbose', action='store_true', help='verbose output')
-parser.add_argument('--debug', action='store_true', help='debug output (shows commands that are executed)')
-
-#note args is the only global variable we use, since its a global readonly setting anyway
-args = parser.parse_args()
-
-if args.ignore_replicated and args.allow_empty:
-    abort("Cannot use allow_empty with ignore_replicated.")
-
-
-try:
-    zfs_autobackup()
-    if not failures:
-        verbose("All operations completed succesfully.")
-        sys.exit(0)
-    else:
-        verbose("{} OPERATION(S) FAILED!".format(failures))
-        #exit with the number of failures.
-        sys.exit(min(255,failures))
-
-except Exception as e:
-    if args.debug:
-        raise
-    else:
-        print(str(e))
-        abort("FATAL ERROR")

zfs_autobackup/CachedProperty.py

@@ -0,0 +1,39 @@
+# NOTE: this should inherit from (object) to function correctly with python 2.7
+class CachedProperty(object):
+    """ A property that is only computed once per instance and
+    then stores the result in _cached_properties of the object.
+
+        Source: https://github.com/bottlepy/bottle/commit/fa7733e075da0d790d809aa3d2f53071897e6f76
+        """
+
+    def __init__(self, func):
+        self.__doc__ = getattr(func, '__doc__')
+        self.func = func
+
+    def __get__(self, obj, cls):
+        if obj is None:
+            return self
+
+        propname = self.func.__name__
+
+        if not hasattr(obj, '_cached_properties'):
+            obj._cached_properties = {}
+
+        if propname not in obj._cached_properties:
+            obj._cached_properties[propname] = self.func(obj)
+            # value = obj.__dict__[propname] = self.func(obj)
+
+        return obj._cached_properties[propname]
+
+    @staticmethod
+    def clear(obj):
+        """clears cache of obj"""
+        if hasattr(obj, '_cached_properties'):
+            obj._cached_properties = {}
+
+    @staticmethod
+    def is_cached(obj, propname):
+        if hasattr(obj, '_cached_properties') and propname in obj._cached_properties:
+            return True
+        else:
+            return False

zfs_autobackup/ExecuteNode.py

@@ -0,0 +1,199 @@
+import os
+import select
+import subprocess
+
+from zfs_autobackup.LogStub import LogStub
+
+class ExecuteNode(LogStub):
+    """an endpoint to execute local or remote commands via ssh"""
+
+    def __init__(self, ssh_config=None, ssh_to=None, readonly=False, debug_output=False):
+        """ssh_config: custom ssh config
+           ssh_to: server you want to ssh to. none means local
+           readonly: only execute commands that don't make any changes (useful for testing-runs)
+           debug_output: show output and exit codes of commands in debugging output.
+        """
+
+        self.ssh_config = ssh_config
+        self.ssh_to = ssh_to
+        self.readonly = readonly
+        self.debug_output = debug_output
+
+    def __repr__(self):
+        if self.ssh_to is None:
+            return "(local)"
+        else:
+            return self.ssh_to
+
+    def _parse_stdout(self, line):
+        """parse stdout. can be overridden in subclass"""
+        if self.debug_output:
+            self.debug("STDOUT > " + line.rstrip())
+
+    def _parse_stderr(self, line, hide_errors):
+        """parse stderr. can be overridden in subclass"""
+        if hide_errors:
+            self.debug("STDERR > " + line.rstrip())
+        else:
+            self.error("STDERR > " + line.rstrip())
+
+    def _parse_stderr_pipe(self, line, hide_errors):
+        """parse stderr from pipe input process. can be overridden in subclass"""
+        if hide_errors:
+            self.debug("STDERR|> " + line.rstrip())
+        else:
+            self.error("STDERR|> " + line.rstrip())
+
+    def run(self, cmd, inp=None, tab_split=False, valid_exitcodes=None, readonly=False, hide_errors=False, pipe=False,
+            return_stderr=False):
+        """run a command on the node cmd: the actual command, should be a list, where the first item is the command
+        and the rest are parameters. input: Can be None, a string or a pipe-handle you got from another run()
+        tab_split: split tabbed files in output into a list valid_exitcodes: list of valid exit codes for this
+        command (checks exit code of both sides of a pipe) readonly: make this True if the command doesn't make any
+        changes and is safe to execute in testmode hide_errors: don't show stderr output as error, instead show it as
+        debugging output (use to hide expected errors) pipe: Instead of executing, return a pipe-handle to be used to
+        input to another run() command. (just like a | in linux) return_stderr: return both stdout and stderr as a
+        tuple. (only returns stderr from this side of the pipe)
+        """
+
+        if not valid_exitcodes:
+            valid_exitcodes = [0]
+
+        encoded_cmd = []
+
+        # use ssh?
+        if self.ssh_to is not None:
+            encoded_cmd.append("ssh".encode('utf-8'))
+
+            if self.ssh_config is not None:
+                encoded_cmd.extend(["-F".encode('utf-8'), self.ssh_config.encode('utf-8')])
+
+            encoded_cmd.append(self.ssh_to.encode('utf-8'))
+
+            # make sure the command gets all the data in utf8 format:
+            # (this is necessary if LC_ALL=en_US.utf8 is not set in the environment)
+            for arg in cmd:
+                # add single quotes for remote commands to support spaces and other weird stuff (remote commands are
+                # executed in a shell) and escape existing single quotes (bash needs ' to end the quoted string,
+                # then a \' for the actual quote and then another ' to start a new quoted string) (and then python
+                # needs the double \ to get a single \)
+                encoded_cmd.append(("'" + arg.replace("'", "'\\''") + "'").encode('utf-8'))
+
+        else:
+            for arg in cmd:
+                encoded_cmd.append(arg.encode('utf-8'))
+
+        # debug and test stuff
+        debug_txt = ""
+        for c in encoded_cmd:
+            debug_txt = debug_txt + " " + c.decode()
+
+        if pipe:
+            debug_txt = debug_txt + " |"
+
+        if self.readonly and not readonly:
+            self.debug("SKIP   > " + debug_txt)
+        else:
+            if pipe:
+                self.debug("PIPE   > " + debug_txt)
+            else:
+                self.debug("RUN    > " + debug_txt)
+
+        # determine stdin
+        if inp is None:
+            # NOTE: Not None, otherwise it reads stdin from terminal!
+            stdin = subprocess.PIPE
+        elif isinstance(inp, str) or type(inp) == 'unicode':
+            self.debug("INPUT  > \n" + inp.rstrip())
+            stdin = subprocess.PIPE
+        elif isinstance(inp, subprocess.Popen):
+            self.debug("Piping input")
+            stdin = inp.stdout
+        else:
+            raise (Exception("Program error: Incompatible input"))
+
+        if self.readonly and not readonly:
+            # todo: what happens if input is piped?
+            return
+
+        # execute and parse/return results
+        p = subprocess.Popen(encoded_cmd, env=os.environ, stdout=subprocess.PIPE, stdin=stdin, stderr=subprocess.PIPE)
+
+        # Note: make streaming?
+        if isinstance(inp, str) or type(inp) == 'unicode':
+            p.stdin.write(inp.encode('utf-8'))
+
+        if p.stdin:
+            p.stdin.close()
+
+        # return pipe
+        if pipe:
+            return p
+
+        # handle all outputs
+        if isinstance(inp, subprocess.Popen):
+            selectors = [p.stdout, p.stderr, inp.stderr]
+            inp.stdout.close()  # otherwise inputprocess wont exit when ours does
+        else:
+            selectors = [p.stdout, p.stderr]
+
+        output_lines = []
+        error_lines = []
+        while True:
+            (read_ready, write_ready, ex_ready) = select.select(selectors, [], [])
+            eof_count = 0
+            if p.stdout in read_ready:
+                line = p.stdout.readline().decode('utf-8')
+                if line != "":
+                    if tab_split:
+                        output_lines.append(line.rstrip().split('\t'))
+                    else:
+                        output_lines.append(line.rstrip())
+                    self._parse_stdout(line)
+                else:
+                    eof_count = eof_count + 1
+            if p.stderr in read_ready:
+                line = p.stderr.readline().decode('utf-8')
+                if line != "":
+                    if tab_split:
+                        error_lines.append(line.rstrip().split('\t'))
+                    else:
+                        error_lines.append(line.rstrip())
+                    self._parse_stderr(line, hide_errors)
+                else:
+                    eof_count = eof_count + 1
+            if isinstance(inp, subprocess.Popen) and (inp.stderr in read_ready):
+                line = inp.stderr.readline().decode('utf-8')
+                if line != "":
+                    self._parse_stderr_pipe(line, hide_errors)
+                else:
+                    eof_count = eof_count + 1
+
+            # stop if both processes are done and all filehandles are EOF:
+            if (p.poll() is not None) and (
+                    (not isinstance(inp, subprocess.Popen)) or inp.poll() is not None) and eof_count == len(selectors):
+                break
+
+        p.stderr.close()
+        p.stdout.close()
+
+        if self.debug_output:
+            self.debug("EXIT   > {}".format(p.returncode))
+
+        # handle piped process error output and exit codes
+        if isinstance(inp, subprocess.Popen):
+            inp.stderr.close()
+            inp.stdout.close()
+
+            if self.debug_output:
+                self.debug("EXIT  |> {}".format(inp.returncode))
+            if valid_exitcodes and inp.returncode not in valid_exitcodes:
+                raise (subprocess.CalledProcessError(inp.returncode, "(pipe)"))
+
+        if valid_exitcodes and p.returncode not in valid_exitcodes:
+            raise (subprocess.CalledProcessError(p.returncode, encoded_cmd))
+
+        if return_stderr:
+            return output_lines, error_lines
+        else:
+            return output_lines

zfs_autobackup/LogConsole.py

@@ -0,0 +1,46 @@
+# python 2 compatibility
+from __future__ import print_function
+
+import sys
+
+
+colorama = False
+if sys.stdout.isatty():
+    try:
+        import colorama
+    except ImportError:
+        colorama = False
+        pass
+
+
+class LogConsole:
+    """Log-class that outputs to console, adding colors if needed"""
+
+    def __init__(self, show_debug=False, show_verbose=False):
+        self.last_log = ""
+        self.show_debug = show_debug
+        self.show_verbose = show_verbose
+
+    @staticmethod
+    def error(txt):
+        if colorama:
+            print(colorama.Fore.RED + colorama.Style.BRIGHT + "! " + txt + colorama.Style.RESET_ALL, file=sys.stderr)
+        else:
+            print("! " + txt, file=sys.stderr)
+        sys.stderr.flush()
+
+    def verbose(self, txt):
+        if self.show_verbose:
+            if colorama:
+                print(colorama.Style.NORMAL + "  " + txt + colorama.Style.RESET_ALL)
+            else:
+                print("  " + txt)
+            sys.stdout.flush()
+
+    def debug(self, txt):
+        if self.show_debug:
+            if colorama:
+                print(colorama.Fore.GREEN + "# " + txt + colorama.Style.RESET_ALL)
+            else:
+                print("# " + txt)
+            sys.stdout.flush()

zfs_autobackup/LogStub.py

@@ -0,0 +1,15 @@
+#Used for baseclasses that dont implement their own logging (Like ExecuteNode)
+#Usually logging is implemented in subclasses (Like ZfsNode thats a subclass of ExecuteNode), but for regression testing its nice to have these stubs.
+
+class LogStub:
+    """Just a stub, usually overriden in subclasses."""
+
+    # simple logging stubs
+    def debug(self, txt):
+        print("DEBUG  : " + txt)
+
+    def verbose(self, txt):
+        print("VERBOSE: " + txt)
+
+    def error(self, txt):
+        print("ERROR  : " + txt)

zfs_autobackup/Thinner.py

@@ -0,0 +1,94 @@
+import time
+
+from zfs_autobackup.ThinnerRule import ThinnerRule
+
+
+class Thinner:
+    """progressive thinner (universal, used for cleaning up snapshots)"""
+
+    def __init__(self, schedule_str=""):
+        """schedule_str: comma seperated list of ThinnerRules. A plain number specifies how many snapshots to always
+        keep.
+        """
+
+        self.rules = []
+        self.always_keep = 0
+
+        if schedule_str == "":
+            return
+
+        rule_strs = schedule_str.split(",")
+        for rule_str in rule_strs:
+            if rule_str.isdigit():
+                self.always_keep = int(rule_str)
+                if self.always_keep < 0:
+                    raise (Exception("Number of snapshots to keep cant be negative: {}".format(self.always_keep)))
+            else:
+                self.rules.append(ThinnerRule(rule_str))
+
+    def human_rules(self):
+        """get list of human readable rules"""
+        ret = []
+        if self.always_keep:
+            ret.append("Keep the last {} snapshot{}.".format(self.always_keep, self.always_keep != 1 and "s" or ""))
+        for rule in self.rules:
+            ret.append(rule.human_str)
+
+        return ret
+
+    def thin(self, objects, keep_objects=None, now=None):
+        """thin list of objects with current schedule rules. objects: list of objects to thin. every object should
+        have timestamp attribute. keep_objects: objects to always keep (these should also be in normal objects list,
+        so we can use them to perhaps delete other obsolete objects)
+
+            return( keeps, removes )
+        """
+
+        if not keep_objects:
+            keep_objects = []
+
+        # always keep a number of the last objets?
+        if self.always_keep:
+            # all of them
+            if len(objects) <= self.always_keep:
+                return objects, []
+
+            # determine which ones
+            always_keep_objects = objects[-self.always_keep:]
+        else:
+            always_keep_objects = []
+
+        # determine time blocks
+        time_blocks = {}
+        for rule in self.rules:
+            time_blocks[rule.period] = {}
+
+        if not now:
+            now = int(time.time())
+
+        keeps = []
+        removes = []
+
+        # traverse objects
+        for thisobject in objects:
+            # important they are ints!
+            timestamp = int(thisobject.timestamp)
+            age = int(now) - timestamp
+
+            # store in the correct time blocks, per period-size, if not too old yet
+            # e.g.: look if there is ANY timeblock that wants to keep this object
+            keep = False
+            for rule in self.rules:
+                if age <= rule.ttl:
+                    block_nr = int(timestamp / rule.period)
+                    if block_nr not in time_blocks[rule.period]:
+                        time_blocks[rule.period][block_nr] = True
+                        keep = True
+
+            # keep it according to schedule, or keep it because it is in the keep_objects list
+            if keep or thisobject in keep_objects or thisobject in always_keep_objects:
+                keeps.append(thisobject)
+            else:
+                removes.append(thisobject)
+
+        return keeps, removes

zfs_autobackup/ThinnerRule.py

@@ -0,0 +1,68 @@
+import re
+
+
+class ThinnerRule:
+    """a thinning schedule rule for Thinner"""
+
+    TIME_NAMES = {
+        'y': 3600 * 24 * 365.25,
+        'm': 3600 * 24 * 30,
+        'w': 3600 * 24 * 7,
+        'd': 3600 * 24,
+        'h': 3600,
+        'min': 60,
+        's': 1,
+    }
+
+    TIME_DESC = {
+        'y': 'year',
+        'm': 'month',
+        'w': 'week',
+        'd': 'day',
+        'h': 'hour',
+        'min': 'minute',
+        's': 'second',
+    }
+
+    def __init__(self, rule_str):
+        """parse scheduling string
+            example:
+                daily snapshot, remove after a week:     1d1w
+                weekly snapshot, remove after a month:   1w1m
+                monthly snapshot, remove after 6 months: 1m6m
+                yearly snapshot, remove after 2 year:    1y2y
+                keep all snapshots, remove after a day   1s1d
+                keep nothing:                            1s1s
+
+        """
+
+        rule_str = rule_str.lower()
+        matches = re.findall("([0-9]*)([a-z]*)([0-9]*)([a-z]*)", rule_str)[0]
+
+        period_amount = int(matches[0])
+        period_unit = matches[1]
+        ttl_amount = int(matches[2])
+        ttl_unit = matches[3]
+
+        if period_unit not in self.TIME_NAMES:
+            raise (Exception("Invalid period string in schedule: '{}'".format(rule_str)))
+
+        if ttl_unit not in self.TIME_NAMES:
+            raise (Exception("Invalid ttl string in schedule: '{}'".format(rule_str)))
+
+        self.period = period_amount * self.TIME_NAMES[period_unit]
+        self.ttl = ttl_amount * self.TIME_NAMES[ttl_unit]
+
+        if self.period > self.ttl:
+            raise (Exception("Period cant be longer than ttl in schedule: '{}'".format(rule_str)))
+
+        self.rule_str = rule_str
+
+        self.human_str = "Keep every {} {}{}, delete after {} {}{}.".format(
+            period_amount, self.TIME_DESC[period_unit], period_amount != 1 and "s" or "", ttl_amount,
+            self.TIME_DESC[ttl_unit], ttl_amount != 1 and "s" or "")
+
+    def __str__(self):
+        """get schedule as a schedule string"""
+
+        return self.rule_str

zfs_autobackup/ZfsAutobackup.py

@@ -0,0 +1,376 @@
+import argparse
+import sys
+import time
+
+from zfs_autobackup.Thinner import Thinner
+from zfs_autobackup.ZfsDataset import ZfsDataset
+from zfs_autobackup.LogConsole import LogConsole
+from zfs_autobackup.ZfsNode import ZfsNode
+from zfs_autobackup.ThinnerRule import ThinnerRule
+
+
+class ZfsAutobackup:
+    """main class"""
+
+    VERSION = "3.0.1-beta7"
+    HEADER = "zfs-autobackup v{} - Copyright 2020 E.H.Eefting (edwin@datux.nl)".format(VERSION)
+
+    def __init__(self, argv, print_arguments=True):
+
+        # helps with investigating failed regression tests:
+        if print_arguments:
+            print("ARGUMENTS: " + " ".join(argv))
+
+        parser = argparse.ArgumentParser(
+            description=self.HEADER,
+            epilog='When a filesystem fails, zfs_backup will continue and report the number of failures at that end. '
+                   'Also the exit code will indicate the number of failures. Full manual at: https://github.com/psy0rz/zfs_autobackup')
+        parser.add_argument('--ssh-config', default=None, help='Custom ssh client config')
+        parser.add_argument('--ssh-source', default=None,
+                            help='Source host to get backup from. (user@hostname) Default %(default)s.')
+        parser.add_argument('--ssh-target', default=None,
+                            help='Target host to push backup to. (user@hostname) Default  %(default)s.')
+        parser.add_argument('--keep-source', type=str, default="10,1d1w,1w1m,1m1y",
+                            help='Thinning schedule for old source snapshots. Default: %(default)s')
+        parser.add_argument('--keep-target', type=str, default="10,1d1w,1w1m,1m1y",
+                            help='Thinning schedule for old target snapshots. Default: %(default)s')
+
+        parser.add_argument('backup_name', metavar='backup-name',
+                            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)')
+
+        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='Don\'t run the thinner.')
+        parser.add_argument('--min-change', 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='Ignore datasets that seem to be replicated some other way. (No changes since '
+                                 'lastest snapshot. Useful for proxmox HA replication)')
+        parser.add_argument('--no-holds', action='store_true',
+                            help='Don\'t hold snapshots. (Faster)')
+
+        parser.add_argument('--resume', action='store_true', help=argparse.SUPPRESS)
+        parser.add_argument('--strip-path', 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('--buffer', default="",  help='Use mbuffer with specified size to speedup zfs transfer.
+        # (e.g. --buffer 1G) Will also show nice progress output.')
+
+        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', 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', 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', 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('--raw', action='store_true',
+                            help='For encrypted datasets, send data exactly as it exists on disk.')
+
+        parser.add_argument('--test', action='store_true',
+                            help='dont change anything, just show what would be done (still does all read-only '
+                                 'operations)')
+        parser.add_argument('--verbose', action='store_true', help='verbose output')
+        parser.add_argument('--debug', 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
+
+        # note args is the only global variable we use, since its a global readonly setting anyway
+        args = parser.parse_args(argv)
+
+        self.args = args
+
+        #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 args.allow_empty:
+            args.min_change = 0
+
+        if args.destroy_incompatible:
+            args.rollback = True
+
+        self.log = LogConsole(show_debug=self.args.debug, show_verbose=self.args.verbose)
+
+        if args.resume:
+            self.verbose("NOTE: The --resume option isn't needed anymore (its autodetected now)")
+
+        if args.target_path is not None and args.target_path[0] == "/":
+            self.log.error("Target should not start with a /")
+            sys.exit(255)
+
+    def verbose(self, txt):
+        self.log.verbose(txt)
+
+    def error(self, txt):
+        self.log.error(txt)
+
+    def debug(self, txt):
+        self.log.debug(txt)
+
+    def set_title(self, title):
+        self.log.verbose("")
+        self.log.verbose("#### " + title)
+
+    # sync datasets, or thin-only on both sides
+    # target is needed for this.
+    def sync_datasets(self, source_node, source_datasets):
+
+        description = "[Target]"
+
+        self.set_title("Target settings")
+
+        target_thinner = Thinner(self.args.keep_target)
+        target_node = ZfsNode(self.args.backup_name, self, ssh_config=self.args.ssh_config, ssh_to=self.args.ssh_target,
+                              readonly=self.args.test, debug_output=self.args.debug_output, description=description,
+                              thinner=target_thinner)
+        target_node.verbose("Receive datasets under: {}".format(self.args.target_path))
+
+        if self.args.no_send:
+            self.set_title("Thinning source and target")
+        else:
+            self.set_title("Sending and thinning")
+
+        # check if exists, to prevent vague errors
+        target_dataset = ZfsDataset(target_node, self.args.target_path)
+        if not target_dataset.exists:
+            self.error("Target path '{}' does not exist. Please create this dataset first.".format(target_dataset))
+            return 255
+
+        if self.args.filter_properties:
+            filter_properties = self.args.filter_properties.split(",")
+        else:
+            filter_properties = []
+
+        if self.args.set_properties:
+            set_properties = self.args.set_properties.split(",")
+        else:
+            set_properties = []
+
+        if self.args.clear_refreservation:
+            filter_properties.append("refreservation")
+
+        if self.args.clear_mountpoint:
+            set_properties.append("canmount=noauto")
+
+        # sync datasets
+        fail_count = 0
+        target_datasets = []
+        for source_dataset in source_datasets:
+
+            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_datasets.append(target_dataset)
+
+                # ensure parents exists
+                # TODO: this isnt perfect yet, in some cases it can create parents when it shouldn't.
+                if not self.args.no_send \
+                        and target_dataset.parent not in target_datasets \
+                        and not target_dataset.parent.exists:
+                    target_dataset.parent.create_filesystem(parents=True)
+
+                # determine common zpool features
+                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
+                common_features = source_features and target_features
+                # source_dataset.debug("Common features: {}".format(common_features))
+
+                source_dataset.sync_snapshots(target_dataset, show_progress=self.args.progress,
+                                              features=common_features, filter_properties=filter_properties,
+                                              set_properties=set_properties,
+                                              ignore_recv_exit_code=self.args.ignore_transfer_errors,
+                                              holds=not self.args.no_holds, rollback=self.args.rollback,
+                                              raw=self.args.raw, other_snapshots=self.args.other_snapshots,
+                                              no_send=self.args.no_send,
+                                              destroy_incompatible=self.args.destroy_incompatible)
+            except Exception as e:
+                fail_count = fail_count + 1
+                source_dataset.error("FAILED: " + str(e))
+                if self.args.debug:
+                    raise
+
+        # if not self.args.no_thinning:
+        self.thin_missing_targets(ZfsDataset(target_node, self.args.target_path), target_datasets)
+
+        return fail_count
+
+    def thin_missing_targets(self, target_dataset, used_target_datasets):
+        """thin/destroy target datasets that are missing on the source."""
+
+        self.debug("Thinning obsolete datasets")
+
+        for dataset in target_dataset.recursive_datasets:
+            try:
+                if dataset not in used_target_datasets:
+                    dataset.debug("Missing on source, thinning")
+                    dataset.thin()
+
+                    # destroy_missing enabled?
+                    if self.args.destroy_missing is not None:
+
+                        # cant do anything without our own snapshots
+                        if not dataset.our_snapshots:
+                            if dataset.datasets:
+                                dataset.debug("Destroy missing: ignoring")
+                            else:
+                                dataset.verbose(
+                                    "Destroy missing: has no snapshots made by us. (please destroy manually)")
+                        else:
+                            # past the deadline?
+                            deadline_ttl = ThinnerRule("0s" + self.args.destroy_missing).ttl
+                            now = int(time.time())
+                            if dataset.our_snapshots[-1].timestamp + deadline_ttl > now:
+                                dataset.verbose("Destroy missing: Waiting for deadline.")
+                            else:
+
+                                dataset.debug("Destroy missing: Removing our snapshots.")
+
+                                # remove all our snaphots, except last, to safe space in case we fail later on
+                                for snapshot in dataset.our_snapshots[:-1]:
+                                    snapshot.destroy(fail_exception=True)
+
+                                # does it have other snapshots?
+                                has_others = False
+                                for snapshot in dataset.snapshots:
+                                    if not snapshot.is_ours():
+                                        has_others = True
+                                        break
+
+                                if has_others:
+                                    dataset.verbose("Destroy missing: Still in use by other snapshots")
+                                else:
+                                    if dataset.datasets:
+                                        dataset.verbose("Destroy missing: Still has children here.")
+                                    else:
+                                        dataset.verbose("Destroy missing.")
+                                        dataset.our_snapshots[-1].destroy(fail_exception=True)
+                                        dataset.destroy(fail_exception=True)
+
+            except Exception as e:
+                dataset.error("Error during destoy missing ({})".format(str(e)))
+
+    def thin_source(self, source_datasets):
+
+        self.set_title("Thinning source")
+
+        for source_dataset in source_datasets:
+            source_dataset.thin(skip_holds=True)
+
+    def run(self):
+
+        try:
+            self.verbose(self.HEADER)
+
+            if self.args.test:
+                self.verbose("TEST MODE - SIMULATING WITHOUT MAKING ANY CHANGES")
+
+            self.set_title("Source settings")
+
+            description = "[Source]"
+            source_thinner = Thinner(self.args.keep_source)
+            source_node = ZfsNode(self.args.backup_name, 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)
+            source_node.verbose(
+                "Selects all datasets that have property 'autobackup:{}=true' (or childs of datasets that have "
+                "'autobackup:{}=child')".format(
+                    self.args.backup_name, self.args.backup_name))
+
+            self.set_title("Selecting")
+            selected_source_datasets = source_node.selected_datasets
+            if not selected_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))
+                return 255
+
+            source_datasets = []
+
+            # filter out already replicated stuff?
+            if not self.args.ignore_replicated:
+                source_datasets = selected_source_datasets
+            else:
+                self.set_title("Filtering already replicated filesystems")
+                for selected_source_dataset in selected_source_datasets:
+                    if selected_source_dataset.is_changed(self.args.min_change):
+                        source_datasets.append(selected_source_dataset)
+                    else:
+                        selected_source_dataset.verbose("Ignoring, already replicated")
+
+            if not self.args.no_snapshot:
+                self.set_title("Snapshotting")
+                source_node.consistent_snapshot(source_datasets, source_node.new_snapshotname(),
+                                                min_changed_bytes=self.args.min_change)
+
+            # if target is specified, we sync the datasets, otherwise we just thin the source. (e.g. snapshot mode)
+            if self.args.target_path:
+                fail_count = self.sync_datasets(source_node, source_datasets)
+            else:
+                self.thin_source(source_datasets)
+                fail_count = 0
+
+            if not fail_count:
+                if self.args.test:
+                    self.set_title("All tests successfull.")
+                else:
+                    self.set_title("All operations completed successfully")
+                    if not self.args.target_path:
+                        self.verbose("(No target_path specified, only operated as snapshot tool.)")
+
+            else:
+                if fail_count != 255:
+                    self.error("{} failures!".format(fail_count))
+
+            if self.args.test:
+                self.verbose("")
+                self.verbose("TEST MODE - DID NOT MAKE ANY CHANGES!")
+
+            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

zfs_autobackup/ZfsDataset.py

@@ -0,0 +1,802 @@
+import re
+import subprocess
+import time
+
+from zfs_autobackup.CachedProperty import CachedProperty
+
+
+class ZfsDataset:
+    """a zfs dataset (filesystem/volume/snapshot/clone)
+    Note that a dataset doesn't have to actually exist (yet/anymore)
+    Also most properties are cached for performance-reasons, but also to allow --test to function correctly.
+
+    """
+
+    # illegal properties per dataset type. these will be removed from --set-properties and --filter-properties
+    ILLEGAL_PROPERTIES = {
+        'filesystem': [],
+        'volume': ["canmount"],
+    }
+
+    def __init__(self, zfs_node, name, force_exists=None):
+        """name: full path of the zfs dataset exists: specify if you already know a dataset exists or not. for
+        performance and testing reasons. (otherwise it will have to check with zfs list when needed)
+        """
+        self.zfs_node = zfs_node
+        self.name = name  # full name
+        self._virtual_snapshots = []
+        self.invalidate()
+        self.force_exists = force_exists
+
+    def __repr__(self):
+        return "{}: {}".format(self.zfs_node, self.name)
+
+    def __str__(self):
+        return self.name
+
+    def __eq__(self, obj):
+        if not isinstance(obj, ZfsDataset):
+            return False
+
+        return self.name == obj.name
+
+    def verbose(self, txt):
+        self.zfs_node.verbose("{}: {}".format(self.name, txt))
+
+    def error(self, txt):
+        self.zfs_node.error("{}: {}".format(self.name, txt))
+
+    def debug(self, txt):
+        self.zfs_node.debug("{}: {}".format(self.name, txt))
+
+    def invalidate(self):
+        """clear caches"""
+        CachedProperty.clear(self)
+        self.force_exists = None
+        self._virtual_snapshots = []
+
+    def split_path(self):
+        """return the path elements as an array"""
+        return self.name.split("/")
+
+    def lstrip_path(self, count):
+        """return name with first count components stripped"""
+        return "/".join(self.split_path()[count:])
+
+    def rstrip_path(self, count):
+        """return name with last count components stripped"""
+        return "/".join(self.split_path()[:-count])
+
+    @property
+    def filesystem_name(self):
+        """filesystem part of the name (before the @)"""
+        if self.is_snapshot:
+            (filesystem, snapshot) = self.name.split("@")
+            return filesystem
+        else:
+            return self.name
+
+    @property
+    def snapshot_name(self):
+        """snapshot part of the name"""
+        if not self.is_snapshot:
+            raise (Exception("This is not a snapshot"))
+
+        (filesystem, snapshot_name) = self.name.split("@")
+        return snapshot_name
+
+    @property
+    def is_snapshot(self):
+        """true if this dataset is a snapshot"""
+        return self.name.find("@") != -1
+
+    @CachedProperty
+    def parent(self):
+        """get zfs-parent of this dataset. for snapshots this means it will get the filesystem/volume that it belongs
+        to. otherwise it will return the parent according to path
+
+        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)
+        else:
+            return ZfsDataset(self.zfs_node, self.rstrip_path(1))
+
+    def find_prev_snapshot(self, snapshot, other_snapshots=False):
+        """find previous snapshot in this dataset. None if it doesn't exist.
+
+        other_snapshots: set to true to also return snapshots that where not created by us. (is_ours)
+        """
+
+        if self.is_snapshot:
+            raise (Exception("Please call this on a dataset."))
+
+        index = self.find_snapshot_index(snapshot)
+        while index:
+            index = index - 1
+            if other_snapshots or self.snapshots[index].is_ours():
+                return self.snapshots[index]
+        return None
+
+    def find_next_snapshot(self, snapshot, other_snapshots=False):
+        """find next snapshot in this dataset. None if it doesn't exist"""
+
+        if self.is_snapshot:
+            raise (Exception("Please call this on a dataset."))
+
+        index = self.find_snapshot_index(snapshot)
+        while index is not None and index < len(self.snapshots) - 1:
+            index = index + 1
+            if other_snapshots or self.snapshots[index].is_ours():
+                return self.snapshots[index]
+        return None
+
+    @CachedProperty
+    def exists(self):
+        """check if dataset exists.
+        Use force to force a specific value to be cached, if you already know. Useful for performance reasons"""
+
+        if self.force_exists is not None:
+            self.debug("Checking if filesystem exists: was forced to {}".format(self.force_exists))
+            return self.force_exists
+        else:
+            self.debug("Checking if filesystem exists")
+
+        return (self.zfs_node.run(tab_split=True, cmd=["zfs", "list", self.name], readonly=True, valid_exitcodes=[0, 1],
+                                  hide_errors=True) and True)
+
+    def create_filesystem(self, parents=False):
+        """create a filesystem"""
+        if parents:
+            self.verbose("Creating filesystem and parents")
+            self.zfs_node.run(["zfs", "create", "-p", self.name])
+        else:
+            self.verbose("Creating filesystem")
+            self.zfs_node.run(["zfs", "create", self.name])
+
+        self.force_exists = True
+
+    def destroy(self, fail_exception=False):
+        """destroy the dataset. by default failures are not an exception, so we can continue making backups"""
+
+        self.verbose("Destroying")
+
+        if self.is_snapshot:
+            self.release()
+
+        try:
+            self.zfs_node.run(["zfs", "destroy", self.name])
+            self.invalidate()
+            self.force_exists = False
+            return True
+        except subprocess.CalledProcessError:
+            if not fail_exception:
+                return False
+            else:
+                raise
+
+    @CachedProperty
+    def properties(self):
+        """all zfs properties"""
+
+        cmd = [
+            "zfs", "get", "-H", "-o", "property,value", "-p", "all", self.name
+        ]
+
+        if not self.exists:
+            return {}
+
+        self.debug("Getting zfs properties")
+
+        ret = {}
+        for pair in self.zfs_node.run(tab_split=True, cmd=cmd, readonly=True, valid_exitcodes=[0]):
+            if len(pair) == 2:
+                ret[pair[0]] = pair[1]
+
+        return ret
+
+    def is_changed(self, min_changed_bytes=1):
+        """dataset is changed since ANY latest snapshot ?"""
+        self.debug("Checking if dataset is changed")
+
+        if min_changed_bytes == 0:
+            return True
+
+        if int(self.properties['written']) < min_changed_bytes:
+            return False
+        else:
+            return True
+
+    def is_ours(self):
+        """return true if this snapshot is created by this backup_name"""
+        if re.match("^" + self.zfs_node.backup_name + "-[0-9]*$", self.snapshot_name):
+            return True
+        else:
+            return False
+
+    @property
+    def _hold_name(self):
+        return "zfs_autobackup:" + self.zfs_node.backup_name
+
+    @property
+    def holds(self):
+        """get list of holds for dataset"""
+
+        output = self.zfs_node.run(["zfs", "holds", "-H", self.name], valid_exitcodes=[0], tab_split=True,
+                                   readonly=True)
+        return map(lambda fields: fields[1], output)
+
+    def is_hold(self):
+        """did we hold this snapshot?"""
+        return self._hold_name in self.holds
+
+    def hold(self):
+        """hold dataset"""
+        self.debug("holding")
+        self.zfs_node.run(["zfs", "hold", self._hold_name, self.name], valid_exitcodes=[0, 1])
+
+    def release(self):
+        """release dataset"""
+        if self.zfs_node.readonly or self.is_hold():
+            self.debug("releasing")
+            self.zfs_node.run(["zfs", "release", self._hold_name, self.name], valid_exitcodes=[0, 1])
+
+    @property
+    def timestamp(self):
+        """get timestamp from snapshot name. Only works for our own snapshots with the correct format."""
+        time_str = re.findall("^.*-([0-9]*)$", self.snapshot_name)[0]
+        if len(time_str) != 14:
+            raise (Exception("Snapshot has invalid timestamp in name: {}".format(self.snapshot_name)))
+
+        # new format:
+        time_secs = time.mktime(time.strptime(time_str, "%Y%m%d%H%M%S"))
+        return time_secs
+
+    def from_names(self, names):
+        """convert a list of names to a list ZfsDatasets for this zfs_node"""
+        ret = []
+        for name in names:
+            ret.append(ZfsDataset(self.zfs_node, name))
+
+        return ret
+
+    # def add_virtual_snapshot(self, snapshot):
+    #     """pretend a snapshot exists (usefull in test mode)"""
+    #
+    #     # NOTE: we could just call self.snapshots.append() but this would trigger a zfs list which is not always needed.
+    #     if CachedProperty.is_cached(self, 'snapshots'):
+    #         # already cached so add it
+    #         print ("ADDED")
+    #         self.snapshots.append(snapshot)
+    #     else:
+    #         # self.snapshots will add it when requested
+    #         print ("ADDED VIRT")
+    #         self._virtual_snapshots.append(snapshot)
+
+    @CachedProperty
+    def snapshots(self):
+        """get all snapshots of this dataset"""
+
+
+        if not self.exists:
+            return []
+
+        self.debug("Getting snapshots")
+
+        cmd = [
+            "zfs", "list", "-d", "1", "-r", "-t", "snapshot", "-H", "-o", "name", self.name
+        ]
+
+        return self.from_names(self.zfs_node.run(cmd=cmd, readonly=True))
+
+    @property
+    def our_snapshots(self):
+        """get list of snapshots creates by us of this dataset"""
+        ret = []
+        for snapshot in self.snapshots:
+            if snapshot.is_ours():
+                ret.append(snapshot)
+
+        return ret
+
+    def find_snapshot(self, snapshot):
+        """find snapshot by snapshot (can be a snapshot_name or a different ZfsDataset )"""
+
+        if not isinstance(snapshot, ZfsDataset):
+            snapshot_name = snapshot
+        else:
+            snapshot_name = snapshot.snapshot_name
+
+        for snapshot in self.snapshots:
+            if snapshot.snapshot_name == snapshot_name:
+                return snapshot
+
+        return None
+
+    def find_snapshot_index(self, snapshot):
+        """find snapshot index by snapshot (can be a snapshot_name or ZfsDataset)"""
+
+        if not isinstance(snapshot, ZfsDataset):
+            snapshot_name = snapshot
+        else:
+            snapshot_name = snapshot.snapshot_name
+
+        index = 0
+        for snapshot in self.snapshots:
+            if snapshot.snapshot_name == snapshot_name:
+                return index
+            index = index + 1
+
+        return None
+
+    @CachedProperty
+    def written_since_ours(self):
+        """get number of bytes written since our last snapshot"""
+
+        latest_snapshot = self.our_snapshots[-1]
+
+        self.debug("Getting bytes written since our last snapshot")
+        cmd = ["zfs", "get", "-H", "-ovalue", "-p", "written@" + str(latest_snapshot), self.name]
+
+        output = self.zfs_node.run(readonly=True, tab_split=False, cmd=cmd, valid_exitcodes=[0])
+
+        return int(output[0])
+
+    def is_changed_ours(self, min_changed_bytes=1):
+        """dataset is changed since OUR latest snapshot?"""
+
+        if min_changed_bytes == 0:
+            return True
+
+        if not self.our_snapshots:
+            return True
+
+        # NOTE: filesystems can have a very small amount written without actual changes in some cases
+        if self.written_since_ours < min_changed_bytes:
+            return False
+
+        return True
+
+    @CachedProperty
+    def recursive_datasets(self, types="filesystem,volume"):
+        """get all (non-snapshot) datasets recursively under us"""
+
+        self.debug("Getting all recursive datasets under us")
+
+        names = self.zfs_node.run(tab_split=False, readonly=True, valid_exitcodes=[0], cmd=[
+            "zfs", "list", "-r", "-t", types, "-o", "name", "-H", self.name
+        ])
+
+        return self.from_names(names[1:])
+
+    @CachedProperty
+    def datasets(self, types="filesystem,volume"):
+        """get all (non-snapshot) datasets directly under us"""
+
+        self.debug("Getting all datasets under us")
+
+        names = self.zfs_node.run(tab_split=False, readonly=True, valid_exitcodes=[0], cmd=[
+            "zfs", "list", "-r", "-t", types, "-o", "name", "-H", "-d", "1", self.name
+        ])
+
+        return self.from_names(names[1:])
+
+    def send_pipe(self, features, prev_snapshot=None, resume_token=None, show_progress=False, raw=False):
+        """returns a pipe with zfs send output for this snapshot
+
+        resume_token: resume sending from this token. (in that case we don't need to know snapshot names)
+
+        """
+        # build source command
+        cmd = []
+
+        cmd.extend(["zfs", "send", ])
+
+        # all kind of performance options:
+        if 'large_blocks' in features and "-L" in self.zfs_node.supported_send_options:
+            cmd.append("-L")  # large block support (only if recordsize>128k which is seldomly used)
+
+        if 'embedded_data' in features and "-e" in self.zfs_node.supported_send_options:
+            cmd.append("-e")  # WRITE_EMBEDDED, more compact stream
+
+        if "-c" in self.zfs_node.supported_send_options:
+            cmd.append("-c")  # use compressed WRITE records
+
+        # NOTE: performance is usually worse with this option, according to manual
+        # also -D will be depricated in newer ZFS versions
+        # if not resume:
+        #     if "-D" in self.zfs_node.supported_send_options:
+        #         cmd.append("-D") # dedupped stream, sends less duplicate data
+
+        # raw? (for encryption)
+        if raw:
+            cmd.append("--raw")
+
+        # progress output
+        if show_progress:
+            cmd.append("-v")
+            cmd.append("-P")
+
+        # resume a previous send? (don't need more parameters in that case)
+        if resume_token:
+            cmd.extend(["-t", resume_token])
+
+        else:
+            # send properties
+            cmd.append("-p")
+
+            # incremental?
+            if prev_snapshot:
+                cmd.extend(["-i", "@" + prev_snapshot.snapshot_name])
+
+            cmd.append(self.name)
+
+        # if args.buffer and args.ssh_source!="local":
+        #     cmd.append("|mbuffer -m {}".format(args.buffer))
+
+        # NOTE: this doesn't start the send yet, it only returns a subprocess.Pipe
+        return self.zfs_node.run(cmd, pipe=True)
+
+    def recv_pipe(self, pipe, features, filter_properties=None, set_properties=None, ignore_exit_code=False):
+        """starts a zfs recv for this snapshot and uses pipe as input
+
+        note: you can it both on a snapshot or filesystem object.
+        The resulting zfs command is the same, only our object cache is invalidated differently.
+        """
+
+        if set_properties is None:
+            set_properties = []
+
+        if filter_properties is None:
+            filter_properties = []
+
+        # build target command
+        cmd = []
+
+        cmd.extend(["zfs", "recv"])
+
+        # don't mount filesystem that is received
+        cmd.append("-u")
+
+        for property_ in filter_properties:
+            cmd.extend(["-x", property_])
+
+        for property_ in set_properties:
+            cmd.extend(["-o", property_])
+
+        # verbose output
+        cmd.append("-v")
+
+        if 'extensible_dataset' in features and "-s" in self.zfs_node.supported_recv_options:
+            # support resuming
+            self.debug("Enabled resume support")
+            cmd.append("-s")
+
+        cmd.append(self.filesystem_name)
+
+        if ignore_exit_code:
+            valid_exitcodes = []
+        else:
+            valid_exitcodes = [0]
+
+        self.zfs_node.reset_progress()
+        self.zfs_node.run(cmd, inp=pipe, valid_exitcodes=valid_exitcodes)
+
+        # invalidate cache, but we at least know we exist now
+        self.invalidate()
+
+        # in test mode we assume everything was ok and it exists
+        if self.zfs_node.readonly:
+            self.force_exists = True
+
+        # check if transfer was really ok (exit codes have been wrong before due to bugs in zfs-utils and can be
+        # ignored by some parameters)
+        if not self.exists:
+            self.error("error during transfer")
+            raise (Exception("Target doesn't exist after transfer, something went wrong."))
+
+        # if args.buffer and  args.ssh_target!="local":
+        #     cmd.append("|mbuffer -m {}".format(args.buffer))
+
+    def transfer_snapshot(self, target_snapshot, features, prev_snapshot=None, show_progress=False,
+                          filter_properties=None, set_properties=None, ignore_recv_exit_code=False, resume_token=None,
+                          raw=False):
+        """transfer this snapshot to target_snapshot. specify prev_snapshot for incremental transfer
+
+        connects a send_pipe() to recv_pipe()
+        """
+
+        if set_properties is None:
+            set_properties = []
+        if filter_properties is None:
+            filter_properties = []
+
+        self.debug("Transfer snapshot to {}".format(target_snapshot.filesystem_name))
+
+        if resume_token:
+            target_snapshot.verbose("resuming")
+
+        # initial or increment
+        if not prev_snapshot:
+            target_snapshot.verbose("receiving full".format(self.snapshot_name))
+        else:
+            # incremental
+            target_snapshot.verbose("receiving incremental".format(self.snapshot_name))
+
+        # do it
+        pipe = self.send_pipe(features=features, show_progress=show_progress, prev_snapshot=prev_snapshot,
+                              resume_token=resume_token, raw=raw)
+        target_snapshot.recv_pipe(pipe, features=features, filter_properties=filter_properties,
+                                  set_properties=set_properties, ignore_exit_code=ignore_recv_exit_code)
+
+    def abort_resume(self):
+        """abort current resume state"""
+        self.zfs_node.run(["zfs", "recv", "-A", self.name])
+
+    def rollback(self):
+        """rollback to latest existing snapshot on this dataset"""
+
+        for snapshot in reversed(self.snapshots):
+            if snapshot.exists:
+                self.debug("Rolling back")
+                self.zfs_node.run(["zfs", "rollback", snapshot.name])
+                return
+
+    def get_resume_snapshot(self, resume_token):
+        """returns snapshot that will be resumed by this resume token (run this on source with target-token)"""
+        # use zfs send -n option to determine this
+        # NOTE: on smartos stderr, on linux stdout
+        (stdout, stderr) = self.zfs_node.run(["zfs", "send", "-t", resume_token, "-n", "-v"], valid_exitcodes=[0, 255],
+                                             readonly=True, return_stderr=True)
+        if stdout:
+            lines = stdout
+        else:
+            lines = stderr
+        for line in lines:
+            matches = re.findall("toname = .*@(.*)", line)
+            if matches:
+                snapshot_name = matches[0]
+                snapshot = ZfsDataset(self.zfs_node, self.filesystem_name + "@" + snapshot_name)
+                snapshot.debug("resume token belongs to this snapshot")
+                return snapshot
+
+        return None
+
+    def thin_list(self, keeps=None, ignores=None):
+        """determines list of snapshots that should be kept or deleted based on the thinning schedule. cull the herd!
+        keep: list of snapshots to always keep (usually the last) ignores: snapshots to completely ignore (usually
+        incompatible target snapshots that are going to be destroyed anyway)
+
+        returns: ( keeps, obsoletes )
+        """
+
+        if ignores is None:
+            ignores = []
+        if keeps is None:
+            keeps = []
+
+        snapshots = [snapshot for snapshot in self.our_snapshots if snapshot not in ignores]
+
+        return self.zfs_node.thinner.thin(snapshots, keep_objects=keeps)
+
+    def thin(self, skip_holds=False):
+        """destroys snapshots according to thin_list, except last snapshot"""
+
+        (keeps, obsoletes) = self.thin_list(keeps=self.our_snapshots[-1:])
+        for obsolete in obsoletes:
+            if skip_holds and obsolete.is_hold():
+                obsolete.verbose("Keeping (common snapshot)")
+            else:
+                obsolete.destroy()
+                self.snapshots.remove(obsolete)
+
+    def find_common_snapshot(self, target_dataset):
+        """find latest common snapshot between us and target
+        returns None if its an initial transfer
+        """
+        if not target_dataset.snapshots:
+            # 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")
+                    return source_snapshot
+            target_dataset.error("Cant find common snapshot with source.")
+            raise (Exception("You probably need to delete the target dataset to fix this."))
+
+    def find_start_snapshot(self, common_snapshot, other_snapshots):
+        """finds first snapshot to send"""
+
+        if not common_snapshot:
+            if not self.snapshots:
+                start_snapshot = None
+            else:
+                # start from beginning
+                start_snapshot = self.snapshots[0]
+
+                if not start_snapshot.is_ours() and not other_snapshots:
+                    # try to start at a snapshot thats ours
+                    start_snapshot = self.find_next_snapshot(start_snapshot, other_snapshots)
+        else:
+            start_snapshot = self.find_next_snapshot(common_snapshot, other_snapshots)
+
+        return start_snapshot
+
+    def find_incompatible_snapshots(self, common_snapshot):
+        """returns a list of snapshots that is incompatible for a zfs recv onto the common_snapshot.
+        all direct followup snapshots with written=0 are compatible."""
+
+        ret = []
+
+        if common_snapshot and self.snapshots:
+            followup = True
+            for snapshot in self.snapshots[self.find_snapshot_index(common_snapshot) + 1:]:
+                if not followup or int(snapshot.properties['written']) != 0:
+                    followup = False
+                    ret.append(snapshot)
+
+        return ret
+
+    def get_allowed_properties(self, filter_properties, set_properties):
+        """only returns lists of allowed properties for this dataset type"""
+
+        allowed_filter_properties = []
+        allowed_set_properties = []
+        illegal_properties = self.ILLEGAL_PROPERTIES[self.properties['type']]
+        for set_property in set_properties:
+            (property_, value) = set_property.split("=")
+            if property_ not in illegal_properties:
+                allowed_set_properties.append(set_property)
+
+        for filter_property in filter_properties:
+            if filter_property not in illegal_properties:
+                allowed_filter_properties.append(filter_property)
+
+        return allowed_filter_properties, allowed_set_properties
+
+    def sync_snapshots(self, target_dataset, features, show_progress=False, filter_properties=None, set_properties=None,
+                       ignore_recv_exit_code=False, holds=True, rollback=False, raw=False, other_snapshots=False,
+                       no_send=False, destroy_incompatible=False):
+        """sync this dataset's snapshots to target_dataset, while also thinning out old snapshots along the way."""
+
+        if set_properties is None:
+            set_properties = []
+        if filter_properties is None:
+            filter_properties = []
+
+        # determine common and start snapshot
+        target_dataset.debug("Determining start snapshot")
+        common_snapshot = self.find_common_snapshot(target_dataset)
+        start_snapshot = self.find_start_snapshot(common_snapshot, other_snapshots)
+        # should be destroyed before attempting zfs recv:
+        incompatible_target_snapshots = target_dataset.find_incompatible_snapshots(common_snapshot)
+
+        # make target snapshot list the same as source, by adding virtual non-existing ones to the list.
+        target_dataset.debug("Creating virtual target snapshots")
+        source_snapshot = start_snapshot
+        while source_snapshot:
+            # create virtual target snapshot
+            virtual_snapshot = ZfsDataset(target_dataset.zfs_node,
+                                          target_dataset.filesystem_name + "@" + source_snapshot.snapshot_name,
+                                          force_exists=False)
+            target_dataset.snapshots.append(virtual_snapshot)
+            source_snapshot = self.find_next_snapshot(source_snapshot, other_snapshots)
+
+        # now let thinner decide what we want on both sides as final state (after all transfers are done)
+        if self.our_snapshots:
+            self.debug("Create thinning list")
+            (source_keeps, source_obsoletes) = self.thin_list(keeps=[self.our_snapshots[-1]])
+        else:
+            source_obsoletes = []
+
+        if target_dataset.our_snapshots:
+            (target_keeps, target_obsoletes) = target_dataset.thin_list(keeps=[target_dataset.our_snapshots[-1]],
+                                                                        ignores=incompatible_target_snapshots)
+        else:
+            target_keeps = []
+            target_obsoletes = []
+
+        # on source: destroy all obsoletes before common. but after common, only delete snapshots that target also
+        # doesn't want to explicitly keep
+        before_common = True
+        for source_snapshot in self.snapshots:
+            if common_snapshot and source_snapshot.snapshot_name == common_snapshot.snapshot_name:
+                before_common = False
+                # never destroy common snapshot
+            else:
+                target_snapshot = target_dataset.find_snapshot(source_snapshot)
+                if (source_snapshot in source_obsoletes) and (before_common or (target_snapshot not in target_keeps)):
+                    source_snapshot.destroy()
+
+        # on target: destroy everything thats obsolete, except common_snapshot
+        for target_snapshot in target_dataset.snapshots:
+            if (target_snapshot in target_obsoletes) and (
+                    not common_snapshot or target_snapshot.snapshot_name != common_snapshot.snapshot_name):
+                if target_snapshot.exists:
+                    target_snapshot.destroy()
+
+        # now actually transfer the snapshots, if we want
+        if no_send:
+            return
+
+        # resume?
+        resume_token = None
+        if 'receive_resume_token' in target_dataset.properties:
+            resume_token = target_dataset.properties['receive_resume_token']
+            # not valid anymore?
+            resume_snapshot = self.get_resume_snapshot(resume_token)
+            if not resume_snapshot or start_snapshot.snapshot_name != resume_snapshot.snapshot_name:
+                target_dataset.verbose("Cant resume, resume token no longer valid.")
+                target_dataset.abort_resume()
+                resume_token = None
+
+        # incompatible target snapshots?
+        if incompatible_target_snapshots:
+            if not destroy_incompatible:
+                for snapshot in incompatible_target_snapshots:
+                    snapshot.error("Incompatible snapshot")
+                raise (Exception("Please destroy incompatible snapshots or use --destroy-incompatible."))
+            else:
+                for snapshot in incompatible_target_snapshots:
+                    snapshot.verbose("Incompatible snapshot")
+                    snapshot.destroy()
+                    target_dataset.snapshots.remove(snapshot)
+
+        # rollback target to latest?
+        if rollback:
+            target_dataset.rollback()
+
+        # now actually transfer the snapshots
+        prev_source_snapshot = common_snapshot
+        source_snapshot = start_snapshot
+        while source_snapshot:
+            target_snapshot = target_dataset.find_snapshot(source_snapshot)  # still virtual
+
+            # does target actually want it?
+            if target_snapshot not in target_obsoletes:
+                # NOTE: should we let transfer_snapshot handle this?
+                (allowed_filter_properties, allowed_set_properties) = self.get_allowed_properties(filter_properties,
+                                                                                                  set_properties)
+                source_snapshot.transfer_snapshot(target_snapshot, features=features,
+                                                  prev_snapshot=prev_source_snapshot, show_progress=show_progress,
+                                                  filter_properties=allowed_filter_properties,
+                                                  set_properties=allowed_set_properties,
+                                                  ignore_recv_exit_code=ignore_recv_exit_code,
+                                                  resume_token=resume_token, raw=raw)
+                resume_token = None
+
+                # hold the new common snapshots and release the previous ones
+                if holds:
+                    target_snapshot.hold()
+                    source_snapshot.hold()
+
+                if prev_source_snapshot:
+                    if holds:
+                        prev_source_snapshot.release()
+                        target_dataset.find_snapshot(prev_source_snapshot).release()
+
+                # we may now destroy the previous source snapshot if its obsolete
+                if prev_source_snapshot in source_obsoletes:
+                    prev_source_snapshot.destroy()
+
+                    # destroy the previous target snapshot if obsolete (usually this is only the common_snapshot,
+                    # the rest was already destroyed or will not be send)
+                prev_target_snapshot = target_dataset.find_snapshot(prev_source_snapshot)
+                if prev_target_snapshot in target_obsoletes:
+                    prev_target_snapshot.destroy()
+
+                prev_source_snapshot = source_snapshot
+            else:
+                source_snapshot.debug("skipped (target doesn't need it)")
+                # was it actually a resume?
+                if resume_token:
+                    target_dataset.debug("aborting resume, since we don't want that snapshot anymore")
+                    target_dataset.abort_resume()
+                    resume_token = None
+
+            source_snapshot = self.find_next_snapshot(source_snapshot, other_snapshots)

zfs_autobackup/ZfsNode.py

@@ -0,0 +1,238 @@
+# python 2 compatibility
+from __future__ import print_function
+import re
+import subprocess
+import sys
+import time
+
+from zfs_autobackup.ExecuteNode import ExecuteNode
+from zfs_autobackup.Thinner import Thinner
+from zfs_autobackup.CachedProperty import CachedProperty
+from zfs_autobackup.ZfsPool import ZfsPool
+from zfs_autobackup.ZfsDataset import ZfsDataset
+
+
+class ZfsNode(ExecuteNode):
+    """a node that contains zfs datasets. implements global (systemwide/pool wide) zfs commands"""
+
+    def __init__(self, backup_name, logger, ssh_config=None, ssh_to=None, readonly=False, description="",
+                 debug_output=False, thinner=Thinner()):
+        self.backup_name = backup_name
+        if not description and ssh_to:
+            self.description = ssh_to
+        else:
+            self.description = description
+
+        self.logger = logger
+
+        if ssh_config:
+            self.verbose("Using custom SSH config: {}".format(ssh_config))
+
+        if ssh_to:
+            self.verbose("Datasets on: {}".format(ssh_to))
+        else:
+            self.verbose("Datasets are local")
+
+        rules = thinner.human_rules()
+        if rules:
+            for rule in rules:
+                self.verbose(rule)
+        else:
+            self.verbose("Keep no old snaphots")
+
+        self.thinner = thinner
+
+        # list of ZfsPools
+        self.__pools = {}
+
+        self._progress_total_bytes = 0
+        self._progress_start_time = time.time()
+
+        ExecuteNode.__init__(self, ssh_config=ssh_config, ssh_to=ssh_to, readonly=readonly, debug_output=debug_output)
+
+    @CachedProperty
+    def supported_send_options(self):
+        """list of supported options, for optimizing sends"""
+        # not every zfs implementation supports them all
+
+        ret = []
+        for option in ["-L", "-e", "-c"]:
+            if self.valid_command(["zfs", "send", option, "zfs_autobackup_option_test"]):
+                ret.append(option)
+        return ret
+
+    @CachedProperty
+    def supported_recv_options(self):
+        """list of supported options"""
+        # not every zfs implementation supports them all
+
+        ret = []
+        for option in ["-s"]:
+            if self.valid_command(["zfs", "recv", option, "zfs_autobackup_option_test"]):
+                ret.append(option)
+        return ret
+
+    def valid_command(self, cmd):
+        """test if a specified zfs options are valid exit code. use this to determine support options"""
+
+        try:
+            self.run(cmd, hide_errors=True, valid_exitcodes=[0, 1])
+        except subprocess.CalledProcessError:
+            return False
+
+        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"""
+
+        return self.__pools.setdefault(name, ZfsPool(self, name))
+
+    def reset_progress(self):
+        """reset progress output counters"""
+        self._progress_total_bytes = 0
+        self._progress_start_time = time.time()
+
+    def parse_zfs_progress(self, line, hide_errors, prefix):
+        """try to parse progress output of zfs recv -Pv, and don't show it as error to the user """
+
+        # is it progress output?
+        progress_fields = line.rstrip().split("\t")
+
+        if (line.find("nvlist version") == 0 or
+                line.find("resume token contents") == 0 or
+                len(progress_fields) != 1 or
+                line.find("skipping ") == 0 or
+                re.match("send from .*estimated size is ", line)):
+
+            # always output for debugging offcourse
+            self.debug(prefix + line.rstrip())
+
+            # actual useful info
+            if len(progress_fields) >= 3:
+                if progress_fields[0] == 'full' or progress_fields[0] == 'size':
+                    self._progress_total_bytes = int(progress_fields[2])
+                elif progress_fields[0] == 'incremental':
+                    self._progress_total_bytes = int(progress_fields[3])
+                else:
+                    bytes_ = int(progress_fields[1])
+                    if self._progress_total_bytes:
+                        percentage = min(100, int(bytes_ * 100 / self._progress_total_bytes))
+                        speed = int(bytes_ / (time.time() - self._progress_start_time) / (1024 * 1024))
+                        bytes_left = self._progress_total_bytes - bytes_
+                        minutes_left = int((bytes_left / (bytes_ / (time.time() - self._progress_start_time))) / 60)
+
+                        print(">>> {}% {}MB/s (total {}MB, {} minutes left)     \r".format(percentage, speed, int(
+                            self._progress_total_bytes / (1024 * 1024)), minutes_left), end='', file=sys.stderr)
+                        sys.stderr.flush()
+
+            return
+
+        # still do the normal stderr output handling
+        if hide_errors:
+            self.debug(prefix + line.rstrip())
+        else:
+            self.error(prefix + line.rstrip())
+
+    def _parse_stderr_pipe(self, line, hide_errors):
+        self.parse_zfs_progress(line, hide_errors, "STDERR|> ")
+
+    def _parse_stderr(self, line, hide_errors):
+        self.parse_zfs_progress(line, hide_errors, "STDERR > ")
+
+    def verbose(self, txt):
+        self.logger.verbose("{} {}".format(self.description, txt))
+
+    def error(self, txt):
+        self.logger.error("{} {}".format(self.description, txt))
+
+    def debug(self, txt):
+        self.logger.debug("{} {}".format(self.description, txt))
+
+    def new_snapshotname(self):
+        """determine uniq new snapshotname"""
+        return self.backup_name + "-" + time.strftime("%Y%m%d%H%M%S")
+
+    def consistent_snapshot(self, datasets, snapshot_name, min_changed_bytes):
+        """create a consistent (atomic) snapshot of specified datasets, per pool.
+        """
+
+        pools = {}
+
+        # collect snapshots that we want to make, per pool
+        # self.debug(datasets)
+        for dataset in datasets:
+            if not dataset.is_changed_ours(min_changed_bytes):
+                dataset.verbose("No changes since {}".format(dataset.our_snapshots[-1].snapshot_name))
+                continue
+
+            # force_exist, since we're making it
+            snapshot = ZfsDataset(dataset.zfs_node, dataset.name + "@" + snapshot_name, force_exists=True)
+
+            pool = dataset.split_path()[0]
+            if pool not in pools:
+                pools[pool] = []
+
+            pools[pool].append(snapshot)
+
+            # update cache, but try to prevent an unneeded zfs list
+            if self.readonly or CachedProperty.is_cached(dataset, 'snapshots'):
+                dataset.snapshots.append(snapshot)  # NOTE: this will trigger zfs list if its not cached
+
+        if not pools:
+            self.verbose("No changes anywhere: not creating snapshots.")
+            return
+
+        # create consistent snapshot per pool
+        for (pool_name, snapshots) in pools.items():
+            cmd = ["zfs", "snapshot"]
+
+            cmd.extend(map(lambda snapshot_: str(snapshot_), snapshots))
+
+            self.verbose("Creating snapshots {} in pool {}".format(snapshot_name, pool_name))
+            self.run(cmd, readonly=False)
+
+    @CachedProperty
+    def selected_datasets(self):
+        """determine filesystems that should be backupped by looking at the special autobackup-property, systemwide
+
+           returns: list of ZfsDataset
+        """
+
+        self.debug("Getting selected datasets")
+
+        # get all source filesystems that have the backup property
+        lines = self.run(tab_split=True, readonly=True, cmd=[
+            "zfs", "get", "-t", "volume,filesystem", "-o", "name,value,source", "-s", "local,inherited", "-H",
+            "autobackup:" + self.backup_name
+        ])
+
+        # determine filesystems that should be actually backupped
+        selected_filesystems = []
+        direct_filesystems = []
+        for line in lines:
+            (name, value, source) = line
+            dataset = ZfsDataset(self, name)
+
+            if value == "false":
+                dataset.verbose("Ignored (disabled)")
+
+            else:
+                if source == "local" and (value == "true" or value == "child"):
+                    direct_filesystems.append(name)
+
+                if source == "local" and value == "true":
+                    dataset.verbose("Selected (direct selection)")
+                    selected_filesystems.append(dataset)
+                elif source.find("inherited from ") == 0 and (value == "true" or value == "child"):
+                    inherited_from = re.sub("^inherited from ", "", source)
+                    if inherited_from in direct_filesystems:
+                        selected_filesystems.append(dataset)
+                        dataset.verbose("Selected (inherited selection)")
+                    else:
+                        dataset.debug("Ignored (already a backup)")
+                else:
+                    dataset.verbose("Ignored (only childs)")
+
+        return selected_filesystems

zfs_autobackup/ZfsPool.py

@@ -0,0 +1,64 @@
+from zfs_autobackup.CachedProperty import CachedProperty
+
+
+class ZfsPool():
+    """a zfs pool"""
+
+    def __init__(self, zfs_node, name):
+        """name: name of the pool
+        """
+
+        self.zfs_node = zfs_node
+        self.name = name
+
+    def __repr__(self):
+        return "{}: {}".format(self.zfs_node, self.name)
+
+    def __str__(self):
+        return self.name
+
+    def __eq__(self, obj):
+        if not isinstance(obj, ZfsPool):
+            return False
+
+        return self.name == obj.name
+
+    def verbose(self, txt):
+        self.zfs_node.verbose("zpool {}: {}".format(self.name, txt))
+
+    def error(self, txt):
+        self.zfs_node.error("zpool {}: {}".format(self.name, txt))
+
+    def debug(self, txt):
+        self.zfs_node.debug("zpool {}: {}".format(self.name, txt))
+
+    @CachedProperty
+    def properties(self):
+        """all zpool properties"""
+
+        self.debug("Getting zpool properties")
+
+        cmd = [
+            "zpool", "get", "-H", "-p", "all", self.name
+        ]
+
+        ret = {}
+
+        for pair in self.zfs_node.run(tab_split=True, cmd=cmd, readonly=True, valid_exitcodes=[0]):
+            if len(pair) == 4:
+                ret[pair[1]] = pair[2]
+
+        return ret
+
+    @property
+    def features(self):
+        """get list of active zpool features"""
+
+        ret = []
+        for (key, value) in self.properties.items():
+            if key.startswith("feature@"):
+                feature = key.split("@")[1]
+                if value == 'enabled' or value == 'active':
+                    ret.append(feature)
+
+        return ret

zfs_autobackup/__init__.py

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

zfs_autobackup/__main__.py

@@ -0,0 +1,10 @@
+# (c)edwin@datux.nl  - Released under GPL V3
+#
+# Greetings from eth0 2019 :)
+
+import sys
+
+if __name__ == "__main__":
+    from . import cli
+    cli()
+