propstest

Overview ¶

Package propstest provides a public test-fixture helper for constructing a fully-wired *props.Props with hermetic, safe defaults.

Tools built on go-tool-base — and GTB's own tests — frequently need a Props instance to drive commands and bootstrap-style code under test. Hand-assembling the logger, in-memory filesystem, telemetry collector, error handler, tool metadata and config container in every test is repetitive and easy to get wrong (for example, leaving Collector nil and violating the documented non-nil-Collector invariant).

propstest.New returns a Props with every field wired to a hermetic default: a noop logger, an in-memory afero filesystem, a NoopCollector, an error handler whose Exit and Writer are inert, benign Tool metadata, a deterministic Version, empty-but-valid Assets, and a usable empty Config container. Each field may be overridden with a functional Option.

The helper performs no real filesystem, network, keychain or os.Exit side effects, and every call returns a fresh, independent instance, so it is safe to use from t.Parallel() tests.

func TestSomething(t *testing.T) {
	t.Parallel()
	p := propstest.New(propstest.WithTool(props.Tool{Name: "mytool"}))
	// ... drive code that needs a *props.Props ...
}