ftltest

Documentation

Overview

Package ftltest contains test utilities for the ftl package.

Index

• Constants
• func Context(options ...func(context.Context) error) context.Context
• func WhenVerb[Req any, Resp any](verb ftl.Verb[Req, Resp], ...) func(context.Context) error
• func WithConfig(name string, value any) func(context.Context) error
• func WithDSN(name string, dbType DBType, dsn string) func(context.Context) error
• func WithSecret(name string, value any) func(context.Context) error
• type DBType

Constants

const (
	DBTypePostgres = DBType(modulecontext.DBTypePostgres)
)

Functions

func Context

func Context(options ...func(context.Context) 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(context.Context) 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 WithConfig

func WithConfig(name string, value any) func(context.Context) error

WithConfig sets a configuration for the current module

To be used with Context(...)

func WithDSN

func WithDSN(name string, dbType DBType, dsn string) func(context.Context) error

WithDSN sets a DSN for the current module

To be used with Context(...)

func WithSecret

func WithSecret(name string, value any) func(context.Context) error

WithSecret sets a secret for the current module

To be used with Context(...)

Types

type DBType

type DBType int32