test

Documentation

Index

• Variables
• func AssertEqualJSON(t *testing.T, expected []byte, actual []byte, msgAndArgs ...any) bool
• func AssertSnapshot(t *testing.T, name, expected string)
• func AssertXEqual(t *testing.T, expected types.XValue, actual types.XValue, msgAndArgs ...any) bool
• func CreateSessionAssets(assetsJSON []byte, testServerURL string) (flows.SessionAssets, error)
• func CreateTestSession(testServerURL string, redact envs.RedactionPolicy) (flows.Session, []events.Event, error)
• func CreateTestVoiceSession(testServerURL string) (flows.Session, []events.Event, error)
• func JSONDelete(data []byte, path []string) []byte
• func JSONReplace(data []byte, path []string, value []byte) []byte
• func LoadFlowFromAssets(env envs.Environment, path string, uuid assets.FlowUUID) (flows.Flow, error)
• func LoadSessionAssets(env envs.Environment, path string) (flows.SessionAssets, error)
• func MockUniverse() func()
• func MockWebhooksHandler(w http.ResponseWriter, r *http.Request)
• func MockedHTTP(mocks map[string][]*httpx.MockResponse) (*http.Client, *httpx.MocksTransport)
• func NewChannel(name string, address string, schemes []string, roles []assets.ChannelRole, ...) *core.Channel
• func NewEngine() flows.Engine
• func NewHTTPServer(port int, handler http.HandlerFunc) *httptest.Server
• func NewMockedEngine(mocks map[string][]*httpx.MockResponse) flows.Engine
• func NewTelChannel(name string, address string, roles []assets.ChannelRole, ...) *core.Channel
• func NormalizeJSON(data []byte) ([]byte, error)
• func ResumeSession(session flows.Session, sa flows.SessionAssets, msgText string) (flows.Session, flows.Sprint, error)
• func RootError(err error) error
• type EventLog
  • func NewEventLog() *EventLog
  • func (l *EventLog) Error() error
  • func (l *EventLog) Log(e events.Event)
• type SessionBuilder
  • func NewSessionBuilder() *SessionBuilder
  • func (b *SessionBuilder) Build() (flows.SessionAssets, flows.Session, flows.Sprint, error)
  • func (b *SessionBuilder) MustBuild() (flows.SessionAssets, flows.Session, flows.Sprint)
  • func (b *SessionBuilder) WithAssets(sa flows.SessionAssets) *SessionBuilder
  • func (b *SessionBuilder) WithAssetsJSON(assetsJSON []byte) *SessionBuilder
  • func (b *SessionBuilder) WithAssetsPath(path string) *SessionBuilder
  • func (b *SessionBuilder) WithContact(uuid core.ContactUUID, id flows.ContactID, name string, lang i18n.Language, ...) *SessionBuilder
  • func (b *SessionBuilder) WithEnvironment(env envs.Environment) *SessionBuilder
  • func (b *SessionBuilder) WithFlow(flowUUID assets.FlowUUID) *SessionBuilder
  • func (b *SessionBuilder) WithMocks(mocks map[string][]*httpx.MockResponse) *SessionBuilder
  • func (b *SessionBuilder) WithTriggerMsg(text string) *SessionBuilder

Variables

var MockStartTime = time.Date(2025, 5, 4, 12, 30, 45, 123456789, time.UTC)

MockStartTime is the start time used by MockUniverse

var UpdateSnapshots bool

UpdateSnapshots indicates whether tests should update snapshots

Functions

func AssertEqualJSON

func AssertEqualJSON(t *testing.T, expected []byte, actual []byte, msgAndArgs ...any) bool

AssertEqualJSON checks two JSON strings for equality

func AssertSnapshot

func AssertSnapshot(t *testing.T, name, expected string)

AssertSnapshot checks that the file contains the expected text. However it creates the file if -update was set or file doesn't exist.

func AssertXEqual

func AssertXEqual(t *testing.T, expected types.XValue, actual types.XValue, msgAndArgs ...any) bool

AssertXEqual is equivalent to assert.Equal for two XValue instances

func CreateSessionAssets

func CreateSessionAssets(assetsJSON []byte, testServerURL string) (flows.SessionAssets, error)

CreateSessionAssets creates assets from given JSON

func CreateTestSession

func CreateTestSession(testServerURL string, redact envs.RedactionPolicy) (flows.Session, []events.Event, error)

CreateTestSession creates a standard example session for testing

func CreateTestVoiceSession

func CreateTestVoiceSession(testServerURL string) (flows.Session, []events.Event, error)

