storetestutil

Documentation

Index

• Constants
• func CreateBlockFromHead(t testing.TB, dir string, head *tsdb.Head) ulid.ULID
• func CreateHeadWithSeries(t testing.TB, j int, opts HeadGenOptions) (*tsdb.Head, []*storepb.Series)
• func ReadSeriesFromBlock(t testing.TB, h tsdb.BlockReader, extLabels labels.Labels, skipChunks bool) []*storepb.Series
• func RunSeriesInterestingCases(t testutil.TB, maxSamples, maxSeries int, ...)
• func TestServerSeries(t testutil.TB, store storepb.StoreServer, cases ...*SeriesCase)
• type HeadGenOptions
• type SeriesCase
• type SeriesServer
  • func NewSeriesServer(ctx context.Context) *SeriesServer
  • func (s *SeriesServer) Context() context.Context
  • func (s *SeriesServer) Send(r *storepb.SeriesResponse) error
• type StoreSeriesClient
  • func (c *StoreSeriesClient) Context() context.Context
  • func (c *StoreSeriesClient) Recv() (*storepb.SeriesResponse, error)
• type TestClient
  • func (c TestClient) Addr() (string, bool)
  • func (c TestClient) LabelSets() []labels.Labels
  • func (c TestClient) String() string
  • func (c TestClient) SupportsSharding() bool
  • func (c TestClient) SupportsWithoutReplicaLabels() bool
  • func (c TestClient) TSDBInfos() []infopb.TSDBInfo
  • func (c TestClient) TimeRange() (mint, maxt int64)

Constants

const (
	// LabelLongSuffix is a label with ~50B in size, to emulate real-world high cardinality.
	LabelLongSuffix = "aaaaaaaaaabbbbbbbbbbccccccccccdddddddddd"
)

Functions

func CreateBlockFromHead

func CreateBlockFromHead(t testing.TB, dir string, head *tsdb.Head) ulid.ULID

func CreateHeadWithSeries

func CreateHeadWithSeries(t testing.TB, j int, opts HeadGenOptions) (*tsdb.Head, []*storepb.Series)

CreateHeadWithSeries returns head filled with given samples and same series returned in separate list for assertion purposes. Returned series list has "ext1"="1" prepended. Each series looks as follows: {foo=bar,i=000001aaaaaaaaaabbbbbbbbbbccccccccccdddddddddd} <random value> where number indicate sample number from 0. Returned series are framed in the same way as remote read would frame them.

func ReadSeriesFromBlock

func ReadSeriesFromBlock(t testing.TB, h tsdb.BlockReader, extLabels labels.Labels, skipChunks bool) []*storepb.Series

func RunSeriesInterestingCases

func RunSeriesInterestingCases(t testutil.TB, maxSamples, maxSeries int, f func(t testutil.TB, samplesPerSeries, series int))

func TestServerSeries

func TestServerSeries(t testutil.TB, store storepb.StoreServer, cases ...*SeriesCase)

TestServerSeries runs tests against given cases.

Types

type HeadGenOptions

type HeadGenOptions struct {
	TSDBDir                  string
	SamplesPerSeries, Series int
	ScrapeInterval           time.Duration

	WithWAL       bool
	PrependLabels labels.Labels
	SkipChunks    bool // Skips chunks in returned slice (not in generated head!).
	SampleType    chunkenc.ValueType

	Random *rand.Rand
}

type SeriesCase

type SeriesCase struct {
	Name string
	Req  *storepb.SeriesRequest

	// Exact expectations are checked only for tests. For benchmarks only length is assured.
	ExpectedSeries   []*storepb.Series
	ExpectedWarnings []string
	ExpectedHints    []hintspb.SeriesResponseHints
	HintsCompareFunc func(t testutil.TB, expected, actual hintspb.SeriesResponseHints)
}

SeriesCase represents single test/benchmark case for testing storepb series.

type SeriesServer

type SeriesServer struct {
	// This field just exist to pseudo-implement the unused methods of the interface.
	storepb.Store_SeriesServer

	SeriesSet []*storepb.Series
	Warnings  []string
	HintsSet  []*types.Any

	Size int64
	// contains filtered or unexported fields
}

SeriesServer is test gRPC storeAPI series server.

func NewSeriesServer

func NewSeriesServer(ctx context.Context) *SeriesServer

func (*SeriesServer) Context

func (s *SeriesServer) Context() context.Context

func (*SeriesServer) Send

func (s *SeriesServer) Send(r *storepb.SeriesResponse) error

type StoreSeriesClient

type StoreSeriesClient struct {
	// This field just exist to pseudo-implement the unused methods of the interface.
	storepb.Store_SeriesClient
	Ctx context.Context

	RespSet         []*storepb.SeriesResponse
	RespDur         time.Duration
	SlowSeriesIndex int

	InjectedError      error
	InjectedErrorIndex int
	// contains filtered or unexported fields
}

StoreSeriesClient is test gRPC storeAPI series client.

func (*StoreSeriesClient) Context

func (c *StoreSeriesClient) Context() context.Context

func (*StoreSeriesClient) Recv

func (c *StoreSeriesClient) Recv() (*storepb.SeriesResponse, error)

type TestClient

type TestClient struct {
	storepb.StoreClient

	Name string

	ExtLset                     []labels.Labels
	MinTime, MaxTime            int64
	Shardable                   bool
	WithoutReplicaLabelsEnabled bool
	IsLocalStore                bool
	StoreTSDBInfos              []infopb.TSDBInfo
}

func (TestClient) Addr

func (c TestClient) Addr() (string, bool)

func (TestClient) LabelSets

func (c TestClient) LabelSets() []labels.Labels

func (TestClient) String

func (c TestClient) String() string

func (TestClient) SupportsSharding

func (c TestClient) SupportsSharding() bool

func (TestClient) SupportsWithoutReplicaLabels

func (c TestClient) SupportsWithoutReplicaLabels() bool

func (TestClient) TSDBInfos

func (c TestClient) TSDBInfos() []infopb.TSDBInfo

func (TestClient) TimeRange

func (c TestClient) TimeRange() (mint, maxt int64)