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 // TestPutBlockCollision
 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 // TestPutBlockTouchFails
 249 //     When PutBlock is asked to PUT an existing block, but cannot
 250 //     modify the timestamp, it should write a second block.
 251 //
 252 func TestPutBlockTouchFails(t *testing.T) {
 253         defer teardown()
 254
 255         // Prepare two test Keep volumes.
 256         KeepVM = MakeTestVolumeManager(2)
 257         defer func() { KeepVM.Quit() }()
 258         vols := KeepVM.Volumes()
 259
 260         // Store a block and then make the underlying volume bad,
 261         // so a subsequent attempt to update the file timestamp
 262         // will fail.
 263         vols[0].Put(TEST_HASH, BAD_BLOCK)
 264         old_mtime, err := vols[0].Mtime(TEST_HASH)
 265         if err != nil {
 266                 t.Fatalf("vols[0].Mtime(%s): %s\n", TEST_HASH, err)
 267         }
 268
 269         // vols[0].Touch will fail on the next call, so the volume
 270         // manager will store a copy on vols[1] instead.
 271         vols[0].(*MockVolume).Touchable = false
 272         if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
 273                 t.Fatalf("PutBlock: %v", err)
 274         }
 275         vols[0].(*MockVolume).Touchable = true
 276
 277         // Now the mtime on the block on vols[0] should be unchanged, and
 278         // there should be a copy of the block on vols[1].
 279         new_mtime, err := vols[0].Mtime(TEST_HASH)
 280         if err != nil {
 281                 t.Fatalf("vols[0].Mtime(%s): %s\n", TEST_HASH, err)
 282         }
 283         if !new_mtime.Equal(old_mtime) {
 284                 t.Errorf("mtime was changed on vols[0]:\nold_mtime = %v\nnew_mtime = %v\n",
 285                         old_mtime, new_mtime)
 286         }
 287         result, err := vols[1].Get(TEST_HASH)
 288         if err != nil {
 289                 t.Fatalf("vols[1]: %v", err)
 290         }
 291         if bytes.Compare(result, TEST_BLOCK) != 0 {
 292                 t.Errorf("new block does not match test block\nnew block = %v\n", result)
 293         }
 294 }
 295
 296 // ========================================
 297 // FindKeepVolumes tests.
 298 // ========================================
 299
 300 // TestFindKeepVolumes
 301 //     Confirms that FindKeepVolumes finds tmpfs volumes with "/keep"
 302 //     directories at the top level.
 303 //
 304 func TestFindKeepVolumes(t *testing.T) {
 305         var tempVols [2]string
 306         var err error
 307
 308         defer func() {
 309                 for _, path := range tempVols {
 310                         os.RemoveAll(path)
 311                 }
 312         }()
 313
 314         // Create two directories suitable for using as keep volumes.
 315         for i := range tempVols {
 316                 if tempVols[i], err = ioutil.TempDir("", "findvol"); err != nil {
 317                         t.Fatal(err)
 318                 }
 319                 tempVols[i] = tempVols[i] + "/keep"
 320                 if err = os.Mkdir(tempVols[i], 0755); err != nil {
 321                         t.Fatal(err)
 322                 }
 323         }
 324
 325         // Set up a bogus PROC_MOUNTS file.
 326         if f, err := ioutil.TempFile("", "keeptest"); err == nil {
 327                 for _, vol := range tempVols {
 328                         fmt.Fprintf(f, "tmpfs %s tmpfs opts\n", path.Dir(vol))
 329                 }
 330                 f.Close()
 331                 PROC_MOUNTS = f.Name()
 332
 333                 // Check that FindKeepVolumes finds the temp volumes.
 334                 resultVols := FindKeepVolumes()
 335                 if len(tempVols) != len(resultVols) {
 336                         t.Fatalf("set up %d volumes, FindKeepVolumes found %d\n",
 337                                 len(tempVols), len(resultVols))
 338                 }
 339                 for i := range tempVols {
 340                         if tempVols[i] != resultVols[i] {
 341                                 t.Errorf("FindKeepVolumes returned %s, expected %s\n",
 342                                         resultVols[i], tempVols[i])
 343                         }
 344                 }
 345
 346                 os.Remove(f.Name())
 347         }
 348 }
 349
 350 // TestFindKeepVolumesFail
 351 //     When no Keep volumes are present, FindKeepVolumes returns an empty slice.
 352 //
 353 func TestFindKeepVolumesFail(t *testing.T) {
 354         defer teardown()
 355
 356         // Set up a bogus PROC_MOUNTS file with no Keep vols.
 357         if f, err := ioutil.TempFile("", "keeptest"); err == nil {
 358                 fmt.Fprintln(f, "rootfs / rootfs opts 0 0")
 359                 fmt.Fprintln(f, "sysfs /sys sysfs opts 0 0")
 360                 fmt.Fprintln(f, "proc /proc proc opts 0 0")
 361                 fmt.Fprintln(f, "udev /dev devtmpfs opts 0 0")
 362                 fmt.Fprintln(f, "devpts /dev/pts devpts opts 0 0")
 363                 f.Close()
 364                 PROC_MOUNTS = f.Name()
 365
 366                 // Check that FindKeepVolumes returns an empty array.
 367                 resultVols := FindKeepVolumes()
 368                 if len(resultVols) != 0 {
 369                         t.Fatalf("FindKeepVolumes returned %v", resultVols)
 370                 }
 371
 372                 os.Remove(PROC_MOUNTS)
 373         }
 374 }
 375
 376 // TestIndex
 377 //     Test an /index request.
 378 func TestIndex(t *testing.T) {
 379         defer teardown()
 380
 381         // Set up Keep volumes and populate them.
 382         // Include multiple blocks on different volumes, and
 383         // some metadata files.
 384         KeepVM = MakeTestVolumeManager(2)
 385         defer func() { KeepVM.Quit() }()
 386
 387         vols := KeepVM.Volumes()
 388         vols[0].Put(TEST_HASH, TEST_BLOCK)
 389         vols[1].Put(TEST_HASH_2, TEST_BLOCK_2)
 390         vols[0].Put(TEST_HASH_3, TEST_BLOCK_3)
 391         vols[0].Put(TEST_HASH+".meta", []byte("metadata"))
 392         vols[1].Put(TEST_HASH_2+".meta", []byte("metadata"))
 393
 394         index := vols[0].Index("") + vols[1].Index("")
 395         index_rows := strings.Split(index, "\n")
 396         sort.Strings(index_rows)
 397         sorted_index := strings.Join(index_rows, "\n")
 398         expected := `^\n` + TEST_HASH + `\+\d+ \d+\n` +
 399                 TEST_HASH_3 + `\+\d+ \d+\n` +
 400                 TEST_HASH_2 + `\+\d+ \d+$`
 401
 402         match, err := regexp.MatchString(expected, sorted_index)
 403         if err == nil {
 404                 if !match {
 405                         t.Errorf("IndexLocators returned:\n%s", index)
 406                 }
 407         } else {
 408                 t.Errorf("regexp.MatchString: %s", err)
 409         }
 410 }
 411
 412 // TestNodeStatus
 413 //     Test that GetNodeStatus returns valid info about available volumes.
 414 //
 415 //     TODO(twp): set up appropriate interfaces to permit more rigorous
 416 //     testing.
 417 //
 418 func TestNodeStatus(t *testing.T) {
 419         defer teardown()
 420
 421         // Set up test Keep volumes with some blocks.
 422         KeepVM = MakeTestVolumeManager(2)
 423         defer func() { KeepVM.Quit() }()
 424
 425         vols := KeepVM.Volumes()
 426         vols[0].Put(TEST_HASH, TEST_BLOCK)
 427         vols[1].Put(TEST_HASH_2, TEST_BLOCK_2)
 428
 429         // Get node status and make a basic sanity check.
 430         st := GetNodeStatus()
 431         for i := range vols {
 432                 volinfo := st.Volumes[i]
 433                 mtp := volinfo.MountPoint
 434                 if mtp != "/bogo" {
 435                         t.Errorf("GetNodeStatus mount_point %s, expected /bogo", mtp)
 436                 }
 437                 if volinfo.DeviceNum == 0 {
 438                         t.Errorf("uninitialized device_num in %v", volinfo)
 439                 }
 440                 if volinfo.BytesFree == 0 {
 441                         t.Errorf("uninitialized bytes_free in %v", volinfo)
 442                 }
 443                 if volinfo.BytesUsed == 0 {
 444                         t.Errorf("uninitialized bytes_used in %v", volinfo)
 445                 }
 446         }
 447 }
 448
 449 // ========================================
 450 // Helper functions for unit tests.
 451 // ========================================
 452
 453 // MakeTestVolumeManager
 454 //     Creates and returns a RRVolumeManager with the specified number
 455 //     of MockVolumes.
 456 //
 457 func MakeTestVolumeManager(num_volumes int) VolumeManager {
 458         vols := make([]Volume, num_volumes)
 459         for i := range vols {
 460                 vols[i] = CreateMockVolume()
 461         }
 462         return MakeRRVolumeManager(vols)
 463 }
 464
 465 // teardown
 466 //     Cleanup to perform after each test.
 467 //
 468 func teardown() {
 469         data_manager_token = ""
 470         enforce_permissions = false
 471         PermissionSecret = nil
 472         KeepVM = nil
 473 }