blobtesting

Documentation

Overview

Package blobtesting is used for testing BLOB storage implementations.

Index

• Constants
• Variables
• func AssertConnectionInfoRoundTrips(ctx context.Context, t *testing.T, s blob.Storage)
• func AssertGetBlob(ctx context.Context, t *testing.T, s blob.Storage, blobID blob.ID, ...)
• func AssertGetBlobNotFound(ctx context.Context, t *testing.T, s blob.Storage, blobID blob.ID)
• func AssertGetMetadataNotFound(ctx context.Context, t *testing.T, s blob.Storage, blobID blob.ID)
• func AssertInvalidOffsetLength(ctx context.Context, t *testing.T, s blob.Storage, blobID blob.ID, ...)
• func AssertListResults(ctx context.Context, t *testing.T, s blob.Storage, prefix blob.ID, ...)
• func AssertListResultsIDs(ctx context.Context, t *testing.T, s blob.Storage, prefix blob.ID, ...)
• func CleanupOldData(ctx context.Context, tb testing.TB, st blob.Storage, cleanupAge time.Duration)
• func NewEventuallyConsistentStorage(st blob.Storage, listSettleTime time.Duration, timeNow func() time.Time) blob.Storage
• func NewMapStorage(data DataMap, keyTime map[blob.ID]time.Time, timeNow func() time.Time) blob.Storage
• func VerifyConcurrentAccess(t *testing.T, st blob.Storage, options ConcurrentAccessOptions)
• func VerifyStorage(ctx context.Context, t *testing.T, r blob.Storage, opts blob.PutOptions)
• type ConcurrentAccessOptions
• type DataMap
• type Fault
• type FaultyStorage
  • func (s *FaultyStorage) Close(ctx context.Context) error
  • func (s *FaultyStorage) ConnectionInfo() blob.ConnectionInfo
  • func (s *FaultyStorage) DeleteBlob(ctx context.Context, id blob.ID) error
  • func (s *FaultyStorage) DisplayName() string
  • func (s *FaultyStorage) FlushCaches(ctx context.Context) error
  • func (s *FaultyStorage) GetBlob(ctx context.Context, id blob.ID, offset, length int64, ...) error
  • func (s *FaultyStorage) GetMetadata(ctx context.Context, id blob.ID) (blob.Metadata, error)
  • func (s *FaultyStorage) ListBlobs(ctx context.Context, prefix blob.ID, callback func(blob.Metadata) error) error
  • func (s *FaultyStorage) PutBlob(ctx context.Context, id blob.ID, data blob.Bytes, opts blob.PutOptions) error
  • func (s *FaultyStorage) SetTime(ctx context.Context, id blob.ID, t time.Time) error
  • func (s *FaultyStorage) VerifyAllFaultsExercised(t *testing.T)

Constants

const MinCleanupAge = time.Hour

MinCleanupAge is the default cleanup age.

Variables

var TestValidationOptions = providervalidation.Options{
	MaxClockDrift:           3 * time.Minute,
	ConcurrencyTestDuration: 15 * time.Second,
	NumPutBlobWorkers:       3,
	NumGetBlobWorkers:       3,
	NumGetMetadataWorkers:   3,
	NumListBlobsWorkers:     3,
	MaxBlobLength:           10e6,
}

TestValidationOptions is the set of options used when running providing validation from tests. nolint:gomnd

Functions

func AssertConnectionInfoRoundTrips

func AssertConnectionInfoRoundTrips(ctx context.Context, t *testing.T, s blob.Storage)

AssertConnectionInfoRoundTrips verifies that the ConnectionInfo returned by a given storage can be used to create equivalent storage. nolint:thelper

func AssertGetBlob

func AssertGetBlob(ctx context.Context, t *testing.T, s blob.Storage, blobID blob.ID, expected []byte)

AssertGetBlob asserts that the specified BLOB has correct content.

func AssertGetBlobNotFound

func AssertGetBlobNotFound(ctx context.Context, t *testing.T, s blob.Storage, blobID blob.ID)

AssertGetBlobNotFound asserts that GetBlob() for specified blobID returns ErrNotFound.

func AssertGetMetadataNotFound

func AssertGetMetadataNotFound(ctx context.Context, t *testing.T, s blob.Storage, blobID blob.ID)

AssertGetMetadataNotFound asserts that GetMetadata() for specified blobID returns ErrNotFound.

func AssertInvalidOffsetLength

func AssertInvalidOffsetLength(ctx context.Context, t *testing.T, s blob.Storage, blobID blob.ID, offset, length int64)

AssertInvalidOffsetLength verifies that the given combination of (offset,length) fails on GetBlob().

func AssertListResults

func AssertListResults(ctx context.Context, t *testing.T, s blob.Storage, prefix blob.ID, want ...blob.ID)

