summaries

type BeforeAndAfter map[string]TestBeforeAndAfter

type CheckState struct {
	HostName   string          // The host (e.g. wpt.fyi)
	TestRun    *shared.TestRun // The (completed) TestRun, if applicable.
	Product    shared.ProductSpec
	HeadSHA    string
	DetailsURL *url.URL
	// The current status. Can be one of "queued", "in_progress", or "completed". Default: "queued". (Optional.)
	Status string
	// Can be one of "success", "failure", "neutral", "cancelled", "timed_out", or "action_required".
	// (Optional. Required if you provide a status of "completed".)
	Conclusion *string
	Actions    []github.CheckRunAction
	PRNumbers  []int
}

type Completed struct {
	CheckState
	ResultsComparison

	Results BeforeAndAfter
	More    int
}

type Pending struct {
	CheckState

	RunsURL string // URL for the list of test runs
}

type Regressed struct {
	CheckState
	ResultsComparison

	Regressions BeforeAndAfter
	More        int
}

type ResultsComparison struct {
	BaseRun       shared.TestRun
	HeadRun       shared.TestRun
	MasterDiffURL string
	DiffURL       string // URL for the diff-view of the results
	HostURL       string // Host environment URL, e.g. "https://wpt.fyi"
}

type Summary interface {
	// GetCheckState returns the info needed to update a check.
	GetCheckState() CheckState

	// GetActions returns the actions that can be taken by the user.
	GetActions() []*github.CheckRunAction

	// GetSummary compiles the summary markdown template.
	GetSummary() (string, error)
}

type TestBeforeAndAfter struct {
	PassingBefore int
	PassingAfter  int
	TotalBefore   int
	TotalAfter    int
}