Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
caea0bae3c |
No files matched your search
@@ -128,8 +128,8 @@ walk"). As the file `/etc/cron.d/sfdupes`:
|
|||||||
- one line naming the database;
|
- one line naming the database;
|
||||||
- progress lines, as described under "Progress";
|
- progress lines, as described under "Progress";
|
||||||
- a warning for each path it skips;
|
- a warning for each path it skips;
|
||||||
- a line for each system, temporary or cache directory the walk leaves out
|
- a line for each system or temporary directory the walk leaves out (see
|
||||||
(see "Rules for the walk");
|
"Rules for the walk");
|
||||||
- a line for each path left out because its filesystem is one the kernel,
|
- a line for each path left out because its filesystem is one the kernel,
|
||||||
the core of the operating system, makes up or keeps in memory, such as
|
the core of the operating system, makes up or keeps in memory, such as
|
||||||
`tmpfs`;
|
`tmpfs`;
|
||||||
@@ -254,14 +254,15 @@ In order:
|
|||||||
- `report` prints the file-level duplicate report from the database.
|
- `report` prints the file-level duplicate report from the database.
|
||||||
- `trees` prints the duplicate-tree report from the database.
|
- `trees` prints the duplicate-tree report from the database.
|
||||||
- `info` prints the database's details.
|
- `info` prints the database's details.
|
||||||
- `dwim` scans `/`, then prints the duplicate-tree report.
|
- `dwim` scans `/` with the default excludes, then prints the duplicate-tree
|
||||||
|
report.
|
||||||
|
|
||||||
```
|
```
|
||||||
sfdupes scan [--workers N] [-x] [--no-default-excludes] [--exclude PATH]... PATH...
|
sfdupes scan [--workers N] [-x] [--no-default-excludes] [--exclude PATH]... PATH...
|
||||||
sfdupes report > dupes.tsv
|
sfdupes report > dupes.tsv
|
||||||
sfdupes trees > dupetrees.tsv
|
sfdupes trees > dupetrees.tsv
|
||||||
sfdupes info
|
sfdupes info
|
||||||
sfdupes dwim [--workers N] [-x] [--no-default-excludes] [--exclude PATH]...
|
sfdupes dwim
|
||||||
sfdupes --version
|
sfdupes --version
|
||||||
sfdupes [command] --help
|
sfdupes [command] --help
|
||||||
```
|
```
|
||||||
@@ -291,21 +292,20 @@ The reference below is also the program's specification.
|
|||||||
database is `/var/lib/sfdupes/db.sqlite`. There is no command-line flag for
|
database is `/var/lib/sfdupes/db.sqlite`. There is no command-line flag for
|
||||||
it. The path names the file exactly, whatever characters it holds. A relative
|
it. The path names the file exactly, whatever characters it holds. A relative
|
||||||
path is relative to the working directory.
|
path is relative to the working directory.
|
||||||
- `--workers N` (`scan`, `dwim`) sets how many directories `scan` reads at once
|
- `--workers N` (`scan`) sets how many directories `scan` reads at once while it
|
||||||
while it lists the trees. It also sets how many files `scan` reads at once
|
lists the trees. It also sets how many files `scan` reads at once while it
|
||||||
while it hashes them. The default is the number of CPUs. `N` must be at
|
hashes them. The default is the number of CPUs. `N` must be at least 1. A
|
||||||
least 1. A smaller value is a usage error, reported in one line on stderr with
|
smaller value is a usage error, reported in one line on stderr with exit 2
|
||||||
exit 2 before anything is scanned.
|
before anything is scanned.
|
||||||
- `-x`, `--one-file-system` (`scan`, `dwim`) keeps the walk of each operand out
|
- `-x`, `--one-file-system` (`scan`) keeps the walk of each operand out of
|
||||||
of directories on other filesystems, as the same flag does for `du` and
|
directories on other filesystems, as the same flag does for `du` and `rsync`.
|
||||||
`rsync`. By default the walk also enters directories on other filesystems.
|
By default the walk also enters directories on other filesystems.
|
||||||
- `--no-default-excludes` (`scan`, `dwim`) lets the walk enter the default
|
- `--no-default-excludes` (`scan`) lets the walk enter the default excludes.
|
||||||
excludes. Those are the system, temporary and cache directories the walk
|
Those are the system and temporary directories the walk otherwise leaves out,
|
||||||
otherwise leaves out, such as `/var/tmp` and `/var/cache` on Linux (see "Rules
|
such as `/var/tmp` on Linux (see "Rules for the walk").
|
||||||
for the walk").
|
- `--exclude PATH` (`scan`) keeps the walk out of `PATH` and everything below
|
||||||
- `--exclude PATH` (`scan`, `dwim`) keeps the walk out of `PATH` and everything
|
it. `PATH` may be a directory or a file. The flag may be given more than once.
|
||||||
below it. `PATH` may be a directory or a file. The flag may be given more than
|
The walk knows `PATH` by its device ID and inode number, as it knows the
|
||||||
once. The walk knows `PATH` by its device ID and inode number, as it knows the
|
|
||||||
database files (see "Rules for the walk"). So the walk leaves `PATH` out
|
database files (see "Rules for the walk"). So the walk leaves `PATH` out
|
||||||
whatever path leads to it. That includes a hard link to a file given as
|
whatever path leads to it. That includes a hard link to a file given as
|
||||||
`PATH`. A symlink given as `PATH` excludes its target. An empty `PATH`, as in
|
`PATH`. A symlink given as `PATH` excludes its target. An empty `PATH`, as in
|
||||||
@@ -318,9 +318,9 @@ The reference below is also the program's specification.
|
|||||||
- `--help`, `-h`, alone or after a subcommand, prints the help text to stderr
|
- `--help`, `-h`, alone or after a subcommand, prints the help text to stderr
|
||||||
and exits 0. It writes nothing to stdout. The help of `sfdupes` and of `scan`
|
and exits 0. It writes nothing to stdout. The help of `sfdupes` and of `scan`
|
||||||
names the database. The help of `report`, `trees`, `info` and `dwim` says what
|
names the database. The help of `report`, `trees`, `info` and `dwim` says what
|
||||||
each prints. `sfdupes scan --help` and `sfdupes dwim --help` also list the
|
each prints. `sfdupes scan --help` also lists the default excludes of the
|
||||||
default excludes of the system they run on, and the filesystem types the walk
|
system it runs on, and the filesystem types the walk never records anything
|
||||||
never records anything on.
|
on.
|
||||||
|
|
||||||
### Duplicate detection
|
### Duplicate detection
|
||||||
|
|
||||||
@@ -572,17 +572,12 @@ walk practical on large or busy storage pools.
|
|||||||
`--no-default-excludes` does not change this rule.
|
`--no-default-excludes` does not change this rule.
|
||||||
|
|
||||||
- Below an operand, the walk does not enter a default exclude. On Linux, the
|
- Below an operand, the walk does not enter a default exclude. On Linux, the
|
||||||
default excludes hold the kernel's view of the running system, temporary
|
default excludes hold temporary files and the kernel's view of the running
|
||||||
files, and caches. A cache here is data that programs and package managers
|
system. They depend on the system, and `sfdupes scan --help` lists those of
|
||||||
download or build again on their own. The default excludes depend on the
|
the system it runs on. On Linux they are:
|
||||||
system, and `sfdupes scan --help` lists those of the system it runs on. In the
|
|
||||||
lists, `*` stands for any one directory name, so `/home/*/.cache` matches
|
|
||||||
`/home/alice/.cache`. On Linux they are:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
/proc, /sys, /dev, /run, /tmp, /var/tmp, /var/cache
|
/proc, /sys, /dev, /run, /tmp, /var/tmp
|
||||||
/root/.cache, /root/.npm, /root/.cargo/registry, /root/go/pkg/mod
|
|
||||||
/home/*/.cache, /home/*/.npm, /home/*/.cargo/registry, /home/*/go/pkg/mod
|
|
||||||
```
|
```
|
||||||
|
|
||||||
On macOS they are:
|
On macOS they are:
|
||||||
@@ -590,21 +585,13 @@ walk practical on large or busy storage pools.
|
|||||||
```
|
```
|
||||||
/dev, /private/tmp, /private/var/tmp, /private/var/vm
|
/dev, /private/tmp, /private/var/tmp, /private/var/vm
|
||||||
/System/Volumes/VM, /System/Volumes/Data
|
/System/Volumes/VM, /System/Volumes/Data
|
||||||
/private/var/folders, /Library/Caches
|
|
||||||
/private/var/root/Library/Caches, /private/var/root/.cache
|
|
||||||
/private/var/root/.npm, /private/var/root/.cargo/registry
|
|
||||||
/private/var/root/go/pkg/mod
|
|
||||||
/Users/*/Library/Caches, /Users/*/.cache, /Users/*/.npm
|
|
||||||
/Users/*/.cargo/registry, /Users/*/go/pkg/mod
|
|
||||||
```
|
```
|
||||||
|
|
||||||
`/private/var/folders` holds each user's temporary files and caches on
|
A walk of `/` on macOS reaches everything in `/System/Volumes/Data` already,
|
||||||
macOS. Root's home on macOS is `/var/root`, which the walk reaches as
|
through firmlinks. Firmlinks are the links macOS uses to show the data
|
||||||
`/private/var/root`. A walk of `/` on macOS reaches everything in
|
volume inside the system volume. Walking `/System/Volumes/Data` as well
|
||||||
`/System/Volumes/Data` already, through firmlinks. Firmlinks are the links
|
would record each of those files twice. Any other system has no default
|
||||||
macOS uses to show the data volume inside the system volume. Walking
|
excludes.
|
||||||
`/System/Volumes/Data` as well would record each of those files twice. Any
|
|
||||||
other system has no default excludes.
|
|
||||||
|
|
||||||
An operand at or inside a default exclude is walked, so
|
An operand at or inside a default exclude is walked, so
|
||||||
`sfdupes scan /tmp/x` works when `/tmp/x` is on a persistent filesystem.
|
`sfdupes scan /tmp/x` works when `/tmp/x` is on a persistent filesystem.
|
||||||
@@ -862,7 +849,8 @@ The summary line on stderr gives:
|
|||||||
- the records read;
|
- the records read;
|
||||||
- the duplicate-tree groups;
|
- the duplicate-tree groups;
|
||||||
- the dupe trees, which is the number of rows;
|
- the dupe trees, which is the number of rows;
|
||||||
- the reclaimable bytes, the sum of `size` over all rows.
|
- the reclaimable bytes, the sum of `size` over all rows, leaving out a row
|
||||||
|
whose `dupe` lies inside another row's `dupe`.
|
||||||
|
|
||||||
```
|
```
|
||||||
trees: 14 records read, 1 duplicate tree groups, 1 dupe trees, 3.0 KiB reclaimable
|
trees: 14 records read, 1 duplicate tree groups, 1 dupe trees, 3.0 KiB reclaimable
|
||||||
@@ -871,25 +859,14 @@ trees: 14 records read, 1 duplicate tree groups, 1 dupe trees, 3.0 KiB reclaimab
|
|||||||
### `dwim` mode
|
### `dwim` mode
|
||||||
|
|
||||||
`dwim`, short for "do what I mean", scans a new machine and reports its
|
`dwim`, short for "do what I mean", scans a new machine and reports its
|
||||||
duplicate trees in one command. It takes no positional arguments. Like `scan`,
|
duplicate trees in one command. It takes no positional arguments and no flags of
|
||||||
it should run as root, so that it can read every file.
|
its own. Like `scan`, it should run as root, so that it can read every file.
|
||||||
|
|
||||||
`dwim` takes these flags of `scan`, with the same meaning (see "Settings"):
|
`dwim` runs what `sfdupes scan /` runs with no flags. The walk skips the default
|
||||||
|
excludes and crosses into other filesystems. `--workers` keeps its default. The
|
||||||
- `--workers N`;
|
|
||||||
- `-x`, `--one-file-system`;
|
|
||||||
- `--no-default-excludes`;
|
|
||||||
- `--exclude PATH`, which may be given more than once.
|
|
||||||
|
|
||||||
`dwim` runs what `sfdupes scan /` runs with the same flags. With no flags, the
|
|
||||||
walk skips the default excludes and crosses into other filesystems. The
|
|
||||||
database, its creation and the scan lock are those of `scan`. Then `dwim` runs
|
database, its creation and the scan lock are those of `scan`. Then `dwim` runs
|
||||||
what `sfdupes trees` runs. The largest trees come first.
|
what `sfdupes trees` runs. The largest trees come first.
|
||||||
|
|
||||||
```
|
|
||||||
sfdupes dwim -x --exclude /srv/cache
|
|
||||||
```
|
|
||||||
|
|
||||||
The report goes to stdout, exactly as `trees` prints it. On stderr comes what
|
The report goes to stdout, exactly as `trees` prints it. On stderr comes what
|
||||||
`scan` prints, then what `trees` prints, then one last line:
|
`scan` prints, then what `trees` prints, then one last line:
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
the tracker yet is filed as an issue first.
|
the tracker yet is filed as an issue first.
|
||||||
- Branch from `next`.
|
- Branch from `next`.
|
||||||
- Do the work, with tests, in small focused commits.
|
- Do the work, with tests, in small focused commits.
|
||||||
- Delete Next Step from `TODO.md`, in the same commit as the work.
|
- Record the step at the top of Completed Steps, in the same commit as the work.
|
||||||
- Push the branch and open a PR against `next`. Its title ends with
|
- Push the branch and open a PR against `next`. Its title ends with
|
||||||
` (closes #N)`.
|
` (closes #N)`.
|
||||||
- An independent review gates each merge to `next`. Every finding is addressed
|
- An independent review gates each merge to `next`. Every finding is addressed
|
||||||
@@ -15,7 +15,8 @@
|
|||||||
|
|
||||||
- Pre-1.0.
|
- Pre-1.0.
|
||||||
- The tracker is authoritative for the pre-1.0 backlog. The open issues under
|
- The tracker is authoritative for the pre-1.0 backlog. The open issues under
|
||||||
the `1.0.0` milestone are what remains before the tag.
|
the `1.0.0` milestone are what remains before the tag. This file records
|
||||||
|
history and process, not the queue.
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
@@ -23,6 +24,771 @@
|
|||||||
https://git.eeqj.de/sneak/sfdupes/milestone/17. The issues are not restated
|
https://git.eeqj.de/sneak/sfdupes/milestone/17. The issues are not restated
|
||||||
here, because a copy drifts as soon as the tracker moves.
|
here, because a copy drifts as soon as the tracker moves.
|
||||||
|
|
||||||
|
# Completed Steps
|
||||||
|
|
||||||
|
Newest first. An entry ends with its date and its issue or branch, where those
|
||||||
|
are known.
|
||||||
|
|
||||||
|
- The reclaimable total of `trees` is the sum of `size` over all rows, leaving
|
||||||
|
out a row whose `dupe` lies inside another row's `dupe`. Before, the bytes of
|
||||||
|
such a row were counted twice (2026-11-11,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/168)
|
||||||
|
- The help of `sfdupes` and of `scan` names the database, its default path and
|
||||||
|
`SFDUPES_DATABASE`. The help of `report` and `trees` lists the columns, the
|
||||||
|
order of the rows and the escapes. The help of `info` lists its lines. The
|
||||||
|
help of `dwim` says that it scans `/`, should run as root and keeps the scan
|
||||||
|
in the database (2026-11-11, https://git.eeqj.de/sneak/sfdupes/issues/177)
|
||||||
|
- New `scan` flag `--exclude PATH`, which may be repeated. The walk neither
|
||||||
|
enters nor records an excluded path, and keeps the records below it. An
|
||||||
|
operand at or below one is a fatal error (2026-11-11,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/163)
|
||||||
|
|
||||||
|
- `report` and `trees` leave out a copy that was deleted after the scan. Each
|
||||||
|
checks only the copy itself with `lstat`: the file, or the directory at the
|
||||||
|
top of a tree. A group left with one copy is not reported. A missing `scan`
|
||||||
|
operand is still a fatal error (2026-11-11,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/173)
|
||||||
|
- The usage line of `scan` no longer ends in `[flags]`. It is the line
|
||||||
|
`README.md` shows under "Subcommands" (2026-11-11,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/169)
|
||||||
|
- `report` and `trees` leave out empty files. `report` writes no group of size
|
||||||
|
0, and `trees` writes no group whose trees hold 0 bytes. An empty file still
|
||||||
|
counts toward a tree's digest (2026-11-11,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/178)
|
||||||
|
- The Go code moved out of the repository root. `cmd/sfdupes/main.go` is the
|
||||||
|
command, and it calls `Main` in the package `internal/sfdupes`. `main.go`
|
||||||
|
became `internal/sfdupes/cli.go`. Every other file kept its name. The install
|
||||||
|
path is now `sneak.berlin/go/sfdupes/cmd/sfdupes` (2026-11-10,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/157)
|
||||||
|
|
||||||
|
- New subcommand `dwim`. It runs what `sfdupes scan /` runs with no flags, then
|
||||||
|
what `sfdupes trees` runs. Its last line on stderr says that `sfdupes trees`
|
||||||
|
prints the report again (2026-11-06,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/154)
|
||||||
|
|
||||||
|
- `scan` resolves each operand to its real path, symlinks followed, before the
|
||||||
|
walk. A symlink operand is scanned at its target instead of skipped. With
|
||||||
|
`/srv/link` a symlink to a directory outside `/srv`, `scan /srv /srv/link/sub`
|
||||||
|
walks `sub` on its own instead of dropping it and deleting its records
|
||||||
|
(2026-11-06, https://git.eeqj.de/sneak/sfdupes/issues/144)
|
||||||
|
|
||||||
|
- `README.md` and a comment in `internal/sfdupes/scan.go` no longer say ZFS
|
||||||
|
counts a new file's blocks only seconds after the write. The count can land in
|
||||||
|
under a second. Both now say up to seconds after the write, as the comment on
|
||||||
|
`diskSizeOf` in `internal/sfdupes/scan_test.go` does (2026-11-03,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/152)
|
||||||
|
|
||||||
|
- The three disk size tests in `internal/sfdupes/scan_test.go` no longer fail at
|
||||||
|
random on ZFS. `unix.Sync` can return before ZFS has counted a file's blocks,
|
||||||
|
and one ZFS commit can take a file through several sizes. The test that needs
|
||||||
|
the size to change waits for it, for at most 30 seconds. Each test reads the
|
||||||
|
size before and after its scan. The rewrite test rescans until the two reads
|
||||||
|
match, then compares exactly. The other two fail only on a `disk_size` outside
|
||||||
|
the two reads (2026-11-02, https://git.eeqj.de/sneak/sfdupes/issues/150)
|
||||||
|
|
||||||
|
- `TODO.md` rewritten from scratch by the same rules as `README.md`, sentence by
|
||||||
|
sentence. Every completed step is kept, with its date and its issue or branch.
|
||||||
|
The policy-compliance checklist of 2026-07-22 is folded into its step
|
||||||
|
(2026-11-02, https://git.eeqj.de/sneak/sfdupes/issues/135)
|
||||||
|
|
||||||
|
- `README.md` rewritten from scratch, sentence by sentence, as a newcomer reads
|
||||||
|
it. It leads with what the program is and how to use it. A reference section
|
||||||
|
covers every setting and every subcommand. Development and testing come last.
|
||||||
|
Every statement was checked against the code on `next`. Five comments in
|
||||||
|
`internal/sfdupes/cli_test.go` cite "Settings", where their rules now live.
|
||||||
|
One comment each in these files cites what the README now says:
|
||||||
|
- `internal/sfdupes/scan_test.go`;
|
||||||
|
- `internal/sfdupes/trees_test.go`;
|
||||||
|
- `internal/sfdupes/exclude_test.go`.
|
||||||
|
|
||||||
|
(2026-11-02, https://git.eeqj.de/sneak/sfdupes/issues/135)
|
||||||
|
|
||||||
|
- Each record holds `disk_size`, the bytes the file takes on disk. That is its
|
||||||
|
allocated blocks, `st_blocks` × 512, from the `lstat` call the walk already
|
||||||
|
makes. `trees` prints a `disk_size` column after `size`. It is the sum over
|
||||||
|
the `dupe` copy's files. On a compressed or sparse file `disk_size` differs
|
||||||
|
from `size`. A rescan updates the `disk_size` of an unchanged file whose size
|
||||||
|
on disk changed, without reading the file (2026-10-27,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/147)
|
||||||
|
|
||||||
|
- The database keeps the number of records and the sum of their sizes in the one
|
||||||
|
row of a `totals` table. Three triggers on `files` keep that row current.
|
||||||
|
`info` reads that row. So do `scan`'s `load` phase and the `read` phases of
|
||||||
|
`report` and `trees`, for their totals. No count reads every record any more.
|
||||||
|
The triggers make each write to `files` slower. `scan` keeps SQLite's
|
||||||
|
temporary data in memory. That wins back part of that time (2026-10-27,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/146)
|
||||||
|
|
||||||
|
- an operand at or inside a directory named `.zfs` is never scanned, whether
|
||||||
|
given alone or under another operand. `scan` warns about it, counts it as
|
||||||
|
skipped and does not walk it (2026-10-26,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/142)
|
||||||
|
|
||||||
|
- A file or directory removed while the scan runs is not an error, in the walk
|
||||||
|
or in the hash phase. The scan prints no line for it and does not count it as
|
||||||
|
skipped. When the first of several hard links to a file is gone, the hash
|
||||||
|
phase reads the next one instead. On a terminal every progress display starts
|
||||||
|
with the spinner, the hash phase's included. A phase with an exact total ends
|
||||||
|
its line with its percent and a 10-column bar at the terminal's right edge.
|
||||||
|
The bar no longer moves as the line's length changes. A line too wide for the
|
||||||
|
terminal now loses its rate before its bar. The time remaining is labelled
|
||||||
|
`remain`, not `eta` (2026-10-26, https://git.eeqj.de/sneak/sfdupes/issues/133)
|
||||||
|
|
||||||
|
- The `head`, `tail` and `content` columns are BLOBs, each holding the raw 32
|
||||||
|
bytes of a SHA-256. That is half the size of the hex text they held. The
|
||||||
|
hashes stay raw from the hash phase through the database to `report` and
|
||||||
|
`trees`. Reading a record whose hash is not 32 bytes is an error (2026-10-26,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/134)
|
||||||
|
|
||||||
|
- The hash phase gives three hashes to every file that the walk records. `head`
|
||||||
|
and `tail` are the SHA-256 of its first and last 64 KiB. `content` is the
|
||||||
|
SHA-256 of the whole file under 100 MiB, and of 1 MiB at each gigabyte from
|
||||||
|
100 MiB up. Gone are:
|
||||||
|
- the 10 MiB and 50 MiB thresholds;
|
||||||
|
- the size census, which counted the sizes of every walked file and of every
|
||||||
|
record outside the operands. A file was hashed only when the census showed
|
||||||
|
another file of its size;
|
||||||
|
- the records without hashes;
|
||||||
|
- the content phase.
|
||||||
|
|
||||||
|
A scan has four phases, and a rescan reads only new and changed files.
|
||||||
|
`info` no longer counts the records with `head` and `tail` hashes, nor those
|
||||||
|
with a content hash, since every record has all three (2026-10-25,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/132)
|
||||||
|
|
||||||
|
- `REPO_POLICIES.md` and the four scripts that pass `CACHEBUST` were copied
|
||||||
|
again from `sneak/prompts` `next` at `0653579`. Two steps now come before
|
||||||
|
`ARG CACHEBUST`:
|
||||||
|
- the module download in the `lint`, `test` and `builder` stages of the
|
||||||
|
`Dockerfile`;
|
||||||
|
- the package install in `builder`.
|
||||||
|
|
||||||
|
Docker keeps them until one of these changes:
|
||||||
|
- the base image;
|
||||||
|
- the install line;
|
||||||
|
- `go.mod` or `go.sum`.
|
||||||
|
|
||||||
|
Every step that checks or compiles the code still comes after
|
||||||
|
`ARG CACHEBUST`. `golangci-lint run` also keeps the linter's own cache.
|
||||||
|
README says the same (2026-10-18,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/109)
|
||||||
|
|
||||||
|
- The release rule was set. Until 1.0, each tip of `main` that passes the build
|
||||||
|
gets the next `v0.0.N` tag.
|
||||||
|
`go install sneak.berlin/go/sfdupes/cmd/sfdupes@latest` then installs it.
|
||||||
|
`go.mod` retracts `v0.0.1`, the early build without a database. When the
|
||||||
|
linker set no version, `sfdupes --version` prints the version Go recorded in
|
||||||
|
the binary. That is the tag, or the pseudo-version of a `go install` build. It
|
||||||
|
prints `dev` only when neither is known. README "Install" documented:
|
||||||
|
- the rule;
|
||||||
|
- what `@main` and `v0.0.1` give;
|
||||||
|
- how to check an installed binary.
|
||||||
|
|
||||||
|
(2026-10-17, https://git.eeqj.de/sneak/sfdupes/issues/116)
|
||||||
|
|
||||||
|
- `scan` creates the database's directory where the database path leads. The
|
||||||
|
directory is the path with its last element cut off as text, so a `..` in it
|
||||||
|
stays. A `..` after a symlinked directory therefore goes through the symlink,
|
||||||
|
as it does when the file is opened. With
|
||||||
|
`SFDUPES_DATABASE=/srv/link/../new/db.sqlite` and `/srv/link` a symlink to
|
||||||
|
`/data/x`, it now creates `/data/new` and the database in it. It used to
|
||||||
|
create `/srv/new` and then fail (2026-10-17,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/119)
|
||||||
|
|
||||||
|
- `scan` never records its own database. Once the database and its `.lock` file
|
||||||
|
are open, it notes the device and inode of each of these:
|
||||||
|
- the database file;
|
||||||
|
- its `-wal` and `-shm` files;
|
||||||
|
- the `.lock` file.
|
||||||
|
|
||||||
|
The walk passes over any file with the device and inode of one of them,
|
||||||
|
however it reaches the file. It prints no line for such a file and counts
|
||||||
|
nothing. A record an earlier scan left for one of them is deleted
|
||||||
|
(2026-10-17, https://git.eeqj.de/sneak/sfdupes/issues/115)
|
||||||
|
|
||||||
|
- `scan` never records or reads anything on a filesystem that is not persistent,
|
||||||
|
such as `tmpfs` or `proc`. Such a filesystem is one the kernel makes up or
|
||||||
|
keeps in memory. `scan` matches them by device ID, however the walk or the
|
||||||
|
content phase reaches a path. As the scan starts, it lists the mounted
|
||||||
|
filesystems of those types, from `/proc/self/mountinfo` on Linux and from the
|
||||||
|
mount list on macOS. No flag turns that off. Below an operand, the walk does
|
||||||
|
not enter the default excludes either. So `sfdupes scan /` skips the kernel's
|
||||||
|
view of the running system and the temporary directories. On Linux those are:
|
||||||
|
|
||||||
|
```
|
||||||
|
/proc, /sys, /dev, /run, /tmp, /var/tmp
|
||||||
|
```
|
||||||
|
|
||||||
|
On macOS they are:
|
||||||
|
|
||||||
|
```
|
||||||
|
/dev, /private/tmp, /private/var/tmp, /private/var/vm
|
||||||
|
/System/Volumes/VM, /System/Volumes/Data
|
||||||
|
```
|
||||||
|
|
||||||
|
A Windows list exists in the code but is not used. An operand at or inside a
|
||||||
|
default exclude is still walked. The scan prints a line for each path it
|
||||||
|
leaves out, without counting it as skipped. The records there count as
|
||||||
|
outside the scanned operands, as for `-x`. `--no-default-excludes` turns off
|
||||||
|
the default excludes only, and `scan --help` lists them (2026-10-17,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/124)
|
||||||
|
|
||||||
|
- A progress display's rate covers the items completed over the last 5 seconds.
|
||||||
|
When stderr is not a terminal, it covers the items since the line before. It
|
||||||
|
falls to 0 while nothing completes. A burst after a wait no longer reads as a
|
||||||
|
steady rate of over 1,000 files a second. The time remaining still comes from
|
||||||
|
the phase's average. Once no item has completed for 10 seconds, the line shows
|
||||||
|
`stalled` and where the phase waits in place of the rate, as
|
||||||
|
`stalled disk/db`. The places are:
|
||||||
|
- `disk`;
|
||||||
|
- `db`;
|
||||||
|
- `out`, for stdout;
|
||||||
|
- `cpu`.
|
||||||
|
|
||||||
|
A phase that may wait in two places names both. Each phase's word is set in
|
||||||
|
the code that defines the phase. A line too wide for the terminal loses its
|
||||||
|
bar first, then its rate or those words. Four parts stay whole:
|
||||||
|
- the phase;
|
||||||
|
- the progress;
|
||||||
|
- the elapsed time;
|
||||||
|
- the ETA, the time remaining.
|
||||||
|
|
||||||
|
The content phase had one display for its checks and one for its reads. Both
|
||||||
|
lost those words on an 80-column terminal, at counts like those of README's
|
||||||
|
example. That happened for most elapsed times and ETAs in minutes. Every
|
||||||
|
other phase kept them whenever the elapsed time and the ETA were both in
|
||||||
|
minutes. The content phase writes its last partial batch, the records not
|
||||||
|
yet written, under a display of its own (2026-10-16,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/125)
|
||||||
|
|
||||||
|
- New subcommand `info` prints the database's details on stdout, one per line as
|
||||||
|
a name, a tab and the value:
|
||||||
|
- the path and where it came from;
|
||||||
|
- the sizes of the database file and of its `-wal` file, when there is one;
|
||||||
|
- when the database file was last changed;
|
||||||
|
- the schema version;
|
||||||
|
- the number of records;
|
||||||
|
- how many records have `head` and `tail` hashes;
|
||||||
|
- how many records have a content hash;
|
||||||
|
- the sizes of all records added up.
|
||||||
|
|
||||||
|
It opens the database as `report` does and shows two phases on stderr,
|
||||||
|
`[1/2] open` and `[2/2] count`. The schema version and the counts come from
|
||||||
|
one read-only transaction, a read of the database at one moment. The counts
|
||||||
|
come from one query (2026-10-16,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/117)
|
||||||
|
|
||||||
|
- `report` shows its work on stderr in two phases, `[1/2] open` and
|
||||||
|
`[2/2] read`, with the progress display `scan` and `trees` use. The display
|
||||||
|
runs from the moment `report` starts until the summary line. `open` says it is
|
||||||
|
opening the database, also while it waits on a busy one. `read` counts the
|
||||||
|
records, then reads them against that count in signature order. SQLite takes
|
||||||
|
that order from the `files_signature` index without sorting, so the first
|
||||||
|
record comes at once. `report` forms the duplicate groups itself and holds
|
||||||
|
only those of the size it is reading. It writes them ordered by first path
|
||||||
|
before it reads the next size. stdout and the summary line are unchanged, and
|
||||||
|
SQLite no longer needs a temporary file to sort in (2026-10-16,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/114)
|
||||||
|
|
||||||
|
- `trees` shows its work on stderr in four phases, from `[1/4] open` to
|
||||||
|
`[4/4] write`, each with the progress display `scan` uses. The display runs
|
||||||
|
from the moment `trees` starts until the summary line. `open` says it is
|
||||||
|
opening the database, also while it waits on a busy one. `read` counts the
|
||||||
|
records, then reads them against that count. `group` counts the directories it
|
||||||
|
groups, and `write` the groups it writes. A display's rate names what its
|
||||||
|
phase counts:
|
||||||
|
- files;
|
||||||
|
- records;
|
||||||
|
- directories;
|
||||||
|
- groups.
|
||||||
|
|
||||||
|
stdout and the summary line are unchanged. When stdout and stderr are the
|
||||||
|
same file, as one terminal is, no line of stdout shares a line with the
|
||||||
|
display. When they are not, the display keeps being drawn while stdout waits
|
||||||
|
on a slow reader (2026-10-16, https://git.eeqj.de/sneak/sfdupes/issues/113)
|
||||||
|
|
||||||
|
- Each `scan` phase's progress display names the phase and its place among the
|
||||||
|
five, as `[2/5] walk`. It runs from the moment that the phase starts. It
|
||||||
|
shows:
|
||||||
|
- the progress;
|
||||||
|
- the elapsed time;
|
||||||
|
- the ETA, the time remaining.
|
||||||
|
|
||||||
|
`load` counts the records first. The walk's total is estimated from the
|
||||||
|
records under the operands. The content phase takes its total from SQLite's
|
||||||
|
grouping alone. Until the first record is returned, it says it is searching
|
||||||
|
the database. On a terminal a phase with an exact total draws its line
|
||||||
|
followed by the bar of the progress-bar library. Any other phase draws a
|
||||||
|
spinner followed by the line. Every display is drawn again several times a
|
||||||
|
second. No line reaches the terminal's last column, however narrow the
|
||||||
|
terminal is, even after it is made narrower during a phase. A line too wide
|
||||||
|
leaves out its rate, then its bar. The rest stays whole. The line is cut
|
||||||
|
short only when the rest alone does not fit, as below about 70 columns late
|
||||||
|
in a large scan. When stderr is not a terminal, the line is printed every 5
|
||||||
|
seconds whether or not an item completed (2026-10-16,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/112)
|
||||||
|
|
||||||
|
- `scan`, `report` and `trees` first print a line on stderr naming the database
|
||||||
|
they use, as an absolute path. The line says whether that path is the default
|
||||||
|
or comes from `SFDUPES_DATABASE`. `scan` says when the database is new. README
|
||||||
|
"Database" says when `scan` writes each file (2026-10-16,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/111)
|
||||||
|
|
||||||
|
- The canonical files and model scripts were copied again from `sneak/prompts`
|
||||||
|
`next` at `e3f79c4`:
|
||||||
|
- `golangci-lint` v2.14.0;
|
||||||
|
- lint and test are phases of the `Dockerfile` that write no image, and
|
||||||
|
`make test` runs the suite under the race detector. Gone are
|
||||||
|
`Dockerfile.lint`, `script/verify-lint-image-pin` and `make test-race`;
|
||||||
|
- every `docker build` in `script/` passes a new `CACHEBUST` value. Every
|
||||||
|
stage of the `Dockerfile` declares it first, so every `RUN` step runs on
|
||||||
|
every build. The steps that compile keep Go's build cache, and the tests
|
||||||
|
run with `-count=1`;
|
||||||
|
- `prettier` runs on the host, from the `node` and `yarn` that
|
||||||
|
`script/bootstrap` installs. The `prettier` and `markdown` stages are
|
||||||
|
gone, and the build stage installs `git` and `make` itself;
|
||||||
|
- a new push cancels the workflow's older run on the same branch, and a run
|
||||||
|
stops after 20 minutes;
|
||||||
|
- a coding agent's settings file is deleted.
|
||||||
|
|
||||||
|
Since https://git.eeqj.de/sneak/sfdupes/issues/109 two steps come before
|
||||||
|
`ARG CACHEBUST`:
|
||||||
|
- the module download in `lint`, `test` and the build stage;
|
||||||
|
- the install of `git` and `make` in the build stage.
|
||||||
|
|
||||||
|
Docker keeps them between builds. Every step that checks or compiles the
|
||||||
|
code still runs on every build (2026-10-15,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/95)
|
||||||
|
|
||||||
|
- With `-x`, an operand under another operand is no longer dropped when a
|
||||||
|
directory between the two, the inner one included, is on a different
|
||||||
|
filesystem than the outer one. The inner operand is then walked on its own.
|
||||||
|
For a regular-file operand the check starts at its directory. The records of
|
||||||
|
files gone from below it are deleted (2026-10-14,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/106)
|
||||||
|
|
||||||
|
- With `-x`, `scan` keeps the records below a directory on another filesystem
|
||||||
|
under its operand, instead of deleting them. It counts their sizes in the size
|
||||||
|
census (2026-10-14, https://git.eeqj.de/sneak/sfdupes/issues/99)
|
||||||
|
|
||||||
|
- The hash and content phases open each file without blocking and check that it
|
||||||
|
is still a regular file. A file that is now a FIFO or device node is warned
|
||||||
|
about and skipped instead of hanging the scan (2026-10-14,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/100)
|
||||||
|
|
||||||
|
- The scan lock file is named from the database's path with symlinks resolved,
|
||||||
|
after `scan` creates the database file if it is missing. A scan through a
|
||||||
|
symlink to the database therefore fails while another scan holds the lock
|
||||||
|
(2026-10-14, https://git.eeqj.de/sneak/sfdupes/issues/101)
|
||||||
|
|
||||||
|
- On a terminal, a warning for the last file of a phase no longer erases the
|
||||||
|
phase's finished bar. The bar is drawn again below the warning (2026-10-14,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/102)
|
||||||
|
|
||||||
|
- `scan` records the mtime to the nanosecond, as whole seconds in `mtime` plus
|
||||||
|
`mtime_nsec`, and compares it at that resolution. A same-size rewrite within
|
||||||
|
the same second is hashed again (2026-10-07,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/12)
|
||||||
|
|
||||||
|
- The narration was cut from `TODO.md` Completed Steps and from the comments in
|
||||||
|
`script/`, `Dockerfile` and `Dockerfile.lint` (gone since
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/95). The Workflow section now
|
||||||
|
branches from and merges to `next` (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/49)
|
||||||
|
|
||||||
|
- `make test-race` ran the test suite under the race detector in a cgo-enabled
|
||||||
|
container, outside `make check`. Since
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/95 `make test` itself runs the suite
|
||||||
|
under the race detector, in the `Dockerfile`'s Debian-based `test` phase.
|
||||||
|
`make test-race` is gone (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/18)
|
||||||
|
|
||||||
|
- A bare `docker build .` failed, naming `script/cibuild` and `script/docker`,
|
||||||
|
rather than serve the gates, the lint and test steps, from cache. Since
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/95 a bare build succeeds, as
|
||||||
|
`REPO_POLICIES.md` requires, and may serve the gates from cache. The builds in
|
||||||
|
`script/` pass a new `CACHEBUST` value, so theirs always run (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/39)
|
||||||
|
|
||||||
|
- `make fmt` and `make fmt-check` run `prettier` over all Markdown, and the
|
||||||
|
Gitea workflow checks it. All Markdown was reformatted (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/19)
|
||||||
|
|
||||||
|
- `script/lint` writes no image, so a run no longer leaves an untagged one
|
||||||
|
behind (2026-10-04, https://git.eeqj.de/sneak/sfdupes/issues/48)
|
||||||
|
|
||||||
|
- Tests cover:
|
||||||
|
- a missing database;
|
||||||
|
- `scan` keeping stdout empty;
|
||||||
|
- its skip warning;
|
||||||
|
- the `report` and `trees` summary lines;
|
||||||
|
- every subcommand going through `runE`.
|
||||||
|
|
||||||
|
(2026-10-04, https://git.eeqj.de/sneak/sfdupes/issues/16)
|
||||||
|
|
||||||
|
- `.golangci.yml` was replaced with the current canonical copy, which uses
|
||||||
|
`gomodguard_v2`, so lint no longer prints a deprecation warning (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/26)
|
||||||
|
|
||||||
|
- A test fails when either `hashWorker` cancellation check in
|
||||||
|
`internal/sfdupes/scan.go` is removed (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/83)
|
||||||
|
|
||||||
|
- A database path holding `?`, `#` or `%` opens exactly the file it names
|
||||||
|
(2026-10-04, https://git.eeqj.de/sneak/sfdupes/issues/55)
|
||||||
|
|
||||||
|
- `scan` rejects `--workers` below 1 as a usage error instead of running
|
||||||
|
single-threaded (2026-10-04, https://git.eeqj.de/sneak/sfdupes/issues/10)
|
||||||
|
|
||||||
|
- A test fails when either walk cancellation check in `internal/sfdupes/scan.go`
|
||||||
|
is removed (2026-10-04, https://git.eeqj.de/sneak/sfdupes/issues/81)
|
||||||
|
|
||||||
|
- A test checks that `scan` refuses a database with another schema version
|
||||||
|
(2026-10-04, https://git.eeqj.de/sneak/sfdupes/issues/64)
|
||||||
|
|
||||||
|
- Four inaccurate comments in `internal/sfdupes/cancel_test.go` were corrected,
|
||||||
|
and `walkCancelInFlightDirs` was renamed to `walkCancelInFlightFiles`
|
||||||
|
(2026-10-04, https://git.eeqj.de/sneak/sfdupes/issues/33)
|
||||||
|
|
||||||
|
- The `-x` filesystem-boundary rules in `subdirJob` are tested (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/17)
|
||||||
|
|
||||||
|
- `scan` creates the schema in one transaction. A version-0 database with a
|
||||||
|
`files` table is refused with a clear schema-version error (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/11)
|
||||||
|
|
||||||
|
- README documents install, Docker, a daily `cron` scan and how to read and
|
||||||
|
check the reports (2026-10-04, https://git.eeqj.de/sneak/sfdupes/issues/54)
|
||||||
|
|
||||||
|
- The `Dockerfile` build stage kept the Go module cache out of `builder`'s home
|
||||||
|
and copied the sources with `--chown`, so no `chown -R` walked them. Since
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/95 there is no `builder` user and
|
||||||
|
nothing changes owner. The build stage only compiles, as root, and the tests
|
||||||
|
run as `nobody` in the `test` phase (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/43)
|
||||||
|
|
||||||
|
- `--version` prints `sfdupes VERSION` to stdout. README documents it and
|
||||||
|
`--help` (2026-10-04, https://git.eeqj.de/sneak/sfdupes/issues/15)
|
||||||
|
|
||||||
|
- `scan` stops cleanly on `SIGINT` or `SIGTERM`: it commits what it has hashed,
|
||||||
|
deletes nothing more, and exits 1 (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/5)
|
||||||
|
|
||||||
|
- `report` and `trees` stream the records instead of holding them all in memory.
|
||||||
|
The schema gains the `files_signature` index (2026-10-04,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/14)
|
||||||
|
|
||||||
|
- Progress prints at once on a non-terminal and uses a real terminal test.
|
||||||
|
Warnings print through a spinner instead of racing its redraw (2026-10-03,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/13)
|
||||||
|
|
||||||
|
- These operands are warned about and skipped, and the records beneath them are
|
||||||
|
kept:
|
||||||
|
- symlinks;
|
||||||
|
- sockets;
|
||||||
|
- FIFOs;
|
||||||
|
- device nodes;
|
||||||
|
- `.zfs` directories.
|
||||||
|
|
||||||
|
(2026-10-03, https://git.eeqj.de/sneak/sfdupes/issues/9)
|
||||||
|
|
||||||
|
- `scan` holds a lock on a lock file beside the database for its whole run, so a
|
||||||
|
second `scan` fails at once with exit 1 (2026-10-03,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/53)
|
||||||
|
|
||||||
|
- Tests cover stdout write failures in `report` and `trees`. README states that
|
||||||
|
`| head` ends `sfdupes` by `SIGPIPE` and that `>&-` writes to `/dev/null`
|
||||||
|
(2026-10-03, https://git.eeqj.de/sneak/sfdupes/issues/30)
|
||||||
|
|
||||||
|
- `report` and `trees` open the database read-only, and `scan` leaves it out of
|
||||||
|
WAL mode, so reading needs only read access (2026-10-03,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/8)
|
||||||
|
|
||||||
|
- Four characters are escaped in `report`, `trees` and warning paths:
|
||||||
|
- tab;
|
||||||
|
- newline;
|
||||||
|
- carriage return;
|
||||||
|
- backslash.
|
||||||
|
|
||||||
|
The root directory's path is `/` (2026-10-03,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/7)
|
||||||
|
|
||||||
|
- A plain `docker build .` stamps the `git` tag or short commit instead of
|
||||||
|
`dev`. `.dockerignore` sends `.git` without `.git/config`. The build stage
|
||||||
|
stamps the `VERSION` build argument, else `git describe --tags --always`. It
|
||||||
|
fails if the context carries `.git` and the version is still empty, `dev` or
|
||||||
|
`unknown`. The Gitea workflow checks out the full history (`fetch-depth: 0`),
|
||||||
|
so it stamps the same value as `make build` (2026-10-02, branch `next`,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/67)
|
||||||
|
|
||||||
|
- The 1 KiB end-window sampling was replaced with the hashes chosen by file
|
||||||
|
size, and README "Duplicate detection" documented every size threshold. A file
|
||||||
|
under 10 MiB was hashed in full, and its `head`, `tail` and `content` all held
|
||||||
|
that hash. A larger file got only its 64 KiB `head` and `tail` in the hash
|
||||||
|
phase. The content phase ran after the update phase. It read a file for
|
||||||
|
`content` only when its size, `head` and `tail` matched another record's, from
|
||||||
|
this scan or an earlier one. `content` was the whole file below 50 MiB, and
|
||||||
|
gigabyte-spaced 1 MiB samples at or above. It never read a file gone or
|
||||||
|
changed since its record was written. `report` and `trees` left out any record
|
||||||
|
without a `content` hash. The `content` column is part of the version 1
|
||||||
|
schema. Superseded by https://git.eeqj.de/sneak/sfdupes/issues/132
|
||||||
|
(2026-09-22, branch `next`, https://git.eeqj.de/sneak/sfdupes/issues/61)
|
||||||
|
|
||||||
|
- The dead `files.dat` references were removed from `Makefile`, `.gitignore` and
|
||||||
|
`.dockerignore` (2026-09-21, branch `next`,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/22)
|
||||||
|
|
||||||
|
- The lint-image pin comments and `FROM` form in `Dockerfile` and
|
||||||
|
`Dockerfile.lint` were fixed. Both pins became the policy
|
||||||
|
`# image:vX.Y.Z, YYYY-MM-DD` comment over a bare `FROM image@sha256:...`,
|
||||||
|
without the false `(Debian-based)` note or the tag. Since
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/95 the `Dockerfile`'s `lint` phase
|
||||||
|
holds the only `golangci-lint` pin, in that form. `Dockerfile.lint` is gone,
|
||||||
|
and so is `script/verify-lint-image-pin`, which compared the two pins
|
||||||
|
(2026-08-10, branch `next`, https://git.eeqj.de/sneak/sfdupes/issues/25)
|
||||||
|
|
||||||
|
- All linting ran in Docker, via `Dockerfile.lint` and `script/lint`. Per the
|
||||||
|
owner ruling the linter is never installed on a host, and
|
||||||
|
`golangci-lint config verify` runs before `golangci-lint run`.
|
||||||
|
`script/bootstrap` stopped installing or pinning the linter, and
|
||||||
|
`script/verify-linter-pin` was retired. Since
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/95 both commands run in the
|
||||||
|
`Dockerfile`'s `lint` phase. `script/lint` builds that phase alone, and the
|
||||||
|
build stage depends on it through `COPY --from=lint /src/go.sum /dev/null`.
|
||||||
|
`Dockerfile.lint` and `script/verify-lint-image-pin` are gone. Nothing inside
|
||||||
|
an image build may run `docker`, so the phase calls `golangci-lint` directly
|
||||||
|
(2026-08-10, branch `next`, https://git.eeqj.de/sneak/sfdupes/issues/46)
|
||||||
|
|
||||||
|
- The Docker build stage's prerequisites were installed by running
|
||||||
|
`script/bootstrap` instead of `apk add --no-cache make` inline.
|
||||||
|
`script/verify-linter-pin` failed the build unless the linter copied from the
|
||||||
|
lint stage was the version that `script/bootstrap` pinned. Builds then took up
|
||||||
|
to 5m14s from an empty cache, mostly in a `chown -R` of the module cache,
|
||||||
|
filed as https://git.eeqj.de/sneak/sfdupes/issues/43. Since
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/95 the build stage installs `git` and
|
||||||
|
`make` with `apk add --no-cache` and only compiles. The `lint` and `test`
|
||||||
|
phases are the gates (2026-08-09, branch `dockerfile-bootstrap`,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/42)
|
||||||
|
|
||||||
|
- The Docker layer cache is defeated for the gate steps, so `script/cibuild` and
|
||||||
|
`script/docker` cannot report a pass they did not earn. The `Dockerfile`
|
||||||
|
copies the tree before its gates. On an unchanged tree Docker served them from
|
||||||
|
cache, and the build exited 0 without running them. The fix was a
|
||||||
|
`CHECK_EPOCH` build argument. Since
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/95 every `docker build` in `script/`
|
||||||
|
passes a new `CACHEBUST` value instead. Every stage of the `Dockerfile`
|
||||||
|
declares it before every step that checks or compiles the code. Run as root,
|
||||||
|
the tests fail `TestScanHardlinkRunFailsTogether`, because root reads through
|
||||||
|
the `chmod(0)` the test relies on. So the `test` phase runs them as `nobody`
|
||||||
|
(2026-08-09, branch `cibuild-cache-bust`,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/32)
|
||||||
|
|
||||||
|
- `script/bootstrap` checked the installed `golangci-lint` version instead of
|
||||||
|
only its presence. The version lived only in `GOLANGCI_LINT_VERSION`, with the
|
||||||
|
`go install` module reference derived from it. Any installed version that was
|
||||||
|
not the pin was reinstalled, whether:
|
||||||
|
- older;
|
||||||
|
- newer;
|
||||||
|
- absent;
|
||||||
|
- unparseable.
|
||||||
|
|
||||||
|
`go install` writes into `GOBIN`, or `GOPATH/bin`, while `make lint` ran the
|
||||||
|
first `golangci-lint` on `PATH`. So bootstrap re-read the effective version
|
||||||
|
after installing. On a mismatch it printed both paths and both versions and
|
||||||
|
exited non-zero. It did not reorder `PATH` or delete anyone's binary. The
|
||||||
|
`--version` call kept its stderr and was bounded by `timeout(1)` where that
|
||||||
|
exists. `git`, `make` and `go` kept presence-only checks. The version check
|
||||||
|
was verified by bootstrapping this host from v2.10.1 to v2.12.2, and again
|
||||||
|
to a no-op. Stub runs of the script under `dash` covered:
|
||||||
|
- a thirteen-input version-parse matrix;
|
||||||
|
- a shadowed install, which must exit non-zero;
|
||||||
|
- an install destination not on `PATH`;
|
||||||
|
- `GOBIN` set;
|
||||||
|
- a wedged binary, which must hit the timeout.
|
||||||
|
|
||||||
|
`make check` and `make lint` were clean at v2.12.2, so v2.10.1 had not been
|
||||||
|
hiding findings on `main`. Superseded by
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/46, since the linter is no longer
|
||||||
|
installed on a host (2026-08-09, branch `bootstrap-version-check`,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/24)
|
||||||
|
|
||||||
|
- The hash worker pool unwinds on the error path. The pool is an owned,
|
||||||
|
context-aware `hashPool`. Every blocking send in the feeder and the workers
|
||||||
|
selects on `ctx.Done()`, and `jobs` is closed on every path out. `hashPhase`
|
||||||
|
defers `pool.stop()`, which cancels and then drains `results` until the last
|
||||||
|
goroutine has exited. Draining is what frees a worker parked on a send. `ctx`
|
||||||
|
is passed from `cmd.Context()` as the first parameter, through:
|
||||||
|
- `runScan`;
|
||||||
|
- `syncScan`;
|
||||||
|
- both worker pools;
|
||||||
|
- the whole database layer.
|
||||||
|
|
||||||
|
The walk pool gets the same treatment, plus a `ctx.Err()` guard after the
|
||||||
|
walk. A cancelled walk yields a partial size census, and every file that it
|
||||||
|
never reached looks vanished to the update phase. That phase's own `BeginTx`
|
||||||
|
also fails on the cancelled context before deleting anything. The guard is
|
||||||
|
still the barrier once an interrupted scan may commit what it has. Tests
|
||||||
|
drive `run(scan)` against a database whose insert trigger aborts. They
|
||||||
|
assert that the scan fails instead of hanging, and that the goroutine count
|
||||||
|
returns to its pre-scan baseline. Other tests cancel a scan part-way through
|
||||||
|
the walk, deterministically, by counting the scan's own checks of
|
||||||
|
`ctx.Done()`. They assert that it stops at the guard with every record
|
||||||
|
intact. It then holds a partial size census and a still-populated record
|
||||||
|
index. Direct tests cover the remaining cancellation branches of both pools.
|
||||||
|
They test:
|
||||||
|
- `sendEvent`;
|
||||||
|
- the walk workers;
|
||||||
|
- `dispatchDirs`;
|
||||||
|
- `feedHashJobs`;
|
||||||
|
- `hashWorker`;
|
||||||
|
- `hashPhase`.
|
||||||
|
|
||||||
|
(2026-08-09, branch `hash-pool-cleanup`,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/6)
|
||||||
|
|
||||||
|
- The database is closed on every fatal exit path. `fatalf` and its `os.Exit(1)`
|
||||||
|
are gone. So the deferred `db.Close()` runs when a subcommand fails, and with
|
||||||
|
it the SQLite WAL checkpoint. These return errors instead:
|
||||||
|
- `runScan`;
|
||||||
|
- `runReport`;
|
||||||
|
- `runTrees`;
|
||||||
|
- `loadRecords`;
|
||||||
|
- `resolveRoots`.
|
||||||
|
|
||||||
|
The single exit point is `run` in `internal/sfdupes/cli.go`. It maps a
|
||||||
|
`fatalError`, anything a subcommand returned, to exit 1, and cobra's own
|
||||||
|
argument and flag errors to exit 2. So a runtime failure is never reported
|
||||||
|
as a usage error, nor printed with the usage text.
|
||||||
|
`internal/sfdupes/cli_test.go` drives the CLI in-process and asserts the
|
||||||
|
exit codes from README "Error handling" and the stdout/stderr split. It also
|
||||||
|
checks that a fatal error after the database is open leaves no `-wal` or
|
||||||
|
`-shm` file behind, for `scan`, `report` or `trees` (2026-08-09, branch
|
||||||
|
`db-close-on-fatal`, https://git.eeqj.de/sneak/sfdupes/issues/4)
|
||||||
|
|
||||||
|
- `golangci-lint` was updated to v2.12.2 with the canonical config, merged as
|
||||||
|
`38a01bd`. The pinned linter in the `Dockerfile` lint stage and
|
||||||
|
`script/bootstrap` went from v2.12.1 to v2.12.2, and `.golangci.yml` was
|
||||||
|
replaced with the canonical file. Four thresholds now live under
|
||||||
|
`linters.settings`, as the v2 schema requires, so they are applied:
|
||||||
|
- `lll`;
|
||||||
|
- `funlen`;
|
||||||
|
- `cyclop`;
|
||||||
|
- `dupl`.
|
||||||
|
|
||||||
|
No new lint findings surfaced (2026-08-09, branch `golangci-v2.12.2`,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/3)
|
||||||
|
|
||||||
|
- `Makefile` targets were converted to scripts-to-rule-them-all `script/`
|
||||||
|
entrypoints, like the other managed repos. All 12 entrypoints exist:
|
||||||
|
- `bootstrap`, `setup` and `projectname`;
|
||||||
|
- `test`, `lint`, `fmt`, `fmt-check` and `check`;
|
||||||
|
- `docker`, `cibuild`, `precommit` and `install-precommit`.
|
||||||
|
|
||||||
|
Every `Makefile` target does nothing but call its script (2026-07-26, commit
|
||||||
|
`3abeacf`, https://git.eeqj.de/sneak/sfdupes/issues/1)
|
||||||
|
|
||||||
|
- The binary is the default `make` target. Plain `make` builds `sfdupes`, where
|
||||||
|
it used to run `check` plus `build`. `make build` remains as an alias
|
||||||
|
(2026-07-24, branch `make-default-target`)
|
||||||
|
|
||||||
|
- The phases became scan-wide, with concurrent operands and batched updates. All
|
||||||
|
operands seed the shared walk pool, and every pass runs once over the whole
|
||||||
|
scan. So the totals and ETAs cover the whole scan. The per-operand walk, hash
|
||||||
|
and update cycles and their stderr announcements are gone. The update pass
|
||||||
|
writes in batches, each in its own transaction. The filesystem is
|
||||||
|
authoritative and the database follows it, so one scan's changes need not land
|
||||||
|
all at once (2026-07-24, branch `scan-wide-phases`)
|
||||||
|
|
||||||
|
- The stat pass was split back out of the walk. Phases are strictly sequential
|
||||||
|
again, per operand, with parallelism only inside each phase:
|
||||||
|
- walk;
|
||||||
|
- stat;
|
||||||
|
- hash;
|
||||||
|
- update.
|
||||||
|
|
||||||
|
The walk enumerates paths with per-directory workers, and the stat pass
|
||||||
|
lstats them with per-file workers. That restores the exact total and ETA of
|
||||||
|
the stat bar (2026-07-24, branch `parallel-phases`)
|
||||||
|
|
||||||
|
- Each operand is announced on stderr before its passes. With per-operand walk,
|
||||||
|
hash and update cycles, a multi-operand run such as `scan /srv/*` showed pass
|
||||||
|
totals that looked like the whole run's (2026-07-24, branch
|
||||||
|
`scan-operand-progress`)
|
||||||
|
|
||||||
|
- The walk became parallel. The walk pass was a single goroutine and took hours
|
||||||
|
at about 20 million files on a busy pool. One ZFS server took 4 hours for 22
|
||||||
|
million files. It is now a walk by a pool of per-directory workers that
|
||||||
|
records size and mtime as it goes. That folds away the separate stat pass and
|
||||||
|
halves the metadata reads. Each `PATH` operand commits in its own transaction,
|
||||||
|
so an interrupted scan keeps completed operands (2026-07-24, branch
|
||||||
|
`parallel-walk`)
|
||||||
|
|
||||||
|
- `scan` gained a persistent database. It maintains an SQLite database that
|
||||||
|
survives between runs, with the absolute path as each record's key. The driver
|
||||||
|
is `modernc.org/sqlite`, pure Go, so cgo stays disabled. A rescan hashes only
|
||||||
|
new or changed files, by mtime and size. It deletes the records of files
|
||||||
|
vanished from under the scanned operands and leaves records outside them
|
||||||
|
untouched. So `scan` can run daily from `cron`. `report` and `trees` read the
|
||||||
|
database, with no positional arguments, instead of a scan stream. The database
|
||||||
|
is at `/var/lib/sfdupes/db.sqlite`, and `SFDUPES_DATABASE` overrides that. WAL
|
||||||
|
journaling plus a single-transaction update keep a report run during a scan
|
||||||
|
safe (2026-07-24, branch `persistent-database`)
|
||||||
|
|
||||||
|
- The `origin` remote, `git@git.eeqj.de:sneak/sfdupes.git`, was added. `v0.0.1`
|
||||||
|
was tagged, and `main` and the tags were pushed (2026-07-23)
|
||||||
|
|
||||||
|
- The `scan` command line was reworked. Required `PATH...` operands, parsed by
|
||||||
|
cobra, replace the `/srv` `-root` default. The new `-x`, `--one-file-system`
|
||||||
|
flag follows the GNU convention and stops at filesystem boundaries, which the
|
||||||
|
walk crosses by default (2026-07-23, branch `scan-required-paths`)
|
||||||
|
|
||||||
|
- The repo was brought into compliance with `REPO_POLICIES.md` (the version of
|
||||||
|
2026-07-06), the existing repo checklist and the Go styleguide. The audit of
|
||||||
|
2026-07-22 found these gaps, and the branch closed them:
|
||||||
|
- `.gitignore`, with the standard patterns for secrets and for OS, editor
|
||||||
|
and Go files. The compiled `sfdupes` binary and `files.dat` had been
|
||||||
|
sitting untracked in the tree;
|
||||||
|
- `.editorconfig`;
|
||||||
|
- `LICENSE` and the README License section. MIT was assumed from house
|
||||||
|
convention, for the owner to confirm;
|
||||||
|
- `REPO_POLICIES.md` in the repo root;
|
||||||
|
- the canonical `.golangci.yml`, with its 150 findings fixed, so that
|
||||||
|
`make lint` is clean;
|
||||||
|
- the `Makefile` targets the policy requires:
|
||||||
|
- `test` and `lint`;
|
||||||
|
- `fmt` and `fmt-check`;
|
||||||
|
- `docker` and `hooks`.
|
||||||
|
|
||||||
|
`check` depended on `build`, which wrote the binary. `make check` must
|
||||||
|
not modify files, so `check` no longer depends on `build`;
|
||||||
|
|
||||||
|
- a test suite, which the policy required with a 30-second timeout and the
|
||||||
|
conditional `-v` rerun. At 64% coverage, it covers:
|
||||||
|
- parsing and grouping;
|
||||||
|
- digests and suppression;
|
||||||
|
- hashing and the scan pipeline;
|
||||||
|
- a multistage `Dockerfile` and `.dockerignore`. The `Dockerfile` had:
|
||||||
|
- hash-pinned images;
|
||||||
|
- a lint stage that failed fast;
|
||||||
|
- a build stage that ran `make check`;
|
||||||
|
- `.gitea/workflows/check.yml`, running `docker build .` on push with the
|
||||||
|
checkout action pinned by commit SHA;
|
||||||
|
- the README sections the policy requires. The first is a Description whose
|
||||||
|
first line names the project, its purpose and category, its license and
|
||||||
|
its author. Then come Getting Started and Rationale, and at the end TODO,
|
||||||
|
License and Author;
|
||||||
|
- the stale README non-goal "no git repository setup and no CI" removed;
|
||||||
|
- the pre-commit hook, installed with `make hooks` once that target existed.
|
||||||
|
|
||||||
|
The code was already `gofmt`-clean, so no standalone formatting commit was
|
||||||
|
needed (2026-07-23, branch `repo-policy-compliance`)
|
||||||
|
|
||||||
|
- `git init` was run, with a README-only first commit. The code baseline was
|
||||||
|
committed on `main` (2026-07-22)
|
||||||
|
|
||||||
|
- The `scan`, `report` and `trees` subcommands were implemented (pre-git
|
||||||
|
history)
|
||||||
|
|
||||||
# Future Steps
|
# Future Steps
|
||||||
|
|
||||||
- Possible later features, out of scope per README, are a byte-for-byte check of
|
- Possible later features, out of scope per README, are a byte-for-byte check of
|
||||||
|
|||||||
@@ -358,9 +358,8 @@ func TestRunScanInterrupted(t *testing.T) {
|
|||||||
stderr := captureStderr(t)
|
stderr := captureStderr(t)
|
||||||
dir := buildSmokeTree(t)
|
dir := buildSmokeTree(t)
|
||||||
|
|
||||||
opts := scanOptions{workers: walkCancelWorkers}
|
err := runScan(t.Context(), []string{dir}, walkCancelWorkers, false,
|
||||||
|
false, nil)
|
||||||
err := runScan(t.Context(), []string{dir}, opts)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -383,7 +382,8 @@ func TestRunScanInterrupted(t *testing.T) {
|
|||||||
go func() {
|
go func() {
|
||||||
defer close(done)
|
defer close(done)
|
||||||
|
|
||||||
err = runScan(cancelledContext(t), []string{dir}, opts)
|
err = runScan(cancelledContext(t), []string{dir}, walkCancelWorkers,
|
||||||
|
false, false, nil)
|
||||||
}()
|
}()
|
||||||
|
|
||||||
awaitReturn(t, done, "runScan")
|
awaitReturn(t, done, "runScan")
|
||||||
@@ -410,7 +410,8 @@ func TestRunScanInterrupted(t *testing.T) {
|
|||||||
got, before)
|
got, before)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = runScan(t.Context(), []string{dir}, opts)
|
err = runScan(t.Context(), []string{dir}, walkCancelWorkers, false,
|
||||||
|
false, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -436,7 +437,7 @@ func TestRunScanInterruptedMidHash(t *testing.T) {
|
|||||||
dir := buildWalkCancelTree(t)
|
dir := buildWalkCancelTree(t)
|
||||||
|
|
||||||
err := runScan(newWalkClock(hashCancelAtDone), []string{dir},
|
err := runScan(newWalkClock(hashCancelAtDone), []string{dir},
|
||||||
scanOptions{workers: walkCancelWorkers})
|
walkCancelWorkers, false, false, nil)
|
||||||
if !errors.Is(err, errInterrupted) {
|
if !errors.Is(err, errInterrupted) {
|
||||||
t.Fatalf("runScan interrupted mid-hash = %v, want %v",
|
t.Fatalf("runScan interrupted mid-hash = %v, want %v",
|
||||||
err, errInterrupted)
|
err, errInterrupted)
|
||||||
|
|||||||
+54
-86
@@ -88,10 +88,10 @@ value, separated by a tab:
|
|||||||
size of recorded files their total size, in bytes, then rounded
|
size of recorded files their total size, in bytes, then rounded
|
||||||
`
|
`
|
||||||
|
|
||||||
dwimHelp = `dwim runs what "sfdupes scan /" runs with the same flags, then what
|
dwimHelp = `dwim runs what "sfdupes scan /" runs, then what "sfdupes trees" runs.
|
||||||
"sfdupes trees" runs. Run it as root, so that the scan can read every
|
Run it as root, so that the scan can read every file. The scan is stored
|
||||||
file. The scan is stored in the database, as scan stores it, so
|
in the database, as scan stores it, so "sfdupes trees" prints the report
|
||||||
"sfdupes trees" prints the report again later.
|
again later.
|
||||||
`
|
`
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -100,11 +100,12 @@ file. The scan is stored in the database, as scan stores it, so
|
|||||||
// cobra prints for it is the whole message.
|
// cobra prints for it is the whole message.
|
||||||
var errNoSubcommand = errors.New("no subcommand")
|
var errNoSubcommand = errors.New("no subcommand")
|
||||||
|
|
||||||
// errWorkersBelowOne is the usage error for a --workers value below 1.
|
// errWorkersBelowOne is the usage error for a scan --workers value
|
||||||
|
// below 1.
|
||||||
var errWorkersBelowOne = errors.New("--workers must be at least 1")
|
var errWorkersBelowOne = errors.New("--workers must be at least 1")
|
||||||
|
|
||||||
// errEmptyExcludeValue is the usage error for an empty --exclude value,
|
// errEmptyExcludeValue is the usage error for an empty scan --exclude
|
||||||
// as from --exclude "$DIR" with DIR unset. Taken as a path, it
|
// value, as from --exclude "$DIR" with DIR unset. Taken as a path, it
|
||||||
// would name the working directory.
|
// would name the working directory.
|
||||||
var errEmptyExcludeValue = errors.New("--exclude must not be empty")
|
var errEmptyExcludeValue = errors.New("--exclude must not be empty")
|
||||||
|
|
||||||
@@ -255,116 +256,83 @@ func newRootCommand(stdout, stderr io.Writer) *cobra.Command {
|
|||||||
}),
|
}),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
dwimCmd := &cobra.Command{
|
||||||
|
Use: cmdDwim,
|
||||||
|
Short: "Scan / with the default excludes, then print the duplicate-tree report",
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: runE(func(ctx context.Context, _ []string) error {
|
||||||
|
return runDwim(ctx, "/", stdout)
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
root.Long = root.Short + ".\n\n" + databaseHelp
|
root.Long = root.Short + ".\n\n" + databaseHelp
|
||||||
reportCmd.Long = reportCmd.Short + ".\n\n" + reportHelp
|
reportCmd.Long = reportCmd.Short + ".\n\n" + reportHelp
|
||||||
treesCmd.Long = treesCmd.Short + ".\n\n" + treesHelp
|
treesCmd.Long = treesCmd.Short + ".\n\n" + treesHelp
|
||||||
infoCmd.Long = infoCmd.Short + ".\n\n" + infoHelp
|
infoCmd.Long = infoCmd.Short + ".\n\n" + infoHelp
|
||||||
|
dwimCmd.Long = dwimCmd.Short + ".\n\n" + dwimHelp
|
||||||
|
|
||||||
root.AddCommand(newScanCommand(), reportCmd, treesCmd, infoCmd,
|
root.AddCommand(newScanCommand(), reportCmd, treesCmd, infoCmd, dwimCmd)
|
||||||
newDwimCommand(stdout))
|
|
||||||
|
|
||||||
return root
|
return root
|
||||||
}
|
}
|
||||||
|
|
||||||
// scanOptions holds the values of the flags that scan and dwim share:
|
// newScanCommand builds the scan subcommand, with its --workers, -x,
|
||||||
// --workers, -x, --no-default-excludes and --exclude.
|
// --no-default-excludes and --exclude flags. Its help names the
|
||||||
type scanOptions struct {
|
|
||||||
workers int
|
|
||||||
oneFS bool
|
|
||||||
noDefaultExcludes bool
|
|
||||||
excludePaths []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// scanFlagsUsage names the flags that scan and dwim share, for their
|
|
||||||
// usage lines.
|
|
||||||
const scanFlagsUsage = "[--workers N] [-x] [--no-default-excludes] " +
|
|
||||||
"[--exclude PATH]..."
|
|
||||||
|
|
||||||
// addScanFlags adds the flags that scan and dwim share to cmd, which
|
|
||||||
// stores their values in opts.
|
|
||||||
func addScanFlags(cmd *cobra.Command, opts *scanOptions) {
|
|
||||||
cmd.Flags().IntVar(&opts.workers, "workers", runtime.NumCPU(),
|
|
||||||
"concurrent workers for the walk and hash phases")
|
|
||||||
cmd.Flags().BoolVarP(&opts.oneFS, "one-file-system", "x", false,
|
|
||||||
"do not cross filesystem boundaries")
|
|
||||||
cmd.Flags().BoolVar(&opts.noDefaultExcludes, "no-default-excludes",
|
|
||||||
false, "enter the default excludes, the paths listed above")
|
|
||||||
// A string array, not a slice, so a comma in a path is not a
|
|
||||||
// separator.
|
|
||||||
cmd.Flags().StringArrayVar(&opts.excludePaths, "exclude", nil,
|
|
||||||
"never enter or record `PATH` or anything below it; repeatable")
|
|
||||||
}
|
|
||||||
|
|
||||||
// check rejects the flag values that are usage errors, before the
|
|
||||||
// command runs. It is the PreRunE of scan and dwim.
|
|
||||||
func (o *scanOptions) check(cmd *cobra.Command, _ []string) error {
|
|
||||||
err := checkScanWorkers(cmd, o.workers)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return rejectEmptyExcludeValue(cmd, o.excludePaths)
|
|
||||||
}
|
|
||||||
|
|
||||||
// newScanCommand builds the scan subcommand. Its help names the
|
|
||||||
// database, and lists the default excludes of the system it runs on and
|
// database, and lists the default excludes of the system it runs on and
|
||||||
// the filesystem types it never records anything on.
|
// the filesystem types it never records anything on.
|
||||||
func newScanCommand() *cobra.Command {
|
func newScanCommand() *cobra.Command {
|
||||||
var opts scanOptions
|
var (
|
||||||
|
scanWorkers int
|
||||||
|
scanOneFS bool
|
||||||
|
scanNoDefaultExcludes bool
|
||||||
|
scanExclude []string
|
||||||
|
)
|
||||||
|
|
||||||
short := "Walk trees and synchronize the scan database"
|
short := "Walk trees and synchronize the scan database"
|
||||||
|
|
||||||
scanCmd := &cobra.Command{
|
scanCmd := &cobra.Command{
|
||||||
Use: cmdScan + " " + scanFlagsUsage + " PATH...",
|
Use: cmdScan + " [--workers N] [-x] [--no-default-excludes] " +
|
||||||
|
"[--exclude PATH]... PATH...",
|
||||||
// The Use line already names every flag, so cobra must not
|
// The Use line already names every flag, so cobra must not
|
||||||
// append its generic "[flags]" to it.
|
// append its generic "[flags]" to it.
|
||||||
DisableFlagsInUseLine: true,
|
DisableFlagsInUseLine: true,
|
||||||
Short: short,
|
Short: short,
|
||||||
Long: short + ".\n\n" + databaseHelp + "\n" +
|
Long: short + ".\n\n" + databaseHelp + "\n" +
|
||||||
defaultExcludesHelp(runtime.GOOS),
|
defaultExcludesHelp(runtime.GOOS),
|
||||||
Args: cobra.MinimumNArgs(1),
|
Args: cobra.MinimumNArgs(1),
|
||||||
PreRunE: opts.check,
|
PreRunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
|
err := checkScanWorkers(cmd, scanWorkers)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return rejectEmptyExcludeValue(cmd, scanExclude)
|
||||||
|
},
|
||||||
RunE: runE(func(ctx context.Context, args []string) error {
|
RunE: runE(func(ctx context.Context, args []string) error {
|
||||||
ctx, stop := interruptContext(ctx)
|
ctx, stop := interruptContext(ctx)
|
||||||
defer stop()
|
defer stop()
|
||||||
|
|
||||||
return runScan(ctx, args, opts)
|
return runScan(ctx, args, scanWorkers, scanOneFS,
|
||||||
|
scanNoDefaultExcludes, scanExclude)
|
||||||
}),
|
}),
|
||||||
}
|
}
|
||||||
addScanFlags(scanCmd, &opts)
|
scanCmd.Flags().IntVar(&scanWorkers, "workers", runtime.NumCPU(),
|
||||||
|
"concurrent workers for the walk and hash phases")
|
||||||
|
scanCmd.Flags().BoolVarP(&scanOneFS, "one-file-system", "x", false,
|
||||||
|
"do not cross filesystem boundaries")
|
||||||
|
scanCmd.Flags().BoolVar(&scanNoDefaultExcludes, "no-default-excludes",
|
||||||
|
false, "enter the default excludes, the paths listed above")
|
||||||
|
// A string array, not a slice, so a comma in a path is not a
|
||||||
|
// separator.
|
||||||
|
scanCmd.Flags().StringArrayVar(&scanExclude, "exclude", nil,
|
||||||
|
"never enter or record `PATH` or anything below it; repeatable")
|
||||||
|
|
||||||
return scanCmd
|
return scanCmd
|
||||||
}
|
}
|
||||||
|
|
||||||
// newDwimCommand builds the dwim subcommand, which takes the scan flags
|
// checkScanWorkers rejects a scan --workers value below 1. That is a
|
||||||
// with the meaning they have for scan. Its help says what dwim runs,
|
// usage error reported in one line: cobra prints the returned message
|
||||||
// then lists the default excludes and the filesystem types the scan
|
// without the usage text, and run exits 2.
|
||||||
// never records anything on.
|
|
||||||
func newDwimCommand(stdout io.Writer) *cobra.Command {
|
|
||||||
var opts scanOptions
|
|
||||||
|
|
||||||
short := "Scan /, then print the duplicate-tree report"
|
|
||||||
|
|
||||||
dwimCmd := &cobra.Command{
|
|
||||||
Use: cmdDwim + " " + scanFlagsUsage,
|
|
||||||
DisableFlagsInUseLine: true,
|
|
||||||
Short: short,
|
|
||||||
Long: short + ".\n\n" + dwimHelp + "\n" +
|
|
||||||
defaultExcludesHelp(runtime.GOOS),
|
|
||||||
Args: cobra.NoArgs,
|
|
||||||
PreRunE: opts.check,
|
|
||||||
RunE: runE(func(ctx context.Context, _ []string) error {
|
|
||||||
return runDwim(ctx, "/", opts, stdout)
|
|
||||||
}),
|
|
||||||
}
|
|
||||||
addScanFlags(dwimCmd, &opts)
|
|
||||||
|
|
||||||
return dwimCmd
|
|
||||||
}
|
|
||||||
|
|
||||||
// checkScanWorkers rejects a --workers value below 1. That is a usage
|
|
||||||
// error reported in one line: cobra prints the returned message without
|
|
||||||
// the usage text, and run exits 2.
|
|
||||||
func checkScanWorkers(cmd *cobra.Command, workers int) error {
|
func checkScanWorkers(cmd *cobra.Command, workers int) error {
|
||||||
if workers >= 1 {
|
if workers >= 1 {
|
||||||
return nil
|
return nil
|
||||||
@@ -375,7 +343,7 @@ func checkScanWorkers(cmd *cobra.Command, workers int) error {
|
|||||||
return fmt.Errorf("%w, got %d", errWorkersBelowOne, workers)
|
return fmt.Errorf("%w, got %d", errWorkersBelowOne, workers)
|
||||||
}
|
}
|
||||||
|
|
||||||
// rejectEmptyExcludeValue rejects an empty --exclude value. That
|
// rejectEmptyExcludeValue rejects an empty scan --exclude value. That
|
||||||
// is a usage error reported in one line, as for --workers below 1.
|
// is a usage error reported in one line, as for --workers below 1.
|
||||||
func rejectEmptyExcludeValue(cmd *cobra.Command, excludePaths []string) error {
|
func rejectEmptyExcludeValue(cmd *cobra.Command, excludePaths []string) error {
|
||||||
if !slices.Contains(excludePaths, "") {
|
if !slices.Contains(excludePaths, "") {
|
||||||
|
|||||||
@@ -25,9 +25,6 @@ const usageMarker = "Usage:"
|
|||||||
// helpFlag asks for the help text.
|
// helpFlag asks for the help text.
|
||||||
const helpFlag = "--help"
|
const helpFlag = "--help"
|
||||||
|
|
||||||
// workersFlag is the scan and dwim flag that sets the worker count.
|
|
||||||
const workersFlag = "--workers"
|
|
||||||
|
|
||||||
// TestMain stops the tests at once, saying why, when their temporary
|
// TestMain stops the tests at once, saying why, when their temporary
|
||||||
// directory is not on a persistent filesystem: scan records nothing
|
// directory is not on a persistent filesystem: scan records nothing
|
||||||
// there (README "Rules for the walk"), so most scan tests would fail
|
// there (README "Rules for the walk"), so most scan tests would fail
|
||||||
@@ -576,8 +573,8 @@ func TestRunNamesDefaultDatabase(t *testing.T) {
|
|||||||
}{
|
}{
|
||||||
cmdScan: {
|
cmdScan: {
|
||||||
run: func() error {
|
run: func() error {
|
||||||
return runScan(t.Context(), []string{missing},
|
return runScan(t.Context(), []string{missing}, 1, false, false,
|
||||||
scanOptions{workers: 1})
|
nil)
|
||||||
},
|
},
|
||||||
want: scanWant,
|
want: scanWant,
|
||||||
},
|
},
|
||||||
@@ -668,7 +665,7 @@ func TestRunScanRejectsWorkersBelowOne(t *testing.T) {
|
|||||||
|
|
||||||
var stdout, stderr bytes.Buffer
|
var stdout, stderr bytes.Buffer
|
||||||
|
|
||||||
args := []string{cmdScan, workersFlag, workers, t.TempDir()}
|
args := []string{cmdScan, "--workers", workers, t.TempDir()}
|
||||||
|
|
||||||
code := run(args, &stdout, &stderr)
|
code := run(args, &stdout, &stderr)
|
||||||
if code != exitUsage {
|
if code != exitUsage {
|
||||||
|
|||||||
+10
-10
@@ -5,20 +5,20 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
|
"runtime"
|
||||||
)
|
)
|
||||||
|
|
||||||
// runDwim implements the dwim subcommand: it runs what "sfdupes scan
|
// runDwim implements the dwim subcommand: it runs what "sfdupes scan
|
||||||
// root" runs with the scan flags in opts, then what "sfdupes trees"
|
// root" runs with no flags, then what "sfdupes trees" runs, and ends
|
||||||
// runs, and ends with a line on stderr saying how to print the report
|
// with a line on stderr saying how to print the report again. The dwim
|
||||||
// again. The dwim command passes "/" as root. It catches SIGINT and
|
// command passes "/" as root. It catches SIGINT and SIGTERM as scan
|
||||||
// SIGTERM as scan does, but only during the scan. An error from the
|
// does, but only during the scan. An error from the scan, an interrupt
|
||||||
// scan, an interrupt included, ends it before the report. During the
|
// included, ends it before the report. During the report, a signal
|
||||||
// report, a signal ends it at once, as it ends trees.
|
// ends it at once, as it ends trees.
|
||||||
func runDwim(
|
func runDwim(ctx context.Context, root string, stdout io.Writer) error {
|
||||||
ctx context.Context, root string, opts scanOptions, stdout io.Writer,
|
|
||||||
) error {
|
|
||||||
scanCtx, stop := interruptContext(ctx)
|
scanCtx, stop := interruptContext(ctx)
|
||||||
err := runScan(scanCtx, []string{root}, opts)
|
err := runScan(scanCtx, []string{root}, runtime.NumCPU(), false, false,
|
||||||
|
nil)
|
||||||
|
|
||||||
stop()
|
stop()
|
||||||
|
|
||||||
|
|||||||
@@ -2,10 +2,7 @@ package sfdupes //nolint:testpackage // calls the unexported runDwim
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"runtime"
|
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
@@ -31,7 +28,7 @@ func TestRunDwimPrintsLargestTreesFirst(t *testing.T) {
|
|||||||
|
|
||||||
stderr := captureStderr(t)
|
stderr := captureStderr(t)
|
||||||
|
|
||||||
err := runDwim(t.Context(), root, scanOptions{workers: 1}, &stdout)
|
err := runDwim(t.Context(), root, &stdout)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("runDwim: %v; stderr: %s", err, stderr())
|
t.Fatalf("runDwim: %v; stderr: %s", err, stderr())
|
||||||
}
|
}
|
||||||
@@ -70,7 +67,7 @@ func TestRunDwimScanErrorPrintsNoReport(t *testing.T) {
|
|||||||
|
|
||||||
stderr := captureStderr(t)
|
stderr := captureStderr(t)
|
||||||
|
|
||||||
err := runDwim(t.Context(), missing, scanOptions{workers: 1}, &stdout)
|
err := runDwim(t.Context(), missing, &stdout)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("runDwim on a missing root: error = nil, want it fatal")
|
t.Fatal("runDwim on a missing root: error = nil, want it fatal")
|
||||||
}
|
}
|
||||||
@@ -84,127 +81,3 @@ func TestRunDwimScanErrorPrintsNoReport(t *testing.T) {
|
|||||||
t.Errorf("stderr = %q, want nothing from trees or dwim", got)
|
t.Errorf("stderr = %q, want nothing from trees or dwim", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRunDwimExcludeLeavesTreeOut(t *testing.T) {
|
|
||||||
// dwim passes its --exclude paths to the scan: an excluded copy is
|
|
||||||
// not recorded, so its pair is not reported.
|
|
||||||
t.Setenv(databaseEnv, testDBPath(t))
|
|
||||||
|
|
||||||
root := realTempDir(t)
|
|
||||||
|
|
||||||
kept := []string{
|
|
||||||
filepath.Dir(writeFile(t, root, "a1/f.bin", pattern(1, 300))),
|
|
||||||
filepath.Dir(writeFile(t, root, "a2/f.bin", pattern(1, 300))),
|
|
||||||
}
|
|
||||||
writeFile(t, root, "b1/f.bin", pattern(2, 5000))
|
|
||||||
excluded := filepath.Dir(writeFile(t, root, "b2/f.bin", pattern(2, 5000)))
|
|
||||||
|
|
||||||
var stdout bytes.Buffer
|
|
||||||
|
|
||||||
stderr := captureStderr(t)
|
|
||||||
|
|
||||||
opts := scanOptions{workers: 1, excludePaths: []string{excluded}}
|
|
||||||
|
|
||||||
err := runDwim(t.Context(), root, opts, &stdout)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("runDwim: %v; stderr: %s", err, stderr())
|
|
||||||
}
|
|
||||||
|
|
||||||
lines := strings.Split(strings.TrimSuffix(stdout.String(), "\n"), "\n")
|
|
||||||
if len(lines) != 2 {
|
|
||||||
t.Fatalf("stdout = %q, want a header and one group",
|
|
||||||
stdout.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
want := kept[0] + "\t" + kept[1] + "\t1\t300\t"
|
|
||||||
if !strings.HasPrefix(lines[1], want) {
|
|
||||||
t.Errorf("group = %q, want it to start %q", lines[1], want)
|
|
||||||
}
|
|
||||||
|
|
||||||
skipped := "scan: skipped " + excluded + " (--exclude)\n"
|
|
||||||
if got := stderr(); !strings.Contains(got, skipped) {
|
|
||||||
t.Errorf("stderr = %q, want it to contain %q", got, skipped)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRunDwimTakesScanFlags(t *testing.T) {
|
|
||||||
// The dwim command parses and checks the scan flags as scan does.
|
|
||||||
// Each case stops before the walk of / begins, and before the
|
|
||||||
// database is created. "dwim --exclude /" excludes its own operand.
|
|
||||||
cases := map[string]struct {
|
|
||||||
args []string
|
|
||||||
code int
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
"--exclude /": {
|
|
||||||
[]string{cmdDwim, excludeFlag, "/"},
|
|
||||||
exitFatal,
|
|
||||||
"sfdupes: scan /: operand excluded by --exclude /\n",
|
|
||||||
},
|
|
||||||
"--exclude empty": {
|
|
||||||
[]string{cmdDwim, excludeFlag, ""},
|
|
||||||
exitUsage,
|
|
||||||
"Error: --exclude must not be empty\n",
|
|
||||||
},
|
|
||||||
"--workers 0": {
|
|
||||||
[]string{cmdDwim, workersFlag, "0", "-x", "--no-default-excludes"},
|
|
||||||
exitUsage,
|
|
||||||
"Error: --workers must be at least 1, got 0\n",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for name, tc := range cases {
|
|
||||||
t.Run(name, func(t *testing.T) {
|
|
||||||
path := testDBPath(t)
|
|
||||||
t.Setenv(databaseEnv, path)
|
|
||||||
|
|
||||||
stdout := captureStdout(t)
|
|
||||||
stderr := captureStderr(t)
|
|
||||||
|
|
||||||
code := run(tc.args, os.Stdout, os.Stderr)
|
|
||||||
if code != tc.code {
|
|
||||||
t.Errorf("run(%q) = %d, want %d", tc.args, code, tc.code)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.HasSuffix(stderr(), tc.want) || stdout() != "" {
|
|
||||||
t.Errorf("stdout, stderr = %q, %q, want \"\" and stderr "+
|
|
||||||
"ending %q", stdout(), stderr(), tc.want)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := os.Lstat(path)
|
|
||||||
if !errors.Is(err, os.ErrNotExist) {
|
|
||||||
t.Errorf("lstat %s: %v, want no database", path, err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRunDwimHelpListsScanFlags(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// README "Subcommands" shows this usage line for dwim.
|
|
||||||
const want = "\n sfdupes dwim [--workers N] [-x] [--no-default-excludes] " +
|
|
||||||
"[--exclude PATH]...\n"
|
|
||||||
|
|
||||||
var stdout, stderr bytes.Buffer
|
|
||||||
|
|
||||||
run([]string{cmdDwim, "-h"}, &stdout, &stderr)
|
|
||||||
|
|
||||||
if !strings.Contains(stderr.String(), want) {
|
|
||||||
t.Errorf("dwim -h stderr = %q, want the usage line %q",
|
|
||||||
stderr.String(), want)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(stderr.String(), excludeFlag+" PATH") {
|
|
||||||
t.Errorf("dwim -h stderr = %q, want %s PATH", stderr.String(),
|
|
||||||
excludeFlag)
|
|
||||||
}
|
|
||||||
|
|
||||||
// README "Settings": the help lists the default excludes and the
|
|
||||||
// filesystem types the walk never records anything on.
|
|
||||||
help := strings.TrimSpace(defaultExcludesHelp(runtime.GOOS))
|
|
||||||
if !strings.Contains(stderr.String(), help) {
|
|
||||||
t.Errorf("dwim -h stderr = %q, want it to hold %q", stderr.String(),
|
|
||||||
help)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -72,31 +72,14 @@ type walkRules struct {
|
|||||||
func defaultExcludes(goos string) []string {
|
func defaultExcludes(goos string) []string {
|
||||||
switch goos {
|
switch goos {
|
||||||
case goosLinux:
|
case goosLinux:
|
||||||
// The kernel's view of the running system, temporary files, and
|
return []string{"/proc", "/sys", "/dev", "/run", "/tmp", "/var/tmp"}
|
||||||
// caches that programs and package managers fill again on their
|
|
||||||
// own: the system's, root's and those in each home in /home.
|
|
||||||
return []string{
|
|
||||||
"/proc", "/sys", "/dev", "/run", "/tmp", "/var/tmp", "/var/cache",
|
|
||||||
"/root/.cache", "/root/.npm", "/root/.cargo/registry",
|
|
||||||
"/root/go/pkg/mod",
|
|
||||||
"/home/*/.cache", "/home/*/.npm", "/home/*/.cargo/registry",
|
|
||||||
"/home/*/go/pkg/mod",
|
|
||||||
}
|
|
||||||
case goosDarwin:
|
case goosDarwin:
|
||||||
// A walk of / reaches everything in /System/Volumes/Data through
|
// A walk of / reaches everything in /System/Volumes/Data through
|
||||||
// the firmlinks, so walking it as well would record each of
|
// the firmlinks, so walking it as well would record each of
|
||||||
// those files twice. /private/var/folders holds each user's
|
// those files twice.
|
||||||
// temporary files and caches. The walk reaches root's home,
|
|
||||||
// /var/root, as /private/var/root.
|
|
||||||
return []string{
|
return []string{
|
||||||
"/dev", "/private/tmp", "/private/var/tmp", "/private/var/vm",
|
"/dev", "/private/tmp", "/private/var/tmp", "/private/var/vm",
|
||||||
"/System/Volumes/VM", "/System/Volumes/Data",
|
"/System/Volumes/VM", "/System/Volumes/Data",
|
||||||
"/private/var/folders", "/Library/Caches",
|
|
||||||
"/private/var/root/Library/Caches", "/private/var/root/.cache",
|
|
||||||
"/private/var/root/.npm", "/private/var/root/.cargo/registry",
|
|
||||||
"/private/var/root/go/pkg/mod",
|
|
||||||
"/Users/*/Library/Caches", "/Users/*/.cache", "/Users/*/.npm",
|
|
||||||
"/Users/*/.cargo/registry", "/Users/*/go/pkg/mod",
|
|
||||||
}
|
}
|
||||||
case goosWindows:
|
case goosWindows:
|
||||||
// Relative to the root of the drive an operand lies on. The
|
// Relative to the root of the drive an operand lies on. The
|
||||||
@@ -271,7 +254,7 @@ func readMountInfo(mountinfo io.Reader) (map[uint64]string, error) {
|
|||||||
return devices, lines.Err()
|
return devices, lines.Err()
|
||||||
}
|
}
|
||||||
|
|
||||||
// defaultExcludesHelp describes, for the scan and dwim help, the
|
// defaultExcludesHelp describes, for the scan command's help, the
|
||||||
// default excludes of the system goos names and, where the scan lists
|
// default excludes of the system goos names and, where the scan lists
|
||||||
// the mounted filesystems, the types it never records anything on.
|
// the mounted filesystems, the types it never records anything on.
|
||||||
func defaultExcludesHelp(goos string) string {
|
func defaultExcludesHelp(goos string) string {
|
||||||
|
|||||||
@@ -24,22 +24,10 @@ func TestDefaultExcludes(t *testing.T) {
|
|||||||
// on any other system. The Windows list exists in the code only: the
|
// on any other system. The Windows list exists in the code only: the
|
||||||
// binary does not build for Windows, so the README leaves it out.
|
// binary does not build for Windows, so the README leaves it out.
|
||||||
cases := map[string][]string{
|
cases := map[string][]string{
|
||||||
goosLinux: {
|
goosLinux: {"/proc", "/sys", "/dev", "/run", "/tmp", "/var/tmp"},
|
||||||
"/proc", "/sys", "/dev", "/run", "/tmp", "/var/tmp", "/var/cache",
|
|
||||||
"/root/.cache", "/root/.npm", "/root/.cargo/registry",
|
|
||||||
"/root/go/pkg/mod",
|
|
||||||
"/home/*/.cache", "/home/*/.npm", "/home/*/.cargo/registry",
|
|
||||||
"/home/*/go/pkg/mod",
|
|
||||||
},
|
|
||||||
goosDarwin: {
|
goosDarwin: {
|
||||||
"/dev", "/private/tmp", "/private/var/tmp", "/private/var/vm",
|
"/dev", "/private/tmp", "/private/var/tmp", "/private/var/vm",
|
||||||
"/System/Volumes/VM", "/System/Volumes/Data",
|
"/System/Volumes/VM", "/System/Volumes/Data",
|
||||||
"/private/var/folders", "/Library/Caches",
|
|
||||||
"/private/var/root/Library/Caches", "/private/var/root/.cache",
|
|
||||||
"/private/var/root/.npm", "/private/var/root/.cargo/registry",
|
|
||||||
"/private/var/root/go/pkg/mod",
|
|
||||||
"/Users/*/Library/Caches", "/Users/*/.cache", "/Users/*/.npm",
|
|
||||||
"/Users/*/.cargo/registry", "/Users/*/go/pkg/mod",
|
|
||||||
},
|
},
|
||||||
goosWindows: {
|
goosWindows: {
|
||||||
"pagefile.sys", "swapfile.sys", "hiberfil.sys",
|
"pagefile.sys", "swapfile.sys", "hiberfil.sys",
|
||||||
@@ -75,29 +63,6 @@ func TestIsDefaultExclude(t *testing.T) {
|
|||||||
t.Errorf("isDefaultExclude(%q) = %v, want %v", path, got, want)
|
t.Errorf("isDefaultExclude(%q) = %v, want %v", path, got, want)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// The Linux list matches the cache directories in /root and in each
|
|
||||||
// home in /home, but nothing below them and no .cache directory
|
|
||||||
// elsewhere.
|
|
||||||
linux := map[string]bool{
|
|
||||||
"/home/u/.cache": true,
|
|
||||||
"/home/u/go/pkg/mod": true,
|
|
||||||
"/root/.cache": true,
|
|
||||||
"/var/cache": true,
|
|
||||||
"/home/u/.cache/pip": false,
|
|
||||||
"/home/u/src/.cache": false,
|
|
||||||
"/srv/home/u/.cache": false,
|
|
||||||
"/home/u/.cargo/bin": false,
|
|
||||||
"/home/u/go/pkg/mod/cache": false,
|
|
||||||
}
|
|
||||||
|
|
||||||
for path, want := range linux {
|
|
||||||
got := isDefaultExclude(path, defaultExcludes(goosLinux))
|
|
||||||
if got != want {
|
|
||||||
t.Errorf("isDefaultExclude(%q, Linux list) = %v, want %v", path,
|
|
||||||
got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReadMountInfo(t *testing.T) {
|
func TestReadMountInfo(t *testing.T) {
|
||||||
@@ -325,7 +290,7 @@ func TestRunScanTempDirOperand(t *testing.T) {
|
|||||||
t.Setenv(databaseEnv, path)
|
t.Setenv(databaseEnv, path)
|
||||||
|
|
||||||
dir := realTempDir(t)
|
dir := realTempDir(t)
|
||||||
if !insideDefaultExclude(dir, defaultExcludes(runtime.GOOS)) {
|
if !underAnyRoot(dir, defaultExcludes(runtime.GOOS)) {
|
||||||
t.Skip(dir + " is not inside a default exclude")
|
t.Skip(dir + " is not inside a default exclude")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -746,20 +711,6 @@ func shmTempDir(t *testing.T) (string, string, walkRules) {
|
|||||||
return dir, fsType, walkRules{nonPersistent: nonPersistent}
|
return dir, fsType, walkRules{nonPersistent: nonPersistent}
|
||||||
}
|
}
|
||||||
|
|
||||||
// insideDefaultExclude reports whether path, which is absolute and
|
|
||||||
// clean, or a directory above it is one of excludes.
|
|
||||||
func insideDefaultExclude(path string, excludes []string) bool {
|
|
||||||
for dir := path; ; dir = filepath.Dir(dir) {
|
|
||||||
if isDefaultExclude(dir, excludes) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if dir == "/" {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertRecorded checks that the database at dbPath holds a record for
|
// assertRecorded checks that the database at dbPath holds a record for
|
||||||
// path when want is set, and none when it is not.
|
// path when want is set, and none when it is not.
|
||||||
func assertRecorded(t *testing.T, dbPath, path string, want bool) {
|
func assertRecorded(t *testing.T, dbPath, path string, want bool) {
|
||||||
|
|||||||
+14
-13
@@ -98,16 +98,17 @@ func scanPhase(name string) string {
|
|||||||
// runs, and the lock is released after it. When ctx is cancelled, as by
|
// runs, and the lock is released after it. When ctx is cancelled, as by
|
||||||
// the SIGINT or SIGTERM that interruptContext catches, the scan keeps
|
// the SIGINT or SIGTERM that interruptContext catches, the scan keeps
|
||||||
// what it has hashed (see syncScan), prints how many files its walk
|
// what it has hashed (see syncScan), prints how many files its walk
|
||||||
// reached, and returns errInterrupted. opts.workers must be at least 1;
|
// reached, and returns errInterrupted. workers must be at least 1; the
|
||||||
// the scan and dwim commands reject anything less. Before the lock is
|
// scan command rejects anything less. Before the lock is taken, the
|
||||||
// taken, the scan lists the filesystems that are not persistent, on
|
// scan lists the filesystems that are not persistent, on which the walk
|
||||||
// which the walk records nothing; unless opts.noDefaultExcludes is set,
|
// records nothing; unless noDefaultExcludes is set, the walk does not
|
||||||
// the walk does not enter the default excludes either. The walk neither
|
// enter the default excludes either. The walk neither enters nor
|
||||||
// enters nor records the paths in opts.excludePaths, the --exclude
|
// records the paths in excludePaths, the --exclude values; an operand
|
||||||
// values; an operand at or below one is a fatal error. Once the
|
// at or below one is a fatal error. Once the database is open, the scan
|
||||||
// database is open, the scan notes its files, which the walk passes
|
// notes its files, which the walk passes over.
|
||||||
// over.
|
func runScan(ctx context.Context, roots []string, workers int,
|
||||||
func runScan(ctx context.Context, roots []string, opts scanOptions) error {
|
oneFS, noDefaultExcludes bool, excludePaths []string,
|
||||||
|
) error {
|
||||||
dbPath, source, err := databasePath()
|
dbPath, source, err := databasePath()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -122,7 +123,7 @@ func runScan(ctx context.Context, roots []string, opts scanOptions) error {
|
|||||||
|
|
||||||
var rules walkRules
|
var rules walkRules
|
||||||
|
|
||||||
rules.excludePaths, err = excludePathInodes(opts.excludePaths)
|
rules.excludePaths, err = excludePathInodes(excludePaths)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("--exclude: %w", err)
|
return fmt.Errorf("--exclude: %w", err)
|
||||||
}
|
}
|
||||||
@@ -137,7 +138,7 @@ func runScan(ctx context.Context, roots []string, opts scanOptions) error {
|
|||||||
return fmt.Errorf("list the mounted filesystems: %w", err)
|
return fmt.Errorf("list the mounted filesystems: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !opts.noDefaultExcludes {
|
if !noDefaultExcludes {
|
||||||
rules.defaultExcludes = defaultExcludes(runtime.GOOS)
|
rules.defaultExcludes = defaultExcludes(runtime.GOOS)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -166,7 +167,7 @@ func runScan(ctx context.Context, roots []string, opts scanOptions) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
st, err := syncScan(ctx, db, roots, opts.workers, opts.oneFS, rules)
|
st, err := syncScan(ctx, db, roots, workers, oneFS, rules)
|
||||||
if errors.Is(err, context.Canceled) {
|
if errors.Is(err, context.Canceled) {
|
||||||
return interrupted(st.walked)
|
return interrupted(st.walked)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2196,7 +2196,7 @@ func TestScanHashWriteFailureUnwindsPool(t *testing.T) {
|
|||||||
var stderr bytes.Buffer
|
var stderr bytes.Buffer
|
||||||
|
|
||||||
code := run([]string{
|
code := run([]string{
|
||||||
cmdScan, workersFlag, strconv.Itoa(hashLeakWorkers), dir,
|
cmdScan, "--workers", strconv.Itoa(hashLeakWorkers), dir,
|
||||||
}, io.Discard, &stderr)
|
}, io.Discard, &stderr)
|
||||||
if code != exitFatal {
|
if code != exitFatal {
|
||||||
t.Fatalf("run(scan) = %d, want %d; stderr: %s",
|
t.Fatalf("run(scan) = %d, want %d; stderr: %s",
|
||||||
|
|||||||
+42
-12
@@ -101,7 +101,7 @@ func runTrees(ctx context.Context, stdout io.Writer) error {
|
|||||||
label: treesPhase("write"), unit: "groups", total: int64(len(dupes)),
|
label: treesPhase("write"), unit: "groups", total: int64(len(dupes)),
|
||||||
stalledOn: "out",
|
stalledOn: "out",
|
||||||
})
|
})
|
||||||
dupeTrees, reclaimable, err := writeTreeGroups(stdout, dupes, prog)
|
dupeTrees, err := writeTreeGroups(stdout, dupes, prog)
|
||||||
|
|
||||||
prog.finish()
|
prog.finish()
|
||||||
|
|
||||||
@@ -112,7 +112,7 @@ func runTrees(ctx context.Context, stdout io.Writer) error {
|
|||||||
fmt.Fprintf(os.Stderr,
|
fmt.Fprintf(os.Stderr,
|
||||||
"trees: %d records read, %d duplicate tree groups, %d dupe trees, "+
|
"trees: %d records read, %d duplicate tree groups, %d dupe trees, "+
|
||||||
"%s reclaimable\n",
|
"%s reclaimable\n",
|
||||||
records, len(dupes), dupeTrees, humanBytes(reclaimable))
|
records, len(dupes), dupeTrees, humanBytes(reclaimableBytes(dupes)))
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -146,22 +146,19 @@ func readTree(ctx context.Context, db *sql.DB,
|
|||||||
// a row for every member of each group but its first, counting each
|
// a row for every member of each group but its first, counting each
|
||||||
// group on prog once its rows are written. The disk_size column is the
|
// group on prog once its rows are written. The disk_size column is the
|
||||||
// dupe's own. stdout may be the terminal prog is drawn on, so the lines
|
// dupe's own. stdout may be the terminal prog is drawn on, so the lines
|
||||||
// go through prog's writer. It returns the number of rows (dupe trees)
|
// go through prog's writer. It returns the number of rows (dupe trees).
|
||||||
// and the bytes they could reclaim.
|
|
||||||
func writeTreeGroups(stdout io.Writer, dupes [][]*treeNode,
|
func writeTreeGroups(stdout io.Writer, dupes [][]*treeNode,
|
||||||
prog *progress,
|
prog *progress,
|
||||||
) (int, int64, error) {
|
) (int, error) {
|
||||||
out := prog.writer(stdout)
|
out := prog.writer(stdout)
|
||||||
|
|
||||||
_, err := fmt.Fprintln(out, "first\tdupe\tfiles\tsize\tdisk_size")
|
_, err := fmt.Fprintln(out, "first\tdupe\tfiles\tsize\tdisk_size")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return 0, 0, fmt.Errorf("write stdout: %w", err)
|
return 0, fmt.Errorf("write stdout: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
dupeTrees := 0
|
dupeTrees := 0
|
||||||
|
|
||||||
var reclaimable int64
|
|
||||||
|
|
||||||
for _, g := range dupes {
|
for _, g := range dupes {
|
||||||
first := g[0]
|
first := g[0]
|
||||||
for _, n := range g[1:] {
|
for _, n := range g[1:] {
|
||||||
@@ -169,11 +166,10 @@ func writeTreeGroups(stdout io.Writer, dupes [][]*treeNode,
|
|||||||
escapePath(first.path), escapePath(n.path),
|
escapePath(first.path), escapePath(n.path),
|
||||||
first.fileCount, first.totalSize, n.diskSize)
|
first.fileCount, first.totalSize, n.diskSize)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return 0, 0, fmt.Errorf("write stdout: %w", err)
|
return 0, fmt.Errorf("write stdout: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
dupeTrees++
|
dupeTrees++
|
||||||
reclaimable += first.totalSize
|
|
||||||
}
|
}
|
||||||
|
|
||||||
prog.increment()
|
prog.increment()
|
||||||
@@ -181,10 +177,44 @@ func writeTreeGroups(stdout io.Writer, dupes [][]*treeNode,
|
|||||||
|
|
||||||
err = out.Flush()
|
err = out.Flush()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return 0, 0, fmt.Errorf("write stdout: %w", err)
|
return 0, fmt.Errorf("write stdout: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return dupeTrees, reclaimable, nil
|
return dupeTrees, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// reclaimableBytes returns the sum of the size column over the rows
|
||||||
|
// that writeTreeGroups writes for dupes, leaving out a row whose dupe
|
||||||
|
// lies inside another row's dupe.
|
||||||
|
func reclaimableBytes(dupes [][]*treeNode) int64 {
|
||||||
|
isDupe := make(map[*treeNode]bool)
|
||||||
|
|
||||||
|
for _, g := range dupes {
|
||||||
|
for _, n := range g[1:] {
|
||||||
|
isDupe[n] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var total int64
|
||||||
|
|
||||||
|
for n := range isDupe {
|
||||||
|
if !insideDupe(n, isDupe) {
|
||||||
|
total += n.totalSize
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return total
|
||||||
|
}
|
||||||
|
|
||||||
|
// insideDupe reports whether a directory above n is in isDupe.
|
||||||
|
func insideDupe(n *treeNode, isDupe map[*treeNode]bool) bool {
|
||||||
|
for p := n.parent; p != nil; p = p.parent {
|
||||||
|
if isDupe[p] {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
// treeBuilder reconstructs the directory hierarchy from records added
|
// treeBuilder reconstructs the directory hierarchy from records added
|
||||||
|
|||||||
@@ -313,7 +313,7 @@ func TestWriteTreeGroupsOnTerminal(t *testing.T) {
|
|||||||
label: treesPhase("write"), unit: "groups", total: int64(len(dupes)),
|
label: treesPhase("write"), unit: "groups", total: int64(len(dupes)),
|
||||||
}, terminalWidth, time.Hour, time.Now)
|
}, terminalWidth, time.Hour, time.Now)
|
||||||
|
|
||||||
_, _, err := writeTreeGroups(os.Stderr, dupes, p)
|
_, err := writeTreeGroups(os.Stderr, dupes, p)
|
||||||
|
|
||||||
p.finish()
|
p.finish()
|
||||||
|
|
||||||
@@ -587,3 +587,64 @@ func TestCollectTreeGroupsKeepsGroupLeftWithTwoCopies(t *testing.T) {
|
|||||||
t.Errorf("groups = %v, want %v", got, want)
|
t.Errorf("groups = %v, want %v", got, want)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestReclaimableBytesCountsNestedDupeOnce checks that a dupe tree
|
||||||
|
// inside another dupe tree adds nothing to the reclaimable bytes. /B/x
|
||||||
|
// lies in /B, so the total adds the sizes of /B and /C/x, 1500 + 1000.
|
||||||
|
func TestReclaimableBytesCountsNestedDupeOnce(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fh, ft, fc := testHash("fh"), testHash("ft"), testHash("fc")
|
||||||
|
gh, gt, gc := testHash("gh"), testHash("gt"), testHash("gc")
|
||||||
|
recs := []scanRec{
|
||||||
|
{size: 1000, head: fh, tail: ft, content: fc, path: "/A/x/f"},
|
||||||
|
{size: 500, head: gh, tail: gt, content: gc, path: "/A/y/g"},
|
||||||
|
{size: 1000, head: fh, tail: ft, content: fc, path: "/B/x/f"},
|
||||||
|
{size: 500, head: gh, tail: gt, content: gc, path: "/B/y/g"},
|
||||||
|
{size: 1000, head: fh, tail: ft, content: fc, path: "/C/x/f"},
|
||||||
|
}
|
||||||
|
|
||||||
|
super, dirs := treeOf(t, recs)
|
||||||
|
dupes := collectTreeGroups(dirs, super, everyPathExists, nil)
|
||||||
|
|
||||||
|
wantGroups := [][]string{{"/A", "/B"}, {"/A/x", "/B/x", "/C/x"}}
|
||||||
|
if got := groupPaths(dupes); !slices.EqualFunc(got, wantGroups,
|
||||||
|
slices.Equal) {
|
||||||
|
t.Fatalf("groups = %v, want %v", got, wantGroups)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := reclaimableBytes(dupes); got != 2500 {
|
||||||
|
t.Errorf("reclaimableBytes = %d, want 2500", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestReclaimableBytesCountsDupeInsideGrandparentDupeOnce checks that a
|
||||||
|
// dupe tree adds nothing when a dupe tree above its parent holds it.
|
||||||
|
// /B/m/x lies in /B, and /B/m is no dupe, since the group of /A and /B
|
||||||
|
// implies that of /A/m and /B/m. The total adds the sizes of /B and
|
||||||
|
// /C/x, 1300 + 1000.
|
||||||
|
func TestReclaimableBytesCountsDupeInsideGrandparentDupeOnce(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
f, w := testHash("f"), testHash("w")
|
||||||
|
recs := []scanRec{
|
||||||
|
{size: 1000, head: f, tail: f, content: f, path: "/A/m/x/f"},
|
||||||
|
{size: 300, head: w, tail: w, content: w, path: "/A/m/w"},
|
||||||
|
{size: 1000, head: f, tail: f, content: f, path: "/B/m/x/f"},
|
||||||
|
{size: 300, head: w, tail: w, content: w, path: "/B/m/w"},
|
||||||
|
{size: 1000, head: f, tail: f, content: f, path: "/C/x/f"},
|
||||||
|
}
|
||||||
|
|
||||||
|
super, dirs := treeOf(t, recs)
|
||||||
|
dupes := collectTreeGroups(dirs, super, everyPathExists, nil)
|
||||||
|
|
||||||
|
wantGroups := [][]string{{"/A", "/B"}, {"/A/m/x", "/B/m/x", "/C/x"}}
|
||||||
|
if got := groupPaths(dupes); !slices.EqualFunc(got, wantGroups,
|
||||||
|
slices.Equal) {
|
||||||
|
t.Fatalf("groups = %v, want %v", got, wantGroups)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := reclaimableBytes(dupes); got != 2300 {
|
||||||
|
t.Errorf("reclaimableBytes = %d, want 2300", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in new issue
Block a user