extensiontest

Documentation

Overview

Package extensiontest define types and functions used to help test packages implementing the extension package interfaces.

Index

• type MockHost
  • func NewMockHost() *MockHost
  • func (mh *MockHost) Context() context.Context
  • func (mh *MockHost) ReportFatalError(err error)
  • func (mh *MockHost) WaitForFatalError(timeout time.Duration) (receivedError bool, err error)

Types

type MockHost

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

MockHost mocks an component.Host for test purposes.

func NewMockHost

func NewMockHost() *MockHost

NewMockHost returns a new instance of MockHost with proper defaults for most tests.

func (*MockHost) Context

func (mh *MockHost) Context() context.Context

Context returns a context provided by the host to be used on the component operations.

func (*MockHost) ReportFatalError

func (mh *MockHost) 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 (*MockHost) WaitForFatalError

func (mh *MockHost) 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.