|
| 1 | +package store |
| 2 | + |
| 3 | +import ( |
| 4 | + "database/sql" |
| 5 | + "os" |
| 6 | + "path/filepath" |
| 7 | + "testing" |
| 8 | + |
| 9 | + "github.com/tompscanlan/coinrollhunter/internal/model" |
| 10 | +) |
| 11 | + |
| 12 | +// sqlOpen reaches past Store to the raw driver, so a test can stand up a database |
| 13 | +// at an arbitrary schema version without Open() migrating it out from under us. |
| 14 | +func sqlOpen(path string) (*sql.DB, error) { return sql.Open("sqlite", path) } |
| 15 | + |
| 16 | +// The claim Backup makes is specifically that it works on a LIVE database — the app |
| 17 | +// is open, the server is running, you did not stop anything. So test it that way: |
| 18 | +// write, back up without closing, and check the snapshot is complete and readable |
| 19 | +// on its own. |
| 20 | +func TestBackupSnapshotsALiveDatabase(t *testing.T) { |
| 21 | + dir := t.TempDir() |
| 22 | + src := filepath.Join(dir, "crh.db") |
| 23 | + |
| 24 | + s, err := Open(src) |
| 25 | + if err != nil { |
| 26 | + t.Fatal(err) |
| 27 | + } |
| 28 | + defer s.Close() |
| 29 | + |
| 30 | + typeID, err := s.InsertItemType(model.ItemType{Kind: "coin", Name: "Mercury Dime", Metal: "silver", FineOzEach: 0.0723}) |
| 31 | + if err != nil { |
| 32 | + t.Fatal(err) |
| 33 | + } |
| 34 | + for i := 0; i < 50; i++ { |
| 35 | + if _, err := s.InsertHolding(model.Holding{ |
| 36 | + ItemTypeID: typeID, Activity: "crh", Qty: 1, BasisUSD: 0.10, Acquired: "2026-07-01", |
| 37 | + }); err != nil { |
| 38 | + t.Fatal(err) |
| 39 | + } |
| 40 | + } |
| 41 | + |
| 42 | + dest := filepath.Join(dir, "backup.db") |
| 43 | + if err := s.Backup(dest); err != nil { |
| 44 | + t.Fatal(err) |
| 45 | + } |
| 46 | + |
| 47 | + // One file, no sidecars. That is the property that makes it copyable: a -wal or |
| 48 | + // -shm left beside it would mean the snapshot is incomplete on its own. |
| 49 | + for _, sidecar := range []string{dest + "-wal", dest + "-shm"} { |
| 50 | + if _, err := os.Stat(sidecar); err == nil { |
| 51 | + t.Errorf("backup left a %s sidecar — the file is not self-contained", filepath.Base(sidecar)) |
| 52 | + } |
| 53 | + } |
| 54 | + |
| 55 | + // The source is still open and usable; a backup must not disturb it. |
| 56 | + if _, err := s.InsertHolding(model.Holding{ItemTypeID: typeID, Activity: "crh", Qty: 1, BasisUSD: 0.10, Acquired: "2026-07-02"}); err != nil { |
| 57 | + t.Fatalf("source database broken after backup: %v", err) |
| 58 | + } |
| 59 | + |
| 60 | + // The snapshot opens standalone and carries every row committed before it ran — |
| 61 | + // and not the one committed after. |
| 62 | + b, err := Open(dest) |
| 63 | + if err != nil { |
| 64 | + t.Fatalf("backup will not open: %v", err) |
| 65 | + } |
| 66 | + defer b.Close() |
| 67 | + |
| 68 | + var n int |
| 69 | + if err := b.db.QueryRow(`SELECT count(*) FROM lots`).Scan(&n); err != nil { |
| 70 | + t.Fatal(err) |
| 71 | + } |
| 72 | + if n != 50 { |
| 73 | + t.Errorf("backup has %d lots, want the 50 committed before it ran", n) |
| 74 | + } |
| 75 | + everyRowHasAUID(t, b) |
| 76 | + |
| 77 | + var ver int |
| 78 | + if err := b.db.QueryRow(`PRAGMA user_version`).Scan(&ver); err != nil { |
| 79 | + t.Fatal(err) |
| 80 | + } |
| 81 | + if srcVer, _ := s.Version(); ver != srcVer { |
| 82 | + t.Errorf("backup schema version %d != source %d", ver, srcVer) |
| 83 | + } |
| 84 | +} |
| 85 | + |
| 86 | +// The backup you most want is the one taken *before* an upgrade — so BackupFile |
| 87 | +// must not migrate the source on its way through. Open() does, which is why the CLI |
| 88 | +// does not go through it. |
| 89 | +func TestBackupFileDoesNotMigrateTheSource(t *testing.T) { |
| 90 | + dir := t.TempDir() |
| 91 | + src := filepath.Join(dir, "old.db") |
| 92 | + |
| 93 | + // A database from an older release: schema version 0, none of our tables. |
| 94 | + db, err := sqlOpen(src) |
| 95 | + if err != nil { |
| 96 | + t.Fatal(err) |
| 97 | + } |
| 98 | + if _, err := db.Exec(`CREATE TABLE lots (id INTEGER PRIMARY KEY); PRAGMA user_version = 4`); err != nil { |
| 99 | + t.Fatal(err) |
| 100 | + } |
| 101 | + db.Close() |
| 102 | + |
| 103 | + dest := filepath.Join(dir, "snap.db") |
| 104 | + if err := BackupFile(src, dest); err != nil { |
| 105 | + t.Fatal(err) |
| 106 | + } |
| 107 | + |
| 108 | + for name, path := range map[string]string{"source": src, "snapshot": dest} { |
| 109 | + d, err := sqlOpen(path) |
| 110 | + if err != nil { |
| 111 | + t.Fatal(err) |
| 112 | + } |
| 113 | + var v int |
| 114 | + if err := d.QueryRow(`PRAGMA user_version`).Scan(&v); err != nil { |
| 115 | + t.Fatal(err) |
| 116 | + } |
| 117 | + d.Close() |
| 118 | + if v != 4 { |
| 119 | + t.Errorf("%s is at schema version %d, want 4 — backup migrated it", name, v) |
| 120 | + } |
| 121 | + } |
| 122 | +} |
| 123 | + |
| 124 | +// A backup command that can silently overwrite the previous backup is a footgun in |
| 125 | +// the one place you least want one. |
| 126 | +func TestBackupRefusesToOverwrite(t *testing.T) { |
| 127 | + dir := t.TempDir() |
| 128 | + s, err := Open(filepath.Join(dir, "crh.db")) |
| 129 | + if err != nil { |
| 130 | + t.Fatal(err) |
| 131 | + } |
| 132 | + defer s.Close() |
| 133 | + |
| 134 | + dest := filepath.Join(dir, "backup.db") |
| 135 | + if err := os.WriteFile(dest, []byte("an earlier backup"), 0o644); err != nil { |
| 136 | + t.Fatal(err) |
| 137 | + } |
| 138 | + if err := s.Backup(dest); err == nil { |
| 139 | + t.Fatal("Backup overwrote an existing file") |
| 140 | + } |
| 141 | + got, err := os.ReadFile(dest) |
| 142 | + if err != nil { |
| 143 | + t.Fatal(err) |
| 144 | + } |
| 145 | + if string(got) != "an earlier backup" { |
| 146 | + t.Error("the existing backup was clobbered") |
| 147 | + } |
| 148 | +} |
0 commit comments