ftltest

Documentation

Overview

Package ftltest contains test utilities for the ftl package.

Index

• func Context(options ...func(*Options) error) context.Context
• func WhenVerb[Req any, Resp any](verb ftl.Verb[Req, Resp], ...) func(*Options) error
• func WithCallsAllowedWithinModule() func(*Options) error
• func WithConfig[T ftl.ConfigType](config ftl.ConfigValue[T], value T) func(*Options) error
• func WithSecret[T ftl.SecretType](secret ftl.SecretValue[T], value T) func(*Options) error
• type Options

Functions

func Context

func Context(options ...func(*Options) error) context.Context

Context suitable for use in testing FTL verbs with provided options

func WhenVerb

func WhenVerb[Req any, Resp any](verb ftl.Verb[Req, Resp], fake func(ctx context.Context, req Req) (resp Resp, err error)) func(*Options) error

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() func(*Options) error

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) func(*Options) error

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 WithSecret

func WithSecret[T ftl.SecretType](secret ftl.SecretValue[T], value T) func(*Options) error

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

)

Types

type Options

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