Compare commits
14
Commits
5e33781974
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c63665011a
|
||
|
|
345a4322a6
|
||
|
|
fea2e0456a
|
||
|
|
8aef768a23
|
||
|
|
efdff589f7
|
||
|
|
50546f2ebb
|
||
|
|
2c7233ce45
|
||
|
|
68b6d77f30
|
||
|
|
980913ee2a
|
||
|
|
0773a384dd
|
||
|
|
4bce0edba5
|
||
|
|
be93015136
|
||
|
|
c2ef47e4ea
|
||
|
|
ec27b8d77f
|
No files matched your search
@@ -0,0 +1,2 @@
|
|||||||
|
Daniele Fucini <dfucini@gmail.com>
|
||||||
|
Daniele Fucini <dfucini@gmail.com> <Fuxino@users.noreply.github.com>
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
pkgname=simple_backup
|
pkgname=simple_backup
|
||||||
pkgdesc='Simple backup script that uses rsync to copy files'
|
pkgdesc='Simple backup script that uses rsync to copy files'
|
||||||
pkgver=4.6.1
|
pkgver=4.7.0
|
||||||
pkgrel=1
|
pkgrel=1
|
||||||
url="https://git.shouldnt.work/fuxino/$pkgname"
|
url="https://git.shouldnt.work/fuxino/$pkgname"
|
||||||
arch=('any')
|
arch=('any')
|
||||||
@@ -24,7 +24,7 @@ checkdepends=('python-pytest'
|
|||||||
conflicts=('simple_backup-git')
|
conflicts=('simple_backup-git')
|
||||||
source=("git+$url?signed#tag=$pkgver")
|
source=("git+$url?signed#tag=$pkgver")
|
||||||
validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
|
validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
|
||||||
sha256sums=('3646012b0d50ca2cc1adcd7904bb34389e8d33724534730b48ae30de6b28f994')
|
sha256sums=('2e457b9efe12d7670bc6c279a3d31291be1debc6eab1d3971a77bf9c0fc6fd19')
|
||||||
|
|
||||||
build()
|
build()
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ simple_backup -h
|
|||||||
to print all possible command line options.
|
to print all possible command line options.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
simple_backup requires Python 3.10 or later.
|
||||||
The script uses rsync to actually run the backup, so you will have to install it on your system. For example on Arch Linux:
|
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
|
```bash
|
||||||
@@ -57,21 +58,29 @@ 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.
|
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.
|
When running as root in other ways (e.g. from a systemd service), specify the user with the --user (or -u) argument.
|
||||||
|
|
||||||
|
## Progress
|
||||||
|
When run in a terminal, simple_backup shows a progress bar with the percentage of files copied, the copy speed and an estimated time to completion.
|
||||||
|
Speed and estimated time follow the last 30 seconds, so the estimate adapts when big files are being copied.
|
||||||
|
Disable it with --no-progress.
|
||||||
|
|
||||||
## Old backups
|
## Old backups
|
||||||
The number of old backups to keep can be set with the --keep (or -k) argument (or in the configuration file).
|
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.
|
By default, 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.
|
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.
|
||||||
|
To free space on the destination first, use --remove-before-backup: old backups are then removed before rsync starts, even if the new backup fails.
|
||||||
|
|
||||||
## Last backup
|
## Last backup
|
||||||
After each successful backup, simple_backup saves its time and directory to `~/.local/state/simple_backup/last_backup` (or `$XDG_STATE_HOME/simple_backup/last_backup`).
|
After each successful backup, simple_backup saves its time and directory to `~/.local/state/simple_backup/last_backup` (or `$XDG_STATE_HOME/simple_backup/last_backup`).
|
||||||
|
It also saves the number of files, so that the next run can show progress and an estimated time while rsync is still looking for files.
|
||||||
When run with sudo or doas, the file goes to the home directory of the user who ran the command.
|
When run with sudo or doas, the file goes to the home directory of the user who ran the command.
|
||||||
Print it with:
|
To see when the last backup was made (e.g. `Last backup: 2026-10-25 14:03 (2 days ago)`), run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
simple_backup --last-backup
|
simple_backup --last-backup
|
||||||
```
|
```
|
||||||
|
|
||||||
The file has two lines: the completion time in ISO 8601 format (e.g. `2026-10-25T14:03:12+02:00`) and the backup directory, so scripts (e.g. a status bar indicator) can easily read it to remind you when a backup is overdue.
|
The first line of the file is the completion time in ISO 8601 format (e.g. `2026-10-25T14:03:12+02:00`), the second the backup directory, and the third (if known) the number of files.
|
||||||
|
Scripts (e.g. a status bar indicator) can easily read the first line to remind you when a backup is overdue.
|
||||||
|
|
||||||
## Remote backup
|
## Remote backup
|
||||||
> **Warning**
|
> **Warning**
|
||||||
@@ -101,4 +110,6 @@ sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
|
|||||||
|
|
||||||
or by editing the sudoers file.
|
or by editing the sudoers file.
|
||||||
If SSH key authentication is not available, password authentication will be used instead.
|
If SSH key authentication is not available, password authentication will be used instead.
|
||||||
|
In that case, if sshpass is installed, it is used to pass the password to rsync, so that you only have to enter it once; otherwise you will be asked for it more than once.
|
||||||
|
sshpass has some security risks (see sshpass(1)), so use SSH key authentication if possible.
|
||||||
Check the man page for more details.
|
Check the man page for more details.
|
||||||
+49
-33
@@ -1,31 +1,34 @@
|
|||||||
.TH SIMPLE_BACKUP 1 2026-11-02 SIMPLE_BACKUP 4.6.1
|
.TH SIMPLE_BACKUP 1 2026-11-21 SIMPLE_BACKUP 4.7.0
|
||||||
.SH NAME
|
.SH NAME
|
||||||
simple_backup \- Backup files and folders using rsync
|
simple_backup \- Backup files and folders using rsync
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B simple_backup
|
.SY simple_backup
|
||||||
\-h, \-\-help
|
\-h,\~\-\-help
|
||||||
.PD 0
|
.YS
|
||||||
.P
|
.SY simple_backup
|
||||||
.PD
|
\-\-last\-backup
|
||||||
.B simple_backup
|
[\-u,\~\-\-user\~USERNAME]
|
||||||
[\-c, \-\-config FILE]
|
.YS
|
||||||
[\-i, \-\-input INPUT [INPUT...]]
|
.SY simple_backup
|
||||||
[\-o, \-\-output DIR]
|
[\-v,\~\-\-verbose]
|
||||||
.PD 0
|
[\-c,\~\-\-config\~FILE]
|
||||||
.P
|
[\-i,\~\-\-inputs\~INPUT\~[INPUT...]]
|
||||||
.PD
|
[\-o,\~\-\-output\~DIR]
|
||||||
.RS 14 [\-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
|
[\-e,\~\-\-exclude\~FILE|DIR|PATTERN\~[FILE|...]]
|
||||||
[\-k, \-\-keep N]
|
[\-k,\~\-\-keep\~N]
|
||||||
[\-\-ssh\-host HOSTNAME]
|
[\-u,\~\-\-user\~USERNAME]
|
||||||
[\-\-ssh\-user USERNAME]
|
[\-\-ssh\-host\~HOSTNAME]
|
||||||
[\-\-keyfile FILE]
|
[\-\-ssh\-user\~USERNAME]
|
||||||
.PD 0
|
[\-\-keyfile\~FILE]
|
||||||
.P
|
[\-\-remote\-sudo]
|
||||||
.PD
|
[\-\-numeric\-ids]
|
||||||
[\-s, \-\-checksum]
|
[\-s,\~\-\-checksum]
|
||||||
[\-z, \-\-compress]
|
[\-z,\~\-\-compress]
|
||||||
|
[\-\-rsync\-options\~OPTION\~[OPTION...]]
|
||||||
[\-\-remove\-before\-backup]
|
[\-\-remove\-before\-backup]
|
||||||
.RE
|
[\-\-no\-syslog]
|
||||||
|
[\-\-no\-progress]
|
||||||
|
.YS
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.B simple_backup
|
.B simple_backup
|
||||||
is a python script for performing backup of files and folders.
|
is a python script for performing backup of files and folders.
|
||||||
@@ -36,15 +39,20 @@ in a configuration file (default location $HOME/.config/simple_backup/simple_bac
|
|||||||
or directly on the command line.
|
or directly on the command line.
|
||||||
.P
|
.P
|
||||||
Parameters specified on the command line will override those in the configuration file.
|
Parameters specified on the command line will override those in the configuration file.
|
||||||
|
The exceptions are remote_sudo and numeric_ids: if enabled in the configuration file, they
|
||||||
|
can\(aqt be disabled on the command line.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.TP
|
.TP
|
||||||
.B \-h, \-\-help
|
.B \-h, \-\-help
|
||||||
Print a short help message and exit.
|
Print a short help message and exit.
|
||||||
.TP
|
.TP
|
||||||
|
.B \-v, \-\-verbose
|
||||||
|
More verbose output.
|
||||||
|
.TP
|
||||||
.B \-c, \-\-config FILE
|
.B \-c, \-\-config FILE
|
||||||
Specify the configuration file, useful to specify a different one from the default.
|
Specify the configuration file, useful to specify a different one from the default.
|
||||||
.TP
|
.TP
|
||||||
.B \-i, \-\-input INPUT [INPUT...]
|
.B \-i, \-\-inputs INPUT [INPUT...]
|
||||||
Specify the files and directories to backup. Multiple inputs can be specified, just separate
|
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,
|
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.
|
or to use single or double quotes around them.
|
||||||
@@ -64,7 +72,7 @@ not preserved either.
|
|||||||
.TP
|
.TP
|
||||||
.B \-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
|
.B \-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
|
||||||
Specify files, directories or patterns to exclude from the backup. Matching files and directories
|
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.
|
will not be copied. Multiple elements can be specified, in the same way as for the \-\-inputs option.
|
||||||
.TP
|
.TP
|
||||||
.B \-k, \-\-keep N
|
.B \-k, \-\-keep N
|
||||||
Specify how many old backups (so excluding the current one) will be kept. The default behavior
|
Specify how many old backups (so excluding the current one) will be kept. The default behavior
|
||||||
@@ -84,15 +92,15 @@ Hostname of the server where to copy the files in case of remote backup through
|
|||||||
Username for connecting to the server in case of remote backup.
|
Username for connecting to the server in case of remote backup.
|
||||||
.TP
|
.TP
|
||||||
.B \-\-keyfile FILE
|
.B \-\-keyfile FILE
|
||||||
Location of the SSH key for server authentication.
|
Location of the SSH key for server authentication.
|
||||||
.TP
|
.TP
|
||||||
.B \-s, \-\-checksums
|
.B \-s, \-\-checksum
|
||||||
Same as rsync option \(aq\-\-checksum\(aq, use checksums instead of mod\-time and size
|
Same as rsync option \(aq\-\-checksum\(aq, use checksums instead of mod\-time and size
|
||||||
to skip files.
|
to skip files.
|
||||||
.TP
|
.TP
|
||||||
.B \-z, \-\-compress
|
.B \-z, \-\-compress
|
||||||
Compress data during transfer (rsync \(aq\-\-compress\(aq option). Useful for remote backup
|
Compress data during transfer (rsync \(aq\-\-compress\(aq option). Useful for remote backup
|
||||||
if saving bandwith is needed.
|
if saving bandwidth is needed.
|
||||||
.TP
|
.TP
|
||||||
.B \-\-remove\-before\-backup
|
.B \-\-remove\-before\-backup
|
||||||
Remove old backups (if necessary) before creating the new backup. Useful to free some space
|
Remove old backups (if necessary) before creating the new backup. Useful to free some space
|
||||||
@@ -108,8 +116,13 @@ Don't use systemd journal for logging.
|
|||||||
.B \-\-no\-progress
|
.B \-\-no\-progress
|
||||||
Don't show a progress bar while rsync copies the files. The progress bar is only shown when
|
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.
|
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
|
It shows the percentage of files copied, the copy speed and the estimated time, both from the
|
||||||
and estimated time are only approximate.
|
last 30 seconds; the time shows \(aq\-\-:\-\-:\-\-\(aq when no file finished in that time (e.g. while
|
||||||
|
copying a big file).
|
||||||
|
While rsync is still looking for files, the percentage and estimated time (marked with
|
||||||
|
\(aq~\(aq) are based on the number of files in the last backup (or on the files found so far,
|
||||||
|
once this backup has more), and stay below 100%. Without a previous count the bar shows
|
||||||
|
\(aq(scanning)\(aq instead.
|
||||||
.TP
|
.TP
|
||||||
.B \-\-rsync\-options OPTIONS [OPTION...]
|
.B \-\-rsync\-options OPTIONS [OPTION...]
|
||||||
By default, the following rsync options are used:
|
By default, the following rsync options are used:
|
||||||
@@ -147,7 +160,8 @@ needs to be allowed to run without password in the same way.
|
|||||||
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.
|
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.
|
||||||
.TP
|
.TP
|
||||||
.B \-\-last\-backup
|
.B \-\-last\-backup
|
||||||
Print the date and directory of the last successful backup, then exit. The exit status is 0, or 1
|
Print the date of the last successful backup and how long ago it was made (for example
|
||||||
|
\(aqLast backup: 2026\-10\-25 14:03 (2 days ago)\(aq), then exit. The exit status is 0, or 1
|
||||||
if no backup has been recorded yet or the state file can\(aqt be read (see
|
if no backup has been recorded yet or the state file can\(aqt be read (see
|
||||||
.BR FILES ).
|
.BR FILES ).
|
||||||
.SH CONFIGURATION
|
.SH CONFIGURATION
|
||||||
@@ -227,7 +241,9 @@ Bad configuration file or options (for example, only one of SSH host and SSH use
|
|||||||
Written after each successful backup (local or remote), replacing the previous one. The first line
|
Written after each successful backup (local or remote), replacing the previous one. The first line
|
||||||
is the completion time in ISO 8601 format with the UTC offset (for example
|
is the completion time in ISO 8601 format with the UTC offset (for example
|
||||||
\(aq2026\-10\-25T14:03:12+02:00\(aq), the second line the backup directory (prefixed with
|
\(aq2026\-10\-25T14:03:12+02:00\(aq), the second line the backup directory (prefixed with
|
||||||
\(aquser@host:\(aq for remote backups). The default location is
|
\(aquser@host:\(aq for remote backups), and the third line, if present, the number of files, used
|
||||||
|
for the progress bar estimate (only counted when the progress bar is shown, otherwise the previous
|
||||||
|
count is kept). The default location is
|
||||||
\fI~/.local/state/simple_backup/last_backup\fR. When running as root with sudo, doas or \-\-user,
|
\fI~/.local/state/simple_backup/last_backup\fR. When running as root with sudo, doas or \-\-user,
|
||||||
the file is written to that user\(aqs \fI~/.local/state\fR and owned by them. Useful for scripts
|
the file is written to that user\(aqs \fI~/.local/state\fR and owned by them. Useful for scripts
|
||||||
that remind you when a backup is overdue.
|
that remind you when a backup is overdue.
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
"""Init."""
|
"""Init."""
|
||||||
|
|
||||||
__version__ = '4.6.1'
|
__version__ = '4.7.0'
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
# Example config file for simple_backup
|
# Example config file for simple_backup
|
||||||
|
|
||||||
[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).
|
# Files and directories to backup. Multiple items can be separated using a comma (','). It is possible to use wildcards (e.g. '*' to match multiple characters) and '~' for the user's home directory.
|
||||||
inputs=/home/user
|
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).
|
# Output directory. For remote backups, this is a path on the server ('~' and relative paths refer to the home directory on the server).
|
||||||
@@ -13,7 +13,8 @@ exclude=*.bak
|
|||||||
# Number of old backups (i.e. excluding the one that's being created) to keep (use -1 to keep all)
|
# Number of old backups (i.e. excluding the one that's being created) to keep (use -1 to keep all)
|
||||||
keep=-1
|
keep=-1
|
||||||
|
|
||||||
# Uncomment the following section to enable backup to remote server through ssh
|
# Uncomment the following section to enable backup to remote server through ssh.
|
||||||
|
# ssh_host can be an alias from ~/.ssh/config (its HostName, Port and IdentityFile are used)
|
||||||
# [server]
|
# [server]
|
||||||
# ssh_host=
|
# ssh_host=
|
||||||
# ssh_user=
|
# ssh_user=
|
||||||
|
|||||||
+134
-15
@@ -74,6 +74,10 @@ SSH_TIMEOUT = 15
|
|||||||
# An rsync --info=progress2 update: size, percent, speed, time, then optionally (xfr#N, ir-chk/to-chk=N/N)
|
# An rsync --info=progress2 update: size, percent, speed, time, then optionally (xfr#N, ir-chk/to-chk=N/N)
|
||||||
PROGRESS_RE = re.compile(r'\s*(\S+)\s+\d+%\s+\S+\s+\d+:\d\d:\d\d(?:\s+\(xfr#\d+, (ir|to)-chk=(\d+)/(\d+)\))?\s*')
|
PROGRESS_RE = re.compile(r'\s*(\S+)\s+\d+%\s+\S+\s+\d+:\d\d:\d\d(?:\s+\(xfr#\d+, (ir|to)-chk=(\d+)/(\d+)\))?\s*')
|
||||||
PROGRESS_BAR_WIDTH = 30
|
PROGRESS_BAR_WIDTH = 30
|
||||||
|
# rsync's transferred size: 1,234B, 1.23MB (-h), 1.17MiB (-hh) or 1.23M (older rsync)
|
||||||
|
SIZE_RE = re.compile(r'([\d.,]+)([KMGTP]?)(i?)B?')
|
||||||
|
# Seconds of recent progress the ETA and speed come from, so they follow changes of pace
|
||||||
|
RATE_WINDOW = 30
|
||||||
|
|
||||||
|
|
||||||
def _format_duration(seconds: float) -> str:
|
def _format_duration(seconds: float) -> str:
|
||||||
@@ -87,6 +91,43 @@ def _format_duration(seconds: float) -> str:
|
|||||||
return f'{s // 60:02d}:{s % 60:02d}'
|
return f'{s // 60:02d}:{s % 60:02d}'
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_size(size: str) -> int | None:
|
||||||
|
"""Bytes in an rsync size field, or None if it can't be parsed"""
|
||||||
|
|
||||||
|
m = SIZE_RE.fullmatch(size)
|
||||||
|
|
||||||
|
if m is None:
|
||||||
|
return None
|
||||||
|
|
||||||
|
number, unit, binary = m.groups()
|
||||||
|
|
||||||
|
try:
|
||||||
|
if unit == '':
|
||||||
|
return int(number.replace(',', '').replace('.', ''))
|
||||||
|
|
||||||
|
# Suffixed sizes use the locale's decimal point
|
||||||
|
return int(float(number.replace(',', '.')) * (1024 if binary else 1000) ** ('KMGTP'.index(unit) + 1))
|
||||||
|
except ValueError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _format_speed(speed: float) -> str:
|
||||||
|
"""Format bytes per second like rsync -h"""
|
||||||
|
|
||||||
|
if speed < 1000:
|
||||||
|
return f'{speed:.0f}B/s'
|
||||||
|
|
||||||
|
units = ['KB', 'MB', 'GB', 'TB']
|
||||||
|
i = 0
|
||||||
|
speed /= 1000
|
||||||
|
|
||||||
|
while speed >= 1000 and i < len(units) - 1:
|
||||||
|
speed /= 1000
|
||||||
|
i += 1
|
||||||
|
|
||||||
|
return f'{speed:.1f}{units[i]}/s'
|
||||||
|
|
||||||
|
|
||||||
class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
|
class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
|
||||||
"""Custom format for argparse help text"""
|
"""Custom format for argparse help text"""
|
||||||
|
|
||||||
@@ -94,13 +135,54 @@ class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFo
|
|||||||
class _ProgressBar:
|
class _ProgressBar:
|
||||||
"""Draws rsync --info=progress2 updates as a bar on stderr"""
|
"""Draws rsync --info=progress2 updates as a bar on stderr"""
|
||||||
|
|
||||||
def __init__(self) -> None:
|
def __init__(self, estimate: int = 0) -> None:
|
||||||
self._start = default_timer()
|
self._start = default_timer()
|
||||||
# rsync reports ir-chk while incremental recursion is still finding files
|
# rsync reports ir-chk while incremental recursion is still finding files
|
||||||
self._scanning = True
|
self._scanning = True
|
||||||
self._checked = 0
|
self._checked = 0
|
||||||
self._total = 0
|
self._total = 0
|
||||||
|
# Total files of the last backup, used until rsync knows the real total
|
||||||
|
self._estimate = estimate
|
||||||
self._shown = False
|
self._shown = False
|
||||||
|
# (time, files checked, bytes copied) about once a second, back to the start of the rate window
|
||||||
|
self._samples: deque[tuple[float, int, int]] = deque([(self._start, 0, 0)])
|
||||||
|
self._file_rate: float | None = None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def total(self) -> int | None:
|
||||||
|
"""Total number of files, once rsync has found them all"""
|
||||||
|
|
||||||
|
return None if self._scanning or self._total == 0 else self._total
|
||||||
|
|
||||||
|
def _sample(self, copied: int | None) -> str:
|
||||||
|
"""Update the file rate over the window, and return the copy speed text (empty if unknown)"""
|
||||||
|
|
||||||
|
now = default_timer()
|
||||||
|
|
||||||
|
if now - self._samples[-1][0] >= 1:
|
||||||
|
self._samples.append((now, self._checked, copied or 0))
|
||||||
|
|
||||||
|
# Keep the newest sample at or before the window start as the base
|
||||||
|
while len(self._samples) > 1 and self._samples[1][0] <= now - RATE_WINDOW:
|
||||||
|
self._samples.popleft()
|
||||||
|
|
||||||
|
t0, checked0, copied0 = self._samples[0]
|
||||||
|
span = now - t0
|
||||||
|
self._file_rate = (self._checked - checked0) / span if span > 0 else None
|
||||||
|
|
||||||
|
if copied is None or span <= 0:
|
||||||
|
return ''
|
||||||
|
|
||||||
|
return f' {_format_speed(max(copied - copied0, 0) / span)}'
|
||||||
|
|
||||||
|
def _eta(self, total: int) -> str:
|
||||||
|
# No file finished within the window (e.g. while copying a big one): no basis for an estimate
|
||||||
|
if not self._file_rate:
|
||||||
|
return '--:--:--'
|
||||||
|
|
||||||
|
eta = int((total - self._checked) / self._file_rate)
|
||||||
|
|
||||||
|
return f'{eta // 3600}:{eta // 60 % 60:02d}:{eta % 60:02d}'
|
||||||
|
|
||||||
def update(self, record: str) -> bool:
|
def update(self, record: str) -> bool:
|
||||||
"""Draw the bar if record is a progress update, and return whether it was"""
|
"""Draw the bar if record is a progress update, and return whether it was"""
|
||||||
@@ -118,21 +200,35 @@ class _ProgressBar:
|
|||||||
self._total = int(m.group(4))
|
self._total = int(m.group(4))
|
||||||
self._checked = self._total - int(m.group(3))
|
self._checked = self._total - int(m.group(3))
|
||||||
|
|
||||||
|
speed = self._sample(_parse_size(size))
|
||||||
|
|
||||||
# Count files, not bytes: with --link-dest unchanged files are linked, and rsync's percentage leaves them out
|
# Count files, not bytes: with --link-dest unchanged files are linked, and rsync's percentage leaves them out
|
||||||
if self._scanning or self._total == 0:
|
percent: int | None
|
||||||
text = f'{self._checked:,} files checked {size} copied (scanning)'
|
|
||||||
percent = None
|
if self.total is None:
|
||||||
|
# Estimate from the last backup; past it, from the files found so far, as the scan is then nearly done
|
||||||
|
estimate = max(self._estimate, self._total)
|
||||||
|
|
||||||
|
if self._estimate > 0 and self._checked > 0:
|
||||||
|
# The real total is still unknown, so never claim 100%
|
||||||
|
percent = min(self._checked * 100 // estimate, 99)
|
||||||
|
text = f'{f"~{percent}":>3}% {self._checked:,}/~{estimate:,} files {size} copied{speed}'
|
||||||
|
|
||||||
|
if percent > 0:
|
||||||
|
text += f' ETA ~{self._eta(estimate)}'
|
||||||
|
else:
|
||||||
|
text = f'{self._checked:,} files checked {size} copied{speed} (scanning)'
|
||||||
|
percent = None
|
||||||
else:
|
else:
|
||||||
percent = self._checked * 100 // self._total
|
percent = self._checked * 100 // self._total
|
||||||
text = f'{percent:3d}% {self._checked:,}/{self._total:,} files {size} copied'
|
text = f'{percent:3d}% {self._checked:,}/{self._total:,} files {size} copied{speed}'
|
||||||
|
|
||||||
if 0 < percent < 100:
|
if 0 < percent < 100:
|
||||||
eta = int((default_timer() - self._start) * (self._total - self._checked) / self._checked)
|
text += f' ETA {self._eta(self._total)}'
|
||||||
text += f' ETA {eta // 3600}:{eta // 60 % 60:02d}:{eta % 60:02d}'
|
|
||||||
|
|
||||||
width = get_terminal_size().columns - 1
|
width = get_terminal_size().columns - 1
|
||||||
|
|
||||||
# Fixed width, so the bar doesn't jump when the text changes length; no bar until the total is known
|
# Fixed width, so the bar doesn't jump when the text changes length; no bar without a total or estimate
|
||||||
if percent is not None and len(text) + PROGRESS_BAR_WIDTH + 4 <= width:
|
if percent is not None and len(text) + PROGRESS_BAR_WIDTH + 4 <= width:
|
||||||
filled = PROGRESS_BAR_WIDTH * percent // 100
|
filled = PROGRESS_BAR_WIDTH * percent // 100
|
||||||
text = f'[{"#" * filled}{"-" * (PROGRESS_BAR_WIDTH - filled)}] {text}'
|
text = f'[{"#" * filled}{"-" * (PROGRESS_BAR_WIDTH - filled)}] {text}'
|
||||||
@@ -195,7 +291,7 @@ class Backup:
|
|||||||
keep: int | None, options: str,
|
keep: int | None, options: str,
|
||||||
ssh_host: str | None = None, ssh_user: str | None = None, ssh_keyfile: str | None = None,
|
ssh_host: str | None = None, ssh_user: str | None = None, ssh_keyfile: str | None = None,
|
||||||
remote_sudo: bool = False, remove_before: bool = False, verbose: bool = False,
|
remote_sudo: bool = False, remove_before: bool = False, verbose: bool = False,
|
||||||
progress: bool = False) -> None:
|
progress: bool = False, file_estimate: int = 0) -> None:
|
||||||
# Missing values are reported by check_params()
|
# Missing values are reported by check_params()
|
||||||
self.inputs = inputs if inputs is not None else []
|
self.inputs = inputs if inputs is not None else []
|
||||||
self.output = output if output is not None else ''
|
self.output = output if output is not None else ''
|
||||||
@@ -209,6 +305,9 @@ class Backup:
|
|||||||
self._remove_before = remove_before
|
self._remove_before = remove_before
|
||||||
self._verbose = verbose
|
self._verbose = verbose
|
||||||
self._progress = progress
|
self._progress = progress
|
||||||
|
self._file_estimate = file_estimate
|
||||||
|
# Files in the backup, known only with the progress bar
|
||||||
|
self.file_count: int | None = None
|
||||||
self._last_backup = ''
|
self._last_backup = ''
|
||||||
self._server = ''
|
self._server = ''
|
||||||
self._output_dir = ''
|
self._output_dir = ''
|
||||||
@@ -768,7 +867,7 @@ class Backup:
|
|||||||
|
|
||||||
if self._progress:
|
if self._progress:
|
||||||
args.append('--info=progress2')
|
args.append('--info=progress2')
|
||||||
bar = _ProgressBar()
|
bar = _ProgressBar(self._file_estimate)
|
||||||
|
|
||||||
with Popen(args, stdin=PIPE, stdout=PIPE, stderr=STDOUT, shell=False, env=env) as p:
|
with Popen(args, stdin=PIPE, stdout=PIPE, stderr=STDOUT, shell=False, env=env) as p:
|
||||||
assert p.stdin is not None and isinstance(p.stdout, io.BufferedIOBase)
|
assert p.stdin is not None and isinstance(p.stdout, io.BufferedIOBase)
|
||||||
@@ -787,6 +886,9 @@ class Backup:
|
|||||||
|
|
||||||
returncode = p.wait()
|
returncode = p.wait()
|
||||||
|
|
||||||
|
if bar is not None:
|
||||||
|
self.file_count = bar.total
|
||||||
|
|
||||||
if returncode == 0:
|
if returncode == 0:
|
||||||
# Without -v, only the summary, which may be fewer than two lines (e.g. with --rsync-options q)
|
# Without -v, only the summary, which may be fewer than two lines (e.g. with --rsync-options q)
|
||||||
for r in output:
|
for r in output:
|
||||||
@@ -1105,12 +1207,28 @@ def _state_file(owner: pwd.struct_passwd | None) -> str:
|
|||||||
return os.path.join(base, 'simple_backup', 'last_backup')
|
return os.path.join(base, 'simple_backup', 'last_backup')
|
||||||
|
|
||||||
|
|
||||||
def _write_state(user: str | None, destination: str) -> None:
|
def _last_file_count(user: str | None) -> int:
|
||||||
"""Record the time and directory of the last successful backup (two lines)"""
|
"""Files in the last backup (third line of the state file), or 0 if unknown"""
|
||||||
|
|
||||||
|
try:
|
||||||
|
with open(_state_file(_state_owner(user)), encoding='utf-8') as fp:
|
||||||
|
return int(fp.read().splitlines()[2])
|
||||||
|
except (OSError, ValueError, IndexError):
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def _write_state(user: str | None, destination: str, file_count: int | None = None) -> None:
|
||||||
|
"""Record the time, directory and file count of the last successful backup (one per line)"""
|
||||||
|
|
||||||
owner = _state_owner(user)
|
owner = _state_owner(user)
|
||||||
path = _state_file(owner)
|
path = _state_file(owner)
|
||||||
tmp = ''
|
tmp = ''
|
||||||
|
|
||||||
|
# Without the progress bar the count is unknown, so keep the previous one
|
||||||
|
if file_count is None:
|
||||||
|
file_count = _last_file_count(user)
|
||||||
|
|
||||||
|
count_line = f'{file_count}\n' if file_count > 0 else ''
|
||||||
euid, egid = os.geteuid(), os.getegid()
|
euid, egid = os.geteuid(), os.getegid()
|
||||||
|
|
||||||
# Create the file (and any missing directories) as the user, not root
|
# Create the file (and any missing directories) as the user, not root
|
||||||
@@ -1125,7 +1243,7 @@ def _write_state(user: str | None, destination: str) -> None:
|
|||||||
fd, tmp = mkstemp(prefix='.last_backup', dir=os.path.dirname(path), text=True)
|
fd, tmp = mkstemp(prefix='.last_backup', dir=os.path.dirname(path), text=True)
|
||||||
|
|
||||||
with os.fdopen(fd, 'w', encoding='utf-8') as fp:
|
with os.fdopen(fd, 'w', encoding='utf-8') as fp:
|
||||||
fp.write(f'{datetime.now().astimezone().isoformat(timespec="seconds")}\n{destination}\n')
|
fp.write(f'{datetime.now().astimezone().isoformat(timespec="seconds")}\n{destination}\n{count_line}')
|
||||||
|
|
||||||
os.replace(tmp, path)
|
os.replace(tmp, path)
|
||||||
except OSError as e:
|
except OSError as e:
|
||||||
@@ -1260,9 +1378,10 @@ def simple_backup() -> int:
|
|||||||
if args.numeric_ids or config_args['numeric_ids']:
|
if args.numeric_ids or config_args['numeric_ids']:
|
||||||
rsync_options.append('--numeric-ids')
|
rsync_options.append('--numeric-ids')
|
||||||
|
|
||||||
|
progress = not args.no_progress and sys.stderr.isatty()
|
||||||
backup = Backup(inputs, output, exclude, keep, ' '.join(rsync_options), ssh_host, ssh_user, ssh_keyfile,
|
backup = Backup(inputs, output, exclude, keep, ' '.join(rsync_options), ssh_host, ssh_user, ssh_keyfile,
|
||||||
remote_sudo, remove_before=args.remove_before_backup, verbose=args.verbose,
|
remote_sudo, remove_before=args.remove_before_backup, verbose=args.verbose,
|
||||||
progress=not args.no_progress and sys.stderr.isatty())
|
progress=progress, file_estimate=_last_file_count(user) if progress else 0)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
return_code = backup.check_params(homedir)
|
return_code = backup.check_params(homedir)
|
||||||
@@ -1273,7 +1392,7 @@ def simple_backup() -> int:
|
|||||||
return_code = backup.run()
|
return_code = backup.run()
|
||||||
|
|
||||||
if return_code == 0:
|
if return_code == 0:
|
||||||
_write_state(user, backup.destination)
|
_write_state(user, backup.destination, backup.file_count)
|
||||||
|
|
||||||
return return_code
|
return return_code
|
||||||
finally:
|
finally:
|
||||||
|
|||||||
+16
-2
@@ -32,7 +32,8 @@ class FakeBackup:
|
|||||||
def __init__(self, inputs: Any, output: Any, exclude: Any, keep: Any, options: str,
|
def __init__(self, inputs: Any, output: Any, exclude: Any, keep: Any, options: str,
|
||||||
ssh_host: str | None = None, ssh_user: str | None = None,
|
ssh_host: str | None = None, ssh_user: str | None = None,
|
||||||
ssh_keyfile: str | None = None, remote_sudo: bool = False,
|
ssh_keyfile: str | None = None, remote_sudo: bool = False,
|
||||||
remove_before: bool = False, verbose: bool = False, progress: bool = False) -> None:
|
remove_before: bool = False, verbose: bool = False, progress: bool = False,
|
||||||
|
file_estimate: int = 0) -> None:
|
||||||
self.inputs = inputs
|
self.inputs = inputs
|
||||||
self.output = output
|
self.output = output
|
||||||
self.exclude = exclude
|
self.exclude = exclude
|
||||||
@@ -45,6 +46,8 @@ class FakeBackup:
|
|||||||
self.remove_before = remove_before
|
self.remove_before = remove_before
|
||||||
self.verbose = verbose
|
self.verbose = verbose
|
||||||
self.progress = progress
|
self.progress = progress
|
||||||
|
self.file_estimate = file_estimate
|
||||||
|
self.file_count: int | None = None
|
||||||
self.homedir: str | None = None
|
self.homedir: str | None = None
|
||||||
self.ran = False
|
self.ran = False
|
||||||
self.closed = False
|
self.closed = False
|
||||||
@@ -87,7 +90,7 @@ def as_root(monkeypatch: pytest.MonkeyPatch) -> None:
|
|||||||
|
|
||||||
monkeypatch.setattr(os, 'geteuid', lambda: 0)
|
monkeypatch.setattr(os, 'geteuid', lambda: 0)
|
||||||
# Writing the state file as root would call seteuid() (covered in test_state.py)
|
# Writing the state file as root would call seteuid() (covered in test_state.py)
|
||||||
monkeypatch.setattr(sb, '_write_state', lambda user, destination: None)
|
monkeypatch.setattr(sb, '_write_state', lambda user, destination, file_count=None: None)
|
||||||
|
|
||||||
for var in ['SUDO_USER', 'SUDO_UID', 'DOAS_USER']:
|
for var in ['SUDO_USER', 'SUDO_UID', 'DOAS_USER']:
|
||||||
monkeypatch.delenv(var, raising=False)
|
monkeypatch.delenv(var, raising=False)
|
||||||
@@ -266,6 +269,17 @@ ssh_keyfile=/keys/id
|
|||||||
assert run_cli('-c', config('backup_dir=/backups'), *argv) == 0
|
assert run_cli('-c', config('backup_dir=/backups'), *argv) == 0
|
||||||
assert last_backup().progress is progress
|
assert last_backup().progress is progress
|
||||||
|
|
||||||
|
@pytest.mark.parametrize('tty, estimate', [(True, 1234), (False, 0)])
|
||||||
|
def test_file_estimate(self, run_cli: RunCli, config: Callable[[str], str], monkeypatch: pytest.MonkeyPatch,
|
||||||
|
tmp_path: Path, tty: bool, estimate: int) -> None:
|
||||||
|
monkeypatch.setattr(sb.sys.stderr, 'isatty', lambda: tty)
|
||||||
|
state = tmp_path / 'state' / 'simple_backup' / 'last_backup'
|
||||||
|
state.parent.mkdir(parents=True)
|
||||||
|
state.write_text('2026-10-25T10:00:00+02:00\n/backups/old\n1234\n')
|
||||||
|
|
||||||
|
assert run_cli('-c', config('backup_dir=/backups')) == 0
|
||||||
|
assert last_backup().file_estimate == estimate
|
||||||
|
|
||||||
def test_check_params_failure(self, run_cli: RunCli, config: Callable[[str], str]) -> None:
|
def test_check_params_failure(self, run_cli: RunCli, config: Callable[[str], str]) -> None:
|
||||||
FakeBackup.check_code = 2
|
FakeBackup.check_code = 2
|
||||||
|
|
||||||
|
|||||||
+92
-4
@@ -207,6 +207,19 @@ class TestRsync:
|
|||||||
assert 'rsync: total size' in caplog.text
|
assert 'rsync: total size' in caplog.text
|
||||||
assert '%' not in caplog.text
|
assert '%' not in caplog.text
|
||||||
|
|
||||||
|
def test_file_count(self, src: Path, out: Path) -> None:
|
||||||
|
backup = make_backup(out, [str(src)], progress=True)
|
||||||
|
|
||||||
|
assert backup.run() == 0
|
||||||
|
# The source folder, its two files and the implied parent folders
|
||||||
|
assert backup.file_count is not None and backup.file_count >= 3
|
||||||
|
|
||||||
|
def test_no_file_count_without_progress(self, src: Path, out: Path) -> None:
|
||||||
|
backup = make_backup(out, [str(src)])
|
||||||
|
|
||||||
|
assert backup.run() == 0
|
||||||
|
assert backup.file_count is None
|
||||||
|
|
||||||
def test_cli(self, src: Path, out: Path, tmp_path: Path, run_cli: Callable[..., int]) -> None:
|
def test_cli(self, src: Path, out: Path, tmp_path: Path, run_cli: Callable[..., int]) -> None:
|
||||||
config_file = str(tmp_path / 'missing.conf')
|
config_file = str(tmp_path / 'missing.conf')
|
||||||
|
|
||||||
@@ -250,10 +263,26 @@ def test_format_duration(seconds: float, text: str) -> None:
|
|||||||
assert sb._format_duration(seconds) == text
|
assert sb._format_duration(seconds) == text
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(('size', 'size_bytes'), [
|
||||||
|
('30,000,000B', 30_000_000), ('4,000,000', 4_000_000), ('30.0MB', 30_000_000), ('30,0MB', 30_000_000),
|
||||||
|
('2.00M', 2_000_000), ('1.5GB', 1_500_000_000), ('28.6MiB', 29_989_273), ('512B', 512), ('?', None),
|
||||||
|
('1.2.3MB', None),
|
||||||
|
])
|
||||||
|
def test_parse_size(size: str, size_bytes: int | None) -> None:
|
||||||
|
assert sb._parse_size(size) == size_bytes
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(('speed', 'text'), [
|
||||||
|
(0, '0B/s'), (999, '999B/s'), (1500, '1.5KB/s'), (10_500_000, '10.5MB/s'), (2e9, '2.0GB/s'), (3e12, '3.0TB/s'),
|
||||||
|
])
|
||||||
|
def test_format_speed(speed: float, text: str) -> None:
|
||||||
|
assert sb._format_speed(speed) == text
|
||||||
|
|
||||||
|
|
||||||
class TestProgressBar:
|
class TestProgressBar:
|
||||||
@pytest.fixture(autouse=True)
|
@pytest.fixture(autouse=True)
|
||||||
def terminal(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
def terminal(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
monkeypatch.setattr(sb, 'get_terminal_size', lambda: os.terminal_size((81, 24)))
|
monkeypatch.setattr(sb, 'get_terminal_size', lambda: os.terminal_size((100, 24)))
|
||||||
# 30 s elapsed at each update
|
# 30 s elapsed at each update
|
||||||
monkeypatch.setattr(sb, 'default_timer', iter([0.0, 30.0]).__next__)
|
monkeypatch.setattr(sb, 'default_timer', iter([0.0, 30.0]).__next__)
|
||||||
|
|
||||||
@@ -261,7 +290,7 @@ class TestProgressBar:
|
|||||||
bar = sb._ProgressBar()
|
bar = sb._ProgressBar()
|
||||||
|
|
||||||
assert bar.update(' 2.00M 25% 1.47MB/s 0:00:02 (xfr#1, ir-chk=1009/2632)')
|
assert bar.update(' 2.00M 25% 1.47MB/s 0:00:02 (xfr#1, ir-chk=1009/2632)')
|
||||||
assert capsys.readouterr().err == '\r1,623 files checked 2.00M copied (scanning)\033[K'
|
assert capsys.readouterr().err == '\r1,623 files checked 2.00M copied 66.7KB/s (scanning)\033[K'
|
||||||
|
|
||||||
def test_update(self, capsys: pytest.CaptureFixture[str]) -> None:
|
def test_update(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
bar = sb._ProgressBar()
|
bar = sb._ProgressBar()
|
||||||
@@ -269,7 +298,7 @@ class TestProgressBar:
|
|||||||
# With --link-dest rsync's percentage leaves out linked files, so the files are counted instead
|
# With --link-dest rsync's percentage leaves out linked files, so the files are counted instead
|
||||||
assert bar.update(' 4,000,000 1% 2.97MB/s 0:00:01 (xfr#2, to-chk=1/4)')
|
assert bar.update(' 4,000,000 1% 2.97MB/s 0:00:01 (xfr#2, to-chk=1/4)')
|
||||||
assert capsys.readouterr().err == \
|
assert capsys.readouterr().err == \
|
||||||
'\r[######################--------] 75% 3/4 files 4,000,000 copied ETA 0:00:10\033[K'
|
'\r[######################--------] 75% 3/4 files 4,000,000 copied 133.3KB/s ETA 0:00:10\033[K'
|
||||||
|
|
||||||
def test_keeps_counts_within_file(self, monkeypatch: pytest.MonkeyPatch,
|
def test_keeps_counts_within_file(self, monkeypatch: pytest.MonkeyPatch,
|
||||||
capsys: pytest.CaptureFixture[str]) -> None:
|
capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
@@ -278,7 +307,66 @@ class TestProgressBar:
|
|||||||
|
|
||||||
assert bar.update(' 2.00M 1% 1.47MB/s 0:00:02 (xfr#1, to-chk=2/4)')
|
assert bar.update(' 2.00M 1% 1.47MB/s 0:00:02 (xfr#1, to-chk=2/4)')
|
||||||
assert bar.update(' 3.00M 2% 1.47MB/s 0:00:03')
|
assert bar.update(' 3.00M 2% 1.47MB/s 0:00:03')
|
||||||
assert capsys.readouterr().err.endswith('] 50% 2/4 files 3.00M copied ETA 0:00:30\033[K')
|
assert capsys.readouterr().err.endswith('] 50% 2/4 files 3.00M copied 100.0KB/s ETA 0:00:30\033[K')
|
||||||
|
|
||||||
|
def test_eta_follows_recent_pace(self, monkeypatch: pytest.MonkeyPatch,
|
||||||
|
capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
|
monkeypatch.setattr(sb, 'default_timer', iter([0.0, 100.0, 130.0]).__next__)
|
||||||
|
bar = sb._ProgressBar()
|
||||||
|
|
||||||
|
# Fast while linking unchanged files, then one file in the last 30 s
|
||||||
|
assert bar.update(' 10.00M 1% 1.47MB/s 0:00:02 (xfr#1, to-chk=100/1000)')
|
||||||
|
assert capsys.readouterr().err.endswith(' 100.0KB/s ETA 0:00:11\033[K')
|
||||||
|
assert bar.update(' 70.00M 7% 1.47MB/s 0:00:02 (xfr#2, to-chk=99/1000)')
|
||||||
|
assert capsys.readouterr().err.endswith(' 2.0MB/s ETA 0:49:30\033[K')
|
||||||
|
|
||||||
|
def test_eta_unknown_within_big_file(self, monkeypatch: pytest.MonkeyPatch,
|
||||||
|
capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
|
monkeypatch.setattr(sb, 'default_timer', iter([0.0, 10.0, 50.0]).__next__)
|
||||||
|
bar = sb._ProgressBar()
|
||||||
|
|
||||||
|
assert bar.update(' 10.00M 1% 1.47MB/s 0:00:02 (xfr#1, to-chk=10/20)')
|
||||||
|
# No file finished in the last 30 s
|
||||||
|
assert bar.update(' 50.00M 5% 1.47MB/s 0:00:02')
|
||||||
|
assert capsys.readouterr().err.endswith(' 50.00M copied 1.0MB/s ETA --:--:--\033[K')
|
||||||
|
|
||||||
|
def test_estimate_while_scanning(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
|
bar = sb._ProgressBar(estimate=4000)
|
||||||
|
|
||||||
|
assert bar.update(' 2.00M 25% 1.47MB/s 0:00:02 (xfr#1, ir-chk=1000/2000)')
|
||||||
|
assert bar.total is None
|
||||||
|
assert capsys.readouterr().err == \
|
||||||
|
'\r[#######-----------------------] ~25% 1,000/~4,000 files 2.00M copied 66.7KB/s ETA ~0:01:30\033[K'
|
||||||
|
|
||||||
|
def test_estimate_exceeded(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
|
bar = sb._ProgressBar(estimate=1000)
|
||||||
|
|
||||||
|
# More files than in the last backup: estimate from the files found so far
|
||||||
|
assert bar.update(' 2.00M 25% 1.47MB/s 0:00:02 (xfr#1, ir-chk=500/2000)')
|
||||||
|
assert capsys.readouterr().err == \
|
||||||
|
'\r[######################--------] ~75% 1,500/~2,000 files 2.00M copied 66.7KB/s ETA ~0:00:10\033[K'
|
||||||
|
|
||||||
|
def test_estimate_capped_while_scanning(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
|
bar = sb._ProgressBar(estimate=1000)
|
||||||
|
|
||||||
|
# All files found so far are checked, but rsync may still find more
|
||||||
|
assert bar.update(' 2.00M 25% 1.47MB/s 0:00:02 (xfr#1, ir-chk=0/2000)')
|
||||||
|
assert bar.total is None
|
||||||
|
assert ' ~99% 2,000/~2,000 files 2.00M copied 66.7KB/s ETA ~0:00:00\033[K' in capsys.readouterr().err
|
||||||
|
|
||||||
|
def test_no_estimate_without_last_count(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
|
bar = sb._ProgressBar()
|
||||||
|
|
||||||
|
# The files found so far are only a guess at the total near the end of the scan
|
||||||
|
assert bar.update(' 2.00M 25% 1.47MB/s 0:00:02 (xfr#1, ir-chk=0/2000)')
|
||||||
|
assert capsys.readouterr().err == '\r2,000 files checked 2.00M copied 66.7KB/s (scanning)\033[K'
|
||||||
|
|
||||||
|
def test_real_total_replaces_estimate(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
|
bar = sb._ProgressBar(estimate=4000)
|
||||||
|
|
||||||
|
assert bar.update(' 4,000,000 1% 2.97MB/s 0:00:01 (xfr#2, to-chk=1/4)')
|
||||||
|
assert bar.total == 4
|
||||||
|
assert ' 75% 3/4 files' in capsys.readouterr().err
|
||||||
|
|
||||||
def test_not_progress(self, capsys: pytest.CaptureFixture[str]) -> None:
|
def test_not_progress(self, capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
bar = sb._ProgressBar()
|
bar = sb._ProgressBar()
|
||||||
|
|||||||
@@ -49,6 +49,29 @@ def test_overwrite(state: Path) -> None:
|
|||||||
assert state.read_text().splitlines()[1] == DESTINATION
|
assert state.read_text().splitlines()[1] == DESTINATION
|
||||||
|
|
||||||
|
|
||||||
|
def test_file_count(state: Path) -> None:
|
||||||
|
sb._write_state(None, DESTINATION, 1234)
|
||||||
|
|
||||||
|
assert state.read_text().splitlines()[2] == '1234'
|
||||||
|
assert sb._last_file_count(None) == 1234
|
||||||
|
|
||||||
|
|
||||||
|
def test_file_count_kept_when_unknown(state: Path) -> None:
|
||||||
|
write_state(state, '2026-10-01T10:00:00+02:00\n/old\n1234\n')
|
||||||
|
|
||||||
|
sb._write_state(None, DESTINATION)
|
||||||
|
|
||||||
|
assert state.read_text().splitlines()[1:] == [DESTINATION, '1234']
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize('text', [None, '2026-10-01T10:00:00+02:00\n/old\n', '2026-10-01T10:00:00+02:00\n/old\nx\n'])
|
||||||
|
def test_no_file_count(state: Path, text: str | None) -> None:
|
||||||
|
if text is not None:
|
||||||
|
write_state(state, text)
|
||||||
|
|
||||||
|
assert sb._last_file_count(None) == 0
|
||||||
|
|
||||||
|
|
||||||
def test_relative_xdg_state_home_ignored(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
|
def test_relative_xdg_state_home_ignored(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
|
||||||
monkeypatch.setenv('XDG_STATE_HOME', 'relative')
|
monkeypatch.setenv('XDG_STATE_HOME', 'relative')
|
||||||
monkeypatch.setenv('HOME', str(tmp_path / 'home'))
|
monkeypatch.setenv('HOME', str(tmp_path / 'home'))
|
||||||
|
|||||||
Reference in new issue
Block a user