X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/fbeca60ad61f0ef846a026b288a3bc5104383da7..50128b53da4003912635b03fb27b5be2c5beaca1:/services/keepstore/volume_generic_test.go diff --git a/services/keepstore/volume_generic_test.go b/services/keepstore/volume_generic_test.go index 24ebc35a5f..7e72a8f246 100644 --- a/services/keepstore/volume_generic_test.go +++ b/services/keepstore/volume_generic_test.go @@ -2,102 +2,1010 @@ package main import ( "bytes" + "context" + "crypto/md5" + "fmt" "os" - "testing" + "regexp" + "sort" + "strconv" + "strings" "time" + + "git.curoverse.com/arvados.git/sdk/go/arvados" + "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 -// TestableVolume for each test case, to avoid leaking state between -// tests. -func DoGenericVolumeTests(t *testing.T, factory TestableVolumeFactory) { - /* - testGetBlock(t, factory) - testGetNoSuchBlock(t, factory) - testGetSystemError(t, factory) - - testCompareSameContent(t, factory) - testCompareWithCollisionError(t, factory) - testCompareWithCorruptError(t, factory) - testCompareSystemError(t, factory) - - testPutBlock(t, factory) - testPutMultipleBlocks(t, factory) - testPutBlockWithSameContent(t, factory) - testPutBlockWithDifferentContent(t, factory) - testPutBlockSystemError(t, factory) - - testTouch(t, factory) - testTouchNoSuchBlock(t, factory) - testTouchSystemError(t, factory) - - testMtime(t, factory) - testMtimeNoSuchBlock(t, factory) - testMtimeSystemError(t, factory) - - testIndexToWithNoPrefix(t, factory) - testIndexToWithPrefix(t, factory) - testIndexToWithNoSuchPrefix(t, factory) - testIndexToOnEmptyVolume(t, factory) - testIndexToSystemError(t, factory) - - testDeleteNewBlock(t, factory) - testDeleteOldWithOnlyBlockInVol(t, factory) - testDeleteOldWithOtherBlocksInVol(t, factory) - testDeleteNoSuchBlock(t, factory) - testDeleteSystemError(t, factory) - - testStatus(t, factory) - testStatusWithError(t, factory) - testStatusSystemError(t, factory) - - testString(t, factory) - testStringSystemError(t, factory) - - testWritableTrue(t, factory) - testWritableFalse(t, factory) - testWritableSystemError(t, factory) - */ +// 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) + + 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) + testTouchNoSuchBlock(t, factory) + + testMtimeNoSuchBlock(t, factory) + + testIndexTo(t, factory) testDeleteNewBlock(t, factory) testDeleteOldBlock(t, factory) + testDeleteNoSuchBlock(t, factory) + + testStatus(t, factory) + + testString(t, factory) + + testUpdateReadOnly(t, factory) + + 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 TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + + v.PutRaw(TestHash, TestBlock) + + buf := make([]byte, BlockSize) + n, err := v.Get(context.Background(), TestHash, buf) + if err != nil { + t.Fatal(err) + } + + if bytes.Compare(buf[:n], 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 +// Test should pass for both writable and read-only volumes +func testGetNoSuchBlock(t TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + + buf := make([]byte, BlockSize) + if _, err := v.Get(context.Background(), TestHash2, buf); 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(context.Background(), 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 TB, factory TestableVolumeFactory, testHash string, testData []byte) { + v := factory(t) + defer v.Teardown() + + v.PutRaw(testHash, testData) + + // Compare the block locator with same content + err := v.Compare(context.Background(), testHash, testData) + if err != nil { + t.Errorf("Got err %q, expected nil", err) + } +} + +// 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.PutRaw(testHash, testDataA) + + // Compare the block locator with different content; collision + err := v.Compare(context.Background(), TestHash, testDataB) + if err == nil { + t.Errorf("Got err nil, expected error due to collision") + } +} + +// 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.PutRaw(TestHash, testDataB) + + err := v.Compare(context.Background(), 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 +// Test is intended for only writable volumes +func testPutBlockWithSameContent(t TB, factory TestableVolumeFactory, testHash string, testData []byte) { + v := factory(t) + defer v.Teardown() + + if v.Writable() == false { + return + } + + err := v.Put(context.Background(), testHash, testData) + if err != nil { + t.Errorf("Got err putting block %q: %q, expected nil", TestBlock, err) + } + + err = v.Put(context.Background(), testHash, testData) + if err != nil { + t.Errorf("Got err putting block second time %q: %q, expected nil", TestBlock, err) + } +} + +// Put a block and put again with different content +// Test is intended for only writable volumes +func testPutBlockWithDifferentContent(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) { + v := factory(t) + defer v.Teardown() + + if v.Writable() == false { + return + } + + v.PutRaw(testHash, testDataA) + + putErr := v.Put(context.Background(), testHash, testDataB) + buf := make([]byte, BlockSize) + n, getErr := v.Get(context.Background(), testHash, buf) + if putErr == nil { + // Put must not return a nil error unless it has + // overwritten the existing data. + if bytes.Compare(buf[:n], testDataB) != 0 { + t.Errorf("Put succeeded but Get returned %+q, expected %+q", buf[:n], 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[:n], testDataA) != 0 && bytes.Compare(buf[:n], testDataB) != 0 { + t.Errorf("Put failed but Get returned %+q, which is neither %+q nor %+q", buf[:n], testDataA, testDataB) + } + } +} + +// Put and get multiple blocks +// Test is intended for only writable volumes +func testPutMultipleBlocks(t TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + + if v.Writable() == false { + return + } + + err := v.Put(context.Background(), TestHash, TestBlock) + if err != nil { + t.Errorf("Got err putting block %q: %q, expected nil", TestBlock, err) + } + + err = v.Put(context.Background(), TestHash2, TestBlock2) + if err != nil { + t.Errorf("Got err putting block %q: %q, expected nil", TestBlock2, err) + } + + err = v.Put(context.Background(), TestHash3, TestBlock3) + if err != nil { + t.Errorf("Got err putting block %q: %q, expected nil", TestBlock3, err) + } + + data := make([]byte, BlockSize) + n, err := v.Get(context.Background(), TestHash, data) + if err != nil { + t.Error(err) + } else { + if bytes.Compare(data[:n], TestBlock) != 0 { + t.Errorf("Block present, but got %+q, expected %+q", data[:n], TestBlock) + } + } + + n, err = v.Get(context.Background(), TestHash2, data) + if err != nil { + t.Error(err) + } else { + if bytes.Compare(data[:n], TestBlock2) != 0 { + t.Errorf("Block present, but got %+q, expected %+q", data[:n], TestBlock2) + } + } + + n, err = v.Get(context.Background(), TestHash3, data) + if err != nil { + t.Error(err) + } else { + if bytes.Compare(data[:n], TestBlock3) != 0 { + t.Errorf("Block present, but to %+q, expected %+q", data[:n], TestBlock3) + } + } +} + +// 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 TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + + if v.Writable() == false { + return + } + + if err := v.Put(context.Background(), TestHash, TestBlock); err != nil { + t.Error(err) + } + + // We'll verify { t0 < threshold < t1 }, where t0 is the + // existing block's timestamp on disk before Put() and t1 is + // its timestamp after Put(). + threshold := time.Now().Add(-time.Second) + + // 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(TestHash, time.Now().Add(-20*time.Second)) + + // Make sure v.Mtime() agrees the above Utime really worked. + 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(context.Background(), TestHash, TestBlock); err != nil { + t.Error(err) + } + + // Verify threshold < t1 + 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) + } +} + +// Touching a non-existing block should result in error. +// 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.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. +// Test should pass for both writable and read-only volumes +func testMtimeNoSuchBlock(t TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + + if _, err := v.Mtime("12345678901234567890123456789012"); err == nil { + t.Error("Expected error when updating Mtime on a non-existing block") + } +} + +// Put a few blocks and invoke IndexTo with: +// * no prefix +// * with a prefix +// * with no such prefix +// Test should pass for both writable and read-only volumes +func testIndexTo(t TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + + // minMtime and maxMtime are the minimum and maximum + // acceptable values the index can report for our test + // blocks. 1-second precision is acceptable. + minMtime := time.Now().UTC().UnixNano() + minMtime -= minMtime % 1e9 + + v.PutRaw(TestHash, TestBlock) + v.PutRaw(TestHash2, TestBlock2) + v.PutRaw(TestHash3, TestBlock3) + + maxMtime := time.Now().UTC().UnixNano() + if maxMtime%1e9 > 0 { + maxMtime -= maxMtime % 1e9 + maxMtime += 1e9 + } + + // 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") + sort.Strings(indexRows) + sortedIndex := strings.Join(indexRows, "\n") + m := regexp.MustCompile( + `^\n` + TestHash + `\+\d+ (\d+)\n` + + TestHash3 + `\+\d+ \d+\n` + + TestHash2 + `\+\d+ \d+$`, + ).FindStringSubmatch(sortedIndex) + if m == nil { + t.Errorf("Got index %q for empty prefix", sortedIndex) + } else { + mtime, err := strconv.ParseInt(m[1], 10, 64) + if err != nil { + t.Error(err) + } else if mtime < minMtime || mtime > maxMtime { + t.Errorf("got %d for TestHash timestamp, expected %d <= t <= %d", + mtime, minMtime, maxMtime) + } + } + + for _, prefix := range []string{"f", "f15", "f15ac"} { + buf = new(bytes.Buffer) + v.IndexTo(prefix, buf) + + m, err := regexp.MatchString(`^`+TestHash2+`\+\d+ \d+\n$`, string(buf.Bytes())) + if err != nil { + t.Error(err) + } else if !m { + t.Errorf("Got index %q for prefix %s", string(buf.Bytes()), prefix) + } + } + + for _, prefix := range []string{"zero", "zip", "zilch"} { + buf = new(bytes.Buffer) + err := v.IndexTo(prefix, buf) + if err != nil { + t.Errorf("Got error on IndexTo with no such prefix %v", err.Error()) + } else if buf.Len() != 0 { + t.Errorf("Expected empty list for IndexTo with no such prefix %s", prefix) + } + } } -// Calling Delete() for a block immediately after writing it should -// neither delete the data nor return an error. -func testDeleteNewBlock(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 TB, factory TestableVolumeFactory) { v := factory(t) defer v.Teardown() - v.Put(TEST_HASH, TEST_BLOCK) + theConfig.BlobSignatureTTL.Set("5m") + + if v.Writable() == false { + return + } - if err := v.Delete(TEST_HASH); err != nil { + v.Put(context.Background(), TestHash, TestBlock) + + if err := v.Trash(TestHash); err != nil { t.Error(err) } - if data, err := v.Get(TEST_HASH); err != nil { + data := make([]byte, BlockSize) + n, err := v.Get(context.Background(), TestHash, data) + 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[:n], TestBlock) != 0 { + t.Errorf("Got data %+q, expected %+q", data[:n], TestBlock) } } // 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)) + theConfig.BlobSignatureTTL.Set("5m") + + if v.Writable() == false { + return + } - if err := v.Delete(TEST_HASH); err != nil { + v.Put(context.Background(), TestHash, TestBlock) + v.TouchWithDate(TestHash, time.Now().Add(-2*theConfig.BlobSignatureTTL.Duration())) + + 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()) + data := make([]byte, BlockSize) + if _, err := v.Get(context.Background(), TestHash, data); err == nil || !os.IsNotExist(err) { + t.Errorf("os.IsNotExist(%v) should have been true", err) + } + + _, err := v.Mtime(TestHash) + if err == nil || !os.IsNotExist(err) { + t.Fatalf("os.IsNotExist(%v) should have been true", err) + } + + err = v.Compare(context.Background(), TestHash, TestBlock) + if err == nil || !os.IsNotExist(err) { + t.Fatalf("os.IsNotExist(%v) should have been true", err) + } + + indexBuf := new(bytes.Buffer) + v.IndexTo("", indexBuf) + if strings.Contains(string(indexBuf.Bytes()), TestHash) { + t.Fatalf("Found trashed block in IndexTo") + } + + err = v.Touch(TestHash) + if err == nil || !os.IsNotExist(err) { + t.Fatalf("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 TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + + 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 TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + + // Get node status and make a basic sanity check. + status := v.Status() + if status.DeviceNum == 0 { + t.Errorf("uninitialized device_num in %v", status) + } + + if status.BytesFree == 0 { + t.Errorf("uninitialized bytes_free in %v", status) + } + + if status.BytesUsed == 0 { + t.Errorf("uninitialized bytes_used in %v", status) + } +} + +// Invoke String for the volume; expect non-empty result +// Test should pass for both writable and read-only volumes +func testString(t TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + + if id := v.String(); len(id) == 0 { + t.Error("Got empty string for v.String()") + } +} + +// 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() == true { + return + } + + v.PutRaw(TestHash, TestBlock) + buf := make([]byte, BlockSize) + + // Get from read-only volume should succeed + _, err := v.Get(context.Background(), TestHash, buf) + if err != nil { + t.Errorf("got err %v, expected nil", err) + } + + // Put a new block to read-only volume should result in error + err = v.Put(context.Background(), TestHash2, TestBlock2) + if err == nil { + t.Errorf("Expected error when putting block in a read-only volume") + } + _, err = v.Get(context.Background(), TestHash2, buf) + if err == nil { + t.Errorf("Expected error when getting block whose put in read-only volume failed") + } + + // 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") + } + + // 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") + } + + // Overwriting an existing block in read-only volume should result in error + err = v.Put(context.Background(), TestHash, TestBlock) + if err == nil { + t.Errorf("Expected error when putting block in a read-only volume") + } +} + +// 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.PutRaw(TestHash, TestBlock) + v.PutRaw(TestHash2, TestBlock2) + v.PutRaw(TestHash3, TestBlock3) + + sem := make(chan int) + go func() { + buf := make([]byte, BlockSize) + n, err := v.Get(context.Background(), TestHash, buf) + if err != nil { + t.Errorf("err1: %v", err) + } + if bytes.Compare(buf[:n], TestBlock) != 0 { + t.Errorf("buf should be %s, is %s", string(TestBlock), string(buf[:n])) + } + sem <- 1 + }() + + go func() { + buf := make([]byte, BlockSize) + n, err := v.Get(context.Background(), TestHash2, buf) + if err != nil { + t.Errorf("err2: %v", err) + } + if bytes.Compare(buf[:n], TestBlock2) != 0 { + t.Errorf("buf should be %s, is %s", string(TestBlock2), string(buf[:n])) + } + sem <- 1 + }() + + go func() { + buf := make([]byte, BlockSize) + n, err := v.Get(context.Background(), TestHash3, buf) + if err != nil { + t.Errorf("err3: %v", err) + } + if bytes.Compare(buf[:n], TestBlock3) != 0 { + t.Errorf("buf should be %s, is %s", string(TestBlock3), string(buf[:n])) + } + sem <- 1 + }() + + // Wait for all goroutines to finish + for done := 0; done < 3; done++ { + <-sem + } +} + +// 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(context.Background(), TestHash, TestBlock) + if err != nil { + t.Errorf("err1: %v", err) + } + sem <- 1 + }(sem) + + go func(sem chan int) { + err := v.Put(context.Background(), TestHash2, TestBlock2) + if err != nil { + t.Errorf("err2: %v", err) + } + sem <- 1 + }(sem) + + go func(sem chan int) { + err := v.Put(context.Background(), TestHash3, TestBlock3) + if err != nil { + t.Errorf("err3: %v", err) + } + sem <- 1 + }(sem) + + // Wait for all goroutines to finish + for done := 0; done < 3; done++ { + <-sem + } + + // Double check that we actually wrote the blocks we expected to write. + buf := make([]byte, BlockSize) + n, err := v.Get(context.Background(), TestHash, buf) + if err != nil { + t.Errorf("Get #1: %v", err) + } + if bytes.Compare(buf[:n], TestBlock) != 0 { + t.Errorf("Get #1: expected %s, got %s", string(TestBlock), string(buf[:n])) + } + + n, err = v.Get(context.Background(), TestHash2, buf) + if err != nil { + t.Errorf("Get #2: %v", err) + } + if bytes.Compare(buf[:n], TestBlock2) != 0 { + t.Errorf("Get #2: expected %s, got %s", string(TestBlock2), string(buf[:n])) + } + + n, err = v.Get(context.Background(), TestHash3, buf) + if err != nil { + t.Errorf("Get #3: %v", err) + } + if bytes.Compare(buf[:n], TestBlock3) != 0 { + t.Errorf("Get #3: expected %s, got %s", string(TestBlock3), string(buf[:n])) + } +} + +// 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(context.Background(), hash, wdata) + if err != nil { + t.Fatal(err) + } + buf := make([]byte, BlockSize) + n, err := v.Get(context.Background(), hash, buf) + if err != nil { + t.Error(err) + } + if bytes.Compare(buf[:n], wdata) != 0 { + t.Error("buf %+q != wdata %+q", buf[:n], 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() { + theConfig.TrashLifetime = 0 + }() + + theConfig.TrashLifetime.Set("1h") + + // put block and backdate it + v.PutRaw(TestHash, TestBlock) + v.TouchWithDate(TestHash, time.Now().Add(-2*theConfig.BlobSignatureTTL.Duration())) + + buf := make([]byte, BlockSize) + n, err := v.Get(context.Background(), TestHash, buf) + if err != nil { + t.Fatal(err) + } + if bytes.Compare(buf[:n], TestBlock) != 0 { + t.Errorf("Got data %+q, expected %+q", buf[:n], TestBlock) + } + + // Trash + err = v.Trash(TestHash) + if v.Writable() == false { + if err != MethodDisabledError { + t.Fatal(err) + } + } else if err != nil { + if err != ErrNotImplemented { + t.Fatal(err) + } + } else { + _, err = v.Get(context.Background(), TestHash, buf) + 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 + n, err = v.Get(context.Background(), TestHash, buf) + if err != nil { + t.Fatal(err) + } + if bytes.Compare(buf[:n], TestBlock) != 0 { + t.Errorf("Got data %+q, expected %+q", buf[:n], TestBlock) + } +} + +func testTrashEmptyTrashUntrash(t TB, factory TestableVolumeFactory) { + v := factory(t) + defer v.Teardown() + defer func(orig arvados.Duration) { + theConfig.TrashLifetime = orig + }(theConfig.TrashLifetime) + + checkGet := func() error { + buf := make([]byte, BlockSize) + n, err := v.Get(context.Background(), TestHash, buf) + if err != nil { + return err + } + if bytes.Compare(buf[:n], TestBlock) != 0 { + t.Fatalf("Got data %+q, expected %+q", buf[:n], TestBlock) + } + + _, err = v.Mtime(TestHash) + if err != nil { + return err + } + + err = v.Compare(context.Background(), TestHash, TestBlock) + if err != nil { + return err + } + + indexBuf := new(bytes.Buffer) + v.IndexTo("", indexBuf) + if !strings.Contains(string(indexBuf.Bytes()), TestHash) { + return os.ErrNotExist + } + + return nil + } + + // First set: EmptyTrash before reaching the trash deadline. + + theConfig.TrashLifetime.Set("1h") + + v.PutRaw(TestHash, TestBlock) + v.TouchWithDate(TestHash, time.Now().Add(-2*theConfig.BlobSignatureTTL.Duration())) + + err := checkGet() + if err != nil { + t.Fatal(err) + } + + // Trash the block + 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) + } + + err = v.Touch(TestHash) + 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) + } + + err = v.Touch(TestHash) + if err != nil { + t.Fatal(err) + } + + // Because we Touch'ed, need to backdate again for next set of tests + v.TouchWithDate(TestHash, time.Now().Add(-2*theConfig.BlobSignatureTTL.Duration())) + + // If the only block in the trash has already been untrashed, + // most volumes will fail a subsequent Untrash with a 404, but + // it's also acceptable for Untrash to succeed. + err = v.Untrash(TestHash) + if err != nil && !os.IsNotExist(err) { + t.Fatalf("Expected success or os.IsNotExist(), but got: %v", err) + } + + // The additional Untrash should not interfere with our + // already-untrashed copy. + err = checkGet() + if err != nil { + t.Fatal(err) + } + + // Untrash might have updated the timestamp, so backdate again + v.TouchWithDate(TestHash, time.Now().Add(-2*theConfig.BlobSignatureTTL.Duration())) + + // Second set: EmptyTrash after the trash deadline has passed. + + theConfig.TrashLifetime.Set("1ns") + + 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. + // (In Azure volumes, un/trash changes Mtime, so first backdate again) + v.TouchWithDate(TestHash, time.Now().Add(-2*theConfig.BlobSignatureTTL.Duration())) + err = v.Trash(TestHash) + err = checkGet() + if err == nil || !os.IsNotExist(err) { + t.Fatalf("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*theConfig.BlobSignatureTTL.Duration())) + + theConfig.TrashLifetime.Set("1ns") + 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*theConfig.BlobSignatureTTL.Duration())) + + // 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*theConfig.BlobSignatureTTL.Duration())) + + theConfig.TrashLifetime.Set("1ns") + err = v.Trash(TestHash) + if err != nil { + t.Fatal(err) + } + + v.PutRaw(TestHash, TestBlock) + v.TouchWithDate(TestHash, time.Now().Add(-2*theConfig.BlobSignatureTTL.Duration())) + + theConfig.TrashLifetime.Set("1h") + 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) } }