testutils

Documentation

Index

• func FixedTempDir(t testing.TB, name string) string
• func TempTestDir(t testing.TB, prefix string) string
• func TestLoggerBackend(t testing.TB, name string) func(subsys string) slog.Logger
• func TestLoggerSys(t testing.TB, sys string) slog.Logger
• type MockPayClient
  • func (pc *MockPayClient) DecodeInvoice(_ context.Context, invoice string) (clientintf.DecodedInvoice, error)
  • func (pc *MockPayClient) DefaultDecodeInvoice(invoice string) (clientintf.DecodedInvoice, error)
  • func (pc *MockPayClient) GetInvoice(ctx context.Context, mat int64, cb func(int64)) (string, error)
  • func (pc *MockPayClient) HookDecodeInvoice(hook func(string) (clientintf.DecodedInvoice, error))
  • func (pc *MockPayClient) HookGetInvoice(hook func(int64, func(int64)) (string, error))
  • func (pc *MockPayClient) HookIsPayCompleted(hook func(string) (int64, error))
  • func (pc *MockPayClient) HookPayInvoice(hook func(string) (int64, error))
  • func (pc *MockPayClient) HookTrackInvoice(hook func(string, int64) (int64, error))
  • func (pc *MockPayClient) IsInvoicePaid(context.Context, int64, string) error
  • func (pc *MockPayClient) IsPaymentCompleted(_ context.Context, invoice string) (int64, error)
  • func (pc *MockPayClient) PayInvoice(_ context.Context, invoice string) (int64, error)
  • func (pc *MockPayClient) PayInvoiceAmount(_ context.Context, invoice string, _ int64) (int64, error)
  • func (pc *MockPayClient) PayScheme() string
  • func (pc *MockPayClient) TrackInvoice(ctx context.Context, inv string, minMAtoms int64) (int64, error)
• type TestLogBackend
  • func NewTestLogBackend(t testing.TB, opts ...TestLogBackendOption) *TestLogBackend
  • func (tlb *TestLogBackend) NamedSubLogger(name string, w io.Writer) func(subsys string) slog.Logger
  • func (tlb *TestLogBackend) Write(b []byte) (int, error)
• type TestLogBackendOption
  • func WithMiddlewareWriter(w io.Writer) TestLogBackendOption
  • func WithShowLog(showLog bool) TestLogBackendOption
• type UnsafeTestInterface

Functions

func FixedTempDir

func FixedTempDir(t testing.TB, name string) string

FixedTempDir creates a temp dir with a fixed name (without any random parts) and cleans it up on a successful test. The dir is cleared before this function returns.

func TempTestDir

func TempTestDir(t testing.TB, prefix string) string

TempTestDir returns a temp dir for a test that only gets cleaned up if the test does not fail.

func TestLoggerBackend

func TestLoggerBackend(t testing.TB, name string) func(subsys string) slog.Logger

TestLoggerBackend returns a function that generates loggers for subsystems, all of which log by calling t.Log.

func TestLoggerSys

func TestLoggerSys(t testing.TB, sys string) slog.Logger

TestLoggerSys returns an slog.Logger that logs by issuing t.Log calls.

Types

type MockPayClient

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

MockPayClient fulfills the clientintf.PaymentClient interface, while allowing to fail certain calls. It is used for tests.

It behaves as the free payment client, except for hooked calls.

func (*MockPayClient) DecodeInvoice

func (pc *MockPayClient) DecodeInvoice(_ context.Context, invoice string) (clientintf.DecodedInvoice, error)

func (*MockPayClient) DefaultDecodeInvoice

func (pc *MockPayClient) DefaultDecodeInvoice(invoice string) (clientintf.DecodedInvoice, error)

DefaultDecodeInvoice is the default behavior of the MockPayClient DecodeInvoice(). Useful when DecodeInvoice is hooked and the default behavior is desired for a particular invoice.

func (*MockPayClient) GetInvoice

func (pc *MockPayClient) GetInvoice(ctx context.Context, mat int64, cb func(int64)) (string, error)

func (*MockPayClient) HookDecodeInvoice

func (pc *MockPayClient) HookDecodeInvoice(hook func(string) (clientintf.DecodedInvoice, error))

func (*MockPayClient) HookGetInvoice

func (pc *MockPayClient) HookGetInvoice(hook func(int64, func(int64)) (string, error))

func (*MockPayClient) HookIsPayCompleted

func (pc *MockPayClient) HookIsPayCompleted(hook func(string) (int64, error))

func (*MockPayClient) HookPayInvoice

func (pc *MockPayClient) HookPayInvoice(hook func(string) (int64, error))

func (*MockPayClient) HookTrackInvoice

func (pc *MockPayClient) HookTrackInvoice(hook func(string, int64) (int64, error))

func (*MockPayClient) IsInvoicePaid

func (pc *MockPayClient) IsInvoicePaid(context.Context, int64, string) error

func (*MockPayClient) IsPaymentCompleted

func (pc *MockPayClient) IsPaymentCompleted(_ context.Context, invoice string) (int64, error)

func (*MockPayClient) PayInvoice

func (pc *MockPayClient) PayInvoice(_ context.Context, invoice string) (int64, error)

func (*MockPayClient) PayInvoiceAmount

func (pc *MockPayClient) PayInvoiceAmount(_ context.Context, invoice string, _ int64) (int64, error)

func (*MockPayClient) PayScheme

func (pc *MockPayClient) PayScheme() string

func (*MockPayClient) TrackInvoice

func (pc *MockPayClient) TrackInvoice(ctx context.Context, inv string, minMAtoms int64) (int64, error)

type TestLogBackend

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

TestLogBackend is a slog backend suitable for using with tests.

func NewTestLogBackend

func NewTestLogBackend(t testing.TB, opts ...TestLogBackendOption) *TestLogBackend

NewTestLogBackend returns a log backend that can be used as an io.Writer to write logs to during a test.

func (*TestLogBackend) NamedSubLogger

func (tlb *TestLogBackend) NamedSubLogger(name string, w io.Writer) func(subsys string) slog.Logger

NamedSubLogger returns a sub logger backend suitable for passing to clients, prefixed with the specified name.

func (*TestLogBackend) Write

func (tlb *TestLogBackend) Write(b []byte) (int, error)

type TestLogBackendOption

type TestLogBackendOption func(t *TestLogBackend)

func WithMiddlewareWriter

func WithMiddlewareWriter(w io.Writer) TestLogBackendOption

func WithShowLog

func WithShowLog(showLog bool) TestLogBackendOption

type UnsafeTestInterface

type UnsafeTestInterface struct {
	// SendUserRM send a custom RM to a remote user.
	SendUserRM func(uid clientintf.UserID, msg interface{}) error

	// QueueUserRM queues a custom RM to a remote user.
	QueueUserRM func(uid clientintf.UserID, msg interface{}) error
}

UnsafeTestInterface is an interface used for exposing internal methods to integration tests.

This struct is subject to change without notice and is should not be used outside internal/* packages.