Documentation
¶
Overview ¶
Package memstore is an in-memory backend.HeaderStore (and backend.Backend) for tests. It keeps the header, its ".prev" backup, and stored objects in maps instead of talking to rclone, so the safe-write protocol and any code that mutates the header can be tested without storage or network.
It is held to the same contract as the real backend by the shared conformance suite in internal/backend/backendtest, so a test that passes against this fake means the same thing it would against rclone.
Index ¶
- type Option
- type Store
- func (s *Store) AfterNextList(fn func())
- func (s *Store) BackupHeader(_ context.Context) error
- func (s *Store) BeforeNextPut(fn func())
- func (s *Store) CorruptNextBlobPut(fn func([]byte) []byte)
- func (s *Store) CorruptNextPut(fn func([]byte) []byte)
- func (s *Store) Delete(_ context.Context, key string) error
- func (s *Store) FailDeleteAfter(n int, err error)
- func (s *Store) FailPutAfter(n int, err error)
- func (s *Store) Get(_ context.Context, key string) ([]byte, error)
- func (s *Store) GetHeader(_ context.Context) ([]byte, error)
- func (s *Store) Header() []byte
- func (s *Store) List(_ context.Context, prefix string) ([]string, error)
- func (s *Store) Prev() []byte
- func (s *Store) Put(_ context.Context, key string, data []byte) error
- func (s *Store) PutHeader(_ context.Context, raw []byte) error
- func (s *Store) PutHeaderCount() int
- func (s *Store) RestoreHeaderBackup(_ context.Context) error
- func (s *Store) SetHeader(raw []byte)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store is an in-memory HeaderStore and Backend. The zero value is not usable; construct one with New. A Store is not safe for concurrent use; tests drive it from a single goroutine.
func (*Store) AfterNextList ¶ added in v0.3.0
func (s *Store) AfterNextList(fn func())
AfterNextList runs fn once, right after the next List captures its keys, so a test can inject an object the in-flight operation will not see.
func (*Store) BackupHeader ¶
BackupHeader copies the header to ".prev", a no-op when versioned or when no header exists, matching RcloneStorage.
func (*Store) BeforeNextPut ¶ added in v0.3.0
func (s *Store) BeforeNextPut(fn func())
BeforeNextPut runs fn once, right before the next Put stores, so a test can interleave a racing operation just ahead of a write.
func (*Store) CorruptNextBlobPut ¶ added in v0.3.0
CorruptNextBlobPut mangles the bytes the next Put stores, so a test can assert a compaction detects a botched snapshot write on read-back.
func (*Store) CorruptNextPut ¶
CorruptNextPut arms a one-shot transform applied to the bytes the next PutHeader stores, so a test can simulate a bad write (truncation, a flipped byte) and assert the safe-write protocol detects it on read-back.
func (*Store) FailDeleteAfter ¶ added in v0.3.0
FailDeleteAfter makes the (n+1)th Delete return err once (simulating a crash after a compaction's snapshot is written but before it finishes deleting).
func (*Store) FailPutAfter ¶
FailPutAfter makes the (n+1)th object Put return err once (simulating a crash mid-rotation); earlier and later Puts succeed.
func (*Store) PutHeader ¶
PutHeader stores the header. If a corruption hook is armed (CorruptNextPut), it is applied to the bytes actually stored and then disarmed, simulating a write that lands different bytes than intended so read-back verification has something to catch.
func (*Store) PutHeaderCount ¶
PutHeaderCount reports how many times PutHeader has been called.
func (*Store) RestoreHeaderBackup ¶
RestoreHeaderBackup copies ".prev" back over the header, or returns ErrNotFound when there is no backup (including when versioned).
Source Files