corehelpers

Documentation

Overview

Package corehelpers contains testhelpers that don't depend on package vault, and thus can be used within vault (as well as elsewhere.)

Index

• func MakeTestPluginDir(t testing.T) (string, func(t testing.T))
• func NewMockBuiltinRegistry() *mockBuiltinRegistry
• func NoopAuditFactory(records **[][]byte) audit.Factory
• func RegisterSubloggerAdder(logger hclog.Logger, adder logging.SubloggerAdder)
• func RetryUntil(t testing.T, timeout time.Duration, f func() error)
• type NoopAudit
  • func NewNoopAudit(config map[string]string) (*NoopAudit, error)
  • func TestNoopAudit(t testing.T, config map[string]string) *NoopAudit
  • func (n *NoopAudit) GetHash(ctx context.Context, data string) (string, error)
  • func (n *NoopAudit) Invalidate(ctx context.Context)
  • func (n *NoopAudit) LogRequest(ctx context.Context, in *logical.LogInput) error
  • func (n *NoopAudit) LogResponse(ctx context.Context, in *logical.LogInput) error
  • func (n *NoopAudit) LogTestMessage(ctx context.Context, in *logical.LogInput, config map[string]string) error
  • func (n *NoopAudit) Reload(ctx context.Context) error
  • func (n *NoopAudit) Salt(ctx context.Context) (*salt.Salt, error)
• type TestLogger
  • func NewTestLogger(t testing.T) *TestLogger
  • func (l *TestLogger) AppendToAllLoggers(sub hclog.Logger) hclog.Logger
  • func (tl *TestLogger) StopLogging()

Functions

func MakeTestPluginDir

func MakeTestPluginDir(t testing.T) (string, func(t testing.T))

MakeTestPluginDir creates a temporary directory suitable for holding plugins. This helper also resolves symlinks to make tests happy on OS X.

func NewMockBuiltinRegistry

func NewMockBuiltinRegistry() *mockBuiltinRegistry

func NoopAuditFactory

func NoopAuditFactory(records **[][]byte) audit.Factory

func RegisterSubloggerAdder

func RegisterSubloggerAdder(logger hclog.Logger, adder logging.SubloggerAdder)

RegisterSubloggerAdder checks to see if the provided logger interface is a TestLogger and re-assigns the SubloggerHook implementation if so.

func RetryUntil

func RetryUntil(t testing.T, timeout time.Duration, f func() error)

RetryUntil runs f until it returns a nil result or the timeout is reached. If a nil result hasn't been obtained by timeout, calls t.Fatal.

Types

type NoopAudit

type NoopAudit struct {
	Config         *audit.BackendConfig
	ReqErr         error
	ReqAuth        []*logical.Auth
	Req            []*logical.Request
	ReqHeaders     []map[string][]string
	ReqNonHMACKeys []string
	ReqErrs        []error

	RespErr            error
	RespAuth           []*logical.Auth
	RespReq            []*logical.Request
	Resp               []*logical.Response
	RespNonHMACKeys    [][]string
	RespReqNonHMACKeys [][]string
	RespErrs           []error
	// contains filtered or unexported fields
}

func NewNoopAudit

func NewNoopAudit(config map[string]string) (*NoopAudit, error)

func TestNoopAudit

func TestNoopAudit(t testing.T, config map[string]string) *NoopAudit

func (*NoopAudit) GetHash

func (n *NoopAudit) GetHash(ctx context.Context, data string) (string, error)

func (*NoopAudit) Invalidate

func (n *NoopAudit) Invalidate(ctx context.Context)

func (*NoopAudit) LogRequest

func (n *NoopAudit) LogRequest(ctx context.Context, in *logical.LogInput) error

func (*NoopAudit) LogResponse

func (n *NoopAudit) LogResponse(ctx context.Context, in *logical.LogInput) error

func (*NoopAudit) LogTestMessage

func (n *NoopAudit) LogTestMessage(ctx context.Context, in *logical.LogInput, config map[string]string) error

func (*NoopAudit) Reload

func (n *NoopAudit) Reload(ctx context.Context) error

func (*NoopAudit) Salt

func (n *NoopAudit) Salt(ctx context.Context) (*salt.Salt, error)

type TestLogger

type TestLogger struct {
	hclog.InterceptLogger
	Path string
	File *os.File

	// For managing temporary start-up state
	sync.RWMutex
	AllLoggers []hclog.Logger
	logging.SubloggerAdder
	// contains filtered or unexported fields
}

func NewTestLogger

func NewTestLogger(t testing.T) *TestLogger

func (*TestLogger) AppendToAllLoggers

func (l *TestLogger) AppendToAllLoggers(sub hclog.Logger) hclog.Logger

AppendToAllLoggers appends the sub logger to allLoggers, or if the TestLogger is assigned to a SubloggerAdder implementation, it calls the underlying hook.

func (*TestLogger) StopLogging

func (tl *TestLogger) StopLogging()