Bump version to 4.4.0

Add a progress bar for rsync
On a terminal, run rsync with --info=progress2 and draw its updates as a progress bar on stderr. The ETA is estimated locally, since rsync reports the elapsed time when a file finishes. Disable it with --no-progress.
2026-10-14 09:48:18 +02:00 · 2026-10-14 09:46:50 +02:00 · 2026-10-14 09:42:37 +02:00 · 2026-10-14 09:40:35 +02:00 · 2026-10-14 08:39:46 +02:00 · 2026-10-14 08:37:06 +02:00
16 changed files with 3664 additions and 695 deletions
@@ -0,0 +1,3 @@
 .idea/
 __pycache__/
 test/
@@ -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>.
@@ -0,0 +1,38 @@
 # PKGBUILD
 # Maintainer: Daniele Fucini <dfucini [at] gmail [dot] com>
 pkgname=simple_backup
 pkgdesc='Simple backup script that uses rsync to copy files'
 pkgver=4.3.0
 pkgrel=1
 url="https://git.shouldnt.work/fuxino/${pkgname}"
 arch=('any')
 license=('GPL-3.0-or-later')
 makedepends=('git'
             'python-setuptools'
             'python-build'
             'python-installer')
 depends=('python>=3.10'
         'rsync')
 optdepends=('python-systemd: use systemd log'
            'python-dbus: for desktop notifications'
            'python-paramiko: for remote backup through ssh')
 conflicts=('simple_backup-git')
 source=(git+${url}?signed#tag=${pkgver})
 validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
 sha256sums=('7d9ea50d5829ac3c681a979745f1ae7afd2453eb46ceeae4f441ef5ae4540bd2')
 build()
 {
    cd ${srcdir}/${pkgname}
    python -m build --wheel --no-isolation
 }
 package()
 {
    cd ${srcdir}/${pkgname}
    python -m installer --destdir=${pkgdir} dist/*.whl
    install -Dm644 ${pkgname}/${pkgname}.conf ${pkgdir}/usr/share/doc/${pkgname}/${pkgname}.conf
    install -Dm644 man/${pkgname}.1 ${pkgdir}/usr/share/man/man1/${pkgname}.1
 }
@@ -1,10 +1,89 @@
-# simple-backup
+simple_backup
 ============
 A simple backup script
 ## Description
-simple-backup is just a bash script that allows you to backup your files.
+simple_backup is a Python script that allows you to backup your files.
-It reads from a configuration file the files/directories that must be copied,
+Parameters like input files/directories, output directory etc. can be specified in a configuration file, or on the command line.
-the destination directory for the backup and a few other options.
+Run:
 ```bash
 simple_backup -h
 ```
 to print all possible command line options.
 ## Dependencies
-rsync is used to perform the backup.  
+The script uses rsync to actually run the backup, so you will have to install it on your system. For example on Arch Linux:
 ```bash
 sudo pacman -Syu rsync
 ```
 Optional dependencies are systemd-python to enable using systemd journal for logging, dbus-python for desktop notifications, and paramiko (version 3.2 or later) for remote backup.
 ## Install
 For Arch Linux and Arch-based distros, two packages are available in the AUR (aur.archlinux.org):
 - **simple_backup** for the release version
 - **simple_backup-git** for the git version
 To install it from source, first clone the repository:
 ```bash
 git clone https://git.shouldnt.work/fuxino/simple_backup.git
 ```
 Then build the package (this requires the Python `build` module, e.g. the python-build package on Arch Linux):
 ```bash
 cd simple_backup
 python -m build --wheel
 ```
 Many distributions don't allow installing packages with pip into the system Python ("externally-managed-environment" error).
 In that case, install the wheel in a virtual environment, for example with pipx:
 ```bash
 pipx install dist/*.whl
 ```
 Optional dependencies can be installed as extras, for example `pipx install 'dist/simple_backup-<version>-py3-none-any.whl[REMOTE]'` (available extras: JOURNAL, NOTIFICATIONS, REMOTE).
 ## Running as root
 To back up files that your user can't read, run simple_backup with sudo or doas.
 In that case the user who ran the command is detected automatically, so that '~' (in the inputs and in the default configuration file path) refers to that user's home directory, not root's.
 When running as root in other ways (e.g. from a systemd service), specify the user with the --user (or -u) argument.
 ## Old backups
 The number of old backups to keep can be set with the --keep (or -k) argument (or in the configuration file).
 Old backups are only removed if rsync completes successfully, so that they are not deleted when the new backup may be incomplete.
 The only rsync error that is ignored is return code 24 (source files vanished during the transfer), which is common when backing up a live system.
 ## Remote backup
 > **Warning**
 > This feature is experimental
 It's possible to use a remote server as destination for the backup. Just use the --ssh-user and --ssh-host arguments (or set them in the configuration file).
 Both are required: if only one of them is set, simple_backup exits with an error.
 For this to work, rsync must be installed on the server too.
 The output directory is a path on the server. A leading '~' and relative paths refer to the user's home directory on the server.
 On the command line, quote '~' so that your local shell doesn't expand it:
 ```bash
 simple_backup --ssh-host server --ssh-user user -o '~/backups'
 ```
 ### Server authentication
 The best way to handle the authentication is to have an ssh agent running on your system, otherwise if a passphrase is necessary to unlock the ssh key, it will be necessary to enter it more than once.
 If needed, it's possible to specify the ssh key location with the --keyfile argument or in the configuration file.
 To be able to connect to the user's ssh agent when running simple_backup with sudo, make sure to preserve the SSH_AUTH_SOCK environment variable. For example:
 ```bash
 sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
 ```
 or by editing the sudoers file.
 If SSH key authentication is not available, password authentication will be used instead.
 Check the man page for more details.
@@ -1,15 +0,0 @@
 #Example config file for my_backup
 # WARNING: Values should NOT be quoted, e.g. use inputs=/some/dir instead of inputs="/some/dir"
 #Input directories. Use a comma to separate items
 inputs=/home/my_home,/etc
 #Output directory
 backup_dir=/media/Backup
 #Exclude patterns. Use a comma to separate items
 exclude=.gvfs,.cache*,[Cc]ache*,.thumbnails*,[Tt]rash*,*.backup*,*~,.dropbox*
 #Number of snapshots to keep (default: keep all)
 keep=
@@ -0,0 +1,222 @@
 .TH SIMPLE_BACKUP 1 2026-10-14 SIMPLE_BACKUP 4.4.0
 .SH NAME
 simple_backup \- Backup files and folders using rsync
 .SH SYNOPSIS
 .B simple_backup
 \-h, \-\-help
 .PD 0
 .P
 .PD
 .B simple_backup
 [\-c, \-\-config FILE]
 [\-i, \-\-input INPUT [INPUT...]]
 [\-o, \-\-output DIR]
 .PD 0
 .P
 .PD
 .RS 14 [\-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
 [\-k, \-\-keep N]
 [\-\-ssh\-host HOSTNAME]
 [\-\-ssh\-user USERNAME]
 [\-\-keyfile FILE]
 .PD 0
 .P
 .PD
 [\-s, \-\-checksum]
 [\-z, \-\-compress]
 [\-\-remove\-before\-backup]
 .RE
 .SH DESCRIPTION
 .B simple_backup
 is a python script for performing backup of files and folders.
 .P
 It uses rsync to copy the files to the specified location. Parameters for the backup such as
 input files/directories, output location and files or folders to exclude can be specified
 in a configuration file (default location $HOME/.config/simple_backup/simple_backup.conf)
 or directly on the command line.
 .P
 Parameters specified on the command line will override those in the configuration file.
 .SH OPTIONS
 .TP
 .B \-h, \-\-help
 Print a short help message and exit.
 .TP
 .B \-c, \-\-config FILE
 Specify the configuration file, useful to specify a different one from the default.
 .TP
 .B \-i, \-\-input INPUT [INPUT...]
 Specify the files and directories to backup. Multiple inputs can be specified, just separate
 them with a space. If filenames or paths contain spaces, don't forget to escape them,
 or to use single or double quotes around them.
 .TP
 .B \-o, \-\-output DIR
 Specify the directory where the files will be copied. The program will automatically
 create a subdirectory called \(aqsimple_backup\(aq (if it does not already exist) and
 inside this directory the actual backup directory (using the current date and time, for example
 \(aq2026\-10\-08_17\-34\-47\(aq).
 .RS
 .P
 Backups are best stored on a Linux filesystem (e.g. ext4 or btrfs). FAT and exFAT filesystems
 are supported, but they don\(aqt support hard links, so each backup will be a full copy instead
 of only storing files that changed since the previous one. File ownership and permissions are
 not preserved either.
 .RE
 .TP
 .B \-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
 Specify files, directories or patterns to exclude from the backup. Matching files and directories
 will not be copied. Multiple elements can be specified, in the same way as for the \-\-input option.
 .TP
 .B \-k, \-\-keep N
 Specify how many old backups (so excluding the current one) will be kept. The default behavior
 is to keep them all (same as N=\-1).
 Old backups are only removed if rsync completes successfully, to avoid deleting them when the
 new backup may be incomplete. rsync return code 24 (source files vanished during the transfer)
 is treated as success, while any other error (including return code 23, partial transfer due to error)
 will prevent old backups from being removed. This does not apply when using \-\-remove\-before\-backup.
 .TP
 .B \-u, \-\-user USERNAME
 Explicitly specify the user running the backup (in case it is needed for home directory expansion).
 .TP
 .B \-\-ssh\-host HOSTNAME
 Hostname of the server where to copy the files in case of remote backup through SSH.
 .TP
 .B \-\-ssh\-user USERNAME
 Username for connecting to the server in case of remote backup.
 .TP
 .B \-\-keyfile FILE
 Location of the SSH key for server authentication. 
 .TP
 .B \-s, \-\-checksums
 Same as rsync option \(aq\-\-checksum\(aq, use checksums instead of mod\-time and size
 to skip files.
 .TP
 .B \-z, \-\-compress
 Compress data during transfer (rsync \(aq\-\-compress\(aq option). Useful for remote backup
 if saving bandwith is needed.
 .TP
 .B \-\-remove\-before\-backup
 Remove old backups (if necessary) before creating the new backup. Useful to free some space
 before performing the backup.
 Default behavior is to remove old backups after successfully completing the backup.
 Note that if the backup fails after old backups have been removed, only the backups kept
 according to \-\-keep will be left, and the new backup may be incomplete. In particular, with
 \-\-keep 0 there will be no complete backup available until the next successful one.
 .TP
 .B \-\-no\-syslog
 Don't use systemd journal for logging.
 .TP
 .B \-\-no\-progress
 Don't show a progress bar while rsync copies the files. The progress bar is only shown when
 the output is a terminal, so it never appears in the systemd journal or in redirected output.
 While rsync is still looking for files, the bar shows \(aq(scanning)\(aq, and the percentage
 and estimated time are only approximate.
 .TP
 .B \-\-rsync\-options OPTIONS [OPTION...]
 By default, the following rsync options are used:
 .RS
 .P
    \-a \-r \-v \-h \-s \-H \-X
 .P
 Using \-\-rsync\-options it is possible to manually select which options to use. Supported values are the following:
 .P
    \-a, \-l, \-p, \-t, \-g, \-o, \-c, \-h, \-D, \-H, \-X, \-s
 .P
 Options \-r, \-v, \-\-ignore\-missing\-args and \-\-mkpath are used in any case. Note that options must be specified without dash (\-), for example:
 .P
 .EX
    simple_backup \-\-rsync\-options a l p
 .EE
 .P
 Check
 .BR rsync (1)
 for details about the options.
 .RE
 .TP
 .B \-\-remote\-sudo
 Run rsync on the remote server with sudo. This is needed if you want to preserve the owner of the files/folders to be copied (rsync \-\-owner option). For this to work the user used to login to the server obviously need to be allowed to use sudo. In addition, the user need to be able to run rsync with sudo without a password. To do this, /etc/sudoers on the server need to be edited adding a line like this one:
 .RS
 .P
    <username> ALL=NOPASSWD:<path/to/rsync>
 .P
 To be able to remove old backups generated with \-\-remote\-sudo (see \-\-keep option), also
 .BR rm (1)
 needs to be allowed to run without password in the same way.
 .RE
 .TP
 .B \-\-numeric\-ids
 Use rsync \-\-numeric\-ids option. This causes rsync to use numeric uid/gid instead of trying to map uid/gid names from the local machine to the server.
 .SH CONFIGURATION
 An example configuration file is provided at \(aq/usr/share/doc/simple_backup/simple_backup.conf\(aq.
 Copy it to the default location ($HOME/.config/simple_backup) and edit it as needed.
 .SH REMOTE BACKUP
 It is possible to choose a directory on a remote server as destination for the backup. The files
 are copied by rsync through SSH. Server hostname and username must be specified, either in the
 configuration file, or on the command line (\(aq\-\-ssh\-host\(aq and \(aq\-\-ssh\-user\(aq options).
 .P
 The output directory is a path on the server. A leading \(aq~\(aq and relative paths refer to the
 home directory of the user on the server. On the command line, quote \(aq~\(aq so that the local
 shell doesn\(aqt expand it, for example:
 .P
 .EX
    simple_backup \-\-ssh\-host server \-\-ssh\-user user \-o \(aq~/backups\(aq
 .EE
 .SS AUTHENTICATION
 For authentication, it is possible to use SSH key or password.
 .P
 When using SSH key, the best way to connect to the server is to have an SSH agent running.
 Otherwise, if the SSH key is encrypted, it will be necessary to enter the passphrase more
 than once. It is possible to specify the SSH key to use with the option \(aq\-\-keyfile\(aq,
 if necessary.
 .P
 When running
 .B simple_backup
 with
 .B sudo,
 in order to connect to the user\(aqs SSH agent it is necessary to preserve the \(aqSSH_AUTH_SOCK\(aq environment variable, for example:
 .P
 .EX
    sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
 .EE
 .P
 It is also possible to make this permanent by editing the
 .B sudoers
 file (see
 .BR sudoers (5))
 .P
 If SSH key authentication is not available, password authentication will be used instead.
 Note that in this case
 .B sshpass
 (if available) will be used to send the password to rsync, to avoid prompting the user for
 the password multiple
 times. This can pose some security risks, see
 .BR sshpass (1)
 for details. For this reason, use SSH key authentication if possible.
 .SH EXIT STATUS
 .TP
 .B 0
 The backup was completed without errors. This includes rsync return code 24 (some source files
 vanished during the transfer), which only logs a warning.
 .TP
 .B 1
 No valid inputs selected for backup.
 .TP
 .B 2
 Backup failed because output directory for storing the backup does not exist.
 .TP
 .B 3
 Permission denied to access the output directory.
 .TP
 .B 4
 rsync error (rsync returned a value other than 0 or 24).
 .TP
 .B 5
 SSH connection failed.
 .TP
 .B 6
 Bad configuration file or options (for example, only one of SSH host and SSH user specified).
 .SH SEE ALSO
 .BR rsync (1)
 .SH AUTHORS
 .MT https://git.shouldnt.work/fuxino
 Daniele Fucini
 .ME
@@ -0,0 +1,63 @@
 [build-system]
 requires = ['setuptools>=77']
 build-backend = 'setuptools.build_meta'
 [project]
 name = "simple_backup"
 dynamic = ["version"]
 description = "Simple backup script that uses rsync to copy files"
 readme = "README.md"
 requires-python = ">=3.10"
 license = "GPL-3.0-or-later"
 license-files = ["LICENSE"]
 authors = [
  { name = "Daniele Fucini", email = "dfucini@gmail.com" }
 ]
 maintainers = [
  { name = "Daniele Fucini", email = "dfucini@gmail.com" }
 ]
 classifiers = [
  "Development Status :: 4 - Beta",
  "Environment :: Console",
  "Natural Language :: English",
  "Operating System :: POSIX :: Linux",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Topic :: System :: Archiving :: Backup",
 ]
 [project.optional-dependencies]
 JOURNAL = ["systemd-python"]
 NOTIFICATIONS = ["dbus-python"]
 REMOTE = ["paramiko>=3.2"]
 [project.urls]
 Homepage = "https://git.shouldnt.work/fuxino/simple_backup"
 [project.scripts]
 simple_backup = "simple_backup.simple_backup:simple_backup"
 [tool.setuptools]
 packages = ["simple_backup"]
 [tool.setuptools.dynamic]
 version = { attr = "simple_backup.__version__" }
 [tool.mypy]
 files = ["simple_backup", "tests"]
 disallow_untyped_defs = true
 warn_unused_ignores = true
 # No usable stubs (types-paramiko lags behind paramiko 5)
 [[tool.mypy.overrides]]
 module = ["paramiko", "systemd", "dbus"]
 ignore_missing_imports = true
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 # Import the repo copy, not an installed one
 pythonpath = ["."]
@@ -1,423 +0,0 @@
 #!/bin/bash
 #Copyright 2015 Daniele Fucini <dfucini@gmail.com>
 #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 3 of the License, or
 #(at your option) any later version.
 #This program is distributed in the hope that it will be useful,
 #but WITHOUT ANY WARRANTY; without even the implied warranty of
 #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 with this program.  If not, see <http://www.gnu.org/licenses/>.
 #Simple backup script. Reads options, sources and destination from a configuration file or standard input
 #Help function
 function help_function {
   echo "simple_backup, version 1.3"
   echo ""
   echo "Usage: $0 [OPTIONS]"
   echo ""
   echo "Options:"
   echo "-h, --help                             Print this help and exit."
   echo "-c, --config      CONFIG_FILE          Use the specified configuration file"
   echo "                                       instead of the default one."
   echo "                                       All other options are ignored."
   echo "-i, --input       INPUT [INPUT...]     Specify a file/dir to include in the backup."
   echo "-d, --directory   DIR                  Specify the output directory for the backup."
   echo "-e, --exclude     PATTERN [PATTERN...] Specify a file/dir/pattern to exclude from"
   echo "                                       the backup."
   echo "-k, --keep        NUMBER               Specify the number of old backups to keep."
   echo "                                       Default: keep all."
   echo "-u, --user        USER                 User performing the backup."
   echo "                                       Default: current user."
   echo "                                       WARNING: This currently doesn't work with"
   echo "                                       other options!"
   echo ""
   echo "If no option is given, the program uses the default"
   echo "configuration file: $HOMEDIR/.simple_backup/config."
   echo ""
   echo "Report bugs to dfucini@gmail.com"
   exit 0
 }
 #Read configuration file
 function read_conf {
   if [[ "$#" -eq 0 ]]; then
      CONFIG="$HOMEDIR/.simple_backup/config"
      if [[ ! -f "$CONFIG" ]]; then
         #If default config file doesn't exist, exit
         echo "$(date): Backup failed (see errors.log)" >> $LOG
         echo "Backup failed"
         echo "Error: Configuration file not found" | tee $ERR
         mv $LOG "$HOMEDIR/.simple_backup/simple_backup.log"
         mv $ERR "$HOMEDIR/.simple_backup/errors.log"
         mv $WARN "$HOMEDIR/.simple_backup/warnings.log"
         exit 1
      fi
   else
      CONFIG="$1"
      if [[ ! -f "$CONFIG" ]]; then
         #If the provided configuration file doesn't exist, exit
         echo "$(date): Backup failed (see errors.log)" >> $LOG
         echo "Backup failed"
         echo "Error: Configuration file not found" | tee -a $ERR
         mv $LOG "$HOMEDIR/.simple_backup/simple_backup.log"
         mv $ERR "$HOMEDIR/.simple_backup/errors.log"
         mv $WARN "$HOMEDIR/.simple_backup/warnings.log"
         exit 1
      fi
   fi
   #Create temporary files
   INPUTS=$(mktemp)
   EXCLUDE=$(mktemp)
   BACKUP=$(mktemp)
   NKEEP=$(mktemp)
   #Parse the configuration file
   awk -v INPUTS="$INPUTS" -v EXCLUDE="$EXCLUDE" -v BACKUP="$BACKUP" \
       -v NKEEP="$NKEEP" -v UHOME="$HOMEDIR/" -F '[=,]' \
      '$1=="inputs" { for ( i=2; i<=NF; i++ ) { sub(/^~\//,UHOME,$i); print $i > INPUTS } }
       $1=="backup_dir" { sub(/^~\//,UHOME,$2); print $2 > BACKUP }
       $1=="exclude" { for ( i=2; i<=NF; i++ ) { sub(/^~\//,UHOME,$i); print $i > EXCLUDE } }
       $1=="keep" { if ( $2 != NULL ) { print $2 > NKEEP } }' $CONFIG
   BACKUP_DEV=$(cat $BACKUP)
   KEEP=$(cat $NKEEP)
   rm "$BACKUP"
   rm "$NKEEP"
   if [[ -z "$BACKUP_DEV" || ! -d "$BACKUP_DEV" ]]; then
      #If the backup directory is not set or doesn't exist, exit
      echo "$(date): Backup failed (see errors.log)" >> $LOG
      echo "Backup failed"
      echo "Error: Output folder \"$BACKUP_DEV\" not found" | tee -a $ERR
      mv $LOG "$HOMEDIR/.simple_backup/simple_backup.log"
      mv $ERR "$HOMEDIR/.simple_backup/errors.log"
      mv $WARN "$HOMEDIR/.simple_backup/warnings.log"
      rm "$INPUTS"
      rm "$EXCLUDE"
      exit 1
   fi
   BACKUP_DIR=$BACKUP_DEV/simple_backup
   DATE=$(date +%Y-%m-%d-%H:%M)
   #Create the backup subdirectory using date
   if [[ ! -d "$BACKUP_DIR" ]]; then
      mkdir -p "$BACKUP_DIR/$DATE"
   else
   #If previous backup(s) exist(s), save link to the last backup
      LAST_BACKUP=$(readlink -f "$BACKUP_DIR/last_backup")
      mkdir "$BACKUP_DIR/$DATE"
   fi
   #Set the backup directory variable to the newly created subfolder
   BACKUP_DIR="$BACKUP_DIR/$DATE"
   n_in=$(cat $INPUTS | wc -l)
   return
 }
 #Parse options
 function parse_options {
   i=1
   n_in=0
   #Create a temporary file to store inputs
   INPUTS=$(mktemp)
   #Create temp file to store exclude patterns
   EXCLUDE=$(mktemp)
   while [[ "$#" -gt 0 ]]
   do
      var="$1"
      case "$var" in
         -h | --help)
            help_function
            rm $INPUTS
            rm $EXCLUDE
            exit 0
            ;;
         -i | --input)
            while [[ "$#" -gt 1 && ! "$2" =~ ^- ]]
            do
               input="$2"
               if [[ -z "$input" ]]; then
                  echo "$(date): Backup failed (see errors.log)" >> $LOG
                  echo "Backup failed"
                  echo "Error: bad options format" | tee -a $ERR
                  mv $LOG "$HOMEDIR/.simple_backup/simple_backup.log"
                  mv $ERR "$HOMEDIR/.simple_backup/errors.log"
                  mv $WARN "$HOMEDIR/.simple_backup/warnings.log"
                  rm $INPUTS
                  rm $EXCLUDE
                  exit 1
               fi
               if [[ ! -e "$input" ]]; then
                 echo "Warning: input \"${INPUTS[$i]}\" not found. Skipping" | tee -a $WARN
               else
                  i=$((i+1))
                  n_in=$((n_in+1))
                  echo "$input" >> "$INPUTS"
               fi
               shift
            done
            ;;
         -d | --directory)
            BACKUP_DEV="$2"
            if [[ -z "$BACKUP_DEV" || ! -d "$BACKUP_DEV" ]]; then
               echo "$(date): Backup failed (see errors.log)" >> $LOG
               echo "Backup failed"
               echo "Error: output folder \"$BACKUP_DEV\" not found" | tee -a $ERR
               mv $LOG "$HOMEDIR/.simple_backup/simple_backup.log"
               mv $ERR "$HOMEDIR/.simple_backup/errors.log"
               mv $WARN "$HOMEDIR/.simple_backup/warnings.log"
               rm $INPUTS
               rm $EXCLUDES
               exit 1
            fi
            BACKUP_DIR="$BACKUP_DEV/simple_backup"
            DATE=$(date +%Y-%m-%d-%H:%M)
            #Create the backup subdirectory using date
            if [[ ! -d "$BACKUP_DIR" ]]; then
               mkdir -p "$BACKUP_DIR/$DATE"
            else
               #If previous backup(s) exist(s), save link to the last backup
               LAST_BACKUP=$(readlink -f "$BACKUP_DIR/last_backup")
               mkdir "$BACKUP_DIR/$DATE"
            fi
            #Set the backup directory variable to the newly created subfolder
            BACKUP_DIR="$BACKUP_DIR/$DATE"
            shift
            ;;
         -e | --exclude)
            while [[ "$#" -gt 1 && ! "$2" =~ ^- ]]
            do
               echo "$2" >> "$EXCLUDE"
               shift
            done
            ;;
         -k | --keep)
            KEEP="$2"
            shift
            ;;
         -c | --config)
               rm "$EXCLUDE"
               rm "$INPUTS"
            read_conf "$2"
            return
            ;;
         -u | --user)
               rm "$EXCLUDE"
               rm "$INPUTS"
               if [[ ! -d "/home/$2" ]]; then
                  echo "$(date): Backup failed (see errors.log)" >> $LOG
                  echo "Backup failed"
                  echo "Error: user $2 doesn't exist" | tee -a $ERR
                  mv $LOG "HOMEDIR/.simple_backup/simple_backup.log"
                  mv $ERR "HOMEDIR/.simple_bakup/errors.log"
                  mv $WARN "HOMEDIR/.simple_backup/warnings.log"
                  exit 1
               fi
               if [[ ! -d "/home/$2/.simple_backup" ]]; then
                  mkdir "/home/$2/.simple_backup"
                  echo "Created directory \"$HOMEDIR/.simple_backup\"." 
                  echo "Copy there sample configuration and edit it"
                  echo "to your needs before running the backup."
                  exit 1
               fi
               HOMEDIR="/home/$2"
               config="/home/$2/.simple_backup/config"
               USER="$2"
               read_conf "$config"
               return
            ;;
         *)
            echo "$(date): Backup failed (see errors.log)" >> $LOG
            echo "Backup failed"
            echo "Error: Option $1 not recognised. Use 'simple-backup -h' to see available options" | tee -a $ERR
            mv $LOG "$HOMEDIR/.simple_backup/simple_backup.log"
            mv $ERR "$HOMEDIR/.simple_backup/errors.log"
            mv $WARN "$HOMEDIR/.simple_backup/warnings.log"
            exit 1
            ;;
      esac
      shift
   done
   return
 }
 #Create temporary log files
 LOG=$(mktemp)
 ERR=$(mktemp)
 WARN=$(mktemp)
 HOMEDIR="$HOME"
 #Check number of parameters
 if [[ "$#" -eq 0 ]]; then
   if [[ ! -d "$HOMEDIR/.simple_backup" ]]; then
      mkdir "$HOMEDIR/.simple_backup"
      echo "Created directory \"$HOMEDIR/.simple_backup\"." 
      echo "Copy there sample configuration and edit it"
      echo "to your needs before running the backup."
      exit 1
   fi
   read_conf
 else
   parse_options $@
 fi
 if [[ -z $n_in || $n_in -eq 0 ]]; then
   echo "$(date): Backup finished (no files copied)" >> $LOG
   echo "Backup finished"
   echo "Warning: no valid input selected. Nothing to do" | tee -a $WARN
   mv $LOG "$HOMEDIR/.simple_backup/simple_backup.log"
   mv $ERR "$HOMEDIR/.simple_backup/errors.log"
   mv $WARN "$HOMEDIR/.simple_backup/warnings.log"
   exit 0
 fi
 echo "$(date): Starting backup" > $LOG
 echo "Starting backup..."
 #If specified, keep the last n backups and remove the others. Default: keep all
 if [[ -n $KEEP ]]; then
   N_BACKUP=$(ls -l $BACKUP_DEV/simple_backup | grep -c ^d)
   N_BACKUP=$(($N_BACKUP-1))
   if [[ $N_BACKUP -gt $KEEP ]]; then
      echo "$(date): Removing old backups" >> $LOG
      echo "Removing old backups..."
      REMOVE=$(mktemp)
      find $BACKUP_DEV/simple_backup/* -maxdepth 0 -type d | sort | head -n $(($N_BACKUP - $KEEP)) >> $REMOVE
      while read line
      do
         rm -r $line
         echo "Removed backup: $line" >> $LOG
      done<$REMOVE
      echo "Removed old backups"
      rm $REMOVE  
   fi
 fi
 # Sort input files for rsync efficiency
 if [[ ! -z "$INPUTS" ]]; then
   sort "$INPUTS" -o "$INPUTS"
 fi
 echo "Copying files. This may take a long time..."
 if [[ -z "$LAST_BACKUP" ]]; then
   rsync -acrv -H -X -R --exclude-from="$EXCLUDE" --files-from="$INPUTS" / "$BACKUP_DIR" --ignore-missing-args >> $LOG 2>> $ERR
 else
   rsync -acrv -H -X -R --link-dest="$LAST_BACKUP" --exclude-from="$EXCLUDE" --files-from="$INPUTS" / "$BACKUP_DIR" --ignore-missing-args >> $LOG 2>> $ERR
 fi
 #Update the logs
 if [[ $(cat $ERR | wc -l) -gt 0 ]]; then
   echo "$(date): Backup finished with errors" >> $LOG
   echo "Backup finished with errors"
 elif [[ $(cat $WARN | wc -l) -gt 0 ]]; then
   echo "$(date): Backup finished with warnings" >> $LOG
   echo "Backup finished (warnings)"
 else
   echo "$(date): Backup finished" >> $LOG
   echo "Backup finished"
 fi
 #Fix ownership and permissions of log files if needed
 if [[ ! -z $USER ]]; then
   chown $USER:$USER $LOG && chmod 644 $LOG
   chown $USER:$USER $ERR && chmod 644 $ERR
   chown $USER:$USER $WARN && chmod 644 $WARN
 fi
 #Copy log files in home directory
 mv $LOG "$HOMEDIR/.simple_backup/simple_backup.log"
 mv $ERR "$HOMEDIR/.simple_backup/errors.log"
 mv $WARN "$HOMEDIR/.simple_backup/warnings.log"
 if [[ ! -z "$EXCLUDE" ]]; then
   rm "$EXCLUDE"
 fi
 if [[ ! -z "$INPUTS" ]]; then
   rm "$INPUTS"
 fi
 if [[ -L "$BACKUP_DEV/simple_backup/last_backup" ]]; then
   rm "$BACKUP_DEV/simple_backup/last_backup"
 fi
 BACKUP_DIR_FULL=$(readlink -f "$BACKUP_DIR")
 ln -sf "$BACKUP_DIR_FULL" "$BACKUP_DEV/simple_backup/last_backup"
 exit 0
@@ -0,0 +1,3 @@
 """Init."""
 __version__ = '4.4.0'
@@ -0,0 +1,22 @@
 # Example config file for simple_backup
 [backup]
 # Files and directories to backup. Multiple items can be separated using a comma (','). It is possible to use wildcards (i.e. '*' to match multiple characters and '~' for the user's home directory).
 inputs=/home/user
 # Output directory. For remote backups, this is a path on the server ('~' and relative paths refer to the home directory on the server).
 backup_dir=/media/Backup
 # Files, directories and patterns to exclude from the backup. Multiple items can be separated using a comma.
 exclude=*.bak
 # Number of old backups (i.e. excluding the one that's being created) to keep (use -1 to keep all)
 keep=-1
 # Uncomment the following section to enable backup to remote server through ssh
 # [server]
 # ssh_host=
 # ssh_user=
 # ssh_keyfile=
 # remote_sudo=false
 # numeric_ids=false
@@ -0,0 +1,30 @@
 """Shared fixtures for the simple_backup tests"""
 import sys
 from typing import Callable
 import pytest
 from simple_backup import simple_backup as sb
@pytest.fixture(autouse=True)
 def no_side_effects(monkeypatch: pytest.MonkeyPatch) -> None:
    """Keep tests out of the systemd journal and the desktop notifications"""
    if hasattr(sb, 'j_handler'):
        sb.logger.removeHandler(sb.j_handler)
    monkeypatch.setattr(sb, '_notify', lambda text: None)
@pytest.fixture
 def run_cli(monkeypatch: pytest.MonkeyPatch) -> Callable[..., int]:
    """Run simple_backup() with the given command line arguments"""
    def run(*argv: str) -> int:
        monkeypatch.setattr(sys, 'argv', ['simple_backup', *argv])
        return sb.simple_backup()
    return run
@@ -0,0 +1,331 @@
 """Tests for combining command line and config values, and for detecting the user"""
 import os
 import pwd
 from pathlib import Path
 from typing import Any, Callable, Optional
 import pytest
 from simple_backup import simple_backup as sb
 USER = pwd.getpwuid(os.getuid()).pw_name
 HOME = pwd.getpwuid(os.getuid()).pw_dir
 UID = os.getuid()
 DEFAULT_OPTIONS = '-r -v --ignore-missing-args --mkpath -a -h -H -X -s'
 RunCli = Callable[..., int]
 class FakeBackup:
    """Records the values simple_backup() passes to Backup"""
    instances: list['FakeBackup'] = []
    check_code = 0
    def __init__(self, inputs: Any, output: Any, exclude: Any, keep: Any, options: str,
                 ssh_host: Optional[str] = None, ssh_user: Optional[str] = None,
                 ssh_keyfile: Optional[str] = None, remote_sudo: bool = False,
                 remove_before: bool = False, verbose: bool = False, progress: bool = False) -> None:
        self.inputs = inputs
        self.output = output
        self.exclude = exclude
        self.keep = keep
        self.options = options
        self.ssh_host = ssh_host
        self.ssh_user = ssh_user
        self.ssh_keyfile = ssh_keyfile
        self.remote_sudo = remote_sudo
        self.remove_before = remove_before
        self.verbose = verbose
        self.progress = progress
        self.homedir: Optional[str] = None
        self.ran = False
        self.closed = False
        FakeBackup.instances.append(self)
    def check_params(self, homedir: str = '') -> int:
        self.homedir = homedir
        return FakeBackup.check_code
    def run(self) -> int:
        self.ran = True
        return 0
    def close(self) -> None:
        self.closed = True
@pytest.fixture(autouse=True)
 def fake_backup(monkeypatch: pytest.MonkeyPatch) -> None:
    FakeBackup.instances = []
    FakeBackup.check_code = 0
    monkeypatch.setattr(sb, 'Backup', FakeBackup)
@pytest.fixture
 def as_user(monkeypatch: pytest.MonkeyPatch) -> None:
    """Run as the current (non-root) user"""
    monkeypatch.setattr(os, 'geteuid', lambda: UID if UID != 0 else 1000)
    monkeypatch.setenv('USER', USER)
    monkeypatch.setenv('HOME', HOME)
@pytest.fixture
 def as_root(monkeypatch: pytest.MonkeyPatch) -> None:
    """Run as root, with no sudo/doas variables set"""
    monkeypatch.setattr(os, 'geteuid', lambda: 0)
    for var in ['SUDO_USER', 'SUDO_UID', 'DOAS_USER']:
        monkeypatch.delenv(var, raising=False)
@pytest.fixture
 def config_calls(monkeypatch: pytest.MonkeyPatch) -> list[tuple[str, Optional[str]]]:
    """Record the config file path and user instead of reading the file"""
    calls: list[tuple[str, Optional[str]]] = []
    read_config = sb._read_config
    def record(config_file: str, user: Optional[str] = None) -> sb.ConfigArgs:
        calls.append((config_file, user))
        return read_config('/nonexistent/simple_backup.conf', user)
    monkeypatch.setattr(sb, '_read_config', record)
    return calls
@pytest.fixture
 def config(tmp_path: Path) -> Callable[[str], str]:
    """Write a config file with existing inputs, followed by the given text"""
    (tmp_path / 'data').mkdir()
    def write(text: str = '') -> str:
        config_file = tmp_path / 'simple_backup.conf'
        config_file.write_text(f'[backup]\ninputs={tmp_path}/data\n{text}\n')
        return str(config_file)
    return write
 def last_backup() -> FakeBackup:
    assert len(FakeBackup.instances) == 1
    return FakeBackup.instances[0]
@pytest.mark.usefixtures('as_user')
 class TestValues:
    def test_config_values(self, run_cli: RunCli, config: Callable[[str], str], tmp_path: Path) -> None:
        config_file = config("""backup_dir=/backups
 exclude=*.bak
 keep=3
 [server]
 ssh_host=server
 ssh_user=user
 ssh_keyfile=/keys/id
 remote_sudo=true
 numeric_ids=true
 """)
        assert run_cli('-c', config_file) == 0
        b = last_backup()
        assert b.inputs == [f'{tmp_path}/data']
        assert b.output == '/backups'
        assert b.exclude == ['*.bak']
        assert b.keep == 3
        assert (b.ssh_host, b.ssh_user, b.ssh_keyfile) == ('server', 'user', '/keys/id')
        assert b.remote_sudo is True
        assert b.options == f'{DEFAULT_OPTIONS} --numeric-ids'
        assert b.ran and b.closed
    def test_cli_overrides_config(self, run_cli: RunCli, config: Callable[[str], str]) -> None:
        config_file = config("""backup_dir=/backups
 exclude=*.bak
 keep=3
 [server]
 ssh_host=server
 ssh_user=user
 ssh_keyfile=/keys/id
 """)
        assert run_cli('-c', config_file, '-i', '/cli/in', '-o', '/cli/out', '-e', '*.tmp', '-k', '0',
                       '--ssh-host', 'cli-host', '--ssh-user', 'cli-user', '--keyfile', '/cli/key') == 0
        b = last_backup()
        assert b.inputs == ['/cli/in']
        assert b.output == '/cli/out'
        assert b.exclude == ['*.tmp']
        assert b.keep == 0
        assert (b.ssh_host, b.ssh_user, b.ssh_keyfile) == ('cli-host', 'cli-user', '/cli/key')
    def test_ssh_host_and_user_from_cli_and_config(self, run_cli: RunCli, config: Callable[[str], str]) -> None:
        config_file = config('backup_dir=/backups\n[server]\nssh_user=user')
        assert run_cli('-c', config_file, '--ssh-host', 'server') == 0
        assert (last_backup().ssh_host, last_backup().ssh_user) == ('server', 'user')
    @pytest.mark.parametrize('server, argv', [
        ('ssh_host=server', []),
        ('ssh_user=user', []),
        ('', ['--ssh-host', 'server']),
        ('', ['--ssh-user', 'user']),
    ])
    def test_only_one_of_ssh_host_and_user(self, run_cli: RunCli, config: Callable[[str], str],
                                           caplog: pytest.LogCaptureFixture, server: str,
                                           argv: list[str]) -> None:
        config_file = config(f'backup_dir=/backups\n[server]\n{server}')
        assert run_cli('-c', config_file, *argv) == 6
        assert FakeBackup.instances == []
        assert 'Both SSH host and SSH user are needed' in caplog.text
    def test_bad_config(self, run_cli: RunCli, config: Callable[[str], str],
                        caplog: pytest.LogCaptureFixture) -> None:
        config_file = config('backup_dir=/backups\nkeep=abc')
        assert run_cli('-c', config_file) == 6
        assert FakeBackup.instances == []
        assert 'Bad configuration file' in caplog.text
    def test_local_output_expanded(self, run_cli: RunCli, config: Callable[[str], str]) -> None:
        assert run_cli('-c', config('backup_dir=~/backups')) == 0
        assert last_backup().output == f'{HOME}/backups'
    def test_remote_output_not_expanded(self, run_cli: RunCli, config: Callable[[str], str]) -> None:
        config_file = config('backup_dir=~/backups\n[server]\nssh_host=server\nssh_user=user')
        assert run_cli('-c', config_file) == 0
        # Expanded on the server
        assert last_backup().output == '~/backups'
    @pytest.mark.parametrize('argv, options', [
        ([], DEFAULT_OPTIONS),
        (['--rsync-options', 'a', 'l'], '-r -v --ignore-missing-args --mkpath -a -l'),
        (['-s', '-z', '--numeric-ids'], f'{DEFAULT_OPTIONS} -c -z --numeric-ids'),
    ])
    def test_rsync_options(self, run_cli: RunCli, config: Callable[[str], str], argv: list[str],
                           options: str) -> None:
        assert run_cli('-c', config('backup_dir=/backups'), *argv) == 0
        assert last_backup().options == options
    def test_flags(self, run_cli: RunCli, config: Callable[[str], str]) -> None:
        assert run_cli('-c', config('backup_dir=/backups'), '--remote-sudo', '--remove-before-backup', '-v') == 0
        b = last_backup()
        assert b.remote_sudo and b.remove_before and b.verbose
    @pytest.mark.parametrize('tty, argv, progress', [
        (True, [], True),
        (True, ['--no-progress'], False),
        (False, [], False),
    ])
    def test_progress(self, run_cli: RunCli, config: Callable[[str], str], monkeypatch: pytest.MonkeyPatch,
                      tty: bool, argv: list[str], progress: bool) -> None:
        monkeypatch.setattr(sb.sys.stderr, 'isatty', lambda: tty)
        assert run_cli('-c', config('backup_dir=/backups'), *argv) == 0
        assert last_backup().progress is progress
    def test_check_params_failure(self, run_cli: RunCli, config: Callable[[str], str]) -> None:
        FakeBackup.check_code = 2
        assert run_cli('-c', config('backup_dir=/backups')) == 2
        b = last_backup()
        assert not b.ran
        assert b.closed
 class TestUser:
    @pytest.mark.usefixtures('as_user')
    def test_current_user(self, run_cli: RunCli, config_calls: list[tuple[str, Optional[str]]]) -> None:
        assert run_cli() == 0
        assert config_calls == [(f'{HOME}/.config/simple_backup/simple_backup.conf', USER)]
        assert last_backup().homedir == HOME
    @pytest.mark.usefixtures('as_root')
    def test_explicit_user(self, run_cli: RunCli, config_calls: list[tuple[str, Optional[str]]]) -> None:
        assert run_cli('-u', USER, '-c', '~/other.conf') == 0
        assert config_calls == [(f'{HOME}/other.conf', USER)]
        assert last_backup().homedir == HOME
    @pytest.mark.usefixtures('as_root')
    @pytest.mark.parametrize('var', ['SUDO_USER', 'DOAS_USER'])
    def test_sudo_or_doas_user(self, run_cli: RunCli, config_calls: list[tuple[str, Optional[str]]],
                               monkeypatch: pytest.MonkeyPatch, var: str) -> None:
        monkeypatch.setenv(var, USER)
        assert run_cli() == 0
        assert config_calls == [(f'{HOME}/.config/simple_backup/simple_backup.conf', USER)]
        assert last_backup().homedir == HOME
    @pytest.mark.usefixtures('as_root')
    def test_root_without_user(self, run_cli: RunCli, config_calls: list[tuple[str, Optional[str]]],
                               caplog: pytest.LogCaptureFixture) -> None:
        assert run_cli() == 0
        # '~' is left to expanduser, i.e. $HOME
        assert config_calls[0][1] is None
        assert last_backup().homedir == ''
        assert 'Failed to detect user' in caplog.text
 class TestDetectUser:
    @pytest.mark.usefixtures('as_root')
    def test_root_prefers_sudo_user(self, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.setenv('SUDO_USER', 'alice')
        monkeypatch.setenv('DOAS_USER', 'bob')
        assert sb._detect_user() == 'alice'
    @pytest.mark.usefixtures('as_root')
    def test_root_doas_user(self, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.setenv('DOAS_USER', 'bob')
        assert sb._detect_user() == 'bob'
    @pytest.mark.usefixtures('as_root')
    def test_root_no_user(self) -> None:
        assert sb._detect_user() is None
    @pytest.mark.usefixtures('as_user')
    def test_non_root(self) -> None:
        assert sb._detect_user() == USER
 class TestTargetUid:
    @pytest.mark.usefixtures('as_user')
    def test_non_root(self) -> None:
        assert sb._target_uid() == os.geteuid()
    @pytest.mark.usefixtures('as_root')
    def test_sudo_uid(self, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.setenv('SUDO_UID', '1234')
        assert sb._target_uid() == 1234
    @pytest.mark.usefixtures('as_root')
    def test_doas_user(self, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.setenv('DOAS_USER', USER)
        assert sb._target_uid() == UID
    @pytest.mark.usefixtures('as_root')
    def test_unknown_doas_user(self, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.setenv('DOAS_USER', 'no-such-user-simple-backup')
        assert sb._target_uid() is None
    @pytest.mark.usefixtures('as_root')
    def test_no_user(self) -> None:
        assert sb._target_uid() is None
@@ -0,0 +1,230 @@
 """Tests for reading the configuration file and expanding paths"""
 import configparser
 import os
 import pwd
 from pathlib import Path
 import pytest
 from simple_backup import simple_backup as sb
 USER = pwd.getpwuid(os.getuid()).pw_name
 HOME = pwd.getpwuid(os.getuid()).pw_dir
 def write_config(path: Path, text: str) -> str:
    config_file = path / 'simple_backup.conf'
    config_file.write_text(text)
    return str(config_file)
 def test_repo_copy_imported() -> None:
    repo = Path(__file__).resolve().parents[1]
    assert Path(sb.__file__).resolve().is_relative_to(repo)
@pytest.mark.parametrize('path, expected', [
    ('~', HOME),
    ('~/docs', f'{HOME}/docs'),
    ('/abs/~/path', '/abs/~/path'),
    ('relative', 'relative'),
 ])
 def test_expand_home(path: str, expected: str) -> None:
    assert sb._expand_home(path, USER) == expected
 def test_expand_inputs_glob(tmp_path: Path) -> None:
    for name in ['a.txt', 'b.txt', 'c.log']:
        (tmp_path / name).touch()
    result = sb._expand_inputs([f'{tmp_path}/*.txt', ''], USER)
    assert sorted(result) == [f'{tmp_path}/a.txt', f'{tmp_path}/b.txt']
 def test_expand_inputs_no_match(tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None:
    assert sb._expand_inputs([f'{tmp_path}/missing'], USER) == []
    assert 'No file or directory matching input' in caplog.text
 def test_expand_inputs_tilde_without_user(caplog: pytest.LogCaptureFixture) -> None:
    sb._expand_inputs(['~/nothing-here'], None)
    assert 'Cannot expand' in caplog.text
 def test_missing_config(tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None:
    config_args = sb._read_config(str(tmp_path / 'missing.conf'), USER)
    assert config_args['inputs'] is None
    assert config_args['output'] is None
    assert config_args['keep'] == -1
    assert 'does not exist' in caplog.text
 def test_missing_config_without_user(tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None:
    sb._read_config(str(tmp_path / 'missing.conf'), None)
    assert 'User not specified' in caplog.text
 def test_read_config(tmp_path: Path) -> None:
    (tmp_path / 'one').mkdir()
    (tmp_path / 'two').mkdir()
    config_file = write_config(tmp_path, f"""
 [backup]
 inputs={tmp_path}/one, {tmp_path}/two, {tmp_path}/one
 backup_dir=~/backups
 exclude=*.bak, , *.tmp
 keep=3
 """)
    config_args = sb._read_config(config_file, USER)
    assert config_args['inputs'] is not None
    assert sorted(config_args['inputs']) == [f'{tmp_path}/one', f'{tmp_path}/two']
    # Expanded later, as it may be a path on the server
    assert config_args['output'] == '~/backups'
    assert config_args['exclude'] == ['*.bak', '*.tmp']
    assert config_args['keep'] == 3
    assert config_args['ssh_host'] is None
    assert config_args['ssh_user'] is None
    assert config_args['ssh_keyfile'] is None
    assert config_args['remote_sudo'] is False
    assert config_args['numeric_ids'] is False
 def test_optional_keys_missing(tmp_path: Path) -> None:
    config_file = write_config(tmp_path, f"""
 [backup]
 inputs={tmp_path}
 backup_dir=/backups
 """)
    config_args = sb._read_config(config_file, USER)
    assert config_args['exclude'] == []
    assert config_args['keep'] == -1
 def test_old_default_section(tmp_path: Path) -> None:
    config_file = write_config(tmp_path, f"""
 [default]
 inputs={tmp_path}
 backup_dir=/backups
 """)
    config_args = sb._read_config(config_file, USER)
    assert config_args['inputs'] == [str(tmp_path)]
    assert config_args['output'] == '/backups'
 def test_percent_in_values(tmp_path: Path) -> None:
    config_file = write_config(tmp_path, f"""
 [backup]
 inputs={tmp_path}
 backup_dir=/backups/100%
 exclude=%temp%
 """)
    config_args = sb._read_config(config_file, USER)
    assert config_args['output'] == '/backups/100%'
    assert config_args['exclude'] == ['%temp%']
 def test_server_section(tmp_path: Path) -> None:
    config_file = write_config(tmp_path, f"""
 [backup]
 inputs={tmp_path}
 backup_dir=backups
 [server]
 ssh_host=server
 ssh_user=user
 ssh_keyfile=/keys/id_ed25519
 remote_sudo=yes
 numeric_ids=true
 """)
    config_args = sb._read_config(config_file, USER)
    assert config_args['ssh_host'] == 'server'
    assert config_args['ssh_user'] == 'user'
    assert config_args['ssh_keyfile'] == '/keys/id_ed25519'
    assert config_args['remote_sudo'] is True
    assert config_args['numeric_ids'] is True
 def test_empty_server_values(tmp_path: Path) -> None:
    config_file = write_config(tmp_path, f"""
 [backup]
 inputs={tmp_path}
 backup_dir=/backups
 [server]
 ssh_host=
 ssh_user=
 ssh_keyfile=
 remote_sudo=
 numeric_ids=
 """)
    config_args = sb._read_config(config_file, USER)
    assert config_args['ssh_host'] is None
    assert config_args['ssh_user'] is None
    assert config_args['ssh_keyfile'] is None
    assert config_args['remote_sudo'] is False
    assert config_args['numeric_ids'] is False
 def test_only_ssh_host(tmp_path: Path) -> None:
    config_file = write_config(tmp_path, f"""
 [backup]
 inputs={tmp_path}
 backup_dir=/backups
 [server]
 ssh_host=server
 """)
    config_args = sb._read_config(config_file, USER)
    # Kept, so that the missing user is reported instead of silently backing up locally
    assert config_args['ssh_host'] == 'server'
    assert config_args['ssh_user'] is None
@pytest.mark.parametrize('line', ['keep=abc', 'remote_sudo=maybe'])
 def test_bad_value(tmp_path: Path, line: str) -> None:
    section = '[server]' if line.startswith('remote_sudo') else ''
    config_file = write_config(tmp_path, f"""
 [backup]
 inputs={tmp_path}
 backup_dir=/backups
 {section}
 {line}
 """)
    with pytest.raises(ValueError):
        sb._read_config(config_file, USER)
@pytest.mark.parametrize('text', [
    '[backup]\nbackup_dir=/backups\n',
    '[backup]\ninputs=/tmp\n',
    '[other]\ninputs=/tmp\n',
    'inputs=/tmp\n',
 ])
 def test_bad_config(tmp_path: Path, text: str) -> None:
    config_file = write_config(tmp_path, text)
    with pytest.raises(configparser.Error):
        sb._read_config(config_file, USER)
@@ -0,0 +1,350 @@
 """Tests for local backups, with real rsync runs and with a fake Popen"""
 import io
 import os
 from datetime import datetime, timedelta
 from pathlib import Path
 from typing import Any, Callable, Iterator, Optional
 import pytest
 from simple_backup import simple_backup as sb
 OPTIONS = '-r -v --ignore-missing-args --mkpath -a -h -H -X -s'
@pytest.fixture(autouse=True)
 def fake_now(monkeypatch: pytest.MonkeyPatch) -> None:
    """Give each backup a new timestamp, as real runs within the same second would collide"""
    def times() -> Iterator[datetime]:
        t = datetime(2026, 10, 14, 10, 0, 0)
        while True:
            yield t
            t += timedelta(hours=1)
    it = times()
    class FakeDatetime:
        @staticmethod
        def now() -> datetime:
            return next(it)
    monkeypatch.setattr(sb, 'datetime', FakeDatetime)
@pytest.fixture
 def src(tmp_path: Path) -> Path:
    src = tmp_path / 'src dir'
    src.mkdir()
    (src / 'same.txt').write_text('unchanged')
    (src / 'changed.txt').write_text('first')
    return src
@pytest.fixture
 def out(tmp_path: Path) -> Path:
    out = tmp_path / 'out dir'
    out.mkdir()
    return out
 def make_backup(out: Path, inputs: list[str], keep: int = -1, exclude: Optional[list[str]] = None,
                remove_before: bool = False, progress: bool = False) -> sb.Backup:
    backup = sb.Backup(inputs, str(out), exclude or [], keep, OPTIONS, remove_before=remove_before,
                       progress=progress)
    assert backup.check_params() == 0
    return backup
 def run_backup(out: Path, inputs: list[str], **kwargs: Any) -> int:
    return make_backup(out, inputs, **kwargs).run()
 def backups(out: Path) -> list[str]:
    return sorted(d.name for d in (out / 'simple_backup').iterdir() if d.is_dir() and not d.is_symlink())
 def copied(out: Path, backup: str, path: Path) -> Path:
    """Path of a file inside a backup (rsync keeps the full source path)"""
    return out / 'simple_backup' / backup / str(path).lstrip('/')
 class TestCheckParams:
    def test_no_inputs(self, out: Path) -> None:
        assert sb.Backup([], str(out), [], -1, OPTIONS).check_params() == 1
    def test_no_output(self) -> None:
        assert sb.Backup(['/x'], None, [], -1, OPTIONS).check_params() == 2
    def test_missing_output(self, tmp_path: Path) -> None:
        assert sb.Backup(['/x'], str(tmp_path / 'missing'), [], -1, OPTIONS).check_params() == 2
    def test_relative_output(self, out: Path, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.chdir(out.parent)
        backup = sb.Backup(['/x'], out.name, [], None, OPTIONS)
        assert backup.check_params() == 0
        assert backup.output == str(out)
        assert backup.keep == -1
 class TestRsync:
    def test_first_backup(self, src: Path, out: Path, caplog: pytest.LogCaptureFixture) -> None:
        assert run_backup(out, [str(src)]) == 0
        assert backups(out) == ['2026-10-14_10-00-00']
        assert copied(out, '2026-10-14_10-00-00', src / 'same.txt').read_text() == 'unchanged'
        assert 'Backup completed' in caplog.text
        assert 'rsync: sent' in caplog.text
    def test_hard_links(self, src: Path, out: Path) -> None:
        assert run_backup(out, [str(src)]) == 0
        (src / 'changed.txt').write_text('second')
        assert run_backup(out, [str(src)]) == 0
        first, second = backups(out)
        assert copied(out, first, src / 'same.txt').stat().st_ino == \
            copied(out, second, src / 'same.txt').stat().st_ino
        assert copied(out, first, src / 'changed.txt').stat().st_ino != \
            copied(out, second, src / 'changed.txt').stat().st_ino
        assert copied(out, second, src / 'changed.txt').read_text() == 'second'
    def test_exclude_and_missing_input(self, src: Path, out: Path, caplog: pytest.LogCaptureFixture) -> None:
        (src / 'skip.bak').touch()
        assert run_backup(out, [str(src), str(src / 'missing')], exclude=['*.bak']) == 0
        (backup,) = backups(out)
        assert copied(out, backup, src / 'same.txt').exists()
        assert not copied(out, backup, src / 'skip.bak').exists()
        assert 'Input' in caplog.text and 'not found' in caplog.text
    def test_all_inputs_missing(self, src: Path, out: Path) -> None:
        assert run_backup(out, [str(src / 'missing')]) == 1
        assert not (out / 'simple_backup').exists()
    @pytest.mark.parametrize('keep, remaining', [
        (-1, ['2026-10-14_10-00-00', '2026-10-14_11-00-00', '2026-10-14_12-00-00']),
        (1, ['2026-10-14_11-00-00', '2026-10-14_12-00-00']),
        (0, ['2026-10-14_12-00-00']),
    ])
    def test_keep(self, src: Path, out: Path, keep: int, remaining: list[str]) -> None:
        for _ in range(3):
            assert run_backup(out, [str(src)], keep=keep) == 0
        assert backups(out) == remaining
    def test_removal_logged(self, src: Path, out: Path, caplog: pytest.LogCaptureFixture) -> None:
        for _ in range(3):
            assert run_backup(out, [str(src)]) == 0
        assert run_backup(out, [str(src)], keep=0) == 0
        assert 'Removing backup 2026-10-14_10-00-00 (1/3)...' in caplog.text
        assert 'Removing backup 2026-10-14_12-00-00 (3/3)...' in caplog.text
        assert 'Removed 3 backups' in caplog.text
    def test_remove_before(self, src: Path, out: Path) -> None:
        assert run_backup(out, [str(src)]) == 0
        assert run_backup(out, [str(src)], keep=0, remove_before=True) == 0
        (backup,) = backups(out)
        assert backup == '2026-10-14_11-00-00'
        # Nothing to link against, as the old backup was removed first
        assert copied(out, backup, src / 'same.txt').stat().st_nlink == 1
    def test_stray_files_and_symlinks(self, src: Path, out: Path) -> None:
        assert run_backup(out, [str(src)]) == 0
        base = out / 'simple_backup'
        (base / 'notes.txt').write_text('keep me')
        # Left by old versions; must not count as a backup, nor be used for --link-dest
        (base / 'last_backup').symlink_to(base / backups(out)[0])
        assert run_backup(out, [str(src)], keep=0) == 0
        assert backups(out) == ['2026-10-14_11-00-00']
        assert (base / 'notes.txt').read_text() == 'keep me'
        assert (base / 'last_backup').is_symlink()
    def test_old_folder_name_format(self, src: Path, out: Path) -> None:
        assert run_backup(out, [str(src)]) == 0
        base = out / 'simple_backup'
        (base / '2026-10-14_10-00-00').rename(base / '2026-10-03 20:15:25')
        assert run_backup(out, [str(src)]) == 0
        assert backups(out) == ['2026-10-03 20:15:25', '2026-10-14_11-00-00']
        assert copied(out, '2026-10-03 20:15:25', src / 'same.txt').stat().st_ino == \
            copied(out, '2026-10-14_11-00-00', src / 'same.txt').stat().st_ino
        assert run_backup(out, [str(src)], keep=0) == 0
        assert backups(out) == ['2026-10-14_12-00-00']
    def test_progress(self, src: Path, out: Path, caplog: pytest.LogCaptureFixture,
                      capsys: pytest.CaptureFixture[str]) -> None:
        assert run_backup(out, [str(src)], progress=True) == 0
        assert '100%' in capsys.readouterr().err
        # Only the summary is logged, not the progress updates
        assert 'rsync: sent' in caplog.text
        assert 'rsync: total size' in caplog.text
        assert '%' not in caplog.text
    def test_cli(self, src: Path, out: Path, tmp_path: Path, run_cli: Callable[..., int]) -> None:
        config_file = str(tmp_path / 'missing.conf')
        for _ in range(2):
            assert run_cli('-c', config_file, '-i', str(src), '-o', str(out), '-k', '0') == 0
        assert backups(out) == ['2026-10-14_11-00-00']
 class ChunkStream(io.BufferedIOBase):
    """Returns the given chunks one per read1() call, like a pipe"""
    def __init__(self, chunks: list[bytes]) -> None:
        self.chunks = chunks
    def read1(self, size: int = -1) -> bytes:
        return self.chunks.pop(0) if self.chunks else b''
 class TestReadRecords:
    def test_split_on_newline_and_cr(self) -> None:
        stream = ChunkStream([b'file\n\r  1.00M  50%\r  2.00M 100%\n\nsent 1 bytes\ntotal'])
        assert list(sb._read_records(stream)) == ['file', '', '  1.00M  50%', '  2.00M 100%', '', 'sent 1 bytes',
                                                  'total']
    def test_records_across_chunks(self) -> None:
        stream = ChunkStream([b'fi', b'le\r', b'\nna', 'mé\n'.encode(), b'\xff\n'])
        assert list(sb._read_records(stream)) == ['file', '', 'namé', '�']
 class TestProgressBar:
    @pytest.fixture(autouse=True)
    def terminal(self, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.setattr(sb, 'get_terminal_size', lambda: os.terminal_size((81, 24)))
        # 30 s elapsed at each update
        monkeypatch.setattr(sb, 'default_timer', iter([0.0, 30.0]).__next__)
    def test_update(self, capsys: pytest.CaptureFixture[str]) -> None:
        bar = sb._ProgressBar()
        assert bar.update('          2.00M  25%    1.47MB/s    0:00:02 (xfr#1, ir-chk=2/4)')
        assert capsys.readouterr().err == \
            '\r[#######-----------------------]   25%  2.00M  1.47MB/s  ETA 0:01:30  (scanning)\033[K'
    def test_without_human_readable(self, capsys: pytest.CaptureFixture[str]) -> None:
        bar = sb._ProgressBar()
        assert bar.update('      4,000,000  50%    2.97MB/s    0:00:01 (xfr#2, to-chk=1/4)')
        assert capsys.readouterr().err.endswith(']   50%  4,000,000  2.97MB/s  ETA 0:00:30\033[K')
    def test_not_progress(self, capsys: pytest.CaptureFixture[str]) -> None:
        bar = sb._ProgressBar()
        for record in ['home/user/file 50% 1:00:00', 'sent 1 bytes  received 2 bytes', 'total size is 3']:
            assert not bar.update(record)
        bar.clear()
        assert capsys.readouterr().err == ''
    def test_narrow_terminal(self, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]) -> None:
        monkeypatch.setattr(sb, 'get_terminal_size', lambda: os.terminal_size((20, 24)))
        assert sb._ProgressBar().update('  6.00M 100%    1.48MB/s    0:00:03 (xfr#3, to-chk=0/4)')
        # No room for the bar
        assert capsys.readouterr().err == '\r100%  6.00M  1.48MB\033[K'
 class FakePopen:
    """Stands in for rsync: creates the destination and returns a chosen return code"""
    returncode = 0
    calls: list[list[str]] = []
    def __init__(self, args: list[str], **kwargs: Any) -> None:
        FakePopen.calls.append(args)
        os.makedirs(args[args.index('/') + 1])
        self.stdin = io.BytesIO()
        self.stdout = io.BytesIO(b'sending incremental file list\nsent 1 bytes  received 2 bytes\ntotal size is 3\n')
    def __enter__(self) -> 'FakePopen':
        return self
    def __exit__(self, *args: Any) -> None:
        pass
    def wait(self) -> int:
        return FakePopen.returncode
@pytest.fixture
 def fake_popen(monkeypatch: pytest.MonkeyPatch) -> type[FakePopen]:
    FakePopen.returncode = 0
    FakePopen.calls = []
    monkeypatch.setattr(sb, 'Popen', FakePopen)
    return FakePopen
@pytest.fixture
 def old_backups(out: Path) -> list[str]:
    names = ['2026-10-01_10-00-00', '2026-10-02_10-00-00']
    for name in names:
        (out / 'simple_backup' / name).mkdir(parents=True)
    return names
 class TestReturnCodes:
    def test_args(self, src: Path, out: Path, fake_popen: type[FakePopen], old_backups: list[str]) -> None:
        assert run_backup(out, [str(src)]) == 0
        (args,) = fake_popen.calls
        assert args[0] == '/usr/bin/rsync'
        assert f'--link-dest={out}/simple_backup/{old_backups[-1]}' in args
        assert args[args.index('/') + 1] == f'{out}/simple_backup/2026-10-14_10-00-00'
    @pytest.mark.parametrize('returncode, result, removed', [
        (0, 0, True),
        (24, 0, True),
        (23, 4, False),
        (2, 4, False),
    ])
    def test_old_backups_removed_only_on_success(self, src: Path, out: Path, fake_popen: type[FakePopen],
                                                 old_backups: list[str], caplog: pytest.LogCaptureFixture,
                                                 returncode: int, result: int, removed: bool) -> None:
        fake_popen.returncode = returncode
        assert run_backup(out, [str(src)], keep=0) == result
        if removed:
            assert backups(out) == ['2026-10-14_10-00-00']
        else:
            assert backups(out) == [*old_backups, '2026-10-14_10-00-00']
            assert 'Old backups will not be removed' in caplog.text
            assert f'return code {returncode}' in caplog.text
    @pytest.mark.parametrize('keep, message', [
        (0, 'No complete backup is available'),
        (1, 'Old backups were removed before the backup'),
    ])
    def test_failure_after_remove_before(self, src: Path, out: Path, fake_popen: type[FakePopen],
                                         old_backups: list[str], caplog: pytest.LogCaptureFixture,
                                         keep: int, message: str) -> None:
        fake_popen.returncode = 23
        assert run_backup(out, [str(src)], keep=keep, remove_before=True) == 4
        assert message in caplog.text
@@ -0,0 +1,568 @@
 """Tests for remote backups, with a fake SSH client that runs commands locally"""
 import importlib.util
 import io
 import os
 import shlex
 import socket
 import subprocess
 import warnings
 from getpass import GetPassWarning
 from pathlib import Path
 from shutil import which
 from typing import Any, Optional
 import pytest
 from simple_backup import simple_backup as sb
 OPTIONS = '-r -v --ignore-missing-args --mkpath -a -h -H -X -s'
 needs_paramiko = pytest.mark.skipif(importlib.util.find_spec('paramiko') is None,
                                    reason='paramiko not installed')
 needs_ssh_keygen = pytest.mark.skipif(which('ssh-keygen') is None, reason='ssh-keygen not installed')
 class FakeSSH:
    """SSHClient stand-in: runs commands with sh in a fake remote home"""
    def __init__(self, home: Path, bin_dir: Path) -> None:
        self.home = home
        self.bin_dir = bin_dir
        self.commands: list[str] = []
        self.fail_on: Optional[str] = None
        self.closed = False
    def exec_command(self, command: str) -> tuple[None, io.BytesIO, io.BytesIO]:
        self.commands.append(command)
        if self.fail_on is not None and self.fail_on in command:
            return None, io.BytesIO(b''), io.BytesIO(b'Permission denied\n')
        env = {'HOME': str(self.home), 'PATH': f'{self.bin_dir}:{os.environ["PATH"]}'}
        p = subprocess.run(['sh', '-c', command], cwd=self.home, env=env, capture_output=True, check=False)
        return None, io.BytesIO(p.stdout), io.BytesIO(p.stderr)
    def close(self) -> None:
        self.closed = True
@pytest.fixture
 def remote_home(tmp_path: Path) -> Path:
    home = tmp_path / 'remote home'
    (home / 'backups').mkdir(parents=True)
    return home
@pytest.fixture
 def ssh(remote_home: Path, tmp_path: Path) -> FakeSSH:
    # A 'sudo' that just runs the command, for --remote-sudo
    bin_dir = tmp_path / 'bin'
    bin_dir.mkdir()
    sudo = bin_dir / 'sudo'
    sudo.write_text('#!/bin/sh\nexec "$@"\n')
    sudo.chmod(0o755)
    return FakeSSH(remote_home, bin_dir)
@pytest.fixture
 def connect(monkeypatch: pytest.MonkeyPatch, ssh: FakeSSH) -> FakeSSH:
    monkeypatch.setattr(sb.Backup, '_ssh_connect', lambda self, homedir='': ssh)
    return ssh
 def remote_backup(output: str = '~/backups', keep: int = -1, **kwargs: Any) -> sb.Backup:
    return sb.Backup(['/x'], output, [], keep, OPTIONS, ssh_host='server', ssh_user='user', **kwargs)
 def connected_backup(output: str = '~/backups', keep: int = -1, **kwargs: Any) -> sb.Backup:
    backup = remote_backup(output, keep, **kwargs)
    assert backup.check_params() == 0
    return backup
 def make_backups(remote_home: Path, *names: str) -> Path:
    base = remote_home / 'backups' / 'simple_backup'
    base.mkdir()
    for name in names:
        (base / name).mkdir()
    return base
 def remote_dirs(base: Path) -> list[str]:
    return sorted(d.name for d in base.iterdir() if d.is_dir())
@pytest.mark.usefixtures('connect')
 class TestRemotePath:
    @pytest.mark.parametrize('output', ['~/backups', 'backups', '~/backups/', '{home}/backups'])
    def test_resolved(self, remote_home: Path, output: str) -> None:
        backup = connected_backup(output.format(home=remote_home))
        assert backup.output == f'{remote_home}/backups'
    def test_home(self, remote_home: Path) -> None:
        assert connected_backup('~').output == str(remote_home)
    def test_shell_characters_not_expanded(self, remote_home: Path) -> None:
        name = 'a $HOME `touch pwned` b'
        (remote_home / name).mkdir()
        assert connected_backup(f'~/{name}').output == f'{remote_home}/{name}'
        assert not (remote_home / 'pwned').exists()
    def test_missing(self, caplog: pytest.LogCaptureFixture) -> None:
        assert remote_backup('~/missing').check_params() == 2
        assert 'Output path for backup does not exist' in caplog.text
    def test_needs_host_and_user(self, tmp_path: Path) -> None:
        # Only one of them: a local backup
        backup = sb.Backup(['/x'], str(tmp_path), [], -1, OPTIONS, ssh_host='server')
        assert backup.check_params() == 0
        assert not backup._remote
 class TestConnectionErrors:
    def test_connection_failed(self, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.setattr(sb.Backup, '_ssh_connect', lambda self, homedir='': None)
        assert remote_backup().check_params() == 5
    @pytest.mark.parametrize('error', [socket.gaierror(-2, 'Name or service not known'),
                                       ConnectionRefusedError(111, 'Connection refused'),
                                       TimeoutError('timed out')])
    def test_os_error(self, monkeypatch: pytest.MonkeyPatch, caplog: pytest.LogCaptureFixture,
                      error: OSError) -> None:
        def fail(self: sb.Backup, homedir: str = '') -> None:
            raise error
        monkeypatch.setattr(sb.Backup, '_ssh_connect', fail)
        assert remote_backup().check_params() == 5
        assert 'Can\'t connect to the server server' in caplog.text
    def test_paramiko_missing(self, monkeypatch: pytest.MonkeyPatch, caplog: pytest.LogCaptureFixture) -> None:
        monkeypatch.delattr(sb, 'paramiko', raising=False)
        assert remote_backup().check_params() == 5
        assert 'Install paramiko' in caplog.text
@pytest.mark.usefixtures('connect')
 class TestRemoveOldBackups:
    def test_keep(self, remote_home: Path) -> None:
        base = make_backups(remote_home, '2026-10-01 10:00:00', '2026-10-02_10-00-00', '2026-10-03_10-00-00')
        (base / 'notes.txt').touch()
        # The newest one stands for the backup just made
        connected_backup(keep=1).remove_old_backups()
        assert remote_dirs(base) == ['2026-10-02_10-00-00', '2026-10-03_10-00-00']
        assert (base / 'notes.txt').exists()
    def test_remove_before(self, remote_home: Path) -> None:
        base = make_backups(remote_home, '2026-10-01_10-00-00', '2026-10-02_10-00-00')
        connected_backup(keep=0, remove_before=True).remove_old_backups()
        assert remote_dirs(base) == []
        assert base.is_dir()
    def test_remote_sudo(self, remote_home: Path, ssh: FakeSSH) -> None:
        base = make_backups(remote_home, '2026-10-01_10-00-00', '2026-10-02_10-00-00')
        connected_backup(keep=0, remote_sudo=True).remove_old_backups()
        assert remote_dirs(base) == ['2026-10-02_10-00-00']
        assert [c for c in ssh.commands if 'rm -r' in c][0].startswith('sudo rm -r ')
    @pytest.mark.parametrize('names', [[], None])
    def test_nothing_to_remove(self, remote_home: Path, names: Optional[list[str]]) -> None:
        if names is not None:
            make_backups(remote_home, *names)
        connected_backup(keep=0, remove_before=True).remove_old_backups()
        # The backup folder itself must never be removed
        assert (remote_home / 'backups').is_dir()
        assert (remote_home / 'backups' / 'simple_backup').is_dir() == (names is not None)
    def test_list_error(self, remote_home: Path, ssh: FakeSSH, caplog: pytest.LogCaptureFixture) -> None:
        base = make_backups(remote_home, '2026-10-01_10-00-00', '2026-10-02_10-00-00')
        backup = connected_backup(keep=0)
        ssh.fail_on = 'find'
        backup.remove_old_backups()
        assert remote_dirs(base) == ['2026-10-01_10-00-00', '2026-10-02_10-00-00']
        assert 'Cannot list old backups on the server' in caplog.text
    def test_remove_error(self, remote_home: Path, ssh: FakeSSH, caplog: pytest.LogCaptureFixture) -> None:
        make_backups(remote_home, '2026-10-01_10-00-00', '2026-10-02_10-00-00')
        backup = connected_backup(keep=0)
        ssh.fail_on = 'rm -r'
        backup.remove_old_backups()
        assert 'Error while removing backup 2026-10-01_10-00-00' in caplog.text
        assert backup._removed_count == 0
@pytest.mark.usefixtures('connect')
 class TestFindLastBackup:
    def test_newest(self, remote_home: Path) -> None:
        base = make_backups(remote_home, '2026-10-01 10:00:00', '2026-10-02_10-00-00')
        (base / 'zzz.txt').touch()
        backup = connected_backup()
        backup.find_last_backup()
        assert backup._last_backup == f'{base}/2026-10-02_10-00-00'
    @pytest.mark.parametrize('create', [True, False])
    def test_none(self, remote_home: Path, caplog: pytest.LogCaptureFixture, create: bool) -> None:
        if create:
            make_backups(remote_home)
        backup = connected_backup()
        backup.find_last_backup()
        assert backup._last_backup == ''
        assert 'No previous backups available' in caplog.text
    def test_no_connection(self) -> None:
        backup = connected_backup()
        backup._ssh = None
        with pytest.raises(SystemExit) as e:
            backup.find_last_backup()
        assert e.value.code == 5
 class RecordPopen:
    """Records the rsync arguments instead of running rsync"""
    returncode = 0
    calls: list[list[str]] = []
    def __init__(self, args: list[str], **kwargs: Any) -> None:
        RecordPopen.calls.append(args)
        self.stdin = io.BytesIO()
        self.stdout = io.BytesIO(b'sent 1 bytes  received 2 bytes\ntotal size is 3\n')
    def __enter__(self) -> 'RecordPopen':
        return self
    def __exit__(self, *args: Any) -> None:
        pass
    def wait(self) -> int:
        return RecordPopen.returncode
@pytest.mark.usefixtures('connect')
 class TestRsyncArgs:
    @pytest.fixture(autouse=True)
    def record_popen(self, monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
        RecordPopen.returncode = 0
        RecordPopen.calls = []
        monkeypatch.setattr(sb, 'Popen', RecordPopen)
        # The input must exist locally
        (tmp_path / 'input').mkdir()
    def run(self, tmp_path: Path, **kwargs: Any) -> tuple[int, list[str]]:
        backup = connected_backup(**kwargs)
        backup.inputs = [str(tmp_path / 'input')]
        returncode = backup.run()
        (args,) = RecordPopen.calls
        return returncode, args
    @staticmethod
    def ssh_command(args: list[str]) -> str:
        return args[args.index('-e') + 1]
    def test_default(self, tmp_path: Path, remote_home: Path) -> None:
        returncode, args = self.run(tmp_path)
        assert returncode == 0
        assert args[args.index('/') + 1].startswith(f'user@server:{remote_home}/backups/simple_backup/')
        assert self.ssh_command(args) == 'ssh -o StrictHostKeyChecking=accept-new'
        assert not any(a.startswith('--rsync-path') for a in args)
        assert not any(a.startswith('--link-dest') for a in args)
    def test_link_dest(self, tmp_path: Path, remote_home: Path) -> None:
        base = make_backups(remote_home, '2026-10-01_10-00-00')
        _, args = self.run(tmp_path)
        assert f'--link-dest={base}/2026-10-01_10-00-00' in args
    def test_keyfile_with_spaces(self, tmp_path: Path) -> None:
        _, args = self.run(tmp_path, ssh_keyfile='/keys/my key')
        # rsync splits the -e command like a shell
        assert shlex.split(self.ssh_command(args)) == ['ssh', '-i', '/keys/my key', '-o',
                                                       'StrictHostKeyChecking=accept-new']
    def test_remote_sudo(self, tmp_path: Path) -> None:
        _, args = self.run(tmp_path, remote_sudo=True)
        assert '--rsync-path=sudo rsync' in args
    def test_password_auth(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.setattr(sb, 'which', lambda cmd: f'/usr/bin/{cmd}')
        monkeypatch.setenv('SSHPASS', 'secret')
        backup = connected_backup()
        backup.inputs = [str(tmp_path / 'input')]
        backup._password_auth = True
        assert backup.run() == 0
        (args,) = RecordPopen.calls
        assert shlex.split(self.ssh_command(args)) == ['sshpass', '-e', 'ssh', '-l', 'user', '-o',
                                                       'StrictHostKeyChecking=accept-new']
        # The password must not stay in the environment
        assert 'SSHPASS' not in os.environ
    def test_failure(self, tmp_path: Path, remote_home: Path) -> None:
        base = make_backups(remote_home, '2026-10-01_10-00-00')
        RecordPopen.returncode = 23
        returncode, _ = self.run(tmp_path, keep=0)
        assert returncode == 4
        assert remote_dirs(base) == ['2026-10-01_10-00-00']
 class FakeClient:
    """paramiko.SSHClient stand-in; connect() takes its outcomes from a list"""
    def __init__(self, outcomes: list[Optional[BaseException]]) -> None:
        self.outcomes = outcomes
        self.connects: list[dict[str, Any]] = []
        self.policies: list[str] = []
        self.known_hosts: Optional[str] = None
        self.closed = False
    def load_host_keys(self, filename: str) -> None:
        self.known_hosts = filename
        if not os.path.isfile(filename):
            raise FileNotFoundError(filename)
    def set_missing_host_key_policy(self, policy: Any) -> None:
        self.policies.append(type(policy).__name__)
    def connect(self, hostname: str, **kwargs: Any) -> None:
        self.connects.append(kwargs)
        outcome = self.outcomes.pop(0)
        if isinstance(outcome, UserWarning):
            # Like WarningPolicy for an unknown host key
            warnings.warn(outcome)
        elif outcome is not None:
            raise outcome
    def close(self) -> None:
        self.closed = True
@pytest.fixture
 def client(monkeypatch: pytest.MonkeyPatch) -> FakeClient:
    fake = FakeClient([])
    monkeypatch.setattr(sb.paramiko, 'SSHClient', lambda: fake)
    def no_terminal(prompt: str = '') -> str:
        raise AssertionError(f'Unexpected prompt: {prompt}')
    monkeypatch.setattr(sb, 'getpass', no_terminal)
    monkeypatch.setattr('builtins.input', no_terminal)
    return fake
 def ssh_error() -> Exception:
    return sb.paramiko.SSHException('Authentication failed')
@needs_paramiko
 class TestLogin:
    def test_agent(self, client: FakeClient, tmp_path: Path) -> None:
        client.outcomes = [None]
        assert remote_backup()._ssh_connect(str(tmp_path)) is client
        assert client.known_hosts == f'{tmp_path}/.ssh/known_hosts'
        assert client.connects[0]['timeout'] == sb.SSH_TIMEOUT
        assert not client.closed
    @pytest.mark.parametrize('answer, connected', [('y', True), (' Yes', True), ('n', False), ('', False)])
    def test_unknown_host_key(self, client: FakeClient, monkeypatch: pytest.MonkeyPatch,
                              answer: str, connected: bool) -> None:
        client.outcomes = [UserWarning('Unknown host key'), None]
        monkeypatch.setattr('builtins.input', lambda prompt: answer)
        result = remote_backup()._ssh_connect()
        assert (result is client) == connected
        assert client.closed != connected
        if connected:
            assert client.policies == ['WarningPolicy', 'AutoAddPolicy']
    def test_unknown_host_key_no_terminal(self, client: FakeClient, monkeypatch: pytest.MonkeyPatch) -> None:
        def eof(prompt: str) -> str:
            raise EOFError
        client.outcomes = [UserWarning('Unknown host key')]
        monkeypatch.setattr('builtins.input', eof)
        assert remote_backup()._ssh_connect() is None
        assert client.closed
    def test_bad_host_key(self, client: FakeClient, caplog: pytest.LogCaptureFixture) -> None:
        class Key:
            def get_base64(self) -> str:
                return 'AAAA'
        client.outcomes = [sb.paramiko.BadHostKeyException('server', Key(), Key())]
        assert remote_backup()._ssh_connect() is None
        assert client.closed
        assert 'Can\'t connect to the server' in caplog.text
    def test_password(self, client: FakeClient, monkeypatch: pytest.MonkeyPatch) -> None:
        client.outcomes = [ssh_error(), ssh_error(), None]
        monkeypatch.setattr(sb, 'getpass', lambda prompt: 'secret')
        monkeypatch.setenv('SSHPASS', '')
        backup = remote_backup()
        assert backup._ssh_connect() is client
        assert client.connects[-1]['password'] == 'secret'
        assert backup._password_auth
        assert os.environ['SSHPASS'] == 'secret'
    def test_wrong_password(self, client: FakeClient, monkeypatch: pytest.MonkeyPatch) -> None:
        client.outcomes = [ssh_error(), ssh_error(), ssh_error()]
        monkeypatch.setattr(sb, 'getpass', lambda prompt: 'wrong')
        assert remote_backup()._ssh_connect() is None
        assert client.closed
    def test_password_no_terminal(self, client: FakeClient, monkeypatch: pytest.MonkeyPatch,
                                  caplog: pytest.LogCaptureFixture) -> None:
        def no_tty(prompt: str) -> str:
            warnings.warn('Can not control echo on the terminal.', GetPassWarning)
            return ''
        client.outcomes = [ssh_error(), ssh_error()]
        monkeypatch.setattr(sb, 'getpass', no_tty)
        assert remote_backup()._ssh_connect() is None
        assert 'Unable to get password' in caplog.text
    @pytest.mark.parametrize('outcome, connected', [(None, True), ('error', False)])
    def test_keyfile(self, client: FakeClient, monkeypatch: pytest.MonkeyPatch,
                     outcome: Optional[str], connected: bool) -> None:
        pkey = object()
        client.outcomes = [ssh_error(), ssh_error(), ssh_error() if outcome else None]
        monkeypatch.setattr(sb.Backup, '_load_ssh_key', lambda self: pkey)
        assert (remote_backup(ssh_keyfile='/keys/id')._ssh_connect() is client) == connected
        assert client.connects[-1]['pkey'] is pkey
    def test_keyfile_not_loaded(self, client: FakeClient, monkeypatch: pytest.MonkeyPatch) -> None:
        client.outcomes = [ssh_error(), ssh_error()]
        monkeypatch.setattr(sb.Backup, '_load_ssh_key', lambda self: None)
        assert remote_backup(ssh_keyfile='/keys/id')._ssh_connect() is None
        assert len(client.connects) == 2
        assert client.closed
@pytest.fixture(scope='module')
 def keys(tmp_path_factory: pytest.TempPathFactory) -> Path:
    """Real keys made by ssh-keygen; encrypted ones use the passphrase 'secret'"""
    key_dir = tmp_path_factory.mktemp('keys')
    key_types = {'ed25519': ['-t', 'ed25519'], 'ecdsa': ['-t', 'ecdsa'],
                 'rsa': ['-t', 'rsa', '-b', '2048'], 'rsa_pem': ['-t', 'rsa', '-b', '2048', '-m', 'PEM']}
    for name, args in key_types.items():
        for suffix, passphrase in [('', ''), ('_enc', 'secret')]:
            subprocess.run(['ssh-keygen', '-q', *args, '-N', passphrase, '-f', str(key_dir / f'{name}{suffix}')],
                           check=True)
    return key_dir
@needs_paramiko
@needs_ssh_keygen
 class TestLoadKey:
    @pytest.fixture(autouse=True)
    def prompts(self, monkeypatch: pytest.MonkeyPatch) -> list[str]:
        asked: list[str] = []
        def answer(prompt: str) -> str:
            asked.append(prompt)
            return self.passphrase
        self.passphrase = 'secret'
        monkeypatch.setattr(sb, 'getpass', answer)
        return asked
    @pytest.mark.parametrize('name', ['ed25519', 'ecdsa', 'rsa', 'rsa_pem'])
    def test_unencrypted(self, keys: Path, prompts: list[str], name: str) -> None:
        key = remote_backup(ssh_keyfile=str(keys / name))._load_ssh_key()
        assert isinstance(key, sb.paramiko.PKey)
        assert prompts == []
    @pytest.mark.parametrize('name', ['ed25519_enc', 'ecdsa_enc', 'rsa_enc', 'rsa_pem_enc'])
    def test_encrypted(self, keys: Path, prompts: list[str], name: str) -> None:
        key = remote_backup(ssh_keyfile=str(keys / name))._load_ssh_key()
        assert isinstance(key, sb.paramiko.PKey)
        assert len(prompts) == 1
    @pytest.mark.parametrize('name', ['ed25519_enc', 'rsa_pem_enc'])
    def test_wrong_passphrase(self, keys: Path, caplog: pytest.LogCaptureFixture, name: str) -> None:
        self.passphrase = 'wrong'
        assert remote_backup(ssh_keyfile=str(keys / name))._load_ssh_key() is None
        assert 'wrong passphrase?' in caplog.text
    def test_no_terminal(self, keys: Path, monkeypatch: pytest.MonkeyPatch,
                         caplog: pytest.LogCaptureFixture) -> None:
        def no_tty(prompt: str) -> str:
            warnings.warn('Can not control echo on the terminal.', GetPassWarning)
            return ''
        monkeypatch.setattr(sb, 'getpass', no_tty)
        assert remote_backup(ssh_keyfile=str(keys / 'ed25519_enc'))._load_ssh_key() is None
        assert 'Unable to get passphrase' in caplog.text
    @pytest.mark.parametrize('content', [None, 'not a key\n'])
    def test_bad_file(self, tmp_path: Path, caplog: pytest.LogCaptureFixture, content: Optional[str]) -> None:
        keyfile = tmp_path / 'id'
        if content is not None:
            keyfile.write_text(content)
        assert remote_backup(ssh_keyfile=str(keyfile))._load_ssh_key() is None
        assert 'Unable to load SSH key' in caplog.text