X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/fe3f19bb8f0a684de9c5a7d1f7c619943d0daca0..8a27fe370239ecb8e50d53f46b45ed61203a35ca:/services/keepstore/volume_test.go diff --git a/services/keepstore/volume_test.go b/services/keepstore/volume_test.go index e8a5a338f5..950b3989aa 100644 --- a/services/keepstore/volume_test.go +++ b/services/keepstore/volume_test.go @@ -1,7 +1,12 @@ -package main +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: AGPL-3.0 + +package keepstore import ( "bytes" + "context" "crypto/md5" "errors" "fmt" @@ -10,6 +15,28 @@ import ( "strings" "sync" "time" + + "git.arvados.org/arvados.git/sdk/go/arvados" + "github.com/sirupsen/logrus" +) + +var ( + TestBlock = []byte("The quick brown fox jumps over the lazy dog.") + TestHash = "e4d909c290d0fb1ca068ffaddf22cbd0" + TestHashPutResp = "e4d909c290d0fb1ca068ffaddf22cbd0+44\n" + + TestBlock2 = []byte("Pack my box with five dozen liquor jugs.") + TestHash2 = "f15ac516f788aec4f30932ffb6395c39" + + TestBlock3 = []byte("Now is the time for all good men to come to the aid of their country.") + TestHash3 = "eed29bbffbc2dbe5e5ee0bb71888e61f" + + // BadBlock is used to test collisions and corruption. + // It must not match any test hashes. + BadBlock = []byte("The magic words are squeamish ossifrage.") + + EmptyHash = "d41d8cd98f00b204e9800998ecf8427e" + EmptyBlock = []byte("") ) // A TestableVolume allows test suites to manipulate the state of an @@ -17,10 +44,14 @@ import ( // 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) + // Returns the strings that a driver uses to record read/write operations. + ReadWriteOperationLabelValues() (r, w string) + // Specify the value Mtime() should return, until the next // call to Touch, TouchWithDate, or Put. TouchWithDate(locator string, lastPut time.Time) @@ -29,22 +60,23 @@ type TestableVolume interface { Teardown() } +func init() { + driver["mock"] = newMockVolume +} + // MockVolumes are test doubles for Volumes, used to test handlers. type MockVolume struct { Store map[string][]byte Timestamps map[string]time.Time // Bad volumes return an error for every operation. - Bad bool + Bad bool + BadVolumeError error // Touchable volumes' Touch() method succeeds for a locator // that has been Put(). Touchable bool - // Readonly volumes return an error for Put, Delete, and - // Touch. - Readonly bool - // 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 @@ -52,15 +84,19 @@ type MockVolume struct { // 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{} + Gate chan struct{} `json:"-"` - called map[string]int - mutex sync.Mutex + cluster *arvados.Cluster + volume arvados.Volume + logger logrus.FieldLogger + metrics *volumeMetricsVecs + called map[string]int + mutex sync.Mutex } -// CreateMockVolume returns a non-Bad, non-Readonly, Touchable mock +// newMockVolume returns a non-Bad, non-Readonly, Touchable mock // volume. -func CreateMockVolume() *MockVolume { +func newMockVolume(cluster *arvados.Cluster, volume arvados.Volume, logger logrus.FieldLogger, metrics *volumeMetricsVecs) (Volume, error) { gate := make(chan struct{}) close(gate) return &MockVolume{ @@ -68,10 +104,13 @@ func CreateMockVolume() *MockVolume { Timestamps: make(map[string]time.Time), Bad: false, Touchable: true, - Readonly: false, called: map[string]int{}, Gate: gate, - } + cluster: cluster, + volume: volume, + logger: logger, + metrics: metrics, + }, nil } // CallCount returns how many times the named method has been called. @@ -95,11 +134,11 @@ func (v *MockVolume) gotCall(method string) { } } -func (v *MockVolume) Compare(loc string, buf []byte) error { +func (v *MockVolume) Compare(ctx context.Context, loc string, buf []byte) error { v.gotCall("Compare") <-v.Gate if v.Bad { - return errors.New("Bad volume") + return v.BadVolumeError } else if block, ok := v.Store[loc]; ok { if fmt.Sprintf("%x", md5.Sum(block)) != loc { return DiskHashError @@ -109,30 +148,29 @@ func (v *MockVolume) Compare(loc string, buf []byte) error { } return nil } else { - return NotFoundError + return os.ErrNotExist } } -func (v *MockVolume) Get(loc string) ([]byte, error) { +func (v *MockVolume) Get(ctx context.Context, loc string, buf []byte) (int, error) { v.gotCall("Get") <-v.Gate if v.Bad { - return nil, errors.New("Bad volume") + return 0, v.BadVolumeError } else if block, ok := v.Store[loc]; ok { - buf := bufs.Get(len(block)) - copy(buf, block) - return buf, nil + copy(buf[:len(block)], block) + return len(block), nil } - return nil, os.ErrNotExist + return 0, os.ErrNotExist } -func (v *MockVolume) Put(loc string, block []byte) error { +func (v *MockVolume) Put(ctx context.Context, loc string, block []byte) error { v.gotCall("Put") <-v.Gate if v.Bad { - return errors.New("Bad volume") + return v.BadVolumeError } - if v.Readonly { + if v.volume.ReadOnly { return MethodDisabledError } v.Store[loc] = block @@ -140,13 +178,20 @@ func (v *MockVolume) Put(loc string, block []byte) error { } func (v *MockVolume) Touch(loc string) error { + return v.TouchWithDate(loc, time.Now()) +} + +func (v *MockVolume) TouchWithDate(loc string, t time.Time) error { v.gotCall("Touch") <-v.Gate - if v.Readonly { + if v.volume.ReadOnly { return MethodDisabledError } + if _, exists := v.Store[loc]; !exists { + return os.ErrNotExist + } if v.Touchable { - v.Timestamps[loc] = time.Now() + v.Timestamps[loc] = t return nil } return errors.New("Touch failed") @@ -158,7 +203,7 @@ func (v *MockVolume) Mtime(loc string) (time.Time, error) { var mtime time.Time var err error if v.Bad { - err = errors.New("Bad volume") + err = v.BadVolumeError } else if t, ok := v.Timestamps[loc]; ok { mtime = t } else { @@ -186,11 +231,11 @@ func (v *MockVolume) IndexTo(prefix string, w io.Writer) error { func (v *MockVolume) Trash(loc string) error { v.gotCall("Delete") <-v.Gate - if v.Readonly { + if v.volume.ReadOnly { return MethodDisabledError } if _, ok := v.Store[loc]; ok { - if time.Since(v.Timestamps[loc]) < blobSignatureTTL { + if time.Since(v.Timestamps[loc]) < time.Duration(v.cluster.Collections.BlobSigningTTL) { return nil } delete(v.Store, loc) @@ -199,7 +244,10 @@ func (v *MockVolume) Trash(loc string) error { return os.ErrNotExist } -// TBD +func (v *MockVolume) GetDeviceID() string { + return "mock-device-id" +} + func (v *MockVolume) Untrash(loc string) error { return nil } @@ -216,13 +264,9 @@ func (v *MockVolume) String() string { return "[MockVolume]" } -func (v *MockVolume) Writable() bool { - return !v.Readonly -} - -func (v *MockVolume) Replication() int { - return 1 +func (v *MockVolume) EmptyTrash() { } -func (v *MockVolume) EmptyTrash() { +func (v *MockVolume) GetStorageClasses() []string { + return nil }