CreateTestVoiceSession creates a standard example session for testing voice flows and actions

func JSONDelete

func JSONDelete(data []byte, path []string) []byte

JSONDelete deletes a node in JSON

func JSONReplace

func JSONReplace(data []byte, path []string, value []byte) []byte

JSONReplace replaces a node in JSON

func LoadFlowFromAssets

func LoadFlowFromAssets(env envs.Environment, path string, uuid assets.FlowUUID) (flows.Flow, error)

func LoadSessionAssets

func LoadSessionAssets(env envs.Environment, path string) (flows.SessionAssets, error)

LoadSessionAssets loads a session assets instance from a static JSON file

func MockUniverse

func MockUniverse() func()

MockUniverse mocks time and random generators for testing

func MockWebhooksHandler

func MockWebhooksHandler(w http.ResponseWriter, r *http.Request)

MockWebhooksHandler is our standard handler for testing webhooks

func MockedHTTP

func MockedHTTP(mocks map[string][]*httpx.MockResponse) (*http.Client, *httpx.MocksTransport)

MockedHTTP creates an HTTP client whose requests are answered from the given mocks rather than being sent. It also returns the mocking transport so tests can assert against it, e.g. that all mocks were used (mocks.HasUnused()).

func NewChannel

func NewChannel(name string, address string, schemes []string, roles []assets.ChannelRole, features []assets.ChannelFeature) *core.Channel

func NewEngine

func NewEngine() flows.Engine

NewEngine creates an engine instance for testing

func NewHTTPServer

func NewHTTPServer(port int, handler http.HandlerFunc) *httptest.Server

NewHTTPServer sets up a mock server

func NewMockedEngine

func NewMockedEngine(mocks map[string][]*httpx.MockResponse) flows.Engine

NewMockedEngine creates an engine instance for testing whose webhook calls are answered from the given mocks

func NewTelChannel

func NewTelChannel(name string, address string, roles []assets.ChannelRole, parent *assets.ChannelReference, country i18n.Country, matchPrefixes []string, allowInternational bool) *core.Channel

func NormalizeJSON

func NormalizeJSON(data []byte) ([]byte, error)

NormalizeJSON re-formats the given JSON

func ResumeSession

func ResumeSession(session flows.Session, sa flows.SessionAssets, msgText string) (flows.Session, flows.Sprint, error)

ResumeSession resumes the given session with potentially different assets

func RootError

func RootError(err error) error

RootError returns the root cause of an error by following the unwrap chain

Types

type EventLog

type EventLog struct {
	Events []events.Event
}

EventLog is a utility for testing things which take an event logger function

func NewEventLog

func NewEventLog() *EventLog

NewEventLog creates a new event log

func (*EventLog) Error

func (l *EventLog) Error() error

func (*EventLog) Log

func (l *EventLog) Log(e events.Event)

type SessionBuilder

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

func NewSessionBuilder

func NewSessionBuilder() *SessionBuilder

func (*SessionBuilder) Build

func (b *SessionBuilder) Build() (flows.SessionAssets, flows.Session, flows.Sprint, error)

func (*SessionBuilder) MustBuild

func (b *SessionBuilder) MustBuild() (flows.SessionAssets, flows.Session, flows.Sprint)

func (*SessionBuilder) WithAssets

func (b *SessionBuilder) WithAssets(sa flows.SessionAssets) *SessionBuilder

func (*SessionBuilder) WithAssetsJSON

func (b *SessionBuilder) WithAssetsJSON(assetsJSON []byte) *SessionBuilder

func (*SessionBuilder) WithAssetsPath

func (b *SessionBuilder) WithAssetsPath(path string) *SessionBuilder

func (*SessionBuilder) WithContact

func (b *SessionBuilder) WithContact(uuid core.ContactUUID, id flows.ContactID, name string, lang i18n.Language, urn urns.URN) *SessionBuilder

func (*SessionBuilder) WithEnvironment

func (b *SessionBuilder) WithEnvironment(env envs.Environment) *SessionBuilder

func (*SessionBuilder) WithFlow

func (b *SessionBuilder) WithFlow(flowUUID assets.FlowUUID) *SessionBuilder

func (*SessionBuilder) WithMocks

func (b *SessionBuilder) WithMocks(mocks map[string][]*httpx.MockResponse) *SessionBuilder

WithMocks builds the session's engine with an HTTP client that answers webhook calls from the given mocks

func (*SessionBuilder) WithTriggerMsg

func (b *SessionBuilder) WithTriggerMsg(text string) *SessionBuilder