testhooks

package

v1.32.0 Latest Latest Go to latest Published: Sep 11, 2026 License: MIT Imports: 9 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/temporalio/temporal

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Call[S any](_ TestHooks, _ Key[func(), S], _ S)
func Get[T any, S any](_ TestHooks, _ Key[T, S], _ S) (T, bool)
func Set[T any, S any](_ TestHooks, _ Key[T, S], _ T, _ any) func()
type Hook
- func NewHook[T any, S any](_ Key[T, S], _ T) Hook
- func (h Hook) Apply(_ TestHooks, _ any) func()
- func (h Hook) Scope() ScopeType
type Key
type ScopeType
type TestHooks
- func NewTestHooks() TestHooks

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	MatchingDisableSyncMatch                 = newKey[bool, namespace.ID]()
	MatchingLBForceReadPartition             = newKey[int, namespace.ID]()
	MatchingLBForceWritePartition            = newKey[int, namespace.ID]()
	UpdateWithStartInBetweenLockAndStart     = newKey[func(), namespace.ID]()
	UpdateWithStartOnClosingWorkflowRetry    = newKey[func(), namespace.ID]()
	TaskQueuesInDeploymentSyncBatchSize      = newKey[int, global]()
	MatchingIgnoreRoutingConfigRevisionCheck = newKey[bool, namespace.ID]()
	MatchingDeploymentRegisterErrorBackoff   = newKey[time.Duration, namespace.ID]()
	MatchingForwardTaskDelay                 = newKey[time.Duration, namespace.ID]()
	HistoryReplicationTaskInterceptor        = newKey[func(*replicationspb.ReplicationTask, func() error) error, global]()
	HistoryReplicationDLQWriteInterceptor    = newKey[func(*persistencespb.ReplicationTaskInfo, func() error) error, global]()
	HistoryChasmRuntimeProvider              = newKey[func(chasm.Engine, chasm.VisibilityManager, *chasm.Registry), global]()
	HistoryTransferTaskInterceptor           = newKey[func(historytasks.Task, func()), namespace.ID]()
	HistoryDLQTaskDeleteInterceptor          = newKey[func(context.Context, *historyservice.DeleteDLQTasksRequest, func(context.Context, *historyservice.DeleteDLQTasksRequest) (*historyservice.DeleteDLQTasksResponse, error)) (*historyservice.DeleteDLQTasksResponse, error), global]()
	NamespaceReplicationTaskInterceptor      = newKey[func(context.Context, *replicationspb.NamespaceTaskAttributes, func() error) error, namespace.Name]()
)

Test hook keys with their return type and scope. Try to avoid global scope as it requires a dedicated test cluster.

View Source

var GlobalScope = global{}

GlobalScope is the singleton value for global hooks.

View Source

var Module = fx.Options(
	fx.Provide(NewTestHooks),
)

Functions ¶

func Call ¶

func Call[S any](_ TestHooks, _ Key[func(), S], _ S)

Call calls a func() hook if present.

TestHooks should be used very sparingly, see comment on TestHooks.

func Get ¶

func Get[T any, S any](_ TestHooks, _ Key[T, S], _ S) (T, bool)

Get gets the value of a test hook. In production mode it always returns the zero value and false, which hopefully the compiler will inline and remove the hook as dead code.

TestHooks should be used very sparingly, see comment on TestHooks.

func Set ¶ added in v1.30.0

func Set[T any, S any](_ TestHooks, _ Key[T, S], _ T, _ any) func()

Set is only to be used by test code together with the test_dep build tag.

Types ¶

type Hook ¶ added in v1.31.0

type Hook struct{}

Hook is an empty stub in production mode. NewHook and its methods are only available with -tags=test_dep.

func NewHook ¶ added in v1.31.0

func NewHook[T any, S any](_ Key[T, S], _ T) Hook

func (Hook) Apply ¶ added in v1.31.0

func (h Hook) Apply(_ TestHooks, _ any) func()

func (Hook) Scope ¶ added in v1.31.0

func (h Hook) Scope() ScopeType

type Key ¶

type Key[T any, S any] struct {
	// contains filtered or unexported fields
}

type ScopeType ¶ added in v1.31.0

type ScopeType int

ScopeType indicates the scope of a hook at runtime.

const (
	ScopeNamespace ScopeType = iota
	ScopeGlobal
)

type TestHooks ¶

type TestHooks struct{}

TestHooks (in production mode) is an empty struct just so the build works. See TestHooks in test_impl.go.

TestHooks are an inherently unclean way of writing tests. They require mixing test-only concerns into production code. In general you should prefer other ways of writing tests wherever possible, and only use TestHooks sparingly, as a last resort.

func NewTestHooks ¶ added in v1.30.0

func NewTestHooks() TestHooks

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL