3448: code review comments.
[arvados.git] / services / keepstore / keepstore_test.go
1 package main
2
3 import (
4         "bytes"
5         "fmt"
6         "io/ioutil"
7         "os"
8         "path"
9         "regexp"
10         "sort"
11         "strings"
12         "testing"
13 )
14
15 var TEST_BLOCK = []byte("The quick brown fox jumps over the lazy dog.")
16 var TEST_HASH = "e4d909c290d0fb1ca068ffaddf22cbd0"
17 var TEST_HASH_PUT_RESPONSE = "e4d909c290d0fb1ca068ffaddf22cbd0+44\n"
18
19 var TEST_BLOCK_2 = []byte("Pack my box with five dozen liquor jugs.")
20 var TEST_HASH_2 = "f15ac516f788aec4f30932ffb6395c39"
21
22 var TEST_BLOCK_3 = []byte("Now is the time for all good men to come to the aid of their country.")
23 var TEST_HASH_3 = "eed29bbffbc2dbe5e5ee0bb71888e61f"
24
25 // BAD_BLOCK is used to test collisions and corruption.
26 // It must not match any test hashes.
27 var BAD_BLOCK = []byte("The magic words are squeamish ossifrage.")
28
29 // TODO(twp): Tests still to be written
30 //
31 //   * TestPutBlockFull
32 //       - test that PutBlock returns 503 Full if the filesystem is full.
33 //         (must mock FreeDiskSpace or Statfs? use a tmpfs?)
34 //
35 //   * TestPutBlockWriteErr
36 //       - test the behavior when Write returns an error.
37 //           - Possible solutions: use a small tmpfs and a high
38 //             MIN_FREE_KILOBYTES to trick PutBlock into attempting
39 //             to write a block larger than the amount of space left
40 //           - use an interface to mock ioutil.TempFile with a File
41 //             object that always returns an error on write
42 //
43 // ========================================
44 // GetBlock tests.
45 // ========================================
46
47 // TestGetBlock
48 //     Test that simple block reads succeed.
49 //
50 func TestGetBlock(t *testing.T) {
51         defer teardown()
52
53         // Prepare two test Keep volumes. Our block is stored on the second volume.
54         KeepVM = MakeTestVolumeManager(2)
55         defer func() { KeepVM.Quit() }()
56
57         vols := KeepVM.Volumes()
58         if err := vols[1].Put(TEST_HASH, TEST_BLOCK); err != nil {
59                 t.Error(err)
60         }
61
62         // Check that GetBlock returns success.
63         result, err := GetBlock(TEST_HASH, false)
64         if err != nil {
65                 t.Errorf("GetBlock error: %s", err)
66         }
67         if fmt.Sprint(result) != fmt.Sprint(TEST_BLOCK) {
68                 t.Errorf("expected %s, got %s", TEST_BLOCK, result)
69         }
70 }
71
72 // TestGetBlockMissing
73 //     GetBlock must return an error when the block is not found.
74 //
75 func TestGetBlockMissing(t *testing.T) {
76         defer teardown()
77
78         // Create two empty test Keep volumes.
79         KeepVM = MakeTestVolumeManager(2)
80         defer func() { KeepVM.Quit() }()
81
82         // Check that GetBlock returns failure.
83         result, err := GetBlock(TEST_HASH, false)
84         if err != NotFoundError {
85                 t.Errorf("Expected NotFoundError, got %v", result)
86         }
87 }
88
89 // TestGetBlockCorrupt
90 //     GetBlock must return an error when a corrupted block is requested
91 //     (the contents of the file do not checksum to its hash).
92 //
93 func TestGetBlockCorrupt(t *testing.T) {
94         defer teardown()
95
96         // Create two test Keep volumes and store a corrupt block in one.
97         KeepVM = MakeTestVolumeManager(2)
98         defer func() { KeepVM.Quit() }()
99
100         vols := KeepVM.Volumes()
101         vols[0].Put(TEST_HASH, BAD_BLOCK)
102
103         // Check that GetBlock returns failure.
104         result, err := GetBlock(TEST_HASH, false)
105         if err != DiskHashError {
106                 t.Errorf("Expected DiskHashError, got %v (buf: %v)", err, result)
107         }
108 }
109
110 // ========================================
111 // PutBlock tests
112 // ========================================
113
114 // TestPutBlockOK
115 //     PutBlock can perform a simple block write and returns success.
116 //
117 func TestPutBlockOK(t *testing.T) {
118         defer teardown()
119
120         // Create two test Keep volumes.
121         KeepVM = MakeTestVolumeManager(2)
122         defer func() { KeepVM.Quit() }()
123
124         // Check that PutBlock stores the data as expected.
125         if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
126                 t.Fatalf("PutBlock: %v", err)
127         }
128
129         vols := KeepVM.Volumes()
130         result, err := vols[0].Get(TEST_HASH)
131         if err != nil {
132                 t.Fatalf("Volume #0 Get returned error: %v", err)
133         }
134         if string(result) != string(TEST_BLOCK) {
135                 t.Fatalf("PutBlock stored '%s', Get retrieved '%s'",
136                         string(TEST_BLOCK), string(result))
137         }
138 }
139
140 // TestPutBlockOneVol
141 //     PutBlock still returns success even when only one of the known
142 //     volumes is online.
143 //
144 func TestPutBlockOneVol(t *testing.T) {
145         defer teardown()
146
147         // Create two test Keep volumes, but cripple one of them.
148         KeepVM = MakeTestVolumeManager(2)
149         defer func() { KeepVM.Quit() }()
150
151         vols := KeepVM.Volumes()
152         vols[0].(*MockVolume).Bad = true
153
154         // Check that PutBlock stores the data as expected.
155         if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
156                 t.Fatalf("PutBlock: %v", err)
157         }
158
159         result, err := GetBlock(TEST_HASH, false)
160         if err != nil {
161                 t.Fatalf("GetBlock: %v", err)
162         }
163         if string(result) != string(TEST_BLOCK) {
164                 t.Error("PutBlock/GetBlock mismatch")
165                 t.Fatalf("PutBlock stored '%s', GetBlock retrieved '%s'",
166                         string(TEST_BLOCK), string(result))
167         }
168 }
169
170 // TestPutBlockMD5Fail
171 //     Check that PutBlock returns an error if passed a block and hash that
172 //     do not match.
173 //
174 func TestPutBlockMD5Fail(t *testing.T) {
175         defer teardown()
176
177         // Create two test Keep volumes.
178         KeepVM = MakeTestVolumeManager(2)
179         defer func() { KeepVM.Quit() }()
180
181         // Check that PutBlock returns the expected error when the hash does
182         // not match the block.
183         if err := PutBlock(BAD_BLOCK, TEST_HASH); err != RequestHashError {
184                 t.Error("Expected RequestHashError, got %v", err)
185         }
186
187         // Confirm that GetBlock fails to return anything.
188         if result, err := GetBlock(TEST_HASH, false); err != NotFoundError {
189                 t.Errorf("GetBlock succeeded after a corrupt block store (result = %s, err = %v)",
190                         string(result), err)
191         }
192 }
193
194 // TestPutBlockCorrupt
195 //     PutBlock should overwrite corrupt blocks on disk when given
196 //     a PUT request with a good block.
197 //
198 func TestPutBlockCorrupt(t *testing.T) {
199         defer teardown()
200
201         // Create two test Keep volumes.
202         KeepVM = MakeTestVolumeManager(2)
203         defer func() { KeepVM.Quit() }()
204
205         // Store a corrupted block under TEST_HASH.
206         vols := KeepVM.Volumes()
207         vols[0].Put(TEST_HASH, BAD_BLOCK)
208         if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
209                 t.Errorf("PutBlock: %v", err)
210         }
211
212         // The block on disk should now match TEST_BLOCK.
213         if block, err := GetBlock(TEST_HASH, false); err != nil {
214                 t.Errorf("GetBlock: %v", err)
215         } else if bytes.Compare(block, TEST_BLOCK) != 0 {
216                 t.Errorf("GetBlock returned: '%s'", string(block))
217         }
218 }
219
220 // PutBlockCollision
221 //     PutBlock returns a 400 Collision error when attempting to
222 //     store a block that collides with another block on disk.
223 //
224 func TestPutBlockCollision(t *testing.T) {
225         defer teardown()
226
227         // These blocks both hash to the MD5 digest cee9a457e790cf20d4bdaa6d69f01e41.
228         var b1 = []byte("\x0e0eaU\x9a\xa7\x87\xd0\x0b\xc6\xf7\x0b\xbd\xfe4\x04\xcf\x03e\x9epO\x854\xc0\x0f\xfbe\x9cL\x87@\xcc\x94/\xeb-\xa1\x15\xa3\xf4\x15\\\xbb\x86\x07Is\x86em}\x1f4\xa4 Y\xd7\x8fZ\x8d\xd1\xef")
229         var b2 = []byte("\x0e0eaU\x9a\xa7\x87\xd0\x0b\xc6\xf7\x0b\xbd\xfe4\x04\xcf\x03e\x9etO\x854\xc0\x0f\xfbe\x9cL\x87@\xcc\x94/\xeb-\xa1\x15\xa3\xf4\x15\xdc\xbb\x86\x07Is\x86em}\x1f4\xa4 Y\xd7\x8fZ\x8d\xd1\xef")
230         var locator = "cee9a457e790cf20d4bdaa6d69f01e41"
231
232         // Prepare two test Keep volumes.
233         KeepVM = MakeTestVolumeManager(2)
234         defer func() { KeepVM.Quit() }()
235
236         // Store one block, then attempt to store the other. Confirm that
237         // PutBlock reported a CollisionError.
238         if err := PutBlock(b1, locator); err != nil {
239                 t.Error(err)
240         }
241         if err := PutBlock(b2, locator); err == nil {
242                 t.Error("PutBlock did not report a collision")
243         } else if err != CollisionError {
244                 t.Errorf("PutBlock returned %v", err)
245         }
246 }
247
248 // ========================================
249 // FindKeepVolumes tests.
250 // ========================================
251
252 // TestFindKeepVolumes
253 //     Confirms that FindKeepVolumes finds tmpfs volumes with "/keep"
254 //     directories at the top level.
255 //
256 func TestFindKeepVolumes(t *testing.T) {
257         var tempVols [2]string
258         var err error
259
260         defer func() {
261                 for _, path := range tempVols {
262                         os.RemoveAll(path)
263                 }
264         }()
265
266         // Create two directories suitable for using as keep volumes.
267         for i := range tempVols {
268                 if tempVols[i], err = ioutil.TempDir("", "findvol"); err != nil {
269                         t.Fatal(err)
270                 }
271                 tempVols[i] = tempVols[i] + "/keep"
272                 if err = os.Mkdir(tempVols[i], 0755); err != nil {
273                         t.Fatal(err)
274                 }
275         }
276
277         // Set up a bogus PROC_MOUNTS file.
278         if f, err := ioutil.TempFile("", "keeptest"); err == nil {
279                 for _, vol := range tempVols {
280                         fmt.Fprintf(f, "tmpfs %s tmpfs opts\n", path.Dir(vol))
281                 }
282                 f.Close()
283                 PROC_MOUNTS = f.Name()
284
285                 // Check that FindKeepVolumes finds the temp volumes.
286                 resultVols := FindKeepVolumes()
287                 if len(tempVols) != len(resultVols) {
288                         t.Fatalf("set up %d volumes, FindKeepVolumes found %d\n",
289                                 len(tempVols), len(resultVols))
290                 }
291                 for i := range tempVols {
292                         if tempVols[i] != resultVols[i] {
293                                 t.Errorf("FindKeepVolumes returned %s, expected %s\n",
294                                         resultVols[i], tempVols[i])
295                         }
296                 }
297
298                 os.Remove(f.Name())
299         }
300 }
301
302 // TestFindKeepVolumesFail
303 //     When no Keep volumes are present, FindKeepVolumes returns an empty slice.
304 //
305 func TestFindKeepVolumesFail(t *testing.T) {
306         defer teardown()
307
308         // Set up a bogus PROC_MOUNTS file with no Keep vols.
309         if f, err := ioutil.TempFile("", "keeptest"); err == nil {
310                 fmt.Fprintln(f, "rootfs / rootfs opts 0 0")
311                 fmt.Fprintln(f, "sysfs /sys sysfs opts 0 0")
312                 fmt.Fprintln(f, "proc /proc proc opts 0 0")
313                 fmt.Fprintln(f, "udev /dev devtmpfs opts 0 0")
314                 fmt.Fprintln(f, "devpts /dev/pts devpts opts 0 0")
315                 f.Close()
316                 PROC_MOUNTS = f.Name()
317
318                 // Check that FindKeepVolumes returns an empty array.
319                 resultVols := FindKeepVolumes()
320                 if len(resultVols) != 0 {
321                         t.Fatalf("FindKeepVolumes returned %v", resultVols)
322                 }
323
324                 os.Remove(PROC_MOUNTS)
325         }
326 }
327
328 // TestIndex
329 //     Test an /index request.
330 func TestIndex(t *testing.T) {
331         defer teardown()
332
333         // Set up Keep volumes and populate them.
334         // Include multiple blocks on different volumes, and
335         // some metadata files.
336         KeepVM = MakeTestVolumeManager(2)
337         defer func() { KeepVM.Quit() }()
338
339         vols := KeepVM.Volumes()
340         vols[0].Put(TEST_HASH, TEST_BLOCK)
341         vols[1].Put(TEST_HASH_2, TEST_BLOCK_2)
342         vols[0].Put(TEST_HASH_3, TEST_BLOCK_3)
343         vols[0].Put(TEST_HASH+".meta", []byte("metadata"))
344         vols[1].Put(TEST_HASH_2+".meta", []byte("metadata"))
345
346         index := vols[0].Index("") + vols[1].Index("")
347         index_rows := strings.Split(index, "\n")
348         sort.Strings(index_rows)
349         sorted_index := strings.Join(index_rows, "\n")
350         expected := `^\n` + TEST_HASH + `\+\d+ \d+\n` +
351                 TEST_HASH_3 + `\+\d+ \d+\n` +
352                 TEST_HASH_2 + `\+\d+ \d+$`
353
354         match, err := regexp.MatchString(expected, sorted_index)
355         if err == nil {
356                 if !match {
357                         t.Errorf("IndexLocators returned:\n%s", index)
358                 }
359         } else {
360                 t.Errorf("regexp.MatchString: %s", err)
361         }
362 }
363
364 // TestNodeStatus
365 //     Test that GetNodeStatus returns valid info about available volumes.
366 //
367 //     TODO(twp): set up appropriate interfaces to permit more rigorous
368 //     testing.
369 //
370 func TestNodeStatus(t *testing.T) {
371         defer teardown()
372
373         // Set up test Keep volumes with some blocks.
374         KeepVM = MakeTestVolumeManager(2)
375         defer func() { KeepVM.Quit() }()
376
377         vols := KeepVM.Volumes()
378         vols[0].Put(TEST_HASH, TEST_BLOCK)
379         vols[1].Put(TEST_HASH_2, TEST_BLOCK_2)
380
381         // Get node status and make a basic sanity check.
382         st := GetNodeStatus()
383         for i := range vols {
384                 volinfo := st.Volumes[i]
385                 mtp := volinfo.MountPoint
386                 if mtp != "/bogo" {
387                         t.Errorf("GetNodeStatus mount_point %s, expected /bogo", mtp)
388                 }
389                 if volinfo.DeviceNum == 0 {
390                         t.Errorf("uninitialized device_num in %v", volinfo)
391                 }
392                 if volinfo.BytesFree == 0 {
393                         t.Errorf("uninitialized bytes_free in %v", volinfo)
394                 }
395                 if volinfo.BytesUsed == 0 {
396                         t.Errorf("uninitialized bytes_used in %v", volinfo)
397                 }
398         }
399 }
400
401 // ========================================
402 // Helper functions for unit tests.
403 // ========================================
404
405 // MakeTestVolumeManager
406 //     Creates and returns a RRVolumeManager with the specified number
407 //     of MockVolumes.
408 //
409 func MakeTestVolumeManager(num_volumes int) VolumeManager {
410         vols := make([]Volume, num_volumes)
411         for i := range vols {
412                 vols[i] = CreateMockVolume()
413         }
414         return MakeRRVolumeManager(vols)
415 }
416
417 // teardown
418 //     Cleanup to perform after each test.
419 //
420 func teardown() {
421         data_manager_token = ""
422         enforce_permissions = false
423         PermissionSecret = nil
424         KeepVM = nil
425 }