ftltest

Documentation

Overview

Package ftltest contains test utilities for the ftl package.

Index

• func Context(options ...Option) context.Context
• func ErrorsForSubscription[E any](ctx context.Context, subscription ftl.SubscriptionHandle[E]) []error
• func EventsForTopic[E any](ctx context.Context, topic ftl.TopicHandle[E]) []E
• func WaitForSubscriptionsToComplete(ctx context.Context)
• type Option
  • func WhenEmpty(empty ftl.Empty, fake func(ctx context.Context) (err error)) Option
  • func WhenMap[T, U any](mapper *ftl.MapHandle[T, U], fake func(context.Context) (any, error)) Option
  • func WhenSink[Req any](sink ftl.Sink[Req], fake func(ctx context.Context, req Req) error) Option
  • func WhenSource[Resp any](source ftl.Source[Resp], fake func(ctx context.Context) (resp Resp, err error)) Option
  • func WhenVerb[Req any, Resp any](verb ftl.Verb[Req, Resp], fake ftl.Verb[Req, Resp]) Option
  • func WithCallsAllowedWithinModule() Option
  • func WithConfig[T ftl.ConfigType](config ftl.ConfigValue[T], value T) Option
  • func WithDatabase(dbHandle ftl.Database) Option
  • func WithDefaultProjectFile() Option
  • func WithMapsAllowed() Option
  • func WithProjectFile(path string) Option
  • func WithSecret[T ftl.SecretType](secret ftl.SecretValue[T], value T) Option
  • func WithSubscriber[E any](subscription ftl.SubscriptionHandle[E], sink ftl.Sink[E]) Option
• type OptionsState
• type SubscriptionResult
  • func ResultsForSubscription[E any](ctx context.Context, subscription ftl.SubscriptionHandle[E]) []SubscriptionResult[E]

Functions

func Context

func Context(options ...Option) context.Context

Context suitable for use in testing FTL verbs with provided options

func ErrorsForSubscription

func ErrorsForSubscription[E any](ctx context.Context, subscription ftl.SubscriptionHandle[E]) []error

ErrorsForSubscription returns all errors encountered while consuming events for a subscription

func EventsForTopic

func EventsForTopic[E any](ctx context.Context, topic ftl.TopicHandle[E]) []E

EventsForTopic returns all published events for a topic

func WaitForSubscriptionsToComplete

func WaitForSubscriptionsToComplete(ctx context.Context)

WaitForSubscriptionsToComplete waits until all subscriptions have consumed all events

Subscriptions with no manually activated subscribers are ignored. Make sure you have called WithSubscriber(…) for all subscriptions you want to wait for.

Types

type Option

type Option func(context.Context, *OptionsState) error

func WhenEmpty

func WhenEmpty(empty ftl.Empty, fake func(ctx context.Context) (err error)) Option

WhenEmpty replaces an implementation for a verb with no request or response

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WhenEmpty(Example.Empty, func(ctx context.Context) error {
    	...
	}),
)

func WhenMap

func WhenMap[T, U any](mapper *ftl.MapHandle[T, U], fake func(context.Context) (any, error)) Option

WhenMap injects a fake implementation of a Mapping function

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WhenMap(Example.MapHandle, func(ctx context.Context) (U, error) {
    	// ...
	}),
	// ... other options
)

func WhenSink

func WhenSink[Req any](sink ftl.Sink[Req], fake func(ctx context.Context, req Req) error) Option

WhenSink replaces an implementation for a verb with no response

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WhenSink(example.Sink, func(ctx context.Context, req example.Req) error {
    	...
	}),
	// ... other options
)

func WhenSource

func WhenSource[Resp any](source ftl.Source[Resp], fake func(ctx context.Context) (resp Resp, err error)) Option

WhenSource replaces an implementation for a verb with no request

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WhenSource(example.Source, func(ctx context.Context) (example.Resp, error) {
    	// ...
	}),
	// ... other options
)

func WhenVerb

func WhenVerb[Req any, Resp any](verb ftl.Verb[Req, Resp], fake ftl.Verb[Req, Resp]) Option

WhenVerb replaces an implementation for a verb

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WhenVerb(Example.Verb, func(ctx context.Context, req Example.Req) (Example.Resp, error) {
    	// ...
	}),
	// ... other options
)

func WithCallsAllowedWithinModule

func WithCallsAllowedWithinModule() Option

WithCallsAllowedWithinModule allows tests to enable calls to all verbs within the current module

Any overrides provided by calling WhenVerb(...) will take precedence

func WithConfig

func WithConfig[T ftl.ConfigType](config ftl.ConfigValue[T], value T) Option

WithConfig sets a configuration for the current module

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WithConfig(exampleEndpoint, "https://example.com"),
	// ... other options
)

func WithDatabase

func WithDatabase(dbHandle ftl.Database) Option

WithDatabase sets up a database for testing by appending "_test" to the DSN and emptying all tables

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WithDatabase(db),
	// ... other options
)

func WithDefaultProjectFile

func WithDefaultProjectFile() Option

WithDefaultProjectFile loads config and secrets from the default project file, which is either the FTL_CONFIG environment variable or the ftl-project.toml file in the git root.

func WithMapsAllowed

func WithMapsAllowed() Option

WithMapsAllowed allows all `ftl.Map` calls to pass through to their original implementation.

Any overrides provided by calling WhenMap(...) will take precedence.

func WithProjectFile

func WithProjectFile(path string) Option

WithProjectFile loads config and secrets from a project file

Takes a path to an FTL project file. If an empty path is provided, the path is inferred from the FTL_CONFIG environment variable. If that is not found, the ftl-project.toml file in the git root is used. If a project file is not found, an error is returned.

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WithProjectFile("path/to/ftl-project.yaml"),
	// ... other options
)

func WithSecret

func WithSecret[T ftl.SecretType](secret ftl.SecretValue[T], value T) Option

WithSecret sets a secret for the current module

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WithSecret(privateKey, "abc123"),
	// ... other options
)

func WithSubscriber

func WithSubscriber[E any](subscription ftl.SubscriptionHandle[E], sink ftl.Sink[E]) Option

WithSubscriber adds a subscriber during a test

By default, all subscribers are disabled in unit tests, and must be manually enabled by calling WithSubscriber(…). This allows easy isolation for each unit test.

WithSubscriber(…) can also be used to make an ad-hoc subscriber for your test by defining a new function as the sink.

To be used when setting up a context for a test:

ctx := ftltest.Context(
	ftltest.WithSubscriber(paymentTopic, ProcessPayment),
	// ... other options
)

type OptionsState

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

type SubscriptionResult

type SubscriptionResult[E any] struct {
	Event E
	Error ftl.Option[error]
}

func ResultsForSubscription

func ResultsForSubscription[E any](ctx context.Context, subscription ftl.SubscriptionHandle[E]) []SubscriptionResult[E]

ResultsForSubscription returns all consumed events for a subscription, with any resulting errors