storagetest

Documentation

Overview

Package stanzareceiver implements a receiver that can be used by the Opentelemetry collector to receive logs using the stanza log agent

Index

• func CreatorID(ctx context.Context, client storage.Client) (component.ID, error)
• func NewNonStorageID(name string) component.ID
• func NewStorageID(name string) component.ID
• type NonStorage
  • func NewNonStorageExtension(name string) *NonStorage
• type StorageHost
  • func NewStorageHost() *StorageHost
  • func (h *StorageHost) GetExtensions() map[component.ID]component.Component
  • func (h *StorageHost) WithExtension(id component.ID, ext extension.Extension) *StorageHost
  • func (h *StorageHost) WithFileBackedStorageExtension(name, storageDir string) *StorageHost
  • func (h *StorageHost) WithInMemoryStorageExtension(name string) *StorageHost
  • func (h *StorageHost) WithNonStorageExtension(name string) *StorageHost
• type TestClient
  • func NewFileBackedClient(kind component.Kind, id component.ID, name string, storageDir string) *TestClient
  • func NewInMemoryClient(kind component.Kind, id component.ID, name string) *TestClient
  • func (p *TestClient) Batch(_ context.Context, ops ...storage.Operation) error
  • func (p *TestClient) Close(_ context.Context) error
  • func (p *TestClient) Delete(_ context.Context, key string) error
  • func (p *TestClient) Get(_ context.Context, key string) ([]byte, error)
  • func (p *TestClient) Set(_ context.Context, key string, value []byte) error
• type TestStorage
  • func NewFileBackedStorageExtension(name string, storageDir string) *TestStorage
  • func NewInMemoryStorageExtension(name string) *TestStorage
  • func (s *TestStorage) GetClient(ctx context.Context, kind component.Kind, ent component.ID, name string) (storage.Client, error)

Functions

func CreatorID

func CreatorID(ctx context.Context, client storage.Client) (component.ID, error)

CreatorID is the component.ID of the extension that created the component

func NewNonStorageID

func NewNonStorageID(name string) component.ID

func NewStorageID

func NewStorageID(name string) component.ID

Types

type NonStorage

type NonStorage struct {
	component.StartFunc
	component.ShutdownFunc
	ID component.ID
}

NonStorage is useful for testing expected behaviors that involve non-storage extensions

func NewNonStorageExtension

func NewNonStorageExtension(name string) *NonStorage

NewNonStorageExtension creates a NonStorage extension

type StorageHost

type StorageHost struct {
	component.Host
	// contains filtered or unexported fields
}

func NewStorageHost

func NewStorageHost() *StorageHost

func (*StorageHost) GetExtensions

func (h *StorageHost) GetExtensions() map[component.ID]component.Component

func (*StorageHost) WithExtension

func (h *StorageHost) WithExtension(id component.ID, ext extension.Extension) *StorageHost

func (*StorageHost) WithFileBackedStorageExtension

func (h *StorageHost) WithFileBackedStorageExtension(name, storageDir string) *StorageHost

func (*StorageHost) WithInMemoryStorageExtension

func (h *StorageHost) WithInMemoryStorageExtension(name string) *StorageHost

func (*StorageHost) WithNonStorageExtension

func (h *StorageHost) WithNonStorageExtension(name string) *StorageHost

type TestClient

type TestClient struct {
	// contains filtered or unexported fields
}

func NewFileBackedClient

func NewFileBackedClient(kind component.Kind, id component.ID, name string, storageDir string) *TestClient

NewFileBackedClient creates a storage.Client that will load previous storage contents upon creation and save storage contents when closed. It also has metadata which may be used to validate test expectations.

func NewInMemoryClient

func NewInMemoryClient(kind component.Kind, id component.ID, name string) *TestClient

NewInMemoryClient creates a storage.Client that functions as a map[string][]byte This is useful for tests that do not involve collector restart behavior.

func (*TestClient) Batch

func (p *TestClient) Batch(_ context.Context, ops ...storage.Operation) error

func (*TestClient) Close

func (p *TestClient) Close(_ context.Context) error

func (*TestClient) Delete

func (p *TestClient) Delete(_ context.Context, key string) error

func (*TestClient) Get

func (p *TestClient) Get(_ context.Context, key string) ([]byte, error)

func (*TestClient) Set

func (p *TestClient) Set(_ context.Context, key string, value []byte) error

type TestStorage

type TestStorage struct {
	component.StartFunc
	component.ShutdownFunc
	ID component.ID
	// contains filtered or unexported fields
}

TestStorage is an in memory storage extension designed for testing

func NewFileBackedStorageExtension

func NewFileBackedStorageExtension(name string, storageDir string) *TestStorage

NewFileBackedStorageExtension creates a TestStorage extension

func NewInMemoryStorageExtension

func NewInMemoryStorageExtension(name string) *TestStorage

NewInMemoryStorageExtension creates a TestStorage extension

func (*TestStorage) GetClient

func (s *TestStorage) GetClient(ctx context.Context, kind component.Kind, ent component.ID, name string) (storage.Client, error)

GetClient returns a storage client for an individual component