assert

type Assertion interface {
	fact.Observer

	// Prepare is called to prepare the assertion for a new test.
	//
	// c is the comparator used to compare messages and other entities.
	Prepare(c compare.Comparator)

	// Ok returns true if the assertion passed.
	Ok() bool

	// BuildReport generates a report about the assertion.
	//
	// ok is true if the assertion is considered to have passed. This may not be
	// the same value as returned from Ok() when this assertion is used as a
	// sub-assertion inside a composite.
	BuildReport(ok bool, r render.Renderer) *Report
}

type AssertionContext struct {
	// Comparator provides logic for comparing messages and application state.
	Comparator compare.Comparator

	// Facts is an ordered slice of the facts that occurred.
	Facts []fact.Fact
}

type Report struct {
	// TreeOk is true if the "tree" that the assertion belongs to passed.
	TreeOk bool

	// Ok is true if this assertion passed.
	Ok bool

	// Criteria is a brief description of the assertion's requirement to pass.
	Criteria string

	// Outcome is a brief description of the outcome of the assertion.
	Outcome string

	// Explanation is a brief description of what actually happened during the
	// test as it relates to this assertion.
	Explanation string

	// Sections contains arbitrary "sections" that are added to the report by
	// the assertion.
	Sections []*ReportSection

	// SubReports contains the reports of any sub-assertions.
	SubReports []*Report
}

type ReportSection struct {
	Title   string
	Content strings.Builder
}