| name | gotit-add-assertion |
| description | Register a project-local assertion type (the `x-` prefix family) when the 8 built-ins (exit_code, contains, not_contains, stderr_contains, regex, json_path, count, golden_file) cannot express the check. Invoke only when a built-in genuinely doesn't fit. |
| version | 1 |
gotit-add-assertion
Add a custom assertion type to the project. Use sparingly — the built-in 8 cover most needs; every custom type is a maintenance cost.
Decision check
Before adding a custom type, confirm none of these fit:
- Stdout substring:
contains / not_contains.
- Stderr substring:
stderr_contains.
- JSON shape:
json_path with op: ==, !=, >=, contains, contains_any, length_gte.
- Array length:
count with op: ==/>= etc.
- Pattern match:
regex.
- Whole-output canonical compare:
golden_file.
If you're tempted to write x-stdout-not-empty, that's count on $.something or regex on \S. Pause and try harder.
When custom is correct
- Domain-specific structural checks (e.g. validate a Protobuf wire format, parse a custom DSL, walk a graph stored in stdout).
- Cross-step invariants computed from captured variables.
Steps
-
Pick a name with the mandatory x- prefix: x-output-lines-gte, x-graph-acyclic, x-protobuf-shape. The schema enforces the prefix.
-
Define a Go function in tests/e2e/helpers/:
import "github.com/shivamstaq/gotit/runner"
func AssertLinesGte(a runner.Assertion, r runner.StepResult, _ map[string]string) error {
expected := toIntFromAny(a.Expected)
lines := strings.Count(r.Stdout, "\n")
if lines < expected {
return fmt.Errorf("x-output-lines-gte: got %d lines, want >= %d", lines, expected)
}
return nil
}
The error message must include the type name and enough context to debug (got vs want, the operator, a truncated slice of stdout for substring failures).
-
Register in runner_test.go:
Assertions: map[string]runner.AssertionFunc{
"x-output-lines-gte": helpers.AssertLinesGte,
},
-
Use in a spec:
- name: many_lines
command: <binary> dump
assert:
- type: x-output-lines-gte
expected: 100
-
Verify: run the spec; cause a failure on purpose first to confirm the error message is useful.
Schema notes
The JSON Schema accepts any x--prefixed type. Editors won't autocomplete custom-type-specific fields — keep your custom type's "shape" close to the built-ins (use expected, value, pattern, path rather than inventing new field names) so editors and reviewers understand it without docs.
Use in daemon log assertions
Custom assertions registered in Config.Assertions are also valid inside a daemon's log_assert: block. The synthetic StepResult passed in has the daemon's captured stdout+stderr merged into both Stdout and Stderr fields, so an assertion written for step output works against daemon logs without changes. Useful when the runner's contains / regex types can't express a daemon-side invariant (e.g. "the daemon logged at least N successful requests" → x-log-request-count-gte).
References
