fxtest

package

v1.0.0-rc2 Latest Latest Go to latest Published: Jul 21, 2017 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bmartynov/fx

Documentation ¶

Index ¶

type App
- func New(tb TB, opts ...fx.Option) *App
- func (app *App) MustStart() *App
- func (app *App) MustStop()
type Lifecycle
- func NewLifecycle(t TB) *Lifecycle
type TB

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type App ¶

type App struct {
	*fx.App
	// contains filtered or unexported fields
}

App is a wrapper around fx.App that provides some testing helpers. By default, it uses the provided TB as the application's logging backend.

func New ¶

func New(tb TB, opts ...fx.Option) *App

New creates a new test application.

func (*App) MustStart ¶

func (app *App) MustStart() *App

MustStart calls Start, failing the test if an error is encountered.

func (*App) MustStop ¶

func (app *App) MustStop()

MustStop calls Stop, failing the test if an error is encountered.

type Lifecycle ¶

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

Lifecycle is a testing spy for fx.Lifecycle. It exposes Start and Stop methods (and some test-specific helpers) so that unit tests can exercise hooks.

func NewLifecycle ¶

func NewLifecycle(t TB) *Lifecycle

NewLifecycle creates a new test lifecycle.

func (*Lifecycle) Append ¶

func (l *Lifecycle) Append(h fx.Hook)

Append registers a new Hook.

func (*Lifecycle) MustStart ¶

func (l *Lifecycle) MustStart() *Lifecycle

MustStart calls Start with context.Background(), failing the test if an error is encountered.

func (*Lifecycle) MustStop ¶

func (l *Lifecycle) MustStop()

MustStop calls Stop with context.Background(), failing the test if an error is encountered.

func (*Lifecycle) Start ¶

func (l *Lifecycle) Start(ctx context.Context) error

Start executes all registered OnStart hooks in order, halting at the first hook that doesn't succeed.

func (*Lifecycle) Stop ¶

func (l *Lifecycle) Stop(ctx context.Context) error

Stop calls all OnStop hooks whose OnStart counterpart was called, running in reverse order.

If any hook returns an error, execution continues for a best-effort cleanup. Any errors encountered are collected into a single error and returned.

type TB ¶

type TB interface {
	Logf(string, ...interface{})
	Errorf(string, ...interface{})
	FailNow()
}

TB is a subset of the standard library's testing.TB interface. It's satisfied by both *testing.T and *testing.B.

Source Files ¶

View all Source files

fxtest.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL