Hooks

Hooks let you customize behavior around engine and factory lifecycle events.

Factory creation hooks:

• WithBeforeEngineCreate
• WithAfterEngineCreate

Engine execution hooks:

• WithBeforeEngineRun
• WithAfterEngineRun

Engine seeding hooks:

• WithBeforeEngineSeed

Engine teardown hooks:

• WithBeforeEngineTeardown
• WithAfterEngineTeardown

Factory close hooks:

• WithBeforeFactoryClose
• WithAfterFactoryClose

• before* hooks run in registration order.
• after* hooks run in reverse registration order.
• Hook errors are joined and returned.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

factory, err := puppetest.NewEngineFactory(
	puppetest.WithBeforeEngineRun(func(evt *puppetest.EngineRunEvent) error {
		evt.TB.Log("about to run", evt.Runner)
		return nil
	}),
	puppetest.WithAfterFactoryClose(func(evt *puppetest.FactoryCloseEvent) error {
		// close external resources here (for example testcontainers)
		_ = evt.Factory
		return nil
	}),
)

A real use case from examples is closing testcontainers resources with WithAfterFactoryClose.