1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
package persistence
import (
"os"
"path/filepath"
"strings"
"testing"
)
func writeTestFile(t *testing.T, path, content string) {
t.Helper()
if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(path, []byte(content), 0644); err != nil {
t.Fatal(err)
}
}
func readTestFile(t *testing.T, path string) string {
t.Helper()
data, err := os.ReadFile(path)
if err != nil {
t.Fatal(err)
}
return string(data)
}
func TestTxnCommitAppliesAllOps(t *testing.T) {
dir := t.TempDir()
journalDir := filepath.Join(dir, ".journal")
writeTestFile(t, filepath.Join(dir, "a.yaml"), "old-a")
writeTestFile(t, filepath.Join(dir, "b.yaml"), "old-b")
writeTestFile(t, filepath.Join(dir, "c.yaml"), "old-c")
txn := NewTransaction(journalDir)
if err := txn.Replace(filepath.Join(dir, "a.yaml"), []byte("new-a"), 0644); err != nil {
t.Fatal(err)
}
if err := txn.Delete(filepath.Join(dir, "b.yaml")); err != nil {
t.Fatal(err)
}
if err := txn.Move(filepath.Join(dir, "c.yaml"), filepath.Join(dir, "d.yaml")); err != nil {
t.Fatal(err)
}
if err := txn.Replace(filepath.Join(dir, "created.yaml"), []byte("created"), 0600); err != nil {
t.Fatal(err)
}
if err := txn.Commit(); err != nil {
t.Fatalf("commit: %v", err)
}
if got := readTestFile(t, filepath.Join(dir, "a.yaml")); got != "new-a" {
t.Fatalf("replace failed: %q", got)
}
if _, err := os.Stat(filepath.Join(dir, "b.yaml")); !os.IsNotExist(err) {
t.Fatalf("delete failed: %v", err)
}
if _, err := os.Stat(filepath.Join(dir, "c.yaml")); !os.IsNotExist(err) {
t.Fatalf("move left source behind: %v", err)
}
if got := readTestFile(t, filepath.Join(dir, "d.yaml")); got != "old-c" {
t.Fatalf("move lost content: %q", got)
}
if got := readTestFile(t, filepath.Join(dir, "created.yaml")); got != "created" {
t.Fatalf("create failed: %q", got)
}
if entries, _ := ListJournalFiles(journalDir); len(entries) != 0 {
t.Fatalf("journal not cleaned: %v", entries)
}
}
func TestTxnRollbackOnFailure(t *testing.T) {
dir := t.TempDir()
journalDir := filepath.Join(dir, ".journal")
writeTestFile(t, filepath.Join(dir, "a.yaml"), "old-a")
// A file inside a read-only subdirectory makes the delete fail.
sub := filepath.Join(dir, "sub")
writeTestFile(t, filepath.Join(sub, "gone.yaml"), "old-gone")
if err := os.Chmod(sub, 0500); err != nil {
t.Fatal(err)
}
t.Cleanup(func() { os.Chmod(sub, 0700) })
txn := NewTransaction(journalDir)
if err := txn.Replace(filepath.Join(dir, "a.yaml"), []byte("new-a"), 0644); err != nil {
t.Fatal(err)
}
if err := txn.Delete(filepath.Join(sub, "gone.yaml")); err != nil {
t.Fatal(err)
}
if err := txn.Commit(); err == nil {
t.Fatal("expected commit to fail")
}
if got := readTestFile(t, filepath.Join(dir, "a.yaml")); got != "old-a" {
t.Fatalf("rollback did not restore a.yaml: %q", got)
}
if got := readTestFile(t, filepath.Join(sub, "gone.yaml")); got != "old-gone" {
t.Fatalf("rollback did not restore deleted file: %q", got)
}
// The restore of gone.yaml ran inside the still read-only directory, so
// the ROLLBACK itself failed there: the journal is the only durable
// record of the pre-transaction state and must be KEPT (deleting it
// would make any remaining divergence unrecoverable). See
// TestCommitKeepsJournalAfterFailedRollback.
if entries, _ := ListJournalFiles(journalDir); len(entries) != 1 {
t.Fatalf("journal must be kept after a failed rollback: %v", entries)
}
// Repair the directory permission: the next Recover completes the
// rollback and cleans the journal.
if err := os.Chmod(sub, 0700); err != nil {
t.Fatal(err)
}
if err := Recover(journalDir); err != nil {
t.Fatalf("recovery retry after repair: %v", err)
}
if got := readTestFile(t, filepath.Join(dir, "a.yaml")); got != "old-a" {
t.Fatalf("recovery retry disturbed a.yaml: %q", got)
}
if got := readTestFile(t, filepath.Join(sub, "gone.yaml")); got != "old-gone" {
t.Fatalf("recovery retry disturbed gone.yaml: %q", got)
}
if entries, _ := ListJournalFiles(journalDir); len(entries) != 0 {
t.Fatalf("completed recovery left journals behind: %v", entries)
}
}
func TestRecoverRollsBackLeftoverJournal(t *testing.T) {
// Simulate a crash: journal exists (it says a.yaml becomes new-a and
// c.yaml is deleted) but the operations never ran.
dir := t.TempDir()
journalDir := filepath.Join(dir, ".journal")
writeTestFile(t, filepath.Join(dir, "a.yaml"), "old-a")
writeTestFile(t, filepath.Join(dir, "c.yaml"), "old-c")
txn := NewTransaction(journalDir)
if err := txn.Replace(filepath.Join(dir, "a.yaml"), []byte("new-a"), 0644); err != nil {
t.Fatal(err)
}
if err := txn.Delete(filepath.Join(dir, "c.yaml")); err != nil {
t.Fatal(err)
}
journal, err := txn.MarshalJournal()
if err != nil {
t.Fatal(err)
}
if err := os.MkdirAll(journalDir, 0700); err != nil {
t.Fatal(err)
}
if err := WriteFile(filepath.Join(journalDir, "txn-crash.json"), journal, 0600); err != nil {
t.Fatal(err)
}
if err := Recover(journalDir); err != nil {
t.Fatalf("recover: %v", err)
}
if got := readTestFile(t, filepath.Join(dir, "a.yaml")); got != "old-a" {
t.Fatalf("recovery did not roll back a.yaml: %q", got)
}
if got := readTestFile(t, filepath.Join(dir, "c.yaml")); got != "old-c" {
t.Fatalf("recovery resurrected a delete: %q", got)
}
if entries, _ := ListJournalFiles(journalDir); len(entries) != 0 {
t.Fatalf("recovered journal not removed: %v", entries)
}
}
func TestRecoverDropsCorruptJournal(t *testing.T) {
dir := t.TempDir()
journalDir := filepath.Join(dir, ".journal")
if err := os.MkdirAll(journalDir, 0700); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(journalDir, "txn-bad.json"), []byte("{not json"), 0600); err != nil {
t.Fatal(err)
}
if err := Recover(journalDir); err != nil {
t.Fatalf("recover corrupt: %v", err)
}
if entries, _ := ListJournalFiles(journalDir); len(entries) != 0 {
t.Fatalf("corrupt journal not removed: %v", entries)
}
}
func TestTxnMoveOverwritesDestination(t *testing.T) {
dir := t.TempDir()
journalDir := filepath.Join(dir, ".journal")
writeTestFile(t, filepath.Join(dir, "src.yaml"), "src-content")
writeTestFile(t, filepath.Join(dir, "dst.yaml"), "dst-content")
txn := NewTransaction(journalDir)
if err := txn.Move(filepath.Join(dir, "src.yaml"), filepath.Join(dir, "dst.yaml")); err != nil {
t.Fatal(err)
}
if err := txn.Commit(); err != nil {
t.Fatalf("commit: %v", err)
}
if got := readTestFile(t, filepath.Join(dir, "dst.yaml")); got != "src-content" {
t.Fatalf("move did not overwrite destination: %q", got)
}
if _, err := os.Stat(filepath.Join(dir, "src.yaml")); !os.IsNotExist(err) {
t.Fatalf("source not removed: %v", err)
}
if !strings.HasSuffix(readTestFile(t, filepath.Join(dir, "dst.yaml")), "content") {
t.Fatal("unreachable")
}
}
// Regression: Move followed by Delete/Replace on the same path used to clobber
// the move record, silently losing the file with a nil Commit error.
func TestTxnRejectsConflictingMoveThenDelete(t *testing.T) {
dir := t.TempDir()
src := filepath.Join(dir, "src.yaml")
dst := filepath.Join(dir, "dst.yaml")
writeTestFile(t, src, "content")
txn := NewTransaction(filepath.Join(dir, ".journal"))
if err := txn.Move(src, dst); err != nil {
t.Fatal(err)
}
if err := txn.Delete(src); err == nil {
t.Fatal("Delete after Move on the same path was accepted")
}
}
func TestTxnRejectsConflictingMoveThenReplace(t *testing.T) {
dir := t.TempDir()
src := filepath.Join(dir, "src.yaml")
dst := filepath.Join(dir, "dst.yaml")
writeTestFile(t, src, "content")
txn := NewTransaction(filepath.Join(dir, ".journal"))
if err := txn.Move(src, dst); err != nil {
t.Fatal(err)
}
if err := txn.Replace(src, []byte("new"), 0644); err == nil {
t.Fatal("Replace after Move on the same path was accepted")
}
}
// Move then Replace on the destination is the supported pattern and must still
// work.
func TestTxnMoveThenReplaceDestination(t *testing.T) {
dir := t.TempDir()
src := filepath.Join(dir, "src.yaml")
dst := filepath.Join(dir, "dst.yaml")
writeTestFile(t, src, "content")
txn := NewTransaction(filepath.Join(dir, ".journal"))
if err := txn.Move(src, dst); err != nil {
t.Fatal(err)
}
if err := txn.Replace(dst, []byte("rewritten"), 0644); err != nil {
t.Fatal(err)
}
if err := txn.Commit(); err != nil {
t.Fatal(err)
}
if got := readTestFile(t, dst); got != "rewritten" {
t.Fatalf("dst = %q, want rewritten", got)
}
}
// Regression: an unrecognised op kind must abort recovery and keep the journal
// rather than silently dropping the before-image and deleting the record.
func TestRecoverKeepsJournalWithUnknownOpKind(t *testing.T) {
dir := t.TempDir()
journalDir := filepath.Join(dir, ".journal")
if err := os.MkdirAll(journalDir, 0700); err != nil {
t.Fatal(err)
}
journal := []byte(`{"ops":[{"path":"` + filepath.Join(dir, "a.yaml") + `","kind":"future-kind","old_exists":false}]}`)
path := filepath.Join(journalDir, "txn-unknown.json")
if err := os.WriteFile(path, journal, 0600); err != nil {
t.Fatal(err)
}
if err := Recover(journalDir); err == nil {
t.Fatal("Recover accepted an unknown op kind")
}
if _, err := os.Stat(path); err != nil {
t.Fatalf("journal with unknown kind was removed: %v", err)
}
}
|
