flash-kv 0.2.1

A simple k/v store API inspired by bitcask
Documentation 
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
283
284
285

use std::{fs, path::PathBuf};

use bytes::Bytes;

use crate::{
  db::Engine,
  errors::Errors,
  option::{self, Options},
  util::rand_kv::{get_test_key, get_test_value},
};

#[test]
fn test_engine_put() {
  let mut opt = Options::default();
  opt.dir_path = PathBuf::from("/tmp/flash-kv-put");
  opt.data_file_size = 64 * 1024 * 1024; // 64MB
  let engine = Engine::open(opt.clone()).expect("fail to open engine");

  // put one item
  let res1 = engine.put(get_test_key(11), get_test_value(11));
  assert!(res1.is_ok());
  let res2 = engine.get(get_test_key(11));
  assert!(res2.is_ok());
  assert!(res2.unwrap().len() > 0);

  // put another item repeatedly
  let res3 = engine.put(get_test_key(22), get_test_value(11));
  assert!(res3.is_ok());
  let res4 = engine.put(get_test_key(22), Bytes::from("11"));
  assert!(res4.is_ok());
  let res5 = engine.get(get_test_key(22));
  assert!(res5.is_ok());
  assert_eq!(res5.unwrap(), Bytes::from("11"));

  // key is empty
  let res6 = engine.put(Bytes::new(), get_test_value(111));
  assert_eq!(Errors::KeyIsEmpty, res6.err().unwrap());

  // value is empty
  let res7 = engine.put(get_test_key(31), Bytes::new());
  assert!(res7.is_ok());
  let res8 = engine.get(get_test_key(31));
  assert_eq!(0, res8.ok().unwrap().len());

  // write to changed data file
  for i in 0..=10000 {
    let res = engine.put(get_test_key(i), get_test_value(i));
    assert!(res.is_ok());
  }

  // restart engine and write data
  std::mem::drop(engine);

  let engine2 = Engine::open(opt.clone()).expect("fail to open engine");
  let res9 = engine2.put(get_test_key(100), get_test_value(100));
  assert!(res9.is_ok());

  let res10 = engine2.get(get_test_key(100));
  assert_eq!(res10.unwrap(), get_test_value(100));

  // delete tested files
  std::fs::remove_dir_all(opt.clone().dir_path).expect("failed to remove dir");
}

#[test]
fn test_engine_get() {
  let mut opt = Options::default();
  opt.dir_path = PathBuf::from("/tmp/flash-kv-get");
  opt.data_file_size = 64 * 1024 * 1024; // 64MB
  let engine = Engine::open(opt.clone()).expect("fail to open engine");

  // read one item
  let res1 = engine.put(get_test_key(11), get_test_value(11));
  assert!(res1.is_ok());
  let res2 = engine.get(get_test_key(11));
  assert!(res2.is_ok());
  assert!(res2.unwrap().len() > 0);

  // read after putting another items
  let res3 = engine.put(get_test_key(22), Bytes::from("22"));
  assert!(res3.is_ok());
  let res4 = engine.put(get_test_key(33), get_test_value(33));
  assert!(res4.is_ok());
  let res5 = engine.get(get_test_key(22));
  assert!(res5.is_ok());
  assert_eq!(res5.unwrap(), Bytes::from("22"));

  // read when key is invaild
  let res6 = engine.get(Bytes::from("not exist"));
  assert_eq!(Errors::KeyNotFound, res6.err().unwrap());

  // read after value is deleted
  let res7 = engine.put(get_test_key(31), Bytes::new());
  assert!(res7.is_ok());
  let res8 = engine.delete(get_test_key(31));
  assert!(res8.is_ok());
  let res9 = engine.get(get_test_key(31));
  assert_eq!(Errors::KeyNotFound, res9.err().unwrap());

  // read from old data file
  for i in 500..=100000 {
    let res = engine.put(get_test_key(i), get_test_value(i));
    assert!(res.is_ok());
  }
  let res10 = engine.get(get_test_key(5000));
  assert!(res10.is_ok());

  // restart engine and read data
  std::mem::drop(engine);

  let engine2 = Engine::open(opt.clone()).expect("fail to open engine");
  let res11 = engine2.get(get_test_key(33));
  assert_eq!(get_test_value(33), res11.unwrap());

  let res12 = engine2.get(get_test_key(22));
  assert_eq!(Bytes::from("22"), res12.unwrap());

  let res13 = engine2.get(get_test_key(333));
  assert_eq!(Errors::KeyNotFound, res13.err().unwrap());

  // delete tested files
  std::fs::remove_dir_all(opt.clone().dir_path).expect("failed to remove dir");
}

