componenttest

Documentation

Overview

Package componenttest define types and functions used to help test packages implementing the component package interfaces.

Index

• func NewNopExporterFactory() component.ExporterFactory
• func NewNopExtensionFactory() component.ExtensionFactory
• func NewNopHost() component.Host
• func NewNopProcessorFactory() component.ProcessorFactory
• func NewNopReceiverFactory() component.ReceiverFactory
• func NopFactories() (component.Factories, error)
• func VerifyProcessorShutdown(t *testing.T, factory component.ProcessorFactory, cfg configmodels.Processor)
• type ErrorWaitingHost
  • func NewErrorWaitingHost() *ErrorWaitingHost
  • func (ews *ErrorWaitingHost) GetExporters() map[configmodels.DataType]map[configmodels.NamedEntity]component.Exporter
  • func (ews *ErrorWaitingHost) GetExtensions() map[configmodels.NamedEntity]component.Extension
  • func (ews *ErrorWaitingHost) GetFactory(_ component.Kind, _ configmodels.Type) component.Factory
  • func (ews *ErrorWaitingHost) ReportFatalError(err error)
  • func (ews *ErrorWaitingHost) WaitForFatalError(timeout time.Duration) (receivedError bool, err error)

Functions

func NewNopExporterFactory

func NewNopExporterFactory() component.ExporterFactory

NewNopExporterFactory returns a component.ExporterFactory that constructs nop exporters.

func NewNopExtensionFactory

func NewNopExtensionFactory() component.ExtensionFactory

NewNopExtensionFactory returns a component.ExtensionFactory that constructs nop exporters.

func NewNopHost

func NewNopHost() component.Host

NewNopHost returns a new instance of nopHost with proper defaults for most tests.

func NewNopProcessorFactory

func NewNopProcessorFactory() component.ProcessorFactory

NewNopProcessorFactory returns a component.ProcessorFactory that constructs nop exporters.

func NewNopReceiverFactory

func NewNopReceiverFactory() component.ReceiverFactory

NewNopReceiverFactory returns a component.ReceiverFactory that constructs nop exporters.

func NopFactories

func NopFactories() (component.Factories, error)

NopFactories returns a component.Factories with all nop factories.

func VerifyProcessorShutdown

func VerifyProcessorShutdown(t *testing.T, factory component.ProcessorFactory, cfg configmodels.Processor)

Types

type ErrorWaitingHost

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

ErrorWaitingHost mocks an component.Host for test purposes.

func NewErrorWaitingHost

func NewErrorWaitingHost() *ErrorWaitingHost

NewErrorWaitingHost returns a new instance of ErrorWaitingHost with proper defaults for most tests.

func (*ErrorWaitingHost) GetExporters

func (ews *ErrorWaitingHost) GetExporters() map[configmodels.DataType]map[configmodels.NamedEntity]component.Exporter

func (*ErrorWaitingHost) GetExtensions

func (ews *ErrorWaitingHost) GetExtensions() map[configmodels.NamedEntity]component.Extension

func (*ErrorWaitingHost) GetFactory

func (ews *ErrorWaitingHost) GetFactory(_ component.Kind, _ configmodels.Type) component.Factory

GetFactory of the specified kind. Returns the factory for a component type.

func (*ErrorWaitingHost) ReportFatalError

func (ews *ErrorWaitingHost) ReportFatalError(err error)

ReportFatalError is used to report to the host that the extension encountered a fatal error (i.e.: an error that the instance can't recover from) after its start function has already returned.

func (*ErrorWaitingHost) WaitForFatalError

func (ews *ErrorWaitingHost) WaitForFatalError(timeout time.Duration) (receivedError bool, err error)

WaitForFatalError waits the given amount of time until an error is reported via ReportFatalError. It returns the error, if any, and a bool to indicated if an error was received before the time out.