7179: some more golint suggested updates
[arvados.git] / services / keepstore / keepstore_test.go
index b153d6dce27309f3cb692ec0d6a84b724386891a..dc641abe0cc39a08ed2cc76871c030897767d277 100644 (file)
@@ -12,19 +12,19 @@ import (
        "testing"
 )
 
-var TEST_BLOCK = []byte("The quick brown fox jumps over the lazy dog.")
-var TEST_HASH = "e4d909c290d0fb1ca068ffaddf22cbd0"
-var TEST_HASH_PUT_RESPONSE = "e4d909c290d0fb1ca068ffaddf22cbd0+44\n"
+var TestBlock = []byte("The quick brown fox jumps over the lazy dog.")
+var TestHash = "e4d909c290d0fb1ca068ffaddf22cbd0"
+var TestHashPutResp = "e4d909c290d0fb1ca068ffaddf22cbd0+44\n"
 
-var TEST_BLOCK_2 = []byte("Pack my box with five dozen liquor jugs.")
-var TEST_HASH_2 = "f15ac516f788aec4f30932ffb6395c39"
+var TestBlock2 = []byte("Pack my box with five dozen liquor jugs.")
+var TestHash2 = "f15ac516f788aec4f30932ffb6395c39"
 
-var TEST_BLOCK_3 = []byte("Now is the time for all good men to come to the aid of their country.")
-var TEST_HASH_3 = "eed29bbffbc2dbe5e5ee0bb71888e61f"
+var TestBlock3 = []byte("Now is the time for all good men to come to the aid of their country.")
+var TestHash3 = "eed29bbffbc2dbe5e5ee0bb71888e61f"
 
-// BAD_BLOCK is used to test collisions and corruption.
+// BadBlock is used to test collisions and corruption.
 // It must not match any test hashes.
-var BAD_BLOCK = []byte("The magic words are squeamish ossifrage.")
+var BadBlock = []byte("The magic words are squeamish ossifrage.")
 
 // TODO(twp): Tests still to be written
 //