#[test]
fn test_engine_delete() {
  let mut opt = Options::default();
  opt.dir_path = PathBuf::from("/tmp/flash-kv-delete");
  opt.data_file_size = 64 * 1024 * 1024; // 64MB
  let engine = Engine::open(opt.clone()).expect("fail to open engine");

  // delete one item
  let res1 = engine.put(get_test_key(11), Bytes::new());
  assert!(res1.is_ok());
  let res2 = engine.delete(get_test_key(11));
  assert!(res2.is_ok());
  let res3 = engine.get(get_test_key(11));
  assert_eq!(Errors::KeyNotFound, res3.err().unwrap());

  // delete a non-exist item
  let res4 = engine.delete(Bytes::from("not existed key"));
  assert!(res4.is_ok());

  // delete an empty key
  let res5 = engine.delete(Bytes::new());
  assert_eq!(Errors::KeyIsEmpty, res5.err().unwrap());

  // delete and put again
  let res6 = engine.put(get_test_key(11), get_test_value(11));
  assert!(res6.is_ok());
  let res7 = engine.delete(get_test_key(11));
  assert!(res7.is_ok());
  let res8 = engine.put(get_test_key(11), get_test_value(11));
  assert!(res8.is_ok());
  let res9 = engine.get(get_test_key(11));
  assert!(res9.is_ok());

  // restart engine and delete data
  std::mem::drop(engine);
  let engine2 = Engine::open(opt.clone()).expect("fail to open engine");
  let res10 = engine2.delete(get_test_key(11));
  assert!(res10.is_ok());
  let res11 = engine2.get(get_test_key(11));
  assert_eq!(Errors::KeyNotFound, res11.err().unwrap());

  // delete tested files
  std::fs::remove_dir_all(opt.clone().dir_path).expect("failed to remove dir");
}

#[test]
fn test_engine_sync() {
  let mut opt = Options::default();
  opt.dir_path = PathBuf::from("/tmp/flash-kv-sync");
  opt.data_file_size = 64 * 1024 * 1024; // 64MB
  let engine = Engine::open(opt.clone()).expect("fail to open engine");

  let res = engine.put(get_test_key(11), get_test_value(11));
  assert!(res.is_ok());

  let sync_res = engine.sync();
  assert!(sync_res.is_ok());

  // delete tested files
  std::fs::remove_dir_all(opt.clone().dir_path).expect("failed to remove dir");
}

#[test]
fn test_engine_close() {
  let mut opt = Options::default();
  opt.dir_path = PathBuf::from("/tmp/flash-kv-close");
  opt.data_file_size = 64 * 1024 * 1024; // 64MB
  let engine = Engine::open(opt.clone()).expect("fail to open engine");

  let res = engine.put(get_test_key(11), get_test_value(11));
  assert!(res.is_ok());

  let close_res = engine.close();
  assert!(close_res.is_ok());

  // delete tested files
  std::fs::remove_dir_all(opt.clone().dir_path).expect("failed to remove dir");
}

#[test]
fn test_engine_filelock() {
  // let mut opt = Options::default();
  // opt.dir_path = PathBuf::from("/tmp/flash-kv-close");
  // opt.data_file_size = 64 * 1024 * 1024; // 64MB
  // let engine = Engine::open(opt.clone()).expect("fail to open engine");

  // let res = engine.put(get_test_key(11), get_test_value(11));
  // assert!(res.is_ok());

  // let close_res = engine.close();
  // assert!(close_res.is_ok());

  // // delete tested files
  // std::fs::remove_dir_all(opt.clone().dir_path).expect("failed to remove dir");

  let mut opt = Options::default();
  opt.dir_path = PathBuf::from("/tmp/flash-kv-flock");
  let engine = Engine::open(opt.clone()).expect("fail to open engine");

  let res1 = Engine::open(opt.clone());
  assert_eq!(Errors::DatabaseIsUsing, res1.err().unwrap());

  let res2 = engine.close();
  assert!(res2.is_ok());

  let res3 = Engine::open(opt.clone());
  assert!(res3.is_ok());

  // delete tested files
  std::fs::remove_dir_all(opt.clone().dir_path).expect("failed to remove dir");
}

#[test]
fn test_engine_stat() {
  let mut opts = option::Options::default();
  opts.dir_path = PathBuf::from("/tmp/flash-kv-stat");
  opts.data_file_size = 64 * 1024 * 1024; // 64MB
  let engine = Engine::open(opts.clone()).expect("fail to open engine");

  for i in 0..=10000 {
    let res = engine.put(get_test_key(i), get_test_value(i));
    assert!(res.is_ok());
  }
  for i in 0..=1000 {
    let res = engine.put(get_test_key(i), get_test_value(i));
    assert!(res.is_ok());
  }
  for i in 2000..=5000 {
    let res = engine.delete(get_test_key(i));
    assert!(res.is_ok());
  }
  let stat = engine.get_engine_stat().unwrap();
  assert!(stat.reclaim_size > 0);

  fs::remove_dir_all(opts.clone().dir_path).unwrap();
}

#[test]
fn test_engine_backup() {
  let mut opts = option::Options::default();
  opts.dir_path = PathBuf::from("/tmp/flash-kv-backup");
  opts.data_file_size = 64 * 1024 * 1024; // 64MB
  let engine = Engine::open(opts.clone()).expect("fail to open engine");

  for i in 0..=10000 {
    let res = engine.put(get_test_key(i), get_test_value(i));
    assert!(res.is_ok());
  }

  let backup_dir = PathBuf::from("/tmp/flash-kv-backup-test");
  let backup_res = engine.backup(backup_dir.clone());
  assert!(backup_res.is_ok());

  let mut opts1 = option::Options::default();
  opts1.dir_path = backup_dir.clone();
  let eng2 = Engine::open(opts1.clone());
  assert!(eng2.is_ok());

  fs::remove_dir_all(opts.clone().dir_path).unwrap();
  fs::remove_dir_all(backup_dir.clone()).unwrap();
}