Merge branch '8087-arv-cli-request-body-from-file' of https://github.com/wtsi-hgi...
[arvados.git] / services / keepstore / volume_generic_test.go
index f1b27bece2b4885a20aa0662768d9bea4b3bc71d..95166c252f004bef5a1ba1f583f4e13f54117f47 100644 (file)
@@ -2,33 +2,57 @@ package main
 
 import (
        "bytes"
+       "crypto/md5"
+       "fmt"
        "os"
        "regexp"
        "sort"
        "strings"
-       "testing"
        "time"
+
+       "git.curoverse.com/arvados.git/sdk/go/arvadostest"
 )
 
+type TB interface {
+       Error(args ...interface{})
+       Errorf(format string, args ...interface{})
+       Fail()
+       FailNow()
+       Failed() bool
+       Fatal(args ...interface{})
+       Fatalf(format string, args ...interface{})
+       Log(args ...interface{})
+       Logf(format string, args ...interface{})
+}
+
 // A TestableVolumeFactory returns a new TestableVolume. The factory
-// function, and the TestableVolume it returns, can use t to write
+// function, and the TestableVolume it returns, can use "t" to write
 // logs, fail the current test, etc.
-type TestableVolumeFactory func(t *testing.T) TestableVolume
+type TestableVolumeFactory func(t TB) TestableVolume
 
 // DoGenericVolumeTests runs a set of tests that every TestableVolume
