X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/3b1598bb557a30f9a896ed36988702c5ae9f2ba9..b3b9aeee4dba20bcddd8cb4ee2cdcd3c8a34eaec:/services/keepstore/volume_generic_test.go

diff --git a/services/keepstore/volume_generic_test.go b/services/keepstore/volume_generic_test.go
index 193d9d2c2c..7580a20259 100644
--- a/services/keepstore/volume_generic_test.go
+++ b/services/keepstore/volume_generic_test.go
@@ -2,32 +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
 // 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)
 
-	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)
@@ -49,11 +74,13 @@ func DoGenericVolumeTests(t *testing.T, factory TestableVolumeFactory) {
 
 	testGetConcurrent(t, factory)
 	testPutConcurrent(t, factory)
+
+	testPutFullBlock(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()
 
@@ -61,7 +88,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)
@@ -73,7 +100,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()
 
@@ -82,56 +109,71 @@ 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) {
+func testCompareSameContent(t TB, factory TestableVolumeFactory, testHash string, testData []byte) {
 	v := factory(t)
 	defer v.Teardown()
 
-	v.PutRaw(TestHash, TestBlock)
+	v.PutRaw(testHash, testData)
 
 	// Compare the block locator with same content
-	err := v.Compare(TestHash, TestBlock)
+	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
+// 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 testCompareWithDifferentContent(t *testing.T, factory TestableVolumeFactory) {
+func testCompareWithCollision(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) {
 	v := factory(t)
 	defer v.Teardown()
 
-	v.PutRaw(TestHash, TestBlock)
+	v.PutRaw(testHash, testDataA)
 
 	// Compare the block locator with different content; collision
-	err := v.Compare(TestHash, []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 hash matches with locator
-// Expect error due to corruption.
+// 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 testCompareWithBadData(t *testing.T, factory TestableVolumeFactory) {
+func testCompareWithCorruptStoredData(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) {
 	v := factory(t)
 	defer v.Teardown()
 
-	v.PutRaw(TestHash, []byte("baddata"))
+	v.PutRaw(TestHash, testDataB)
 
-	err := v.Compare(TestHash, TestBlock)
-	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
 // Test is intended for only writable volumes
-func testPutBlockWithSameContent(t *testing.T, factory TestableVolumeFactory) {
+func testPutBlockWithSameContent(t TB, factory TestableVolumeFactory, testHash string, testData []byte) {
 	v := factory(t)
 	defer v.Teardown()
 
@@ -139,12 +181,12 @@ func testPutBlockWithSameContent(t *testing.T, factory TestableVolumeFactory) {
 		return
 	}
 
-	err := v.Put(TestHash, TestBlock)
+	err := v.Put(testHash, testData)
 	if err != nil {
 		t.Errorf("Got err putting block %q: %q, expected nil", TestBlock, err)
 	}
 
-	err = v.Put(TestHash, TestBlock)
+	err = v.Put(testHash, testData)
 	if err != nil {
 		t.Errorf("Got err putting block second time %q: %q, expected nil", TestBlock, err)
 	}
@@ -152,7 +194,7 @@ func testPutBlockWithSameContent(t *testing.T, factory TestableVolumeFactory) {
 
 // Put a block and put again with different content
 // Test is intended for only writable volumes
-func testPutBlockWithDifferentContent(t *testing.T, factory TestableVolumeFactory) {
+func testPutBlockWithDifferentContent(t TB, factory TestableVolumeFactory, testHash string, testDataA, testDataB []byte) {
 	v := factory(t)
 	defer v.Teardown()
 
@@ -160,25 +202,22 @@ func testPutBlockWithDifferentContent(t *testing.T, factory TestableVolumeFactor
 		return
 	}
 
-	err := v.Put(TestHash, TestBlock)
-	if err != nil {
-		t.Errorf("Got err putting block %q: %q, expected nil", TestBlock, err)
-	}
+	v.PutRaw(testHash, testDataA)
 
-	putErr := v.Put(TestHash, TestBlock2)
-	buf, getErr := v.Get(TestHash)
+	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, TestBlock2) != 0 {
-			t.Errorf("Put succeeded but Get returned %+v, expected %+v", buf, TestBlock2)
+		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, TestBlock) != 0 && bytes.Compare(buf, TestBlock2) != 0 {
-			t.Errorf("Put failed but Get returned %+v, which is neither %+v nor %+v", buf, TestBlock, TestBlock2)
+		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 getErr == nil {
@@ -188,7 +227,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()
 
@@ -214,33 +253,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()
 
@@ -282,7 +327,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()
 
@@ -293,7 +338,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()
 
@@ -307,7 +352,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()
 
@@ -315,6 +360,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")
@@ -357,9 +409,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
@@ -373,37 +426,40 @@ func testDeleteNewBlock(t *testing.T, factory TestableVolumeFactory) {
 	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 {
 		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()
 
@@ -414,7 +470,7 @@ func testDeleteNoSuchBlock(t *testing.T, factory TestableVolumeFactory) {
 
 // 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()
 
@@ -435,7 +491,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()
 
@@ -446,7 +502,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()
 
@@ -493,7 +549,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()
 
@@ -546,7 +602,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()
 
@@ -612,3 +668,31 @@ 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")
+	}
+}