AssertListResults asserts that the list results with given prefix return the specified list of names in order.

func AssertListResultsIDs

func AssertListResultsIDs(ctx context.Context, t *testing.T, s blob.Storage, prefix blob.ID, want ...blob.ID)

AssertListResultsIDs asserts that the list results with given prefix return the specified list of names.

func CleanupOldData

func CleanupOldData(ctx context.Context, tb testing.TB, st blob.Storage, cleanupAge time.Duration)

CleanupOldData removes blobs older than provided time from storage using provided prefix.

func NewEventuallyConsistentStorage

func NewEventuallyConsistentStorage(st blob.Storage, listSettleTime time.Duration, timeNow func() time.Time) blob.Storage

NewEventuallyConsistentStorage returns an eventually-consistent storage wrapper on top of provided storage.

func NewMapStorage

func NewMapStorage(data DataMap, keyTime map[blob.ID]time.Time, timeNow func() time.Time) blob.Storage

NewMapStorage returns an implementation of Storage backed by the contents of given map. Used primarily for testing.

func VerifyConcurrentAccess

func VerifyConcurrentAccess(t *testing.T, st blob.Storage, options ConcurrentAccessOptions)

VerifyConcurrentAccess tests data races on a repository to ensure only clean errors are returned. nolint:gocognit,gocyclo,funlen,cyclop

func VerifyStorage

func VerifyStorage(ctx context.Context, t *testing.T, r blob.Storage, opts blob.PutOptions)

VerifyStorage verifies the behavior of the specified storage. nolint:gocyclo,thelper

Types

type ConcurrentAccessOptions

type ConcurrentAccessOptions struct {
	NumBlobs int // number of shared blos in the pool

	Getters  int
	Putters  int
	Deleters int
	Listers  int

	Iterations int

	RangeGetPercentage              int // 0..100 - probability of issuing range get
	NonExistentListPrefixPercentage int // probability of issuing non-matching list prefix
}

ConcurrentAccessOptions encapsulates parameters for VerifyConcurrentAccess.

type DataMap

type DataMap map[blob.ID][]byte

DataMap is a map of blob ID to their contents.

type Fault

type Fault struct {
	Repeat      int           // how many times to repeat this fault
	Sleep       time.Duration // sleep before returning
	ErrCallback func() error
	WaitFor     chan struct{} // waits until the given channel is closed before returning
	Err         error         // error to return (can be nil in combination with Sleep and WaitFor)
}

Fault describes the behavior of a single fault.

type FaultyStorage

type FaultyStorage struct {
	Base   blob.Storage
	Faults map[string][]*Fault
	// contains filtered or unexported fields
}

FaultyStorage implements fault injection for Storage.

func (*FaultyStorage) Close

func (s *FaultyStorage) Close(ctx context.Context) error

Close implements blob.Storage.

func (*FaultyStorage) ConnectionInfo

func (s *FaultyStorage) ConnectionInfo() blob.ConnectionInfo

ConnectionInfo implements blob.Storage.

func (*FaultyStorage) DeleteBlob

func (s *FaultyStorage) DeleteBlob(ctx context.Context, id blob.ID) error

DeleteBlob implements blob.Storage.

func (*FaultyStorage) DisplayName

func (s *FaultyStorage) DisplayName() string

DisplayName implements blob.Storage.

func (*FaultyStorage) FlushCaches

func (s *FaultyStorage) FlushCaches(ctx context.Context) error

FlushCaches implements blob.Storage.

func (*FaultyStorage) GetBlob

func (s *FaultyStorage) GetBlob(ctx context.Context, id blob.ID, offset, length int64, output blob.OutputBuffer) error

GetBlob implements blob.Storage.

func (*FaultyStorage) GetMetadata

func (s *FaultyStorage) GetMetadata(ctx context.Context, id blob.ID) (blob.Metadata, error)

GetMetadata implements blob.Storage.

func (*FaultyStorage) ListBlobs

func (s *FaultyStorage) ListBlobs(ctx context.Context, prefix blob.ID, callback func(blob.Metadata) error) error

ListBlobs implements blob.Storage.

func (*FaultyStorage) PutBlob

func (s *FaultyStorage) PutBlob(ctx context.Context, id blob.ID, data blob.Bytes, opts blob.PutOptions) error

PutBlob implements blob.Storage.

func (*FaultyStorage) SetTime

func (s *FaultyStorage) SetTime(ctx context.Context, id blob.ID, t time.Time) error

SetTime implements blob.Storage.

func (*FaultyStorage) VerifyAllFaultsExercised

func (s *FaultyStorage) VerifyAllFaultsExercised(t *testing.T)

VerifyAllFaultsExercised fails the test if some faults have not been exercised.