Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d8ca0c1f6c | ||
|
|
d63d3cc7fc |
@@ -152,16 +152,28 @@ All three subcommands operate on a single SQLite database file:
|
|||||||
use. `report` and `trees` require an existing database; a missing
|
use. `report` and `trees` require an existing database; a missing
|
||||||
database file is a fatal error (exit 1) telling the user to run
|
database file is a fatal error (exit 1) telling the user to run
|
||||||
`scan` first.
|
`scan` first.
|
||||||
- The database uses WAL journal mode and a busy timeout, so running a
|
- While `scan` runs, the database is in WAL journal mode with a busy
|
||||||
report while a cron `scan` is in progress is safe. The filesystem
|
timeout, so running a report while a cron `scan` is in progress is
|
||||||
is authoritative; the database is an eventually-consistent
|
safe. The filesystem is authoritative; the database is an
|
||||||
reflection of it. Hashed records are committed in batched
|
eventually-consistent reflection of it. Hashed records are
|
||||||
transactions while the scan is still running (keeping the WAL
|
committed in batched transactions while the scan is still running
|
||||||
small and letting concurrent reports observe progress), so a
|
(keeping the WAL small and letting concurrent reports observe
|
||||||
report may see a scan's changes partially applied, and a scan
|
progress), so a report may see a scan's changes partially applied,
|
||||||
that dies partway leaves a valid database holding everything
|
and a scan that dies partway leaves a valid database holding
|
||||||
hashed so far; the next scan skips those records and converges
|
everything hashed so far; the next scan skips those records and
|
||||||
toward the filesystem.
|
converges toward the filesystem.
|
||||||
|
- `scan` switches the database back to rollback-journal mode when it
|
||||||
|
closes it, so between scans the database file alone holds the whole
|
||||||
|
database. Each switch needs the database to itself: a `scan` that
|
||||||
|
starts while a report is still reading waits for it up to the
|
||||||
|
10-second busy timeout, then fails; a `scan` that ends while a
|
||||||
|
report has the database open warns and leaves the database in WAL
|
||||||
|
mode until the next scan.
|
||||||
|
- `report` and `trees` open the database read-only and need only read
|
||||||
|
access to the database file, and no write access to its directory.
|
||||||
|
While the database is in WAL mode they also read the `-wal` and
|
||||||
|
`-shm` files beside it, which SQLite creates with the database
|
||||||
|
file's permissions.
|
||||||
- Schema (`PRAGMA user_version` is the schema version, currently 1; a
|
- Schema (`PRAGMA user_version` is the schema version, currently 1; a
|
||||||
database with any other version is a fatal error):
|
database with any other version is a fatal error):
|
||||||
|
|
||||||
@@ -251,6 +263,18 @@ duplicates another or lies under another is dropped before walking,
|
|||||||
so every file is reached exactly once and produces one database
|
so every file is reached exactly once and produces one database
|
||||||
record.
|
record.
|
||||||
|
|
||||||
|
An operand that is a symlink (never followed, not even as an operand),
|
||||||
|
socket, FIFO, or device node, or a directory named `.zfs`, is not
|
||||||
|
scanned. `scan` prints a one-line warning naming the path and what it
|
||||||
|
is, counts it as skipped, and drops it from the scanned operands before
|
||||||
|
reading the database. Another operand beneath it is still scanned. The
|
||||||
|
records stored beneath it are not deleted: they are treated like any
|
||||||
|
other record outside the scanned operands, including the content-phase
|
||||||
|
exception below. If it lies under another operand, they are under that
|
||||||
|
operand instead, and are deleted like any other record there that this
|
||||||
|
scan did not verify. This is not an error: a scan whose every operand
|
||||||
|
is dropped walks nothing and exits 0.
|
||||||
|
|
||||||
`scan` synchronizes the database with the filesystem state under the
|
`scan` synchronizes the database with the filesystem state under the
|
||||||
scanned operands:
|
scanned operands:
|
||||||
|
|
||||||
@@ -356,9 +380,12 @@ during the hash phase:
|
|||||||
Rules for the walk:
|
Rules for the walk:
|
||||||
|
|
||||||
- Only regular files. Skip directories, symlinks (do not follow,
|
- Only regular files. Skip directories, symlinks (do not follow,
|
||||||
including symlink operands), sockets, FIFOs, and device nodes.
|
including symlink operands), sockets, FIFOs, and device nodes. An
|
||||||
|
operand that is a symlink, socket, FIFO, or device node is dropped
|
||||||
|
as described in "`scan` mode" above.
|
||||||
- Never descend into a directory named `.zfs` (ZFS snapshot pseudo-dirs;
|
- Never descend into a directory named `.zfs` (ZFS snapshot pseudo-dirs;
|
||||||
walking them would list every file once per snapshot).
|
walking them would list every file once per snapshot), not even
|
||||||
|
when it is an operand; such an operand is dropped the same way.
|
||||||
- Filesystem boundaries are crossed by default. With `-x`
|
- Filesystem boundaries are crossed by default. With `-x`
|
||||||
(long form `--one-file-system`, following the GNU `du`/`rsync`
|
(long form `--one-file-system`, following the GNU `du`/`rsync`
|
||||||
convention), never descend into a directory on a different
|
convention), never descend into a directory on a different
|
||||||
@@ -369,9 +396,11 @@ Rules for the walk:
|
|||||||
path, and continue. Per-file errors never abort the run; the final
|
path, and continue. Per-file errors never abort the run; the final
|
||||||
summary reports how many were skipped. As specified above, a
|
summary reports how many were skipped. As specified above, a
|
||||||
skipped path that has a database record from an earlier scan loses
|
skipped path that has a database record from an earlier scan loses
|
||||||
that record, unless it failed only in the content phase; an
|
that record, unless it failed only in the content phase, or is an
|
||||||
unreadable directory subtree likewise loses its records (accepted:
|
operand dropped before the database was read that lies under no
|
||||||
the database mirrors what the latest scan could actually verify).
|
other operand; an unreadable directory subtree likewise loses its
|
||||||
|
records (accepted: the database mirrors what the latest scan could
|
||||||
|
actually verify).
|
||||||
|
|
||||||
Concurrency: the walk phase (which also stats files), the hash phase,
|
Concurrency: the walk phase (which also stats files), the hash phase,
|
||||||
and the content phase each use a worker pool of `--workers` workers
|
and the content phase each use a worker pool of `--workers` workers
|
||||||
|
|||||||
@@ -29,6 +29,14 @@
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- warn about and skip symlink, socket, FIFO, device and `.zfs`
|
||||||
|
operands, keeping the records beneath them (2026-10-03,
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/9)
|
||||||
|
|
||||||
|
- `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, closes
|
||||||
|
https://git.eeqj.de/sneak/sfdupes/issues/8)
|
||||||
|
|
||||||
- escape tabs, newlines, carriage returns and backslashes in report,
|
- escape tabs, newlines, carriage returns and backslashes in report,
|
||||||
trees and warning paths; the root directory's path is `/`
|
trees and warning paths; the root directory's path is `/`
|
||||||
(2026-10-03, https://git.eeqj.de/sneak/sfdupes/issues/7)
|
(2026-10-03, https://git.eeqj.de/sneak/sfdupes/issues/7)
|
||||||
|
|||||||
@@ -74,16 +74,24 @@ func databasePath() string {
|
|||||||
return defaultDatabasePath
|
return defaultDatabasePath
|
||||||
}
|
}
|
||||||
|
|
||||||
// openDB opens the SQLite database at path with WAL journaling and a
|
// scanParams are the connection parameters for scan: read-write, with
|
||||||
// busy timeout, so a report can run while a cron scan is in progress.
|
// WAL journaling and a busy timeout, so a report can run while a cron
|
||||||
// It does not create or verify the schema.
|
// scan is in progress. closeScanDatabase leaves WAL mode again.
|
||||||
func openDB(path string) (*sql.DB, error) {
|
const scanParams = "_pragma=busy_timeout(10000)" +
|
||||||
dsn := "file:" + path +
|
"&_pragma=journal_mode(WAL)" +
|
||||||
"?_pragma=busy_timeout(10000)" +
|
"&_pragma=synchronous(NORMAL)"
|
||||||
"&_pragma=journal_mode(WAL)" +
|
|
||||||
"&_pragma=synchronous(NORMAL)"
|
|
||||||
|
|
||||||
db, err := sql.Open("sqlite", dsn)
|
// reportParams are the connection parameters for report and trees:
|
||||||
|
// read-only, with the same busy timeout. They set no journal mode,
|
||||||
|
// because setting one is a write.
|
||||||
|
const reportParams = "mode=ro" +
|
||||||
|
"&_pragma=busy_timeout(10000)" +
|
||||||
|
"&_pragma=query_only(1)"
|
||||||
|
|
||||||
|
// openDB opens the SQLite database at path with the connection
|
||||||
|
// parameters params. It does not create or verify the schema.
|
||||||
|
func openDB(path, params string) (*sql.DB, error) {
|
||||||
|
db, err := sql.Open("sqlite", "file:"+path+"?"+params)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("open database %s: %w", path, err)
|
return nil, fmt.Errorf("open database %s: %w", path, err)
|
||||||
}
|
}
|
||||||
@@ -104,7 +112,7 @@ func openScanDatabase(ctx context.Context, path string) (*sql.DB, error) {
|
|||||||
return nil, fmt.Errorf("create database directory: %w", err)
|
return nil, fmt.Errorf("create database directory: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
db, err := openDB(path)
|
db, err := openDB(path, scanParams)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -119,6 +127,24 @@ func openScanDatabase(ctx context.Context, path string) (*sql.DB, error) {
|
|||||||
return db, nil
|
return db, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// closeScanDatabase switches the database at path from WAL back to
|
||||||
|
// rollback-journal mode and closes it. Out of WAL mode the database
|
||||||
|
// file alone holds the whole database, so a reader needs no -wal or
|
||||||
|
// -shm file beside it, nor write access to create them. The switch
|
||||||
|
// fails while a report has the database open; the database then stays
|
||||||
|
// in WAL mode, still readable, until a later scan closes it.
|
||||||
|
func closeScanDatabase(ctx context.Context, db *sql.DB, path string) {
|
||||||
|
// Runs on the way out of a cancelled scan too.
|
||||||
|
_, err := db.ExecContext(context.WithoutCancel(ctx),
|
||||||
|
"PRAGMA journal_mode = DELETE")
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "scan: database %s left in WAL mode: %v\n",
|
||||||
|
path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_ = db.Close()
|
||||||
|
}
|
||||||
|
|
||||||
// openReportDatabase opens an existing database for the report and
|
// openReportDatabase opens an existing database for the report and
|
||||||
// trees subcommands. A missing database file is an error directing the
|
// trees subcommands. A missing database file is an error directing the
|
||||||
// user to run scan first; the schema version must match exactly.
|
// user to run scan first; the schema version must match exactly.
|
||||||
@@ -134,7 +160,7 @@ func openReportDatabase(ctx context.Context,
|
|||||||
return nil, fmt.Errorf("database: %w", err)
|
return nil, fmt.Errorf("database: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
db, err := openDB(path)
|
db, err := openDB(path, reportParams)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|||||||
+44
@@ -5,6 +5,7 @@ import (
|
|||||||
"database/sql"
|
"database/sql"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"slices"
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -130,6 +131,49 @@ func TestOpenReportDatabaseOK(t *testing.T) {
|
|||||||
_ = db.Close()
|
_ = db.Close()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCloseScanDatabaseWhileReportOpen(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// A report holding the database open stops scan from taking it out
|
||||||
|
// of WAL mode. The -wal and -shm files must then stay beside it, so
|
||||||
|
// that a later report still needs only read access.
|
||||||
|
path := testDBPath(t)
|
||||||
|
|
||||||
|
scanDB, err := openScanDatabase(t.Context(), path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
reportDB, err := openReportDatabase(t.Context(), path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
closeScanDatabase(t.Context(), scanDB, path)
|
||||||
|
|
||||||
|
_ = reportDB.Close()
|
||||||
|
|
||||||
|
_, err = os.Stat(path + "-wal")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("no -wal left: the switch out of WAL mode was not "+
|
||||||
|
"stopped: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
makeReadOnly(t, path)
|
||||||
|
|
||||||
|
reportDB, err = openReportDatabase(t.Context(), path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("openReportDatabase: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = reportDB.Close() }()
|
||||||
|
|
||||||
|
_, err = loadFileRows(t.Context(), reportDB)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("loadFileRows: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestApplyChangesRoundTrip(t *testing.T) {
|
func TestApplyChangesRoundTrip(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
|||||||
+207
-16
@@ -44,6 +44,44 @@ func assertNoSidecars(t *testing.T, path string) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// makeReadOnly takes write permission away from the database at path,
|
||||||
|
// from any WAL sidecar beside it, and from their directory, as for a
|
||||||
|
// user reading a database that a root cron scan keeps. Root ignores
|
||||||
|
// file permissions, so it skips the test when run as root.
|
||||||
|
func makeReadOnly(t *testing.T, path string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
if os.Geteuid() == 0 {
|
||||||
|
t.Skip("root ignores file permissions")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := os.Chmod(path, 0o400)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, suffix := range walSuffixes {
|
||||||
|
err = os.Chmod(path+suffix, 0o400)
|
||||||
|
if err != nil && !errors.Is(err, fs.ErrNotExist) {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dir := filepath.Dir(path)
|
||||||
|
|
||||||
|
//nolint:gosec // reaching the database needs the search bit
|
||||||
|
err = os.Chmod(dir, 0o500)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Runs before t.TempDir's own cleanup, which must delete the files.
|
||||||
|
t.Cleanup(func() {
|
||||||
|
//nolint:gosec // removing the directory needs its search bit back
|
||||||
|
_ = os.Chmod(dir, 0o700)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
// captureStdout redirects os.Stdout to a file for the rest of the test
|
// captureStdout redirects os.Stdout to a file for the rest of the test
|
||||||
// and returns a function reading back everything written to it. Only
|
// and returns a function reading back everything written to it. Only
|
||||||
// machine-readable data belongs on stdout (README design goal 4), so
|
// machine-readable data belongs on stdout (README design goal 4), so
|
||||||
@@ -51,16 +89,25 @@ func assertNoSidecars(t *testing.T, path string) {
|
|||||||
func captureStdout(t *testing.T) func() string {
|
func captureStdout(t *testing.T) func() string {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
f, err := os.Create(filepath.Join(t.TempDir(), "stdout"))
|
return captureStream(t, &os.Stdout)
|
||||||
|
}
|
||||||
|
|
||||||
|
// captureStream redirects *stream (os.Stdout or os.Stderr) to a file
|
||||||
|
// for the rest of the test and returns a function reading back
|
||||||
|
// everything written to it.
|
||||||
|
func captureStream(t *testing.T, stream **os.File) func() string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
f, err := os.Create(filepath.Join(t.TempDir(), "capture"))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
saved := os.Stdout
|
saved := *stream
|
||||||
os.Stdout = f
|
*stream = f
|
||||||
|
|
||||||
t.Cleanup(func() {
|
t.Cleanup(func() {
|
||||||
os.Stdout = saved
|
*stream = saved
|
||||||
|
|
||||||
_ = f.Close()
|
_ = f.Close()
|
||||||
})
|
})
|
||||||
@@ -91,13 +138,13 @@ func captureStdout(t *testing.T) func() string {
|
|||||||
// brokenDatabase writes a database that opens cleanly and passes the
|
// brokenDatabase writes a database that opens cleanly and passes the
|
||||||
// schema-version check but has no files table, so the first query
|
// schema-version check but has no files table, so the first query
|
||||||
// fails with the database already open: a fatal error on a path that
|
// fails with the database already open: a fatal error on a path that
|
||||||
// owns an open database.
|
// owns an open database. It closes the database the way scan does.
|
||||||
func brokenDatabase(t *testing.T) string {
|
func brokenDatabase(t *testing.T) string {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
path := testDBPath(t)
|
path := testDBPath(t)
|
||||||
|
|
||||||
db, err := openDB(path)
|
db, err := openDB(path, scanParams)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -108,10 +155,7 @@ func brokenDatabase(t *testing.T) string {
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = db.Close()
|
closeScanDatabase(t.Context(), db, path)
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return path
|
return path
|
||||||
}
|
}
|
||||||
@@ -144,7 +188,10 @@ func TestOpenDatabaseKeepsWALWhileOpen(t *testing.T) {
|
|||||||
|
|
||||||
func TestRunFatalAfterOpenClosesDatabase(t *testing.T) {
|
func TestRunFatalAfterOpenClosesDatabase(t *testing.T) {
|
||||||
// Every subcommand that owns an open database must close it when
|
// Every subcommand that owns an open database must close it when
|
||||||
// it fails: no os.Exit between the open and the return.
|
// it fails: no os.Exit between the open and the return. The
|
||||||
|
// sidecar check is evidence of the close only for scan: report and
|
||||||
|
// trees only read a database that is out of WAL mode, which leaves
|
||||||
|
// nothing on disk whether they close it or not.
|
||||||
cases := map[string][]string{
|
cases := map[string][]string{
|
||||||
cmdScan: {cmdScan},
|
cmdScan: {cmdScan},
|
||||||
cmdReport: {cmdReport},
|
cmdReport: {cmdReport},
|
||||||
@@ -320,21 +367,30 @@ func scanFixture(t *testing.T) []string {
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
var stderr bytes.Buffer
|
scanOK(t, dir)
|
||||||
|
|
||||||
|
return dupes
|
||||||
|
}
|
||||||
|
|
||||||
|
// scanOK runs scan over operands, fails the test unless it exits 0 with
|
||||||
|
// nothing on stdout, and returns everything it printed to stderr.
|
||||||
|
func scanOK(t *testing.T, operands ...string) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
stdout := captureStdout(t)
|
stdout := captureStdout(t)
|
||||||
|
stderr := captureStream(t, &os.Stderr)
|
||||||
|
|
||||||
code := run([]string{cmdScan, dir}, &stderr)
|
code := run(append([]string{cmdScan}, operands...), os.Stderr)
|
||||||
if code != exitOK {
|
if code != exitOK {
|
||||||
t.Fatalf("run(scan) = %d, want %d; stderr: %s",
|
t.Fatalf("run(scan %q) = %d, want %d; stderr: %s",
|
||||||
code, exitOK, stderr.String())
|
operands, code, exitOK, stderr())
|
||||||
}
|
}
|
||||||
|
|
||||||
if got := stdout(); got != "" {
|
if got := stdout(); got != "" {
|
||||||
t.Errorf("scan stdout = %q, want nothing (data only)", got)
|
t.Errorf("scan stdout = %q, want nothing (data only)", got)
|
||||||
}
|
}
|
||||||
|
|
||||||
return dupes
|
return stderr()
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRunScanSucceedsDespiteWarnings(t *testing.T) {
|
func TestRunScanSucceedsDespiteWarnings(t *testing.T) {
|
||||||
@@ -345,6 +401,103 @@ func TestRunScanSucceedsDespiteWarnings(t *testing.T) {
|
|||||||
assertNoSidecars(t, path)
|
assertNoSidecars(t, path)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRunScanSkipsSymlinkOperand(t *testing.T) {
|
||||||
|
path := testDBPath(t)
|
||||||
|
t.Setenv(databaseEnv, path)
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
writeFile(t, dir, "target/sub/f", pattern(1, 10))
|
||||||
|
|
||||||
|
link := filepath.Join(dir, "link")
|
||||||
|
|
||||||
|
err := os.Symlink(filepath.Join(dir, "target"), link)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Scanning a directory through the symlink stores a record beneath
|
||||||
|
// the symlink's own path for a file beneath its target.
|
||||||
|
scanOK(t, filepath.Join(link, "sub"))
|
||||||
|
|
||||||
|
assertOperandSkipped(t, path, link, "symlink",
|
||||||
|
filepath.Join(link, "sub", "f"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunScanWalksOperandUnderSymlinkOperand(t *testing.T) {
|
||||||
|
path := testDBPath(t)
|
||||||
|
t.Setenv(databaseEnv, path)
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
writeFile(t, dir, "target/sub/f", pattern(1, 10))
|
||||||
|
|
||||||
|
link := filepath.Join(dir, "link")
|
||||||
|
|
||||||
|
err := os.Symlink(filepath.Join(dir, "target"), link)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// link is dropped as a symlink, but link/sub must still be scanned,
|
||||||
|
// not dropped as lying under link.
|
||||||
|
scanOK(t, link, filepath.Join(link, "sub"))
|
||||||
|
|
||||||
|
db, err := openDB(path, reportParams)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Cleanup(func() { _ = db.Close() })
|
||||||
|
|
||||||
|
recordByPath(t, dbRecords(t, db), filepath.Join(link, "sub", "f"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunScanSkipsZFSOperand(t *testing.T) {
|
||||||
|
path := testDBPath(t)
|
||||||
|
t.Setenv(databaseEnv, path)
|
||||||
|
|
||||||
|
zfs := filepath.Join(t.TempDir(), ".zfs")
|
||||||
|
snapshot := filepath.Join(zfs, "snapshot", "hourly")
|
||||||
|
f := writeFile(t, snapshot, "f", pattern(1, 10))
|
||||||
|
|
||||||
|
// An operand beneath a .zfs directory is walked, because it is not
|
||||||
|
// itself named .zfs.
|
||||||
|
scanOK(t, snapshot)
|
||||||
|
|
||||||
|
assertOperandSkipped(t, path, zfs, ".zfs directory", f)
|
||||||
|
}
|
||||||
|
|
||||||
|
// assertOperandSkipped scans operand alone and checks that it is skipped
|
||||||
|
// as kind: a warning naming it, one skip in the summary, exit 0, and the
|
||||||
|
// record for kept, which an earlier scan stored beneath operand, still
|
||||||
|
// in the database at dbPath.
|
||||||
|
func assertOperandSkipped(t *testing.T, dbPath, operand, kind,
|
||||||
|
kept string,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
stderr := scanOK(t, operand)
|
||||||
|
|
||||||
|
warning := "walk " + operand + ": skipping " + kind + " operand\n"
|
||||||
|
if !strings.Contains(stderr, warning) {
|
||||||
|
t.Errorf("stderr = %q, want %q", stderr, warning)
|
||||||
|
}
|
||||||
|
|
||||||
|
summary := "scan: 0 files seen (0 added, 0 updated, 0 removed, " +
|
||||||
|
"0 unchanged), 1 skipped\n"
|
||||||
|
if !strings.Contains(stderr, summary) {
|
||||||
|
t.Errorf("stderr = %q, want %q", stderr, summary)
|
||||||
|
}
|
||||||
|
|
||||||
|
db, err := openDB(dbPath, reportParams)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Cleanup(func() { _ = db.Close() })
|
||||||
|
|
||||||
|
recordByPath(t, dbRecords(t, db), kept)
|
||||||
|
}
|
||||||
|
|
||||||
func TestRunReportSucceeds(t *testing.T) {
|
func TestRunReportSucceeds(t *testing.T) {
|
||||||
path := testDBPath(t)
|
path := testDBPath(t)
|
||||||
t.Setenv(databaseEnv, path)
|
t.Setenv(databaseEnv, path)
|
||||||
@@ -395,3 +548,41 @@ func TestRunTreesSucceeds(t *testing.T) {
|
|||||||
|
|
||||||
assertNoSidecars(t, path)
|
assertNoSidecars(t, path)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRunReportsNeedOnlyReadAccess(t *testing.T) {
|
||||||
|
// README §Database: report and trees need only read access to the
|
||||||
|
// database file. With its directory read-only as well, SQLite
|
||||||
|
// cannot create any file beside it.
|
||||||
|
path := testDBPath(t)
|
||||||
|
t.Setenv(databaseEnv, path)
|
||||||
|
|
||||||
|
dupes := scanFixture(t)
|
||||||
|
assertNoSidecars(t, path)
|
||||||
|
makeReadOnly(t, path)
|
||||||
|
|
||||||
|
cases := map[string]string{
|
||||||
|
cmdReport: "first\tdupe\tsize\n" +
|
||||||
|
dupes[0] + "\t" + dupes[1] + "\t300\n",
|
||||||
|
cmdTrees: "first\tdupe\tfiles\tsize\n" +
|
||||||
|
filepath.Dir(dupes[0]) + "\t" + filepath.Dir(dupes[1]) +
|
||||||
|
"\t1\t300\n",
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, want := range cases {
|
||||||
|
var stderr bytes.Buffer
|
||||||
|
|
||||||
|
stdout := captureStdout(t)
|
||||||
|
|
||||||
|
code := run([]string{name}, &stderr)
|
||||||
|
if code != exitOK {
|
||||||
|
t.Errorf("run(%s) = %d, want %d; stderr: %s",
|
||||||
|
name, code, exitOK, stderr.String())
|
||||||
|
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := stdout(); got != want {
|
||||||
|
t.Errorf("%s stdout = %q, want %q", name, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -31,9 +31,9 @@ type scanRec struct {
|
|||||||
// loadRecords opens the database and reads every file record for the
|
// loadRecords opens the database and reads every file record for the
|
||||||
// report and trees subcommands. Any database problem — including a
|
// report and trees subcommands. Any database problem — including a
|
||||||
// missing database — is fatal. The error is returned rather than
|
// missing database — is fatal. The error is returned rather than
|
||||||
// exiting, so that the deferred close — which checkpoints the SQLite
|
// exiting, so that the deferred close always runs; the database is
|
||||||
// WAL — always runs; the database is closed before the caller formats
|
// closed before the caller formats its output, so it stays closed even
|
||||||
// its output, so it stays closed even if that output fails.
|
// if that output fails.
|
||||||
func loadRecords(ctx context.Context) ([]scanRec, error) {
|
func loadRecords(ctx context.Context) ([]scanRec, error) {
|
||||||
dbPath := databasePath()
|
dbPath := databasePath()
|
||||||
|
|
||||||
|
|||||||
@@ -87,8 +87,9 @@ type fileMeta struct {
|
|||||||
// hash only when its size, head, and tail match another file's. Flag
|
// hash only when its size, head, and tail match another file's. Flag
|
||||||
// parsing and the at-least-one-operand check are done by cobra. Errors
|
// parsing and the at-least-one-operand check are done by cobra. Errors
|
||||||
// are returned rather than exiting, so that the deferred close — which
|
// are returned rather than exiting, so that the deferred close — which
|
||||||
// checkpoints the SQLite WAL — always runs. Cancelling ctx unwinds the
|
// takes the database out of WAL mode — always runs. Cancelling ctx
|
||||||
// worker pools and aborts the scan with the context's error.
|
// unwinds the worker pools and aborts the scan with the context's
|
||||||
|
// error.
|
||||||
func runScan(ctx context.Context, roots []string, workers int,
|
func runScan(ctx context.Context, roots []string, workers int,
|
||||||
oneFS bool,
|
oneFS bool,
|
||||||
) error {
|
) error {
|
||||||
@@ -108,7 +109,7 @@ func runScan(ctx context.Context, roots []string, workers int,
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
defer func() { _ = db.Close() }()
|
defer closeScanDatabase(ctx, db, dbPath)
|
||||||
|
|
||||||
st, err := syncScan(ctx, db, roots, workers, oneFS)
|
st, err := syncScan(ctx, db, roots, workers, oneFS)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -210,14 +211,18 @@ type scanState struct {
|
|||||||
// in the content hash of every record of headTailMin or more whose
|
// in the content hash of every record of headTailMin or more whose
|
||||||
// size, head, and tail match another record's). Records outside the
|
// size, head, and tail match another record's). Records outside the
|
||||||
// roots are never touched, except that the content phase fills in
|
// roots are never touched, except that the content phase fills in
|
||||||
// their content hash.
|
// their content hash. Operands the walk cannot start from are dropped
|
||||||
|
// first, so the records beneath them count as outside the roots unless
|
||||||
|
// they lie under another root.
|
||||||
func syncScan(ctx context.Context, db *sql.DB, roots []string,
|
func syncScan(ctx context.Context, db *sql.DB, roots []string,
|
||||||
workers int, oneFS bool,
|
workers int, oneFS bool,
|
||||||
) (scanStats, error) {
|
) (scanStats, error) {
|
||||||
roots = pruneRoots(roots)
|
|
||||||
|
|
||||||
s := &scanState{db: db}
|
s := &scanState{db: db}
|
||||||
|
|
||||||
|
// Types are checked before pruning so that an operand under a
|
||||||
|
// dropped one is still scanned, not dropped as lying under it.
|
||||||
|
roots = pruneRoots(s.walkableRoots(roots))
|
||||||
|
|
||||||
err := s.loadIndex(ctx, roots)
|
err := s.loadIndex(ctx, roots)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return s.st, err
|
return s.st, err
|
||||||
@@ -253,6 +258,35 @@ func syncScan(ctx context.Context, db *sql.DB, roots []string,
|
|||||||
return s.st, s.contentPhase(ctx, workers)
|
return s.st, s.contentPhase(ctx, workers)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// walkableRoots returns the operands the walk can start from: regular
|
||||||
|
// files, and directories not named .zfs. Every other operand is warned
|
||||||
|
// about, counted as skipped, and dropped. A dropped operand is no
|
||||||
|
// longer a root, so the records stored beneath it count as outside the
|
||||||
|
// roots and are not deleted as unverified, unless it lies under another
|
||||||
|
// root. An operand that fails lstat here is kept, and the walk warns
|
||||||
|
// about it.
|
||||||
|
func (s *scanState) walkableRoots(roots []string) []string {
|
||||||
|
kept := make([]string, 0, len(roots))
|
||||||
|
|
||||||
|
for _, root := range roots {
|
||||||
|
fi, err := os.Lstat(root)
|
||||||
|
if err == nil {
|
||||||
|
warn := operandWarning(root, fi)
|
||||||
|
if warn != "" {
|
||||||
|
s.st.skipped++
|
||||||
|
|
||||||
|
fmt.Fprintln(os.Stderr, escapePath(warn))
|
||||||
|
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
kept = append(kept, root)
|
||||||
|
}
|
||||||
|
|
||||||
|
return kept
|
||||||
|
}
|
||||||
|
|
||||||
// loadIndex indexes the database records under the scan roots for
|
// loadIndex indexes the database records under the scan roots for
|
||||||
// change detection and collects the sizes of every record outside
|
// change detection and collects the sizes of every record outside
|
||||||
// them: out-of-scope records join the size census so a scanned file
|
// them: out-of-scope records join the size census so a scanned file
|
||||||
@@ -789,11 +823,43 @@ func sendEvent(ctx context.Context, events chan<- walkEvent,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// operandWarning returns the one-line warning for an operand the walk
|
||||||
|
// does not start from, naming the path and what it is, or "" for one it
|
||||||
|
// does: a regular file, or a directory not named .zfs. Symlinks are
|
||||||
|
// never followed, including as operands.
|
||||||
|
func operandWarning(root string, fi fs.FileInfo) string {
|
||||||
|
var kind string
|
||||||
|
|
||||||
|
switch mode := fi.Mode(); {
|
||||||
|
case mode.IsRegular():
|
||||||
|
return ""
|
||||||
|
case mode.IsDir():
|
||||||
|
if filepath.Base(root) != ".zfs" {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
kind = ".zfs directory"
|
||||||
|
case mode&fs.ModeSymlink != 0:
|
||||||
|
kind = "symlink"
|
||||||
|
case mode&fs.ModeSocket != 0:
|
||||||
|
kind = "socket"
|
||||||
|
case mode&fs.ModeNamedPipe != 0:
|
||||||
|
kind = "FIFO"
|
||||||
|
case mode&fs.ModeDevice != 0:
|
||||||
|
kind = "device node"
|
||||||
|
default:
|
||||||
|
kind = "non-regular file"
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf("walk %s: skipping %s operand", root, kind)
|
||||||
|
}
|
||||||
|
|
||||||
// seedRoot turns one PATH operand into the walk's starting state: a
|
// seedRoot turns one PATH operand into the walk's starting state: a
|
||||||
// regular-file operand is statted and emitted directly, a directory
|
// regular-file operand is statted and emitted directly, and a directory
|
||||||
// operand becomes an initial job, and a symlink or other non-regular
|
// operand becomes an initial job. walkableRoots has already dropped
|
||||||
// operand yields nothing (symlinks are never followed, including as
|
// every other operand. One that has changed into something else since
|
||||||
// operands).
|
// is warned about and skipped here; it is still a root, so the records
|
||||||
|
// stored beneath it are deleted as unverified.
|
||||||
func seedRoot(ctx context.Context, root string,
|
func seedRoot(ctx context.Context, root string,
|
||||||
events chan<- walkEvent,
|
events chan<- walkEvent,
|
||||||
) []dirJob {
|
) []dirJob {
|
||||||
@@ -807,30 +873,30 @@ func seedRoot(ctx context.Context, root string,
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
switch {
|
warn := operandWarning(root, fi)
|
||||||
case fi.IsDir():
|
if warn != "" {
|
||||||
if filepath.Base(root) == ".zfs" {
|
sendEvent(ctx, events, walkEvent{warn: warn, fail: true})
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if fi.IsDir() {
|
||||||
dev, ok := deviceOfInfo(fi)
|
dev, ok := deviceOfInfo(fi)
|
||||||
|
|
||||||
return []dirJob{{path: root, rootDev: dev, rootDevOK: ok}}
|
return []dirJob{{path: root, rootDev: dev, rootDevOK: ok}}
|
||||||
case fi.Mode().IsRegular():
|
|
||||||
dev, ino := inodeOfInfo(fi)
|
|
||||||
|
|
||||||
sendEvent(ctx, events, walkEvent{rec: fileRec{
|
|
||||||
path: root,
|
|
||||||
size: fi.Size(),
|
|
||||||
mtime: fi.ModTime().Unix(),
|
|
||||||
dev: dev,
|
|
||||||
ino: ino,
|
|
||||||
}})
|
|
||||||
|
|
||||||
return nil
|
|
||||||
default:
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
dev, ino := inodeOfInfo(fi)
|
||||||
|
|
||||||
|
sendEvent(ctx, events, walkEvent{rec: fileRec{
|
||||||
|
path: root,
|
||||||
|
size: fi.Size(),
|
||||||
|
mtime: fi.ModTime().Unix(),
|
||||||
|
dev: dev,
|
||||||
|
ino: ino,
|
||||||
|
}})
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// startWalkWorkers starts the walk worker pool. Each worker processes
|
// startWalkWorkers starts the walk worker pool. Each worker processes
|
||||||
|
|||||||
+4
-2
@@ -856,9 +856,11 @@ func TestWalkFileAndSymlinkOperands(t *testing.T) {
|
|||||||
t.Fatalf("file operand: recs = %+v, errs = %d", recs, errs)
|
t.Fatalf("file operand: recs = %+v, errs = %d", recs, errs)
|
||||||
}
|
}
|
||||||
|
|
||||||
// A symlink operand is not followed and yields nothing.
|
// A symlink operand that reaches the walk (it became one after
|
||||||
|
// walkableRoots checked it) is not followed: it yields a warning and
|
||||||
|
// no records.
|
||||||
recs, errs = collectWalk(t, []string{link}, false, 2)
|
recs, errs = collectWalk(t, []string{link}, false, 2)
|
||||||
if errs != 0 || len(recs) != 0 {
|
if errs != 1 || len(recs) != 0 {
|
||||||
t.Fatalf("symlink operand: recs = %+v, errs = %d", recs, errs)
|
t.Fatalf("symlink operand: recs = %+v, errs = %d", recs, errs)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user