wal_test.go 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804
  1. // Copyright 2015 The etcd Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package wal
  15. import (
  16. "bytes"
  17. "io"
  18. "io/ioutil"
  19. "os"
  20. "path/filepath"
  21. "reflect"
  22. "testing"
  23. "github.com/coreos/etcd/pkg/fileutil"
  24. "github.com/coreos/etcd/pkg/pbutil"
  25. "github.com/coreos/etcd/raft/raftpb"
  26. "github.com/coreos/etcd/wal/walpb"
  27. "go.uber.org/zap"
  28. )
  29. func TestNew(t *testing.T) {
  30. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  31. if err != nil {
  32. t.Fatal(err)
  33. }
  34. defer os.RemoveAll(p)
  35. w, err := Create(zap.NewExample(), p, []byte("somedata"))
  36. if err != nil {
  37. t.Fatalf("err = %v, want nil", err)
  38. }
  39. if g := filepath.Base(w.tail().Name()); g != walName(0, 0) {
  40. t.Errorf("name = %+v, want %+v", g, walName(0, 0))
  41. }
  42. defer w.Close()
  43. // file is preallocated to segment size; only read data written by wal
  44. off, err := w.tail().Seek(0, io.SeekCurrent)
  45. if err != nil {
  46. t.Fatal(err)
  47. }
  48. gd := make([]byte, off)
  49. f, err := os.Open(filepath.Join(p, filepath.Base(w.tail().Name())))
  50. if err != nil {
  51. t.Fatal(err)
  52. }
  53. defer f.Close()
  54. if _, err = io.ReadFull(f, gd); err != nil {
  55. t.Fatalf("err = %v, want nil", err)
  56. }
  57. var wb bytes.Buffer
  58. e := newEncoder(&wb, 0, 0)
  59. err = e.encode(&walpb.Record{Type: crcType, Crc: 0})
  60. if err != nil {
  61. t.Fatalf("err = %v, want nil", err)
  62. }
  63. err = e.encode(&walpb.Record{Type: metadataType, Data: []byte("somedata")})
  64. if err != nil {
  65. t.Fatalf("err = %v, want nil", err)
  66. }
  67. r := &walpb.Record{
  68. Type: snapshotType,
  69. Data: pbutil.MustMarshal(&walpb.Snapshot{}),
  70. }
  71. if err = e.encode(r); err != nil {
  72. t.Fatalf("err = %v, want nil", err)
  73. }
  74. e.flush()
  75. if !bytes.Equal(gd, wb.Bytes()) {
  76. t.Errorf("data = %v, want %v", gd, wb.Bytes())
  77. }
  78. }
  79. func TestNewForInitedDir(t *testing.T) {
  80. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  81. if err != nil {
  82. t.Fatal(err)
  83. }
  84. defer os.RemoveAll(p)
  85. os.Create(filepath.Join(p, walName(0, 0)))
  86. if _, err = Create(zap.NewExample(), p, nil); err == nil || err != os.ErrExist {
  87. t.Errorf("err = %v, want %v", err, os.ErrExist)
  88. }
  89. }
  90. func TestOpenAtIndex(t *testing.T) {
  91. dir, err := ioutil.TempDir(os.TempDir(), "waltest")
  92. if err != nil {
  93. t.Fatal(err)
  94. }
  95. defer os.RemoveAll(dir)
  96. f, err := os.Create(filepath.Join(dir, walName(0, 0)))
  97. if err != nil {
  98. t.Fatal(err)
  99. }
  100. f.Close()
  101. w, err := Open(zap.NewExample(), dir, walpb.Snapshot{})
  102. if err != nil {
  103. t.Fatalf("err = %v, want nil", err)
  104. }
  105. if g := filepath.Base(w.tail().Name()); g != walName(0, 0) {
  106. t.Errorf("name = %+v, want %+v", g, walName(0, 0))
  107. }
  108. if w.seq() != 0 {
  109. t.Errorf("seq = %d, want %d", w.seq(), 0)
  110. }
  111. w.Close()
  112. wname := walName(2, 10)
  113. f, err = os.Create(filepath.Join(dir, wname))
  114. if err != nil {
  115. t.Fatal(err)
  116. }
  117. f.Close()
  118. w, err = Open(zap.NewExample(), dir, walpb.Snapshot{Index: 5})
  119. if err != nil {
  120. t.Fatalf("err = %v, want nil", err)
  121. }
  122. if g := filepath.Base(w.tail().Name()); g != wname {
  123. t.Errorf("name = %+v, want %+v", g, wname)
  124. }
  125. if w.seq() != 2 {
  126. t.Errorf("seq = %d, want %d", w.seq(), 2)
  127. }
  128. w.Close()
  129. emptydir, err := ioutil.TempDir(os.TempDir(), "waltestempty")
  130. if err != nil {
  131. t.Fatal(err)
  132. }
  133. defer os.RemoveAll(emptydir)
  134. if _, err = Open(zap.NewExample(), emptydir, walpb.Snapshot{}); err != ErrFileNotFound {
  135. t.Errorf("err = %v, want %v", err, ErrFileNotFound)
  136. }
  137. }
  138. // TODO: split it into smaller tests for better readability
  139. func TestCut(t *testing.T) {
  140. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  141. if err != nil {
  142. t.Fatal(err)
  143. }
  144. defer os.RemoveAll(p)
  145. w, err := Create(zap.NewExample(), p, nil)
  146. if err != nil {
  147. t.Fatal(err)
  148. }
  149. defer w.Close()
  150. state := raftpb.HardState{Term: 1}
  151. if err = w.Save(state, nil); err != nil {
  152. t.Fatal(err)
  153. }
  154. if err = w.cut(); err != nil {
  155. t.Fatal(err)
  156. }
  157. wname := walName(1, 1)
  158. if g := filepath.Base(w.tail().Name()); g != wname {
  159. t.Errorf("name = %s, want %s", g, wname)
  160. }
  161. es := []raftpb.Entry{{Index: 1, Term: 1, Data: []byte{1}}}
  162. if err = w.Save(raftpb.HardState{}, es); err != nil {
  163. t.Fatal(err)
  164. }
  165. if err = w.cut(); err != nil {
  166. t.Fatal(err)
  167. }
  168. snap := walpb.Snapshot{Index: 2, Term: 1}
  169. if err = w.SaveSnapshot(snap); err != nil {
  170. t.Fatal(err)
  171. }
  172. wname = walName(2, 2)
  173. if g := filepath.Base(w.tail().Name()); g != wname {
  174. t.Errorf("name = %s, want %s", g, wname)
  175. }
  176. // check the state in the last WAL
  177. // We do check before closing the WAL to ensure that Cut syncs the data
  178. // into the disk.
  179. f, err := os.Open(filepath.Join(p, wname))
  180. if err != nil {
  181. t.Fatal(err)
  182. }
  183. defer f.Close()
  184. nw := &WAL{
  185. decoder: newDecoder(f),
  186. start: snap,
  187. }
  188. _, gst, _, err := nw.ReadAll()
  189. if err != nil {
  190. t.Fatal(err)
  191. }
  192. if !reflect.DeepEqual(gst, state) {
  193. t.Errorf("state = %+v, want %+v", gst, state)
  194. }
  195. }
  196. func TestSaveWithCut(t *testing.T) {
  197. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  198. if err != nil {
  199. t.Fatal(err)
  200. }
  201. defer os.RemoveAll(p)
  202. w, err := Create(zap.NewExample(), p, []byte("metadata"))
  203. if err != nil {
  204. t.Fatal(err)
  205. }
  206. state := raftpb.HardState{Term: 1}
  207. if err = w.Save(state, nil); err != nil {
  208. t.Fatal(err)
  209. }
  210. bigData := make([]byte, 500)
  211. strdata := "Hello World!!"
  212. copy(bigData, strdata)
  213. // set a lower value for SegmentSizeBytes, else the test takes too long to complete
  214. restoreLater := SegmentSizeBytes
  215. const EntrySize int = 500
  216. SegmentSizeBytes = 2 * 1024
  217. defer func() { SegmentSizeBytes = restoreLater }()
  218. var index uint64 = 0
  219. for totalSize := 0; totalSize < int(SegmentSizeBytes); totalSize += EntrySize {
  220. ents := []raftpb.Entry{{Index: index, Term: 1, Data: bigData}}
  221. if err = w.Save(state, ents); err != nil {
  222. t.Fatal(err)
  223. }
  224. index++
  225. }
  226. w.Close()
  227. neww, err := Open(zap.NewExample(), p, walpb.Snapshot{})
  228. if err != nil {
  229. t.Fatalf("err = %v, want nil", err)
  230. }
  231. defer neww.Close()
  232. wname := walName(1, index)
  233. if g := filepath.Base(neww.tail().Name()); g != wname {
  234. t.Errorf("name = %s, want %s", g, wname)
  235. }
  236. _, newhardstate, entries, err := neww.ReadAll()
  237. if err != nil {
  238. t.Fatal(err)
  239. }
  240. if !reflect.DeepEqual(newhardstate, state) {
  241. t.Errorf("Hard State = %+v, want %+v", newhardstate, state)
  242. }
  243. if len(entries) != int(SegmentSizeBytes/int64(EntrySize)) {
  244. t.Errorf("Number of entries = %d, expected = %d", len(entries), int(SegmentSizeBytes/int64(EntrySize)))
  245. }
  246. for _, oneent := range entries {
  247. if !bytes.Equal(oneent.Data, bigData) {
  248. t.Errorf("the saved data does not match at Index %d : found: %s , want :%s", oneent.Index, oneent.Data, bigData)
  249. }
  250. }
  251. }
  252. func TestRecover(t *testing.T) {
  253. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  254. if err != nil {
  255. t.Fatal(err)
  256. }
  257. defer os.RemoveAll(p)
  258. w, err := Create(zap.NewExample(), p, []byte("metadata"))
  259. if err != nil {
  260. t.Fatal(err)
  261. }
  262. if err = w.SaveSnapshot(walpb.Snapshot{}); err != nil {
  263. t.Fatal(err)
  264. }
  265. ents := []raftpb.Entry{{Index: 1, Term: 1, Data: []byte{1}}, {Index: 2, Term: 2, Data: []byte{2}}}
  266. if err = w.Save(raftpb.HardState{}, ents); err != nil {
  267. t.Fatal(err)
  268. }
  269. sts := []raftpb.HardState{{Term: 1, Vote: 1, Commit: 1}, {Term: 2, Vote: 2, Commit: 2}}
  270. for _, s := range sts {
  271. if err = w.Save(s, nil); err != nil {
  272. t.Fatal(err)
  273. }
  274. }
  275. w.Close()
  276. if w, err = Open(zap.NewExample(), p, walpb.Snapshot{}); err != nil {
  277. t.Fatal(err)
  278. }
  279. metadata, state, entries, err := w.ReadAll()
  280. if err != nil {
  281. t.Fatal(err)
  282. }
  283. if !bytes.Equal(metadata, []byte("metadata")) {
  284. t.Errorf("metadata = %s, want %s", metadata, "metadata")
  285. }
  286. if !reflect.DeepEqual(entries, ents) {
  287. t.Errorf("ents = %+v, want %+v", entries, ents)
  288. }
  289. // only the latest state is recorded
  290. s := sts[len(sts)-1]
  291. if !reflect.DeepEqual(state, s) {
  292. t.Errorf("state = %+v, want %+v", state, s)
  293. }
  294. w.Close()
  295. }
  296. func TestSearchIndex(t *testing.T) {
  297. tests := []struct {
  298. names []string
  299. index uint64
  300. widx int
  301. wok bool
  302. }{
  303. {
  304. []string{
  305. "0000000000000000-0000000000000000.wal",
  306. "0000000000000001-0000000000001000.wal",
  307. "0000000000000002-0000000000002000.wal",
  308. },
  309. 0x1000, 1, true,
  310. },
  311. {
  312. []string{
  313. "0000000000000001-0000000000004000.wal",
  314. "0000000000000002-0000000000003000.wal",
  315. "0000000000000003-0000000000005000.wal",
  316. },
  317. 0x4000, 1, true,
  318. },
  319. {
  320. []string{
  321. "0000000000000001-0000000000002000.wal",
  322. "0000000000000002-0000000000003000.wal",
  323. "0000000000000003-0000000000005000.wal",
  324. },
  325. 0x1000, -1, false,
  326. },
  327. }
  328. for i, tt := range tests {
  329. idx, ok := searchIndex(tt.names, tt.index)
  330. if idx != tt.widx {
  331. t.Errorf("#%d: idx = %d, want %d", i, idx, tt.widx)
  332. }
  333. if ok != tt.wok {
  334. t.Errorf("#%d: ok = %v, want %v", i, ok, tt.wok)
  335. }
  336. }
  337. }
  338. func TestScanWalName(t *testing.T) {
  339. tests := []struct {
  340. str string
  341. wseq, windex uint64
  342. wok bool
  343. }{
  344. {"0000000000000000-0000000000000000.wal", 0, 0, true},
  345. {"0000000000000000.wal", 0, 0, false},
  346. {"0000000000000000-0000000000000000.snap", 0, 0, false},
  347. }
  348. for i, tt := range tests {
  349. s, index, err := parseWalName(tt.str)
  350. if g := err == nil; g != tt.wok {
  351. t.Errorf("#%d: ok = %v, want %v", i, g, tt.wok)
  352. }
  353. if s != tt.wseq {
  354. t.Errorf("#%d: seq = %d, want %d", i, s, tt.wseq)
  355. }
  356. if index != tt.windex {
  357. t.Errorf("#%d: index = %d, want %d", i, index, tt.windex)
  358. }
  359. }
  360. }
  361. func TestRecoverAfterCut(t *testing.T) {
  362. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  363. if err != nil {
  364. t.Fatal(err)
  365. }
  366. defer os.RemoveAll(p)
  367. md, err := Create(zap.NewExample(), p, []byte("metadata"))
  368. if err != nil {
  369. t.Fatal(err)
  370. }
  371. for i := 0; i < 10; i++ {
  372. if err = md.SaveSnapshot(walpb.Snapshot{Index: uint64(i)}); err != nil {
  373. t.Fatal(err)
  374. }
  375. es := []raftpb.Entry{{Index: uint64(i)}}
  376. if err = md.Save(raftpb.HardState{}, es); err != nil {
  377. t.Fatal(err)
  378. }
  379. if err = md.cut(); err != nil {
  380. t.Fatal(err)
  381. }
  382. }
  383. md.Close()
  384. if err := os.Remove(filepath.Join(p, walName(4, 4))); err != nil {
  385. t.Fatal(err)
  386. }
  387. for i := 0; i < 10; i++ {
  388. w, err := Open(zap.NewExample(), p, walpb.Snapshot{Index: uint64(i)})
  389. if err != nil {
  390. if i <= 4 {
  391. if err != ErrFileNotFound {
  392. t.Errorf("#%d: err = %v, want %v", i, err, ErrFileNotFound)
  393. }
  394. } else {
  395. t.Errorf("#%d: err = %v, want nil", i, err)
  396. }
  397. continue
  398. }
  399. metadata, _, entries, err := w.ReadAll()
  400. if err != nil {
  401. t.Errorf("#%d: err = %v, want nil", i, err)
  402. continue
  403. }
  404. if !bytes.Equal(metadata, []byte("metadata")) {
  405. t.Errorf("#%d: metadata = %s, want %s", i, metadata, "metadata")
  406. }
  407. for j, e := range entries {
  408. if e.Index != uint64(j+i+1) {
  409. t.Errorf("#%d: ents[%d].Index = %+v, want %+v", i, j, e.Index, j+i+1)
  410. }
  411. }
  412. w.Close()
  413. }
  414. }
  415. func TestOpenAtUncommittedIndex(t *testing.T) {
  416. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  417. if err != nil {
  418. t.Fatal(err)
  419. }
  420. defer os.RemoveAll(p)
  421. w, err := Create(zap.NewExample(), p, nil)
  422. if err != nil {
  423. t.Fatal(err)
  424. }
  425. if err = w.SaveSnapshot(walpb.Snapshot{}); err != nil {
  426. t.Fatal(err)
  427. }
  428. if err = w.Save(raftpb.HardState{}, []raftpb.Entry{{Index: 0}}); err != nil {
  429. t.Fatal(err)
  430. }
  431. w.Close()
  432. w, err = Open(zap.NewExample(), p, walpb.Snapshot{})
  433. if err != nil {
  434. t.Fatal(err)
  435. }
  436. // commit up to index 0, try to read index 1
  437. if _, _, _, err = w.ReadAll(); err != nil {
  438. t.Errorf("err = %v, want nil", err)
  439. }
  440. w.Close()
  441. }
  442. // TestOpenForRead tests that OpenForRead can load all files.
  443. // The tests creates WAL directory, and cut out multiple WAL files. Then
  444. // it releases the lock of part of data, and excepts that OpenForRead
  445. // can read out all files even if some are locked for write.
  446. func TestOpenForRead(t *testing.T) {
  447. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  448. if err != nil {
  449. t.Fatal(err)
  450. }
  451. defer os.RemoveAll(p)
  452. // create WAL
  453. w, err := Create(zap.NewExample(), p, nil)
  454. if err != nil {
  455. t.Fatal(err)
  456. }
  457. defer w.Close()
  458. // make 10 separate files
  459. for i := 0; i < 10; i++ {
  460. es := []raftpb.Entry{{Index: uint64(i)}}
  461. if err = w.Save(raftpb.HardState{}, es); err != nil {
  462. t.Fatal(err)
  463. }
  464. if err = w.cut(); err != nil {
  465. t.Fatal(err)
  466. }
  467. }
  468. // release the lock to 5
  469. unlockIndex := uint64(5)
  470. w.ReleaseLockTo(unlockIndex)
  471. // All are available for read
  472. w2, err := OpenForRead(zap.NewExample(), p, walpb.Snapshot{})
  473. if err != nil {
  474. t.Fatal(err)
  475. }
  476. defer w2.Close()
  477. _, _, ents, err := w2.ReadAll()
  478. if err != nil {
  479. t.Fatalf("err = %v, want nil", err)
  480. }
  481. if g := ents[len(ents)-1].Index; g != 9 {
  482. t.Errorf("last index read = %d, want %d", g, 9)
  483. }
  484. }
  485. func TestSaveEmpty(t *testing.T) {
  486. var buf bytes.Buffer
  487. var est raftpb.HardState
  488. w := WAL{
  489. encoder: newEncoder(&buf, 0, 0),
  490. }
  491. if err := w.saveState(&est); err != nil {
  492. t.Errorf("err = %v, want nil", err)
  493. }
  494. if len(buf.Bytes()) != 0 {
  495. t.Errorf("buf.Bytes = %d, want 0", len(buf.Bytes()))
  496. }
  497. }
  498. func TestReleaseLockTo(t *testing.T) {
  499. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  500. if err != nil {
  501. t.Fatal(err)
  502. }
  503. defer os.RemoveAll(p)
  504. // create WAL
  505. w, err := Create(zap.NewExample(), p, nil)
  506. defer func() {
  507. if err = w.Close(); err != nil {
  508. t.Fatal(err)
  509. }
  510. }()
  511. if err != nil {
  512. t.Fatal(err)
  513. }
  514. // release nothing if no files
  515. err = w.ReleaseLockTo(10)
  516. if err != nil {
  517. t.Errorf("err = %v, want nil", err)
  518. }
  519. // make 10 separate files
  520. for i := 0; i < 10; i++ {
  521. es := []raftpb.Entry{{Index: uint64(i)}}
  522. if err = w.Save(raftpb.HardState{}, es); err != nil {
  523. t.Fatal(err)
  524. }
  525. if err = w.cut(); err != nil {
  526. t.Fatal(err)
  527. }
  528. }
  529. // release the lock to 5
  530. unlockIndex := uint64(5)
  531. w.ReleaseLockTo(unlockIndex)
  532. // expected remaining are 4,5,6,7,8,9,10
  533. if len(w.locks) != 7 {
  534. t.Errorf("len(w.locks) = %d, want %d", len(w.locks), 7)
  535. }
  536. for i, l := range w.locks {
  537. var lockIndex uint64
  538. _, lockIndex, err = parseWalName(filepath.Base(l.Name()))
  539. if err != nil {
  540. t.Fatal(err)
  541. }
  542. if lockIndex != uint64(i+4) {
  543. t.Errorf("#%d: lockindex = %d, want %d", i, lockIndex, uint64(i+4))
  544. }
  545. }
  546. // release the lock to 15
  547. unlockIndex = uint64(15)
  548. w.ReleaseLockTo(unlockIndex)
  549. // expected remaining is 10
  550. if len(w.locks) != 1 {
  551. t.Errorf("len(w.locks) = %d, want %d", len(w.locks), 1)
  552. }
  553. _, lockIndex, err := parseWalName(filepath.Base(w.locks[0].Name()))
  554. if err != nil {
  555. t.Fatal(err)
  556. }
  557. if lockIndex != uint64(10) {
  558. t.Errorf("lockindex = %d, want %d", lockIndex, 10)
  559. }
  560. }
  561. // TestTailWriteNoSlackSpace ensures that tail writes append if there's no preallocated space.
  562. func TestTailWriteNoSlackSpace(t *testing.T) {
  563. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  564. if err != nil {
  565. t.Fatal(err)
  566. }
  567. defer os.RemoveAll(p)
  568. // create initial WAL
  569. w, err := Create(zap.NewExample(), p, []byte("metadata"))
  570. if err != nil {
  571. t.Fatal(err)
  572. }
  573. // write some entries
  574. for i := 1; i <= 5; i++ {
  575. es := []raftpb.Entry{{Index: uint64(i), Term: 1, Data: []byte{byte(i)}}}
  576. if err = w.Save(raftpb.HardState{Term: 1}, es); err != nil {
  577. t.Fatal(err)
  578. }
  579. }
  580. // get rid of slack space by truncating file
  581. off, serr := w.tail().Seek(0, io.SeekCurrent)
  582. if serr != nil {
  583. t.Fatal(serr)
  584. }
  585. if terr := w.tail().Truncate(off); terr != nil {
  586. t.Fatal(terr)
  587. }
  588. w.Close()
  589. // open, write more
  590. w, err = Open(zap.NewExample(), p, walpb.Snapshot{})
  591. if err != nil {
  592. t.Fatal(err)
  593. }
  594. _, _, ents, rerr := w.ReadAll()
  595. if rerr != nil {
  596. t.Fatal(rerr)
  597. }
  598. if len(ents) != 5 {
  599. t.Fatalf("got entries %+v, expected 5 entries", ents)
  600. }
  601. // write more entries
  602. for i := 6; i <= 10; i++ {
  603. es := []raftpb.Entry{{Index: uint64(i), Term: 1, Data: []byte{byte(i)}}}
  604. if err = w.Save(raftpb.HardState{Term: 1}, es); err != nil {
  605. t.Fatal(err)
  606. }
  607. }
  608. w.Close()
  609. // confirm all writes
  610. w, err = Open(zap.NewExample(), p, walpb.Snapshot{})
  611. if err != nil {
  612. t.Fatal(err)
  613. }
  614. _, _, ents, rerr = w.ReadAll()
  615. if rerr != nil {
  616. t.Fatal(rerr)
  617. }
  618. if len(ents) != 10 {
  619. t.Fatalf("got entries %+v, expected 10 entries", ents)
  620. }
  621. w.Close()
  622. }
  623. // TestRestartCreateWal ensures that an interrupted WAL initialization is clobbered on restart
  624. func TestRestartCreateWal(t *testing.T) {
  625. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  626. if err != nil {
  627. t.Fatal(err)
  628. }
  629. defer os.RemoveAll(p)
  630. // make temporary directory so it looks like initialization is interrupted
  631. tmpdir := filepath.Clean(p) + ".tmp"
  632. if err = os.Mkdir(tmpdir, fileutil.PrivateDirMode); err != nil {
  633. t.Fatal(err)
  634. }
  635. if _, err = os.OpenFile(filepath.Join(tmpdir, "test"), os.O_WRONLY|os.O_CREATE, fileutil.PrivateFileMode); err != nil {
  636. t.Fatal(err)
  637. }
  638. w, werr := Create(zap.NewExample(), p, []byte("abc"))
  639. if werr != nil {
  640. t.Fatal(werr)
  641. }
  642. w.Close()
  643. if Exist(tmpdir) {
  644. t.Fatalf("got %q exists, expected it to not exist", tmpdir)
  645. }
  646. if w, err = OpenForRead(zap.NewExample(), p, walpb.Snapshot{}); err != nil {
  647. t.Fatal(err)
  648. }
  649. defer w.Close()
  650. if meta, _, _, rerr := w.ReadAll(); rerr != nil || string(meta) != "abc" {
  651. t.Fatalf("got error %v and meta %q, expected nil and %q", rerr, meta, "abc")
  652. }
  653. }
  654. // TestOpenOnTornWrite ensures that entries past the torn write are truncated.
  655. func TestOpenOnTornWrite(t *testing.T) {
  656. maxEntries := 40
  657. clobberIdx := 20
  658. overwriteEntries := 5
  659. p, err := ioutil.TempDir(os.TempDir(), "waltest")
  660. if err != nil {
  661. t.Fatal(err)
  662. }
  663. defer os.RemoveAll(p)
  664. w, err := Create(zap.NewExample(), p, nil)
  665. defer func() {
  666. if err = w.Close(); err != nil && err != os.ErrInvalid {
  667. t.Fatal(err)
  668. }
  669. }()
  670. if err != nil {
  671. t.Fatal(err)
  672. }
  673. // get offset of end of each saved entry
  674. offsets := make([]int64, maxEntries)
  675. for i := range offsets {
  676. es := []raftpb.Entry{{Index: uint64(i)}}
  677. if err = w.Save(raftpb.HardState{}, es); err != nil {
  678. t.Fatal(err)
  679. }
  680. if offsets[i], err = w.tail().Seek(0, io.SeekCurrent); err != nil {
  681. t.Fatal(err)
  682. }
  683. }
  684. fn := filepath.Join(p, filepath.Base(w.tail().Name()))
  685. w.Close()
  686. // clobber some entry with 0's to simulate a torn write
  687. f, ferr := os.OpenFile(fn, os.O_WRONLY, fileutil.PrivateFileMode)
  688. if ferr != nil {
  689. t.Fatal(ferr)
  690. }
  691. defer f.Close()
  692. _, err = f.Seek(offsets[clobberIdx], io.SeekStart)
  693. if err != nil {
  694. t.Fatal(err)
  695. }
  696. zeros := make([]byte, offsets[clobberIdx+1]-offsets[clobberIdx])
  697. _, err = f.Write(zeros)
  698. if err != nil {
  699. t.Fatal(err)
  700. }
  701. f.Close()
  702. w, err = Open(zap.NewExample(), p, walpb.Snapshot{})
  703. if err != nil {
  704. t.Fatal(err)
  705. }
  706. // seek up to clobbered entry
  707. _, _, _, err = w.ReadAll()
  708. if err != nil {
  709. t.Fatal(err)
  710. }
  711. // write a few entries past the clobbered entry
  712. for i := 0; i < overwriteEntries; i++ {
  713. // Index is different from old, truncated entries
  714. es := []raftpb.Entry{{Index: uint64(i + clobberIdx), Data: []byte("new")}}
  715. if err = w.Save(raftpb.HardState{}, es); err != nil {
  716. t.Fatal(err)
  717. }
  718. }
  719. w.Close()
  720. // read back the entries, confirm number of entries matches expectation
  721. w, err = OpenForRead(zap.NewExample(), p, walpb.Snapshot{})
  722. if err != nil {
  723. t.Fatal(err)
  724. }
  725. _, _, ents, rerr := w.ReadAll()
  726. if rerr != nil {
  727. // CRC error? the old entries were likely never truncated away
  728. t.Fatal(rerr)
  729. }
  730. wEntries := (clobberIdx - 1) + overwriteEntries
  731. if len(ents) != wEntries {
  732. t.Fatalf("expected len(ents) = %d, got %d", wEntries, len(ents))
  733. }
  734. }