X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/14a27997ba2a94c5a7250ddde4519d5f68b6eda0..5dd88c53ca3357f96bb98ad286d0fb0a52ef5f54:/services/keepstore/volume_test.go

diff --git a/services/keepstore/volume_test.go b/services/keepstore/volume_test.go
index 261501992f..34dcbdc8cf 100644
--- a/services/keepstore/volume_test.go
+++ b/services/keepstore/volume_test.go
@@ -10,6 +10,21 @@ import (
 	"time"
 )
 
+// A TestableVolume allows test suites to manipulate the state of an
+// underlying Volume, in order to test behavior in cases that are
+// impractical to achieve with a sequence of normal Volume operations.
+type TestableVolume interface {
+	Volume
+	// [Over]write content for a locator with the given data,
+	// bypassing all constraints like readonly and serialize.
+	PutRaw(locator string, data []byte)
+	// Specify the value Mtime() should return, until the next
+	// call to Touch, TouchWithDate, or Put.
+	TouchWithDate(locator string, lastPut time.Time)
+	// Clean up, delete temporary files.
+	Teardown()
+}
+
 // MockVolumes are test doubles for Volumes, used to test handlers.
 type MockVolume struct {
 	Store      map[string][]byte
@@ -22,13 +37,23 @@ type MockVolume struct {
 	// Readonly volumes return an error for Put, Delete, and
 	// Touch.
 	Readonly bool
-	called   map[string]int
-	mutex    sync.Mutex
+	// Gate is a "starting gate", allowing test cases to pause
+	// volume operations long enough to inspect state. Every
+	// operation (except Status) starts by receiving from
+	// Gate. Sending one value unblocks one operation; closing the
+	// channel unblocks all operations. By default, Gate is a
+	// closed channel, so all operations proceed without
+	// blocking. See trash_worker_test.go for an example.
+	Gate   chan struct{}
+	called map[string]int
+	mutex  sync.Mutex
 }
 
 // CreateMockVolume returns a non-Bad, non-Readonly, Touchable mock
 // volume.
 func CreateMockVolume() *MockVolume {
+	gate := make(chan struct{})
+	close(gate)
 	return &MockVolume{
 		Store:      make(map[string][]byte),
 		Timestamps: make(map[string]time.Time),
@@ -36,6 +61,7 @@ func CreateMockVolume() *MockVolume {
 		Touchable:  true,
 		Readonly:   false,
 		called:     map[string]int{},
+		Gate:       gate,
 	}
 }
 
@@ -62,6 +88,7 @@ func (v *MockVolume) gotCall(method string) {
 
 func (v *MockVolume) Get(loc string) ([]byte, error) {
 	v.gotCall("Get")
+	<-v.Gate
 	if v.Bad {
 		return nil, errors.New("Bad volume")
 	} else if block, ok := v.Store[loc]; ok {
@@ -74,6 +101,7 @@ func (v *MockVolume) Get(loc string) ([]byte, error) {
 
 func (v *MockVolume) Put(loc string, block []byte) error {
 	v.gotCall("Put")
+	<-v.Gate
 	if v.Bad {
 		return errors.New("Bad volume")
 	}
@@ -86,6 +114,7 @@ func (v *MockVolume) Put(loc string, block []byte) error {
 
 func (v *MockVolume) Touch(loc string) error {
 	v.gotCall("Touch")
+	<-v.Gate
 	if v.Readonly {
 		return MethodDisabledError
 	}
@@ -98,6 +127,7 @@ func (v *MockVolume) Touch(loc string) error {
 
 func (v *MockVolume) Mtime(loc string) (time.Time, error) {
 	v.gotCall("Mtime")
+	<-v.Gate
 	var mtime time.Time
 	var err error
 	if v.Bad {
@@ -112,6 +142,7 @@ func (v *MockVolume) Mtime(loc string) (time.Time, error) {
 
 func (v *MockVolume) IndexTo(prefix string, w io.Writer) error {
 	v.gotCall("IndexTo")
+	<-v.Gate
 	for loc, block := range v.Store {
 		if !IsValidLocator(loc) || !strings.HasPrefix(loc, prefix) {
 			continue
@@ -127,6 +158,7 @@ func (v *MockVolume) IndexTo(prefix string, w io.Writer) error {
 
 func (v *MockVolume) Delete(loc string) error {
 	v.gotCall("Delete")
+	<-v.Gate
 	if v.Readonly {
 		return MethodDisabledError
 	}