Documentation
¶
Overview ¶
Package recordstoretest is the conformance suite every recordstore.Backend runs, so the kv, sqlite and ndjson backends can never disagree about what appending, scanning, expiring and describing a stream mean.
Conformance specs for kinds that replace stored rows: a replaced row moves to the next seq, so a stream's seqs may skip, and backends that cannot must refuse.
Index ¶
- Constants
- Variables
- func Conformance(open func() Harness)
- func Normalize(rows []recordstore.Row) []recordstore.Row
- func SampleRow(n int) recordstore.Row
- func SampleRows(first, last int) []recordstore.Row
- func Scanned(backend recordstore.Backend, stream string, afterSeq int64) ([]int64, []recordstore.Row)
- func Schema(kind string) (recordstore.KindSchema, error)
- type Harness
Constants ¶
const ( // Kind is the kind most conformance streams are written under: unkeyed, // kept whole until the stream expires. Kind = "sample" // KeyedKind holds each name once per stream. KeyedKind = "keyed" // RollingKind holds each name once and keeps each row TTL after its append. RollingKind = "rolling" // ReplacingKind holds each name once, and an append of a stored name // replaces the stored row with the appended one. ReplacingKind = "replacing" // RollingReplacingKind is ReplacingKind keeping each row TTL after its // append. RollingReplacingKind = "rolling_replacing" // CompactingKind drops the rows whose count exceeds 2 when its store // compacts, which only a store whose seqs can skip does. CompactingKind = "compacting" )
const ExpiryTTL = 200 * time.Millisecond
ExpiryTTL is the ttl the expiry spec sets. It is short because the in-process kv store expires against the wall clock, so its Elapse sleeps.
const RecheckInterval = 20 * time.Millisecond
RecheckInterval is how often a conformance tail confirms its stream still exists. It is short so the expiry spec ends within the suite's patience.
const TTL = time.Hour
TTL is the stream ttl every conformance backend is opened with.
Variables ¶
var Columns = []query.ColumnDef{ {Name: "name", Type: query.ColumnTypeString}, {Name: "count", Type: query.ColumnTypeNumber}, {Name: "ok", Type: query.ColumnTypeBoolean}, {Name: "detail", Type: query.ColumnTypeJSON}, }
Columns is the columns of every conformance kind, for a backend that stores rows by column.
Functions ¶
func Conformance ¶
func Conformance(open func() Harness)
Conformance registers the suite. open is called before every spec.
func Normalize ¶
func Normalize(rows []recordstore.Row) []recordstore.Row
Normalize is rows as their JSON encoding reads back, which is the only equality a row promises across backends: an int written may read back as a float, and a nested value as generic maps.
func SampleRows ¶
func SampleRows(first, last int) []recordstore.Row
SampleRows are rows first..last.
func Scanned ¶
func Scanned(backend recordstore.Backend, stream string, afterSeq int64) ([]int64, []recordstore.Row)
Scanned is every row a stream holds after afterSeq, keyed by seq.
func Schema ¶
func Schema(kind string) (recordstore.KindSchema, error)
Schema resolves the conformance kinds and refuses every other kind.
Types ¶
type Harness ¶
type Harness struct {
// Backend is a fresh, empty backend, opened with Schema and TTL.
Backend recordstore.Backend
// Elapse moves the backend's clock forward by d and reaps whatever that
// expired, so a stream whose ttl is shorter than d is gone afterwards.
Elapse func(d time.Duration)
// Advance moves the backend's clock forward by d and reaps nothing, so
// what a spec sees after it is only what the backend itself decided.
Advance func(d time.Duration)
// Now reads the backend's clock.
Now func() time.Time
// Reopen opens another backend over the storage Backend wrote, sharing
// its clock, as a process restarting would.
Reopen func() recordstore.Backend
// Replace reports that the backend stores kinds that replace stored rows
// (recordstore.OnConflictReplace). One that does not must refuse them with
// recordstore.ErrUnsupported.
Replace bool
}
Harness opens the backend under test.
Source Files