statpages

type GoTestRecord ¶ added in v0.32.0

type GoTestRecord struct {
	Test    string `json:"test"`
	Package string `json:"package"`
	Status  string `json:"status"`
	Commit  string `json:"commit"`
	Date    string `json:"date"`
	CIRun   string `json:"ci_run,omitempty"`
	Log     string `json:"log,omitempty"`
}

GoTestRecord is one recorded run of a Go test proof (GitHub issue #2288). A test that runs in CI's fast tier is recorded from a CI run at a commit (CIRun); a test behind an environment gate is recorded from a maintainer's run, whose `go test -v` log is kept beside it (Log).

func ReadGoTestRecord(root, test string) (*GoTestRecord, error)

type Page ¶

type Page struct {
	// Path is the page, relative to the repository root.
	Path string
	// Tool is the marker vocabulary: `<!-- Tool:begin name -->`.
	Tool string
	// Command regenerates the data this page is drawn from and then the
	// page itself. RefreshCommand re-renders the page from data already
	// committed.
	Command string
	// Inputs are the committed files the spans are rendered from.
	Inputs []string
	// contains filtered or unexported fields
}

Page is one generated markdown file.

func Pages() []Page

type ProductScenarioProof ¶ added in v0.32.0

type ProductScenarioProof struct {
	Repo          string `json:"repo"`
	Scenario      string `json:"scenario"`
	Claim         string `json:"claim"`
	Commit        string `json:"commit"`
	Date          string `json:"date"`
	EngineVersion string `json:"engine_version"`
}

ProductScenarioProof is a proof that cites one recorded row of a CI product's scenario run (GitHub issue #2299, ruling C on INTENTIUS/chant#4586). The product (terragucci, plywood, sql-yodeler) runs the scenario on the shared e2e harness against a released choudoufu binary, with a plain run that must pass and a BREAK=1 run that must be caught, and commits one row for it. The proof names that row: the product's repository, the scenario id, the product's claim id, the product commit the row ran at, the date of the run and the choudoufu version it ran.

In claims.json the proof is one flat object, {"kind": "product-scenario", "repo", "scenario", "claim", "commit", "date", "engine_version", "note"}, the same kind and keys plunge's and sql-yodeler's claims use (INTENTIUS/plunge#57, INTENTIUS/sql-yodeler#301). Its "scenario" is the product's scenario id, never a choudoufu scenario path, which is why the decoders read it through DecodeProductScenario rather than as a field of the scenario proof.

A product row is an extra proof beside the engine's own (ruling E). It never replaces an engine scenario: the engine's BREAK arms rebuild the engine from source, which a product running a released binary cannot do.

func DecodeProductScenario(raw []byte) (*ProductScenarioProof, error)

type ProductScenarioRecord ¶ added in v0.32.0

type ProductScenarioRecord struct {
	Repo          string `json:"repo"`
	RowFile       string `json:"row_file"`
	Scenario      string `json:"scenario"`
	Claim         string `json:"claim"`
	Product       string `json:"product"`
	Commit        string `json:"commit"`
	Date          string `json:"date"`
	EngineBinary  string `json:"engine_binary"`
	EngineVersion string `json:"engine_version"`
	FlociDigest   string `json:"floci_digest"`
	Plain         string `json:"plain"`
	Break         string `json:"break"`
}

ProductScenarioRecord is one product row as choudoufu keeps it: the row's own fields (the row shape of INTENTIUS/chant#4587: product, product commit, engine binary and version, floci digest, date, plain and break verdicts), plus the scenario and claim it belongs to and RowFile, the path of the committed row file in the product repository the row was copied from.

func ReadProductScenarioRecord(root string, p ProductScenarioProof) (*ProductScenarioRecord, error)

func (r ProductScenarioRecord) RowURL() string