X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0fc6e0671e822cd4c5671519c7e7c58cff06c91f..c980683a243903babe9cc09cabc71e1c6229fef1:/services/keepstore/volume_generic_test.go diff --git a/services/keepstore/volume_generic_test.go b/services/keepstore/volume_generic_test.go index c08c3f5f00..95166c252f 100644 --- a/services/keepstore/volume_generic_test.go +++ b/services/keepstore/volume_generic_test.go @@ -2,26 +2,42 @@ 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 // 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 TestableVolume // for each test case, to avoid leaking state between tests. -func DoGenericVolumeTests(t *testing.T, factory TestableVolumeFactory) { +func DoGenericVolumeTests(t TB, factory TestableVolumeFactory) { testGet(t, factory) testGetNoSuchBlock(t, factory) + testCompareNonexistent(t, factory) testCompareSameContent(t, factory, TestHash, TestBlock) testCompareSameContent(t, factory, EmptyHash, EmptyBlock) testCompareWithCollision(t, factory, TestHash, TestBlock, []byte("baddata")) @@ -33,10 +49,10 @@ func DoGenericVolumeTests(t *testing.T, factory TestableVolumeFactory) { testPutBlockWithSameContent(t, factory, TestHash, TestBlock) testPutBlockWithSameContent(t, factory, EmptyHash, EmptyBlock) - testPutBlockWithDifferentContent(t, factory, TestHash, TestBlock, TestBlock2) - testPutBlockWithDifferentContent(t, factory, TestHash, EmptyBlock, TestBlock) - testPutBlockWithDifferentContent(t, factory, TestHash, TestBlock, EmptyBlock) - testPutBlockWithDifferentContent(t, factory, EmptyHash, EmptyBlock, TestBlock) + 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) @@ -58,11 +74,16 @@ func DoGenericVolumeTests(t *testing.T, factory TestableVolumeFactory) { testGetConcurrent(t, factory) testPutConcurrent(t, factory) + + testPutFullBlock(t, factory) + + testTrashUntrash(t, factory) + testTrashEmptyTrashUntrash(t, factory) } // Put a test block, get it and verify content // Test should pass for both writable and read-only volumes -func testGet(t *testing.T, factory TestableVolumeFactory) { +func testGet(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -70,7 +91,7 @@ func testGet(t *testing.T, factory TestableVolumeFactory) { buf, err := v.Get(TestHash) if err != nil { - t.Error(err) + t.Fatal(err) } bufs.Put(buf) @@ -82,7 +103,7 @@ func testGet(t *testing.T, factory TestableVolumeFactory) { // Invoke get on a block that does not exist in volume; should result in error // Test should pass for both writable and read-only volumes -func testGetNoSuchBlock(t *testing.T, factory TestableVolumeFactory) { +func testGetNoSuchBlock(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -91,9 +112,22 @@ func testGetNoSuchBlock(t *testing.T, factory TestableVolumeFactory) { } } +// 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 // Test should pass for both writable and read-only volumes -func testCompareSameContent(t *testing.T, factory TestableVolumeFactory, testHash string, testData []byte) { +func testCompareSameContent(t TB, factory TestableVolumeFactory, testHash string, testData []byte) { v := factory(t) defer v.Teardown() @@ -111,7 +145,7 @@ func testCompareSameContent(t *testing.T, factory TestableVolumeFactory, testHas // testHash = md5(testDataA). // // Test should pass for both writable and read-only volumes -func testCompareWithCollision(t *testing.T, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) { +func testCompareWithCollision(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) { v := factory(t) defer v.Teardown() @@ -128,7 +162,7 @@ func testCompareWithCollision(t *testing.T, factory TestableVolumeFactory, testH // corrupted. Requires testHash = md5(testDataA) != md5(testDataB). // // Test should pass for both writable and read-only volumes -func testCompareWithCorruptStoredData(t *testing.T, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) { +func testCompareWithCorruptStoredData(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) { v := factory(t) defer v.Teardown() @@ -142,7 +176,7 @@ func testCompareWithCorruptStoredData(t *testing.T, factory TestableVolumeFactor // Put a block and put again with same content // Test is intended for only writable volumes -func testPutBlockWithSameContent(t *testing.T, factory TestableVolumeFactory, testHash string, testData []byte) { +func testPutBlockWithSameContent(t TB, factory TestableVolumeFactory, testHash string, testData []byte) { v := factory(t) defer v.Teardown() @@ -163,7 +197,7 @@ func testPutBlockWithSameContent(t *testing.T, factory TestableVolumeFactory, te // Put a block and put again with different content // Test is intended for only writable volumes -func testPutBlockWithDifferentContent(t *testing.T, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) { +func testPutBlockWithDifferentContent(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) { v := factory(t) defer v.Teardown() @@ -171,10 +205,7 @@ func testPutBlockWithDifferentContent(t *testing.T, factory TestableVolumeFactor return } - err := v.Put(testHash, testDataA) - if err != nil { - t.Errorf("Got err putting block %q: %q, expected nil", testDataA, err) - } + v.PutRaw(testHash, testDataA) putErr := v.Put(testHash, testDataB) buf, getErr := v.Get(testHash) @@ -182,14 +213,14 @@ func testPutBlockWithDifferentContent(t *testing.T, factory TestableVolumeFactor // 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 %+v, expected %+v", buf, testDataB) + 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 %+v, which is neither %+v nor %+v", buf, testDataA, testDataB) + t.Errorf("Put failed but Get returned %+q, which is neither %+q nor %+q", buf, testDataA, testDataB) } } if getErr == nil { @@ -199,7 +230,7 @@ func testPutBlockWithDifferentContent(t *testing.T, factory TestableVolumeFactor // Put and get multiple blocks // Test is intended for only writable volumes -func testPutMultipleBlocks(t *testing.T, factory TestableVolumeFactory) { +func testPutMultipleBlocks(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -225,33 +256,39 @@ func testPutMultipleBlocks(t *testing.T, factory TestableVolumeFactory) { data, err := v.Get(TestHash) if err != nil { t.Error(err) - } else if bytes.Compare(data, TestBlock) != 0 { - t.Errorf("Block present, but content is incorrect: Expected: %v Found: %v", data, TestBlock) + } else { + if bytes.Compare(data, TestBlock) != 0 { + t.Errorf("Block present, but got %+q, expected %+q", data, TestBlock) + } + bufs.Put(data) } - bufs.Put(data) data, err = v.Get(TestHash2) if err != nil { t.Error(err) - } else if bytes.Compare(data, TestBlock2) != 0 { - t.Errorf("Block present, but content is incorrect: Expected: %v Found: %v", data, TestBlock2) + } else { + if bytes.Compare(data, TestBlock2) != 0 { + t.Errorf("Block present, but got %+q, expected %+q", data, TestBlock2) + } + bufs.Put(data) } - bufs.Put(data) data, err = v.Get(TestHash3) if err != nil { t.Error(err) - } else if bytes.Compare(data, TestBlock3) != 0 { - t.Errorf("Block present, but content is incorrect: Expected: %v Found: %v", data, TestBlock3) + } else { + if bytes.Compare(data, TestBlock3) != 0 { + t.Errorf("Block present, but to %+q, expected %+q", data, TestBlock3) + } + bufs.Put(data) } - bufs.Put(data) } // testPutAndTouch // Test that when applying PUT to a block that already exists, // the block's modification time is updated. // Test is intended for only writable volumes -func testPutAndTouch(t *testing.T, factory TestableVolumeFactory) { +func testPutAndTouch(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -293,7 +330,7 @@ func testPutAndTouch(t *testing.T, factory TestableVolumeFactory) { // Touching a non-existing block should result in error. // Test should pass for both writable and read-only volumes -func testTouchNoSuchBlock(t *testing.T, factory TestableVolumeFactory) { +func testTouchNoSuchBlock(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -304,7 +341,7 @@ func testTouchNoSuchBlock(t *testing.T, factory TestableVolumeFactory) { // Invoking Mtime on a non-existing block should result in error. // Test should pass for both writable and read-only volumes -func testMtimeNoSuchBlock(t *testing.T, factory TestableVolumeFactory) { +func testMtimeNoSuchBlock(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -318,7 +355,7 @@ func testMtimeNoSuchBlock(t *testing.T, factory TestableVolumeFactory) { // * with a prefix // * with no such prefix // Test should pass for both writable and read-only volumes -func testIndexTo(t *testing.T, factory TestableVolumeFactory) { +func testIndexTo(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -326,6 +363,13 @@ func testIndexTo(t *testing.T, factory TestableVolumeFactory) { 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) indexRows := strings.Split(string(buf.Bytes()), "\n") @@ -368,9 +412,10 @@ 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. // Test is intended for only writable volumes -func testDeleteNewBlock(t *testing.T, factory TestableVolumeFactory) { +func testDeleteNewBlock(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() + blobSignatureTTL = 300 * time.Second if v.Writable() == false { return @@ -378,54 +423,57 @@ func testDeleteNewBlock(t *testing.T, factory TestableVolumeFactory) { v.Put(TestHash, TestBlock) - if err := v.Delete(TestHash); err != nil { + if err := v.Trash(TestHash); err != nil { t.Error(err) } data, err := v.Get(TestHash) if err != nil { t.Error(err) - } else if bytes.Compare(data, TestBlock) != 0 { - t.Error("Block still present, but content is incorrect: %+v != %+v", data, TestBlock) + } else { + if bytes.Compare(data, TestBlock) != 0 { + t.Errorf("Got data %+q, expected %+q", data, TestBlock) + } + bufs.Put(data) } - bufs.Put(data) } // Calling Delete() for a block with a timestamp older than // blobSignatureTTL seconds in the past should delete the data. // Test is intended for only writable volumes -func testDeleteOldBlock(t *testing.T, factory TestableVolumeFactory) { +func testDeleteOldBlock(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() + blobSignatureTTL = 300 * time.Second if v.Writable() == false { return } v.Put(TestHash, TestBlock) - v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL*time.Second)) + v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL)) - if err := v.Delete(TestHash); err != nil { + if err := v.Trash(TestHash); err != nil { t.Error(err) } if _, err := v.Get(TestHash); err == nil || !os.IsNotExist(err) { - t.Errorf("os.IsNotExist(%v) should have been true", err.Error()) + t.Errorf("os.IsNotExist(%v) should have been true", err) } } // Calling Delete() for a block that does not exist should result in error. // Test should pass for both writable and read-only volumes -func testDeleteNoSuchBlock(t *testing.T, factory TestableVolumeFactory) { +func testDeleteNoSuchBlock(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() - if err := v.Delete(TestHash2); 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 // Test should pass for both writable and read-only volumes -func testStatus(t *testing.T, factory TestableVolumeFactory) { +func testStatus(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -446,7 +494,7 @@ func testStatus(t *testing.T, factory TestableVolumeFactory) { // Invoke String for the volume; expect non-empty result // Test should pass for both writable and read-only volumes -func testString(t *testing.T, factory TestableVolumeFactory) { +func testString(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -457,7 +505,7 @@ func testString(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 *testing.T, factory TestableVolumeFactory) { +func testUpdateReadOnly(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -490,7 +538,7 @@ func testUpdateReadOnly(t *testing.T, factory TestableVolumeFactory) { } // Delete a block from a read-only volume should result in error - err = v.Delete(TestHash) + err = v.Trash(TestHash) if err == nil { t.Errorf("Expected error when deleting block from a read-only volume") } @@ -504,7 +552,7 @@ func testUpdateReadOnly(t *testing.T, factory TestableVolumeFactory) { // Launch concurrent Gets // Test should pass for both writable and read-only volumes -func testGetConcurrent(t *testing.T, factory TestableVolumeFactory) { +func testGetConcurrent(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -557,7 +605,7 @@ func testGetConcurrent(t *testing.T, factory TestableVolumeFactory) { // Launch concurrent Puts // Test is intended for only writable volumes -func testPutConcurrent(t *testing.T, factory TestableVolumeFactory) { +func testPutConcurrent(t TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() @@ -623,3 +671,269 @@ func testPutConcurrent(t *testing.T, factory TestableVolumeFactory) { 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) + } +}