conformance

type Breakdown struct {
	ID    string `json:"id"`
	Label string `json:"label"`
	Suite string `json:"suite"`
	Of    int    `json:"of"`
	Note  string `json:"note,omitempty"`

	// Overlap is how many of this breakdown's cases are ALSO enumerated in
	// the suite's Cases list. It exists because the two halves were checked
	// only against the suite total and never against each other, and so
	// summed to 35 of 34 for a year without a gate firing: merge-097sf was
	// enumerated while actually being skipped, and su-ascent-902 was counted
	// both individually and in the block. Two errors in opposite directions
	// left a plausible-looking total, which is the hardest kind to see.
	//
	// A real overlap is legitimate -- su-ascent-902 belongs to the XTSE3430
	// block by symptom and is argued individually because its verdict is not
	// the block's -- but it must be DECLARED, so that "the parts do not add
	// up" and "the parts overlap on purpose" cannot be confused.
	Overlap int `json:"overlap,omitempty"`
}

type Case struct {
	ID      string `json:"id"`
	Verdict string `json:"verdict"`
	Note    string `json:"note,omitempty"`
}

type FileResult struct {
	Path    string
	Changed bool
}

type Region struct {
	Name string
	Body func() string

	// Whole says the file IS the region: it is generated end to end, with no
	// hand-written prose around it, so Replace writes the whole file rather
	// than looking for markers in it. docs/stats.md is the only one.
	Whole bool

	// Bare says the body already carries its own "this is generated" header,
	// so ReplaceRegion must not prepend the common one. Only the conformance
	// summary sets it: its header predates this file and is worded for the
	// one region whose defect -- a hand-written Total -- it was built to
	// close. Duplicating a header would be the generator adding noise to a
	// document on every run, which is the opposite of its contract.
	Bare bool

	// Inline says the markers sit on the prose line itself, around the
	// figure, with no header and no line break: an HTML comment on its own
	// line is a block, and a block inside a paragraph or a list item splits
	// it in two mid-sentence. A table row can carry the block form; "**577**
	// of its 593 test documents" cannot.
	Inline bool
}

type Results struct {
	// Decoding is strict (DisallowUnknownFields), so the JSON's own prose --
	// the note telling the next editor not to hand-edit the generated table --
	// needs a home here or the file will not load.
	Comment     string `json:"_comment,omitempty"`
	GeneratedBy string `json:"generated_by,omitempty"`

	Suites  []Suite `json:"suites"`
	Corpora []Suite `json:"corpora"`

	// Tree holds the figures that are DERIVED FROM THE SOURCE TREE rather
	// than from a suite run: how many unit tests, fuzz targets and limit
	// boundary tests there are. Their values are not in this file and cannot
	// be -- see TreeCount in stats.go -- only the counting method is.
	Tree []TreeCount `json:"tree"`

	// SuiteRevisions is the commit of each vendored W3C suite the figures
	// above were measured against, keyed by its directory under testdata/.
	//
	// Without it a figure in this file is not reproducible. The suites are
	// separate checkouts that CI clones at --depth 1 from their default
	// branch, so a suite update can move a count with no change to this
	// repository at all, and the ratchet would then fail on a commit that
	// changed nothing. tests/check.sh has always PRINTED these revisions into
	// its provenance, but that is a per-run artifact which expires; this is
	// the copy that travels with the numbers it explains.
	//
	// A suite that is not its own git checkout is absent rather than wrong:
	// testdata/relaxng is vendored files, and asking git about it answers
	// with THIS repository's HEAD, which would be a revision that means
	// nothing. suiterev in tests/check.sh applies the same containment test.
	SuiteRevisions map[string]string `json:"suite_revisions,omitempty"`

	// Breakdowns are named subsets of a suite's disagreements, such as "14 of
	// the 34 XSLT 3.0 failures want an XTSE3430". Both halves get published,
	// so both are checked: the subset may not exceed its suite's count.
	Breakdowns []Breakdown `json:"breakdowns"`
}

type Suite struct {
	ID            string `json:"id"`
	Component     string `json:"component"`
	Suite         string `json:"suite"`
	Edition       string `json:"edition"`
	Passed        int    `json:"passed"`
	Disagreements int    `json:"disagreements"`
	Total         int    `json:"total"`
	RunDate       string `json:"run_date"`
	Command       string `json:"command"`
	Cases         []Case `json:"cases"`

	// The skipped cases, split by class. Out of scope is what the suite says
	// a conforming processor may leave out -- the wrong spec version, a
	// Unicode version, an optional numbering language; unimplemented is a
	// feature this engine lacks or a dependency the harness does not model.
	// Only the XSLT lanes record them (tests/xslts/deps.go draws the line);
	// a lane that does not is rendered with an empty cell, not a zero.
	SkippedOutOfScope    int `json:"skipped_out_of_scope,omitempty"`
	SkippedUnimplemented int `json:"skipped_unimplemented,omitempty"`

	// Why a suite's cases are not all enumerated above. Rendered nowhere; it
	// is here so the JSON explains itself to whoever next edits it.
	UnenumeratedNote string `json:"unenumerated_note,omitempty"`
}

type TreeCount struct {
	ID     string `json:"id"`
	Label  string `json:"label"`
	Method string `json:"method"`
	Kind   string `json:"kind"`

	Value int `json:"-"`
}