wal_test.go 21 KB

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