testonly

Documentation

Index

• type TestLog
  • func NewTestLog(t *testing.T, opts *tessera.AppendOptions) (*TestLog, func(context.Context) error)

Types

type TestLog

type TestLog struct {
	// Root is the path to the directory which contains the log data.
	Root string
	// SigVerifier can verify log signatures on its checkpoints.
	SigVerifier note.Verifier
	// LogReader reads from the log storage directly.
	LogReader tessera.LogReader
	// Appender provides access to the Appender lifecycle mode for this log.
	Appender *tessera.Appender
}

TestLog represents an ephemeral POSIX log instance intended for use in tests.

func NewTestLog

func NewTestLog(t *testing.T, opts *tessera.AppendOptions) (*TestLog, func(context.Context) error)

NewTestLog creates a temporary POSIX log instance in Appender mode with the provided options.

This log will be rooted in a temporary directory which will be automatically removed by the testing package after use.

Returns an instance of TestLog containing the various structures created, and a shutdown function which MUST be called when the test has finished with the log.