@@ -52,20 +52,20 @@ func TestGetBlock(t *testing.T) {
 
        // Prepare two test Keep volumes. Our block is stored on the second volume.
        KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
+       defer KeepVM.Close()
 
-       vols := KeepVM.Volumes()
-       if err := vols[1].Put(TEST_HASH, TEST_BLOCK); err != nil {
+       vols := KeepVM.AllReadable()
+       if err := vols[1].Put(TestHash, TestBlock); err != nil {
                t.Error(err)
        }
 
        // Check that GetBlock returns success.
-       result, err := GetBlock(TEST_HASH)
+       result, err := GetBlock(TestHash)
        if err != nil {
                t.Errorf("GetBlock error: %s", err)
        }
-       if fmt.Sprint(result) != fmt.Sprint(TEST_BLOCK) {
-               t.Errorf("expected %s, got %s", TEST_BLOCK, result)
+       if fmt.Sprint(result) != fmt.Sprint(TestBlock) {
+               t.Errorf("expected %s, got %s", TestBlock, result)
        }
 }
 
@@ -77,10 +77,10 @@ func TestGetBlockMissing(t *testing.T) {
 
        // Create two empty test Keep volumes.
        KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
+       defer KeepVM.Close()
 
        // Check that GetBlock returns failure.
-       result, err := GetBlock(TEST_HASH)
+       result, err := GetBlock(TestHash)
        if err != NotFoundError {
                t.Errorf("Expected NotFoundError, got %v", result)
        }
@@ -95,13 +95,13 @@ func TestGetBlockCorrupt(t *testing.T) {
 
        // Create two test Keep volumes and store a corrupt block in one.
        KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
+       defer KeepVM.Close()
 
-       vols := KeepVM.Volumes()
-       vols[0].Put(TEST_HASH, BAD_BLOCK)
+       vols := KeepVM.AllReadable()
+       vols[0].Put(TestHash, BadBlock)
 
        // Check that GetBlock returns failure.
-       result, err := GetBlock(TEST_HASH)
+       result, err := GetBlock(TestHash)
        if err != DiskHashError {
                t.Errorf("Expected DiskHashError, got %v (buf: %v)", err, result)
        }
@@ -119,21 +119,21 @@ func TestPutBlockOK(t *testing.T) {
 
        // Create two test Keep volumes.
        KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
+       defer KeepVM.Close()
 
        // Check that PutBlock stores the data as expected.
-       if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
+       if err := PutBlock(TestBlock, TestHash); err != nil {
                t.Fatalf("PutBlock: %v", err)
        }
 
-       vols := KeepVM.Volumes()
-       result, err := vols[0].Get(TEST_HASH)
+       vols := KeepVM.AllReadable()
+       result, err := vols[1].Get(TestHash)
        if err != nil {
                t.Fatalf("Volume #0 Get returned error: %v", err)
        }
-       if string(result) != string(TEST_BLOCK) {
+       if string(result) != string(TestBlock) {
                t.Fatalf("PutBlock stored '%s', Get retrieved '%s'",
-                       string(TEST_BLOCK), string(result))
+                       string(TestBlock), string(result))
        }
 }
 
@@ -146,24 +146,24 @@ func TestPutBlockOneVol(t *testing.T) {
 
        // Create two test Keep volumes, but cripple one of them.
        KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
+       defer KeepVM.Close()
 
-       vols := KeepVM.Volumes()
+       vols := KeepVM.AllWritable()
        vols[0].(*MockVolume).Bad = true
 
        // Check that PutBlock stores the data as expected.
-       if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
+       if err := PutBlock(TestBlock, TestHash); err != nil {
                t.Fatalf("PutBlock: %v", err)
        }
 
-       result, err := GetBlock(TEST_HASH)
+       result, err := GetBlock(TestHash)
        if err != nil {
                t.Fatalf("GetBlock: %v", err)
        }
-       if string(result) != string(TEST_BLOCK) {
+       if string(result) != string(TestBlock) {
                t.Error("PutBlock/GetBlock mismatch")
                t.Fatalf("PutBlock stored '%s', GetBlock retrieved '%s'",
-                       string(TEST_BLOCK), string(result))
+                       string(TestBlock), string(result))
        }
 }
 
@@ -176,16 +176,16 @@ func TestPutBlockMD5Fail(t *testing.T) {
 
        // Create two test Keep volumes.
        KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
+       defer KeepVM.Close()
 
        // Check that PutBlock returns the expected error when the hash does
        // not match the block.
-       if err := PutBlock(BAD_BLOCK, TEST_HASH); err != RequestHashError {
+       if err := PutBlock(BadBlock, TestHash); err != RequestHashError {
                t.Error("Expected RequestHashError, got %v", err)
        }
 
        // Confirm that GetBlock fails to return anything.
-       if result, err := GetBlock(TEST_HASH); err != NotFoundError {
+       if result, err := GetBlock(TestHash); err != NotFoundError {
                t.Errorf("GetBlock succeeded after a corrupt block store (result = %s, err = %v)",
                        string(result), err)
        }
@@ -200,24 +200,24 @@ func TestPutBlockCorrupt(t *testing.T) {
 
        // Create two test Keep volumes.
        KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
+       defer KeepVM.Close()
 
-       // Store a corrupted block under TEST_HASH.
-       vols := KeepVM.Volumes()
-       vols[0].Put(TEST_HASH, BAD_BLOCK)
-       if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
+       // Store a corrupted block under TestHash.
+       vols := KeepVM.AllWritable()
+       vols[0].Put(TestHash, BadBlock)
+       if err := PutBlock(TestBlock, TestHash); err != nil {
                t.Errorf("PutBlock: %v", err)
        }
 
-       // The block on disk should now match TEST_BLOCK.
-       if block, err := GetBlock(TEST_HASH); err != nil {
+       // The block on disk should now match TestBlock.
+       if block, err := GetBlock(TestHash); err != nil {
                t.Errorf("GetBlock: %v", err)
-       } else if bytes.Compare(block, TEST_BLOCK) != 0 {
+       } else if bytes.Compare(block, TestBlock) != 0 {
                t.Errorf("GetBlock returned: '%s'", string(block))
        }
 }
 
-// PutBlockCollision
+// TestPutBlockCollision
 //     PutBlock returns a 400 Collision error when attempting to
 //     store a block that collides with another block on disk.
 //
@@ -231,7 +231,7 @@ func TestPutBlockCollision(t *testing.T) {
 
        // Prepare two test Keep volumes.
        KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
+       defer KeepVM.Close()
 
        // Store one block, then attempt to store the other. Confirm that
        // PutBlock reported a CollisionError.
@@ -245,83 +245,134 @@ func TestPutBlockCollision(t *testing.T) {
        }
 }
 
-// ========================================
-// FindKeepVolumes tests.
-// ========================================
-
-// TestFindKeepVolumes
-//     Confirms that FindKeepVolumes finds tmpfs volumes with "/keep"
-//     directories at the top level.
+// TestPutBlockTouchFails
+//     When PutBlock is asked to PUT an existing block, but cannot
+//     modify the timestamp, it should write a second block.
 //
-func TestFindKeepVolumes(t *testing.T) {
-       var tempVols [2]string
-       var err error
+func TestPutBlockTouchFails(t *testing.T) {
+       defer teardown()
 
-       defer func() {
-               for _, path := range tempVols {
-                       os.RemoveAll(path)
-               }
-       }()
+       // Prepare two test Keep volumes.
+       KeepVM = MakeTestVolumeManager(2)
+       defer KeepVM.Close()
+       vols := KeepVM.AllWritable()
+
+       // Store a block and then make the underlying volume bad,
+       // so a subsequent attempt to update the file timestamp
+       // will fail.
+       vols[0].Put(TestHash, BadBlock)
+       oldMtime, err := vols[0].Mtime(TestHash)
+       if err != nil {
+               t.Fatalf("vols[0].Mtime(%s): %s\n", TestHash, err)
+       }
 
-       // Create two directories suitable for using as keep volumes.
+       // vols[0].Touch will fail on the next call, so the volume
+       // manager will store a copy on vols[1] instead.
+       vols[0].(*MockVolume).Touchable = false
+       if err := PutBlock(TestBlock, TestHash); err != nil {
+               t.Fatalf("PutBlock: %v", err)
+       }
+       vols[0].(*MockVolume).Touchable = true
+
+       // Now the mtime on the block on vols[0] should be unchanged, and
+       // there should be a copy of the block on vols[1].
+       newMtime, err := vols[0].Mtime(TestHash)
+       if err != nil {
+               t.Fatalf("vols[0].Mtime(%s): %s\n", TestHash, err)
+       }
+       if !newMtime.Equal(oldMtime) {
+               t.Errorf("mtime was changed on vols[0]:\noldMtime = %v\nnewMtime = %v\n",
+                       oldMtime, newMtime)
+       }
+       result, err := vols[1].Get(TestHash)
+       if err != nil {
+               t.Fatalf("vols[1]: %v", err)
+       }
+       if bytes.Compare(result, TestBlock) != 0 {
+               t.Errorf("new block does not match test block\nnew block = %v\n", result)
+       }
+}
+
+func TestDiscoverTmpfs(t *testing.T) {
+       var tempVols [4]string
+       var err error
+
+       // Create some directories suitable for using as keep volumes.
        for i := range tempVols {
                if tempVols[i], err = ioutil.TempDir("", "findvol"); err != nil {
                        t.Fatal(err)
                }
+               defer os.RemoveAll(tempVols[i])
                tempVols[i] = tempVols[i] + "/keep"
                if err = os.Mkdir(tempVols[i], 0755); err != nil {
                        t.Fatal(err)
                }
        }
 
-       // Set up a bogus PROC_MOUNTS file.
-       if f, err := ioutil.TempFile("", "keeptest"); err == nil {
-               for _, vol := range tempVols {
-                       fmt.Fprintf(f, "tmpfs %s tmpfs opts\n", path.Dir(vol))
+       // Set up a bogus ProcMounts file.
+       f, err := ioutil.TempFile("", "keeptest")
+       if err != nil {
+               t.Fatal(err)
+       }
+       defer os.Remove(f.Name())
+       for i, vol := range tempVols {
+               // Add readonly mount points at odd indexes.
+               var opts string
+               switch i % 2 {
+               case 0:
+                       opts = "rw,nosuid,nodev,noexec"
+               case 1:
+                       opts = "nosuid,nodev,noexec,ro"
                }
-               f.Close()
-               PROC_MOUNTS = f.Name()
-
-               // Check that FindKeepVolumes finds the temp volumes.
-               resultVols := FindKeepVolumes()
-               if len(tempVols) != len(resultVols) {
-                       t.Fatalf("set up %d volumes, FindKeepVolumes found %d\n",
-                               len(tempVols), len(resultVols))
+               fmt.Fprintf(f, "tmpfs %s tmpfs %s 0 0\n", path.Dir(vol), opts)
+       }
+       f.Close()
+       ProcMounts = f.Name()
+
+       var resultVols volumeSet
+       added := resultVols.Discover()
+
+       if added != len(resultVols) {
+               t.Errorf("Discover returned %d, but added %d volumes",
+                       added, len(resultVols))
+       }
+       if added != len(tempVols) {
+               t.Errorf("Discover returned %d but we set up %d volumes",
+                       added, len(tempVols))
+       }
+       for i, tmpdir := range tempVols {
+               if tmpdir != resultVols[i].(*UnixVolume).root {
+                       t.Errorf("Discover returned %s, expected %s\n",
+                               resultVols[i].(*UnixVolume).root, tmpdir)
                }
-               for i := range tempVols {
-                       if tempVols[i] != resultVols[i] {
-                               t.Errorf("FindKeepVolumes returned %s, expected %s\n",
-                                       resultVols[i], tempVols[i])
-                       }
+               if expectReadonly := i%2 == 1; expectReadonly != resultVols[i].(*UnixVolume).readonly {
+                       t.Errorf("Discover added %s with readonly=%v, should be %v",
+                               tmpdir, !expectReadonly, expectReadonly)
                }
-
-               os.Remove(f.Name())
        }
 }
 
-// TestFindKeepVolumesFail
-//     When no Keep volumes are present, FindKeepVolumes returns an empty slice.
-//
-func TestFindKeepVolumesFail(t *testing.T) {
+func TestDiscoverNone(t *testing.T) {
        defer teardown()
 
-       // Set up a bogus PROC_MOUNTS file with no Keep vols.
-       if f, err := ioutil.TempFile("", "keeptest"); err == nil {
-               fmt.Fprintln(f, "rootfs / rootfs opts 0 0")
-               fmt.Fprintln(f, "sysfs /sys sysfs opts 0 0")
-               fmt.Fprintln(f, "proc /proc proc opts 0 0")
-               fmt.Fprintln(f, "udev /dev devtmpfs opts 0 0")
-               fmt.Fprintln(f, "devpts /dev/pts devpts opts 0 0")
-               f.Close()
-               PROC_MOUNTS = f.Name()
-
-               // Check that FindKeepVolumes returns an empty array.
-               resultVols := FindKeepVolumes()
-               if len(resultVols) != 0 {
-                       t.Fatalf("FindKeepVolumes returned %v", resultVols)
-               }
-
-               os.Remove(PROC_MOUNTS)
+       // Set up a bogus ProcMounts file with no Keep vols.
+       f, err := ioutil.TempFile("", "keeptest")
+       if err != nil {
+               t.Fatal(err)
+       }
+       defer os.Remove(f.Name())
+       fmt.Fprintln(f, "rootfs / rootfs opts 0 0")
+       fmt.Fprintln(f, "sysfs /sys sysfs opts 0 0")
+       fmt.Fprintln(f, "proc /proc proc opts 0 0")
+       fmt.Fprintln(f, "udev /dev devtmpfs opts 0 0")
+       fmt.Fprintln(f, "devpts /dev/pts devpts opts 0 0")
+       f.Close()
+       ProcMounts = f.Name()
+
+       var resultVols volumeSet
+       added := resultVols.Discover()
+       if added != 0 || len(resultVols) != 0 {
+               t.Fatalf("got %d, %v; expected 0, []", added, resultVols)
        }
 }
 
@@ -334,92 +385,53 @@ func TestIndex(t *testing.T) {
        // Include multiple blocks on different volumes, and
        // some metadata files.
        KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
-
-       vols := KeepVM.Volumes()
-       vols[0].Put(TEST_HASH, TEST_BLOCK)
-       vols[1].Put(TEST_HASH_2, TEST_BLOCK_2)
-       vols[0].Put(TEST_HASH_3, TEST_BLOCK_3)
-       vols[0].Put(TEST_HASH+".meta", []byte("metadata"))
-       vols[1].Put(TEST_HASH_2+".meta", []byte("metadata"))
-
-       index := vols[0].Index("") + vols[1].Index("")
-       index_rows := strings.Split(index, "\n")
-       sort.Strings(index_rows)
-       sorted_index := strings.Join(index_rows, "\n")
-       expected := `^\n` + TEST_HASH + `\+\d+ \d+\n` +
-               TEST_HASH_3 + `\+\d+ \d+\n` +
-               TEST_HASH_2 + `\+\d+ \d+$`
-
-       match, err := regexp.MatchString(expected, sorted_index)
+       defer KeepVM.Close()
+
+       vols := KeepVM.AllReadable()
+       vols[0].Put(TestHash, TestBlock)
+       vols[1].Put(TestHash2, TestBlock2)
+       vols[0].Put(TestHash3, TestBlock3)
+       vols[0].Put(TestHash+".meta", []byte("metadata"))
+       vols[1].Put(TestHash2+".meta", []byte("metadata"))
+
+       buf := new(bytes.Buffer)
+       vols[0].IndexTo("", buf)
+       vols[1].IndexTo("", buf)
+       indexRows := strings.Split(string(buf.Bytes()), "\n")
+       sort.Strings(indexRows)
+       sortedIndex := strings.Join(indexRows, "\n")
+       expected := `^\n` + TestHash + `\+\d+ \d+\n` +
+               TestHash3 + `\+\d+ \d+\n` +
+               TestHash2 + `\+\d+ \d+$`
+
+       match, err := regexp.MatchString(expected, sortedIndex)
        if err == nil {
                if !match {
-                       t.Errorf("IndexLocators returned:\n%s", index)
+                       t.Errorf("IndexLocators returned:\n%s", string(buf.Bytes()))
                }
        } else {
                t.Errorf("regexp.MatchString: %s", err)
        }
 }
 
-// TestNodeStatus
-//     Test that GetNodeStatus returns valid info about available volumes.
-//
-//     TODO(twp): set up appropriate interfaces to permit more rigorous
-//     testing.
-//
-func TestNodeStatus(t *testing.T) {
-       defer teardown()
-
-       // Set up test Keep volumes with some blocks.
-       KeepVM = MakeTestVolumeManager(2)
-       defer func() { KeepVM.Quit() }()
-
-       vols := KeepVM.Volumes()
-       vols[0].Put(TEST_HASH, TEST_BLOCK)
-       vols[1].Put(TEST_HASH_2, TEST_BLOCK_2)
-
-       // Get node status and make a basic sanity check.
-       st := GetNodeStatus()
-       for i := range vols {
-               volinfo := st.Volumes[i]
-               mtp := volinfo.MountPoint
-               if mtp != "/bogo" {
-                       t.Errorf("GetNodeStatus mount_point %s, expected /bogo", mtp)
-               }
-               if volinfo.DeviceNum == 0 {
-                       t.Errorf("uninitialized device_num in %v", volinfo)
-               }
-               if volinfo.BytesFree == 0 {
-                       t.Errorf("uninitialized bytes_free in %v", volinfo)
-               }
-               if volinfo.BytesUsed == 0 {
-                       t.Errorf("uninitialized bytes_used in %v", volinfo)
-               }
-       }
-}
-
 // ========================================
 // Helper functions for unit tests.
 // ========================================
 
-// MakeTestVolumeManager
-//     Creates and returns a RRVolumeManager with the specified number
-//     of MockVolumes.
-//
-func MakeTestVolumeManager(num_volumes int) VolumeManager {
-       vols := make([]Volume, num_volumes)
+// MakeTestVolumeManager returns a RRVolumeManager with the specified
+// number of MockVolumes.
+func MakeTestVolumeManager(numVolumes int) VolumeManager {
+       vols := make([]Volume, numVolumes)
        for i := range vols {
                vols[i] = CreateMockVolume()
        }
        return MakeRRVolumeManager(vols)
 }
 
-// teardown
-//     Cleanup to perform after each test.
-//
+// teardown cleans up after each test.
 func teardown() {
        data_manager_token = ""
-       enforce_permissions = false
+       enforcePermissions = false
        PermissionSecret = nil
        KeepVM = nil
 }