-// is expected to pass. It calls factory to create a new writable
-// TestableVolume for each test case, to avoid leaking state between
-// tests.
-func DoGenericVolumeTests(t *testing.T, factory TestableVolumeFactory) {
+// is expected to pass. It calls factory to create a new TestableVolume
+// for each test case, to avoid leaking state between tests.
+func DoGenericVolumeTests(t TB, factory TestableVolumeFactory) {
        testGet(t, factory)
        testGetNoSuchBlock(t, factory)
 
-       testCompareSameContent(t, factory)
-       testCompareWithDifferentContent(t, factory)
-       testCompareWithBadData(t, factory)
-
-       testPutBlockWithSameContent(t, factory)
-       testPutBlockWithDifferentContent(t, factory)
+       testCompareNonexistent(t, factory)
+       testCompareSameContent(t, factory, TestHash, TestBlock)
+       testCompareSameContent(t, factory, EmptyHash, EmptyBlock)
+       testCompareWithCollision(t, factory, TestHash, TestBlock, []byte("baddata"))
+       testCompareWithCollision(t, factory, TestHash, TestBlock, EmptyBlock)
+       testCompareWithCollision(t, factory, EmptyHash, EmptyBlock, TestBlock)
+       testCompareWithCorruptStoredData(t, factory, TestHash, TestBlock, []byte("baddata"))
+       testCompareWithCorruptStoredData(t, factory, TestHash, TestBlock, EmptyBlock)
+       testCompareWithCorruptStoredData(t, factory, EmptyHash, EmptyBlock, []byte("baddata"))
+
+       testPutBlockWithSameContent(t, factory, TestHash, TestBlock)
+       testPutBlockWithSameContent(t, factory, EmptyHash, EmptyBlock)
+       testPutBlockWithDifferentContent(t, factory, arvadostest.MD5CollisionMD5, arvadostest.MD5CollisionData[0], arvadostest.MD5CollisionData[1])
+       testPutBlockWithDifferentContent(t, factory, arvadostest.MD5CollisionMD5, EmptyBlock, arvadostest.MD5CollisionData[0])
+       testPutBlockWithDifferentContent(t, factory, arvadostest.MD5CollisionMD5, arvadostest.MD5CollisionData[0], EmptyBlock)
+       testPutBlockWithDifferentContent(t, factory, EmptyHash, EmptyBlock, arvadostest.MD5CollisionData[0])
        testPutMultipleBlocks(t, factory)
 
        testPutAndTouch(t, factory)
@@ -46,175 +70,233 @@ func DoGenericVolumeTests(t *testing.T, factory TestableVolumeFactory) {
 
        testString(t, factory)
 
-       testWritableTrue(t, factory)
+       testUpdateReadOnly(t, factory)
 
-       testGetSerialized(t, factory)
-       testPutSerialized(t, factory)
-}
+       testGetConcurrent(t, factory)
+       testPutConcurrent(t, factory)
 
-// DoGenericReadOnlyVolumeTests runs a set of tests that every
-// read-only TestableVolume is expected to pass. It calls factory
-// to create a new read-only TestableVolume for each test case,
-// to avoid leaking state between tests.
-func DoGenericReadOnlyVolumeTests(t *testing.T, factory TestableVolumeFactory) {
-       testWritableFalse(t, factory)
-       testUpdateReadOnly(t, factory)
+       testPutFullBlock(t, factory)
+
+       testTrashUntrash(t, factory)
+       testTrashEmptyTrashUntrash(t, factory)
 }
 
 // Put a test block, get it and verify content
-func testGet(t *testing.T, factory TestableVolumeFactory) {
+// Test should pass for both writable and read-only volumes
+func testGet(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
-       v.Put(TEST_HASH, TEST_BLOCK)
 
-       buf, err := v.Get(TEST_HASH)
+       v.PutRaw(TestHash, TestBlock)
+
+       buf, err := v.Get(TestHash)
        if err != nil {
-               t.Error(err)
+               t.Fatal(err)
        }
-       if bytes.Compare(buf, TEST_BLOCK) != 0 {
-               t.Errorf("expected %s, got %s", string(TEST_BLOCK), string(buf))
+
+       bufs.Put(buf)
+
+       if bytes.Compare(buf, TestBlock) != 0 {
+               t.Errorf("expected %s, got %s", string(TestBlock), string(buf))
        }
 }
 
 // Invoke get on a block that does not exist in volume; should result in error
-func testGetNoSuchBlock(t *testing.T, factory TestableVolumeFactory) {
+// Test should pass for both writable and read-only volumes
+func testGetNoSuchBlock(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
-       v.Put(TEST_HASH, TEST_BLOCK)
 
-       if _, err := v.Get(TEST_HASH_2); err == nil {
-               t.Errorf("Expected error while getting non-existing block %v", TEST_HASH_2)
+       if _, err := v.Get(TestHash2); err == nil {
+               t.Errorf("Expected error while getting non-existing block %v", TestHash2)
+       }
+}
+
+// Compare() should return os.ErrNotExist if the block does not exist.
+// Otherwise, writing new data causes CompareAndTouch() to generate
+// error logs even though everything is working fine.
+func testCompareNonexistent(t TB, factory TestableVolumeFactory) {
+       v := factory(t)
+       defer v.Teardown()
+
+       err := v.Compare(TestHash, TestBlock)
+       if err != os.ErrNotExist {
+               t.Errorf("Got err %T %q, expected os.ErrNotExist", err, err)
        }
 }
 
 // Put a test block and compare the locator with same content
-func testCompareSameContent(t *testing.T, factory TestableVolumeFactory) {
+// Test should pass for both writable and read-only volumes
+func testCompareSameContent(t TB, factory TestableVolumeFactory, testHash string, testData []byte) {
        v := factory(t)
        defer v.Teardown()
 
-       v.Put(TEST_HASH, TEST_BLOCK)
+       v.PutRaw(testHash, testData)
 
        // Compare the block locator with same content
-       err := v.Compare(TEST_HASH, TEST_BLOCK)
+       err := v.Compare(testHash, testData)
        if err != nil {
                t.Errorf("Got err %q, expected nil", err)
        }
 }
 
-// Put a test block and compare the locator with a different content
-// Expect error due to collision
-func testCompareWithDifferentContent(t *testing.T, factory TestableVolumeFactory) {
+// Test behavior of Compare() when stored data matches expected
+// checksum but differs from new data we need to store. Requires
+// testHash = md5(testDataA).
+//
+// Test should pass for both writable and read-only volumes
+func testCompareWithCollision(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) {
        v := factory(t)
        defer v.Teardown()
 
-       v.Put(TEST_HASH, TEST_BLOCK)
+       v.PutRaw(testHash, testDataA)
 
        // Compare the block locator with different content; collision
-       err := v.Compare(TEST_HASH, []byte("baddata"))
+       err := v.Compare(TestHash, testDataB)
        if err == nil {
-               t.Errorf("Expected error due to collision")
+               t.Errorf("Got err nil, expected error due to collision")
        }
 }
 
-// Put a test block with bad data (hash does not match, but Put does not verify)
-// Compare the locator with good data whose has matches with locator
-// Expect error due to corruption.
-func testCompareWithBadData(t *testing.T, factory TestableVolumeFactory) {
+// Test behavior of Compare() when stored data has become
+// corrupted. Requires testHash = md5(testDataA) != md5(testDataB).
+//
+// Test should pass for both writable and read-only volumes
+func testCompareWithCorruptStoredData(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) {
        v := factory(t)
        defer v.Teardown()
 
-       v.Put(TEST_HASH, []byte("baddata"))
+       v.PutRaw(TestHash, testDataB)
 
-       err := v.Compare(TEST_HASH, TEST_BLOCK)
-       if err == nil {
-               t.Errorf("Expected error due to corruption")
+       err := v.Compare(testHash, testDataA)
+       if err == nil || err == CollisionError {
+               t.Errorf("Got err %+v, expected non-collision error", err)
        }
 }
 
 // Put a block and put again with same content
-func testPutBlockWithSameContent(t *testing.T, factory TestableVolumeFactory) {
+// Test is intended for only writable volumes
+func testPutBlockWithSameContent(t TB, factory TestableVolumeFactory, testHash string, testData []byte) {
        v := factory(t)
        defer v.Teardown()
 
-       err := v.Put(TEST_HASH, TEST_BLOCK)
+       if v.Writable() == false {
+               return
+       }
+
+       err := v.Put(testHash, testData)
        if err != nil {
-               t.Errorf("Got err putting block %q: %q, expected nil", TEST_BLOCK, err)
+               t.Errorf("Got err putting block %q: %q, expected nil", TestBlock, err)
        }
 
-       err = v.Put(TEST_HASH, TEST_BLOCK)
+       err = v.Put(testHash, testData)
        if err != nil {
-               t.Errorf("Got err putting block second time %q: %q, expected nil", TEST_BLOCK, err)
+               t.Errorf("Got err putting block second time %q: %q, expected nil", TestBlock, err)
        }
 }
 
 // Put a block and put again with different content
-func testPutBlockWithDifferentContent(t *testing.T, factory TestableVolumeFactory) {
+// Test is intended for only writable volumes
+func testPutBlockWithDifferentContent(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) {
        v := factory(t)
        defer v.Teardown()
 
-       err := v.Put(TEST_HASH, TEST_BLOCK)
-       if err != nil {
-               t.Errorf("Got err putting block %q: %q, expected nil", TEST_BLOCK, err)
+       if v.Writable() == false {
+               return
        }
 
-       // Whether Put with the same loc with different content fails or succeeds
-       // is implementation dependent. So, just check loc exists after overwriting.
-       // We also do not want to see if loc has block1 or block2, for the same reason.
-       if err = v.Put(TEST_HASH, TEST_BLOCK_2); err != nil {
-               t.Errorf("Got err putting block with different content %q: %q, expected nil", TEST_BLOCK, err)
+       v.PutRaw(testHash, testDataA)
+
+       putErr := v.Put(testHash, testDataB)
+       buf, getErr := v.Get(testHash)
+       if putErr == nil {
+               // Put must not return a nil error unless it has
+               // overwritten the existing data.
+               if bytes.Compare(buf, testDataB) != 0 {
+                       t.Errorf("Put succeeded but Get returned %+q, expected %+q", buf, testDataB)
+               }
+       } else {
+               // It is permissible for Put to fail, but it must
+               // leave us with either the original data, the new
+               // data, or nothing at all.
+               if getErr == nil && bytes.Compare(buf, testDataA) != 0 && bytes.Compare(buf, testDataB) != 0 {
+                       t.Errorf("Put failed but Get returned %+q, which is neither %+q nor %+q", buf, testDataA, testDataB)
+               }
        }
-       if _, err := v.Get(TEST_HASH); err != nil {
-               t.Errorf("Got err getting block %q: %q, expected nil", TEST_BLOCK, err)
+       if getErr == nil {
+               bufs.Put(buf)
        }
 }
 
 // Put and get multiple blocks
-func testPutMultipleBlocks(t *testing.T, factory TestableVolumeFactory) {
+// Test is intended for only writable volumes
+func testPutMultipleBlocks(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
-       err := v.Put(TEST_HASH, TEST_BLOCK)
+       if v.Writable() == false {
+               return
+       }
+
+       err := v.Put(TestHash, TestBlock)
        if err != nil {
-               t.Errorf("Got err putting block %q: %q, expected nil", TEST_BLOCK, err)
+               t.Errorf("Got err putting block %q: %q, expected nil", TestBlock, err)
        }
 
-       err = v.Put(TEST_HASH_2, TEST_BLOCK_2)
+       err = v.Put(TestHash2, TestBlock2)
        if err != nil {
-               t.Errorf("Got err putting block %q: %q, expected nil", TEST_BLOCK_2, err)
+               t.Errorf("Got err putting block %q: %q, expected nil", TestBlock2, err)
        }
 
-       err = v.Put(TEST_HASH_3, TEST_BLOCK_3)
+       err = v.Put(TestHash3, TestBlock3)
        if err != nil {
-               t.Errorf("Got err putting block %q: %q, expected nil", TEST_BLOCK_3, err)
+               t.Errorf("Got err putting block %q: %q, expected nil", TestBlock3, err)
        }
 
-       if data, err := v.Get(TEST_HASH); err != nil {
+       data, err := v.Get(TestHash)
+       if err != nil {
                t.Error(err)
-       } else if bytes.Compare(data, TEST_BLOCK) != 0 {
-               t.Errorf("Block present, but content is incorrect: Expected: %v  Found: %v", data, TEST_BLOCK)
+       } else {
+               if bytes.Compare(data, TestBlock) != 0 {
+                       t.Errorf("Block present, but got %+q, expected %+q", data, TestBlock)
+               }
+               bufs.Put(data)
        }
 
-       if data, err := v.Get(TEST_HASH_2); err != nil {
+       data, err = v.Get(TestHash2)
+       if err != nil {
                t.Error(err)
-       } else if bytes.Compare(data, TEST_BLOCK_2) != 0 {
-               t.Errorf("Block present, but content is incorrect: Expected: %v  Found: %v", data, TEST_BLOCK_2)
+       } else {
+               if bytes.Compare(data, TestBlock2) != 0 {
+                       t.Errorf("Block present, but got %+q, expected %+q", data, TestBlock2)
+               }
+               bufs.Put(data)
        }
 
-       if data, err := v.Get(TEST_HASH_3); err != nil {
+       data, err = v.Get(TestHash3)
+       if err != nil {
                t.Error(err)
-       } else if bytes.Compare(data, TEST_BLOCK_3) != 0 {
-               t.Errorf("Block present, but content is incorrect: Expected: %v  Found: %v", data, TEST_BLOCK_3)
+       } else {
+               if bytes.Compare(data, TestBlock3) != 0 {
+                       t.Errorf("Block present, but to %+q, expected %+q", data, TestBlock3)
+               }
+               bufs.Put(data)
        }
 }
 
 // testPutAndTouch
 //   Test that when applying PUT to a block that already exists,
 //   the block's modification time is updated.
-func testPutAndTouch(t *testing.T, factory TestableVolumeFactory) {
+// Test is intended for only writable volumes
+func testPutAndTouch(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
-       if err := v.Put(TEST_HASH, TEST_BLOCK); err != nil {
+       if v.Writable() == false {
+               return
+       }
+
+       if err := v.Put(TestHash, TestBlock); err != nil {
                t.Error(err)
        }
 
@@ -226,20 +308,20 @@ func testPutAndTouch(t *testing.T, factory TestableVolumeFactory) {
        // Set the stored block's mtime far enough in the past that we
        // can see the difference between "timestamp didn't change"
        // and "timestamp granularity is too low".
-       v.TouchWithDate(TEST_HASH, time.Now().Add(-20*time.Second))
+       v.TouchWithDate(TestHash, time.Now().Add(-20*time.Second))
 
        // Make sure v.Mtime() agrees the above Utime really worked.
-       if t0, err := v.Mtime(TEST_HASH); err != nil || t0.IsZero() || !t0.Before(threshold) {
+       if t0, err := v.Mtime(TestHash); err != nil || t0.IsZero() || !t0.Before(threshold) {
                t.Errorf("Setting mtime failed: %v, %v", t0, err)
        }
 
        // Write the same block again.
-       if err := v.Put(TEST_HASH, TEST_BLOCK); err != nil {
+       if err := v.Put(TestHash, TestBlock); err != nil {
                t.Error(err)
        }
 
        // Verify threshold < t1
-       if t1, err := v.Mtime(TEST_HASH); err != nil {
+       if t1, err := v.Mtime(TestHash); err != nil {
                t.Error(err)
        } else if t1.Before(threshold) {
                t.Errorf("t1 %v should be >= threshold %v after v.Put ", t1, threshold)
@@ -247,21 +329,19 @@ func testPutAndTouch(t *testing.T, factory TestableVolumeFactory) {
 }
 
 // Touching a non-existing block should result in error.
-func testTouchNoSuchBlock(t *testing.T, factory TestableVolumeFactory) {
+// Test should pass for both writable and read-only volumes
+func testTouchNoSuchBlock(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
-       if err := v.Put(TEST_HASH, TEST_BLOCK); err != nil {
-               t.Error(err)
-       }
-
-       if err := v.Touch(TEST_HASH); err != nil {
+       if err := v.Touch(TestHash); err == nil {
                t.Error("Expected error when attempted to touch a non-existing block")
        }
 }
 
 // Invoking Mtime on a non-existing block should result in error.
-func testMtimeNoSuchBlock(t *testing.T, factory TestableVolumeFactory) {
+// Test should pass for both writable and read-only volumes
+func testMtimeNoSuchBlock(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
@@ -274,35 +354,43 @@ func testMtimeNoSuchBlock(t *testing.T, factory TestableVolumeFactory) {
 // * no prefix
 // * with a prefix
 // * with no such prefix
-func testIndexTo(t *testing.T, factory TestableVolumeFactory) {
+// Test should pass for both writable and read-only volumes
+func testIndexTo(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
-       v.Put(TEST_HASH, TEST_BLOCK)
-       v.Put(TEST_HASH_2, TEST_BLOCK_2)
-       v.Put(TEST_HASH_3, TEST_BLOCK_3)
+       v.PutRaw(TestHash, TestBlock)
+       v.PutRaw(TestHash2, TestBlock2)
+       v.PutRaw(TestHash3, TestBlock3)
+
+       // Blocks whose names aren't Keep hashes should be omitted from
+       // index
+       v.PutRaw("fffffffffnotreallyahashfffffffff", nil)
+       v.PutRaw("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", nil)
+       v.PutRaw("f0000000000000000000000000000000f", nil)
+       v.PutRaw("f00", nil)
 
        buf := new(bytes.Buffer)
        v.IndexTo("", buf)
-       index_rows := strings.Split(string(buf.Bytes()), "\n")
-       sort.Strings(index_rows)
-       sorted_index := strings.Join(index_rows, "\n")
+       indexRows := strings.Split(string(buf.Bytes()), "\n")
+       sort.Strings(indexRows)
+       sortedIndex := strings.Join(indexRows, "\n")
        m, err := regexp.MatchString(
-               `^\n`+TEST_HASH+`\+\d+ \d+\n`+
-                       TEST_HASH_3+`\+\d+ \d+\n`+
-                       TEST_HASH_2+`\+\d+ \d+$`,
-               sorted_index)
+               `^\n`+TestHash+`\+\d+ \d+\n`+
+                       TestHash3+`\+\d+ \d+\n`+
+                       TestHash2+`\+\d+ \d+$`,
+               sortedIndex)
        if err != nil {
                t.Error(err)
        } else if !m {
-               t.Errorf("Got index %q for empty prefix", sorted_index)
+               t.Errorf("Got index %q for empty prefix", sortedIndex)
        }
 
        for _, prefix := range []string{"f", "f15", "f15ac"} {
                buf = new(bytes.Buffer)
                v.IndexTo(prefix, buf)
 
-               m, err := regexp.MatchString(`^`+TEST_HASH_2+`\+\d+ \d+\n$`, string(buf.Bytes()))
+               m, err := regexp.MatchString(`^`+TestHash2+`\+\d+ \d+\n$`, string(buf.Bytes()))
                if err != nil {
                        t.Error(err)
                } else if !m {
@@ -323,50 +411,69 @@ func testIndexTo(t *testing.T, factory TestableVolumeFactory) {
 
 // Calling Delete() for a block immediately after writing it (not old enough)
 // should neither delete the data nor return an error.
-func testDeleteNewBlock(t *testing.T, factory TestableVolumeFactory) {
+// Test is intended for only writable volumes
+func testDeleteNewBlock(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
-       v.Put(TEST_HASH, TEST_BLOCK)
+       blobSignatureTTL = 300 * time.Second
+
+       if v.Writable() == false {
+               return
+       }
+
+       v.Put(TestHash, TestBlock)
 
-       if err := v.Delete(TEST_HASH); err != nil {
+       if err := v.Trash(TestHash); err != nil {
                t.Error(err)
        }
-       if data, err := v.Get(TEST_HASH); err != nil {
+       data, err := v.Get(TestHash)
+       if err != nil {
                t.Error(err)
-       } else if bytes.Compare(data, TEST_BLOCK) != 0 {
-               t.Error("Block still present, but content is incorrect: %+v != %+v", data, TEST_BLOCK)
+       } else {
+               if bytes.Compare(data, TestBlock) != 0 {
+                       t.Errorf("Got data %+q, expected %+q", data, TestBlock)
+               }
+               bufs.Put(data)
        }
 }
 
 // Calling Delete() for a block with a timestamp older than
-// blob_signature_ttl seconds in the past should delete the data.
-func testDeleteOldBlock(t *testing.T, factory TestableVolumeFactory) {
+// blobSignatureTTL seconds in the past should delete the data.
+// Test is intended for only writable volumes
+func testDeleteOldBlock(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
-       v.Put(TEST_HASH, TEST_BLOCK)
-       v.TouchWithDate(TEST_HASH, time.Now().Add(-2*blob_signature_ttl*time.Second))
+       blobSignatureTTL = 300 * time.Second
+
+       if v.Writable() == false {
+               return
+       }
+
+       v.Put(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
 
-       if err := v.Delete(TEST_HASH); err != nil {
+       if err := v.Trash(TestHash); err != nil {
                t.Error(err)
        }
-       if _, err := v.Get(TEST_HASH); err == nil || !os.IsNotExist(err) {
-               t.Errorf("os.IsNotExist(%v) should have been true", err.Error())
+       if _, err := v.Get(TestHash); err == nil || !os.IsNotExist(err) {
+               t.Errorf("os.IsNotExist(%v) should have been true", err)
        }
 }
 
 // Calling Delete() for a block that does not exist should result in error.
-func testDeleteNoSuchBlock(t *testing.T, factory TestableVolumeFactory) {
+// Test should pass for both writable and read-only volumes
+func testDeleteNoSuchBlock(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
-       v.Put(TEST_HASH, TEST_BLOCK)
 
-       if err := v.Delete(TEST_HASH_2); err == nil {
+       if err := v.Trash(TestHash2); err == nil {
                t.Errorf("Expected error when attempting to delete a non-existing block")
        }
 }
 
 // Invoke Status and verify that VolumeStatus is returned
-func testStatus(t *testing.T, factory TestableVolumeFactory) {
+// Test should pass for both writable and read-only volumes
+func testStatus(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
@@ -386,7 +493,8 @@ func testStatus(t *testing.T, factory TestableVolumeFactory) {
 }
 
 // Invoke String for the volume; expect non-empty result
-func testString(t *testing.T, factory TestableVolumeFactory) {
+// Test should pass for both writable and read-only volumes
+func testString(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
@@ -395,107 +503,96 @@ func testString(t *testing.T, factory TestableVolumeFactory) {
        }
 }
 
-// Verify Writable is true on a writable volume
-func testWritableTrue(t *testing.T, factory TestableVolumeFactory) {
-       v := factory(t)
-       defer v.Teardown()
-
-       if v.Writable() == false {
-               t.Errorf("Expected writable to be true on a writable volume")
-       }
-}
-
-// Verify Writable is false on a read-only volume
-func testWritableFalse(t *testing.T, factory TestableVolumeFactory) {
+// Putting, updating, touching, and deleting blocks from a read-only volume result in error.
+// Test is intended for only read-only volumes
+func testUpdateReadOnly(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
-       if v.Writable() != false {
-               t.Errorf("Expected writable to be false on a read-only volume")
+       if v.Writable() == true {
+               return
        }
-}
-
-// Updating, touching, and deleting blocks from a read-only volume result in error.
-func testUpdateReadOnly(t *testing.T, factory TestableVolumeFactory) {
-       v := factory(t)
-       defer v.Teardown()
 
-       v.PutRaw(TEST_HASH, TEST_BLOCK)
+       v.PutRaw(TestHash, TestBlock)
 
-       _, err := v.Get(TEST_HASH)
+       // Get from read-only volume should succeed
+       _, err := v.Get(TestHash)
        if err != nil {
                t.Errorf("got err %v, expected nil", err)
        }
 
-       err = v.Put(TEST_HASH, TEST_BLOCK)
+       // Put a new block to read-only volume should result in error
+       err = v.Put(TestHash2, TestBlock2)
        if err == nil {
                t.Errorf("Expected error when putting block in a read-only volume")
        }
+       _, err = v.Get(TestHash2)
+       if err == nil {
+               t.Errorf("Expected error when getting block whose put in read-only volume failed")
+       }
 
-       err = v.Touch(TEST_HASH)
+       // Touch a block in read-only volume should result in error
+       err = v.Touch(TestHash)
        if err == nil {
                t.Errorf("Expected error when touching block in a read-only volume")
        }
 
-       err = v.Delete(TEST_HASH)
+       // Delete a block from a read-only volume should result in error
+       err = v.Trash(TestHash)
        if err == nil {
                t.Errorf("Expected error when deleting block from a read-only volume")
        }
-}
 
-// Serialization tests: launch a bunch of concurrent
-//
-// TODO(twp): show that the underlying Read/Write operations executed
-// serially and not concurrently. The easiest way to do this is
-// probably to activate verbose or debug logging, capture log output
-// and examine it to confirm that Reads and Writes did not overlap.
-//
-// TODO(twp): a proper test of I/O serialization requires that a
-// second request start while the first one is still underway.
-// Guaranteeing that the test behaves this way requires some tricky
-// synchronization and mocking.  For now we'll just launch a bunch of
-// requests simultaenously in goroutines and demonstrate that they
-// return accurate results.
-//
+       // Overwriting an existing block in read-only volume should result in error
+       err = v.Put(TestHash, TestBlock)
+       if err == nil {
+               t.Errorf("Expected error when putting block in a read-only volume")
+       }
+}
 
-func testGetSerialized(t *testing.T, factory TestableVolumeFactory) {
+// Launch concurrent Gets
+// Test should pass for both writable and read-only volumes
+func testGetConcurrent(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
-       v.Put(TEST_HASH, TEST_BLOCK)
-       v.Put(TEST_HASH_2, TEST_BLOCK_2)
-       v.Put(TEST_HASH_3, TEST_BLOCK_3)
+       v.PutRaw(TestHash, TestBlock)
+       v.PutRaw(TestHash2, TestBlock2)
+       v.PutRaw(TestHash3, TestBlock3)
 
        sem := make(chan int)
        go func(sem chan int) {
-               buf, err := v.Get(TEST_HASH)
+               buf, err := v.Get(TestHash)
                if err != nil {
                        t.Errorf("err1: %v", err)
                }
-               if bytes.Compare(buf, TEST_BLOCK) != 0 {
-                       t.Errorf("buf should be %s, is %s", string(TEST_BLOCK), string(buf))
+               bufs.Put(buf)
+               if bytes.Compare(buf, TestBlock) != 0 {
+                       t.Errorf("buf should be %s, is %s", string(TestBlock), string(buf))
                }
                sem <- 1
        }(sem)
 
        go func(sem chan int) {
-               buf, err := v.Get(TEST_HASH_2)
+               buf, err := v.Get(TestHash2)
                if err != nil {
                        t.Errorf("err2: %v", err)
                }
-               if bytes.Compare(buf, TEST_BLOCK_2) != 0 {
-                       t.Errorf("buf should be %s, is %s", string(TEST_BLOCK_2), string(buf))
+               bufs.Put(buf)
+               if bytes.Compare(buf, TestBlock2) != 0 {
+                       t.Errorf("buf should be %s, is %s", string(TestBlock2), string(buf))
                }
                sem <- 1
        }(sem)
 
        go func(sem chan int) {
-               buf, err := v.Get(TEST_HASH_3)
+               buf, err := v.Get(TestHash3)
                if err != nil {
                        t.Errorf("err3: %v", err)
                }
-               if bytes.Compare(buf, TEST_BLOCK_3) != 0 {
-                       t.Errorf("buf should be %s, is %s", string(TEST_BLOCK_3), string(buf))
+               bufs.Put(buf)
+               if bytes.Compare(buf, TestBlock3) != 0 {
+                       t.Errorf("buf should be %s, is %s", string(TestBlock3), string(buf))
                }
                sem <- 1
        }(sem)
@@ -506,13 +603,19 @@ func testGetSerialized(t *testing.T, factory TestableVolumeFactory) {
        }
 }
 
-func testPutSerialized(t *testing.T, factory TestableVolumeFactory) {
+// Launch concurrent Puts
+// Test is intended for only writable volumes
+func testPutConcurrent(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
+       if v.Writable() == false {
+               return
+       }
+
        sem := make(chan int)
        go func(sem chan int) {
-               err := v.Put(TEST_HASH, TEST_BLOCK)
+               err := v.Put(TestHash, TestBlock)
                if err != nil {
                        t.Errorf("err1: %v", err)
                }
@@ -520,7 +623,7 @@ func testPutSerialized(t *testing.T, factory TestableVolumeFactory) {
        }(sem)
 
        go func(sem chan int) {
-               err := v.Put(TEST_HASH_2, TEST_BLOCK_2)
+               err := v.Put(TestHash2, TestBlock2)
                if err != nil {
                        t.Errorf("err2: %v", err)
                }
@@ -528,7 +631,7 @@ func testPutSerialized(t *testing.T, factory TestableVolumeFactory) {
        }(sem)
 
        go func(sem chan int) {
-               err := v.Put(TEST_HASH_3, TEST_BLOCK_3)
+               err := v.Put(TestHash3, TestBlock3)
                if err != nil {
                        t.Errorf("err3: %v", err)
                }
@@ -541,27 +644,296 @@ func testPutSerialized(t *testing.T, factory TestableVolumeFactory) {
        }
 
        // Double check that we actually wrote the blocks we expected to write.
-       buf, err := v.Get(TEST_HASH)
+       buf, err := v.Get(TestHash)
        if err != nil {
                t.Errorf("Get #1: %v", err)
        }
-       if bytes.Compare(buf, TEST_BLOCK) != 0 {
-               t.Errorf("Get #1: expected %s, got %s", string(TEST_BLOCK), string(buf))
+       bufs.Put(buf)
+       if bytes.Compare(buf, TestBlock) != 0 {
+               t.Errorf("Get #1: expected %s, got %s", string(TestBlock), string(buf))
        }
 
-       buf, err = v.Get(TEST_HASH_2)
+       buf, err = v.Get(TestHash2)
        if err != nil {
                t.Errorf("Get #2: %v", err)
        }
-       if bytes.Compare(buf, TEST_BLOCK_2) != 0 {
-               t.Errorf("Get #2: expected %s, got %s", string(TEST_BLOCK_2), string(buf))
+       bufs.Put(buf)
+       if bytes.Compare(buf, TestBlock2) != 0 {
+               t.Errorf("Get #2: expected %s, got %s", string(TestBlock2), string(buf))
        }
 
-       buf, err = v.Get(TEST_HASH_3)
+       buf, err = v.Get(TestHash3)
        if err != nil {
                t.Errorf("Get #3: %v", err)
        }
-       if bytes.Compare(buf, TEST_BLOCK_3) != 0 {
-               t.Errorf("Get #3: expected %s, got %s", string(TEST_BLOCK_3), string(buf))
+       bufs.Put(buf)
+       if bytes.Compare(buf, TestBlock3) != 0 {
+               t.Errorf("Get #3: expected %s, got %s", string(TestBlock3), string(buf))
+       }
+}
+
+// Write and read back a full size block
+func testPutFullBlock(t TB, factory TestableVolumeFactory) {
+       v := factory(t)
+       defer v.Teardown()
+
+       if !v.Writable() {
+               return
+       }
+
+       wdata := make([]byte, BlockSize)
+       wdata[0] = 'a'
+       wdata[BlockSize-1] = 'z'
+       hash := fmt.Sprintf("%x", md5.Sum(wdata))
+       err := v.Put(hash, wdata)
+       if err != nil {
+               t.Fatal(err)
+       }
+       rdata, err := v.Get(hash)
+       if err != nil {
+               t.Error(err)
+       } else {
+               defer bufs.Put(rdata)
+       }
+       if bytes.Compare(rdata, wdata) != 0 {
+               t.Error("rdata != wdata")
+       }
+}
+
+// With trashLifetime != 0, perform:
+// Trash an old block - which either raises ErrNotImplemented or succeeds
+// Untrash -  which either raises ErrNotImplemented or succeeds
+// Get - which must succeed
+func testTrashUntrash(t TB, factory TestableVolumeFactory) {
+       v := factory(t)
+       defer v.Teardown()
+       defer func() {
+               trashLifetime = 0 * time.Second
+       }()
+
+       trashLifetime = 3600 * time.Second
+
+       // put block and backdate it
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       buf, err := v.Get(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       if bytes.Compare(buf, TestBlock) != 0 {
+               t.Errorf("Got data %+q, expected %+q", buf, TestBlock)
+       }
+       bufs.Put(buf)
+
+       // Trash
+       err = v.Trash(TestHash)
+       if v.Writable() == false {
+               if err != MethodDisabledError {
+                       t.Error(err)
+               }
+       } else if err != nil {
+               if err != ErrNotImplemented {
+                       t.Error(err)
+               }
+       } else {
+               _, err = v.Get(TestHash)
+               if err == nil || !os.IsNotExist(err) {
+                       t.Errorf("os.IsNotExist(%v) should have been true", err)
+               }
+
+               // Untrash
+               err = v.Untrash(TestHash)
+               if err != nil {
+                       t.Fatal(err)
+               }
+       }
+
+       // Get the block - after trash and untrash sequence
+       buf, err = v.Get(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       if bytes.Compare(buf, TestBlock) != 0 {
+               t.Errorf("Got data %+q, expected %+q", buf, TestBlock)
+       }
+       bufs.Put(buf)
+}
+
+func testTrashEmptyTrashUntrash(t TB, factory TestableVolumeFactory) {
+       v := factory(t)
+       defer v.Teardown()
+       defer func(orig time.Duration) {
+               trashLifetime = orig
+       }(trashLifetime)
+
+       checkGet := func() error {
+               buf, err := v.Get(TestHash)
+               if err != nil {
+                       return err
+               }
+               if bytes.Compare(buf, TestBlock) != 0 {
+                       t.Fatalf("Got data %+q, expected %+q", buf, TestBlock)
+               }
+               bufs.Put(buf)
+               return nil
+       }
+
+       // First set: EmptyTrash before reaching the trash deadline.
+
+       trashLifetime = 1 * time.Hour
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       err := checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       err = v.Trash(TestHash)
+       if err == MethodDisabledError || err == ErrNotImplemented {
+               // Skip the trash tests for read-only volumes, and
+               // volume types that don't support trashLifetime>0.
+               return
+       }
+
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       v.EmptyTrash()
+
+       // Even after emptying the trash, we can untrash our block
+       // because the deadline hasn't been reached.
+       err = v.Untrash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // Untrash should fail if the only block in the trash has
+       // already been untrashed.
+       err = v.Untrash(TestHash)
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       // The failed Untrash should not interfere with our
+       // already-untrashed copy.
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // Second set: EmptyTrash after the trash deadline has passed.
+
+       trashLifetime = 1 * time.Nanosecond
+
+       err = v.Trash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       // Even though 1ns has passed, we can untrash because we
+       // haven't called EmptyTrash yet.
+       err = v.Untrash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // Trash it again, and this time call EmptyTrash so it really
+       // goes away.
+       err = v.Trash(TestHash)
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Errorf("os.IsNotExist(%v) should have been true", err)
+       }
+       v.EmptyTrash()
+
+       // Untrash won't find it
+       err = v.Untrash(TestHash)
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       // Get block won't find it
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       // Third set: If the same data block gets written again after
+       // being trashed, and then the trash gets emptied, the newer
+       // un-trashed copy doesn't get deleted along with it.
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       trashLifetime = time.Nanosecond
+       err = v.Trash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       // EmptyTrash should not delete the untrashed copy.
+       v.EmptyTrash()
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // Fourth set: If the same data block gets trashed twice with
+       // different deadlines A and C, and then the trash is emptied
+       // at intermediate time B (A < B < C), it is still possible to
+       // untrash the block whose deadline is "C".
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       trashLifetime = time.Nanosecond
+       err = v.Trash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       trashLifetime = time.Hour
+       err = v.Trash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // EmptyTrash should not prevent us from recovering the
+       // time.Hour ("C") trash
+       v.EmptyTrash()
+       err = v.Untrash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
        }
 }