et

Documentation

Overview

Package et stands for Encore Tests and provides a number of functions and tools for writing fully integrated test suites for Encore applications.

Index

• func SetCfg[T any](cfg config.Value[T], newValue T)
• type TopicHelpers
  • func Topic[T any](topic *pubsub.Topic[T]) TopicHelpers[T]

Functions

func SetCfg

func SetCfg[T any](cfg config.Value[T], newValue T)

SetCfg changes the value of cfg to newValue within the current test and any subtests. Other tests running will not be affected.

It does not support setting slices and panics if given a config value that is a slice.

Types

type TopicHelpers

type TopicHelpers[T any] interface {
	// PublishedMessages returns a slice of all messages published during this test on this topic.
	PublishedMessages() []T
}

TopicHelpers provides functions for interacting with the backing topic implementation during unit tests. It is designed to help test code that uses the pubsub.Topic

Note all functions on this TopicHelpers are scoped to the current test and will only impact and observe state from the current test

func Topic

func Topic[T any](topic *pubsub.Topic[T]) TopicHelpers[T]

Topic returns a TopicHelper for the given topic.