report

type Check struct {
	// ID is the unique identifier for the check. It is used
	// to mount the documentation for each check.
	ID string `json:"id"`

	// Name is the unique name for the check to be reported.
	// It must have short and descriptive name identifying the
	// failure item.
	Name string `json:"name"`

	// Description describes shortly the check.
	Description string `json:"description"`

	// Documentation must point to documentation URL to review the
	// item.
	Documentation string `json:"documentation"`

	// DocumentationSpec is the detailed documentation for the check.
	DocumentationSpec CheckDocumentationSpec `json:"documentationSpec"`

	// Accepted must report acceptance criteria, when true
	// the Check is accepted by the tool, otherwise it is
	// failed and must be reviewede.
	Result CheckResult `json:"result"`

	Test func() CheckResult `json:"-"`

	// Priority is the priority to execute the check.
	// 0 is higher.
	Priority uint64
}

type CheckDocumentationSpec struct {
	Description  string   `json:"description"`
	Expected     string   `json:"expected"`
	Troubleshoot string   `json:"troubleshoot"`
	Action       string   `json:"action"`
	Dependencies []string `json:"dependencies"`
}

type CheckResult struct {
	Name    CheckResultName `json:"result"`
	Message string          `json:"message"`
	Target  string          `json:"want"`
	Actual  string          `json:"got"`
}

type CheckResultName string

type CheckSummary struct {
	Checks []*Check `json:"checks"`
	// contains filtered or unexported fields
}

type ReportChecks struct {
	BaseURL    string       `json:"baseURL"`
	EmptyValue string       `json:"emptyValue"`
	Fail       []*SLOOutput `json:"failures"`
	Pass       []*SLOOutput `json:"successes"`
	Warn       []*SLOOutput `json:"warnings"`
	Skip       []*SLOOutput `json:"skips"`
}

type ReportClusterHealth struct {
	NodeHealthTotal  int                           `json:"nodeHealthTotal,omitempty"`
	NodeHealthy      int                           `json:"nodeHealthy,omitempty"`
	NodeHealthPerc   float64                       `json:"nodeHealthPerc,omitempty"`
	PodHealthTotal   int                           `json:"podHealthTotal,omitempty"`
	PodHealthy       int                           `json:"podHealthy,omitempty"`
	PodHealthPerc    float64                       `json:"podHealthPerc,omitempty"`
	PodHealthDetails []discovery.HealthInfoDetails `json:"podHealthDetails,omitempty"`
}

type ReportClusterOperators struct {
	CountAvailable   uint64 `json:"countAvailable,omitempty"`
	CountProgressing uint64 `json:"countProgressing,omitempty"`
	CountDegraded    uint64 `json:"countDegraded,omitempty"`
}

type ReportData struct {
	Summary  *ReportSummary `json:"summary"`
	Raw      string         `json:"-"`
	Provider *ReportResult  `json:"provider"`
	Baseline *ReportResult  `json:"baseline,omitempty"`
	Checks   *ReportChecks  `json:"checks,omitempty"`
	Setup    *ReportSetup   `json:"setup,omitempty"`
}

type ReportInfra struct {
	Name                 string `json:"name"`
	PlatformType         string `json:"platformType"`
	PlatformName         string `json:"platformName"`
	Topology             string `json:"topology,omitempty"`
	ControlPlaneTopology string `json:"controlPlaneTopology,omitempty"`
	APIServerURL         string `json:"apiServerURL,omitempty"`
	APIServerInternalURL string `json:"apiServerInternalURL,omitempty"`
	NetworkType          string `json:"networkType,omitempty"`
}

type ReportPlugin struct {
	ID            string                       `json:"id"`
	Title         string                       `json:"title"`
	Name          string                       `json:"name"`
	Definition    *plugin.PluginDefinition     `json:"definition,omitempty"`
	Stat          *ReportPluginStat            `json:"stat"`
	ErrorCounters *archive.ErrorCounter        `json:"errorCounters,omitempty"`
	Suite         *summary.OpenshiftTestsSuite `json:"suite"`

	Tests map[string]*plugin.TestItem `json:"tests,omitempty"`

	// Filters
	// SuiteOnly
	FailedFilter1 []*ReportTestFailure `json:"failedTestsFilter1"`
	TagsFilter1   string               `json:"tagsFailuresFilter1"`

	// Filter: BaselineArchive
	FailedFilter2 []*ReportTestFailure `json:"failedTestsFilter2"`
	TagsFilter2   string               `json:"tagsFailuresFilter2"`

	// Filter: FlakeAPI
	FailedFilter3 []*ReportTestFailure `json:"failedTestsFilter3"`
	TagsFilter3   string               `json:"tagsFailuresFilter3"`

	// Filter: BaselineAPI
	FailedFilter4 []*ReportTestFailure `json:"failedTestsFilter4"`
	TagsFilter4   string               `json:"tagsFailuresFilter4"`

	// Filter: KnownFailures
	FailedFilter5 []*ReportTestFailure `json:"failedTestsFilter5"`
	TagsFilter5   string               `json:"tagsFailuresFilter5"`

	// Filter: Replay
	FailedFilter6 []*ReportTestFailure `json:"failedTestsFilter6"`
	TagsFilter6   string               `json:"tagsFailuresFilter6"`

	// Final results after filters
	FailedFiltered []*ReportTestFailure `json:"failedFiltered"`
	TagsFiltered   string               `json:"tagsFailuresFiltered"`
}

type ReportPluginStat struct {
	Completed string `json:"execution"`
	Result    string `json:"result"`
	Status    string `json:"status"`
	Total     int64  `json:"total"`
	Passed    int64  `json:"passed"`
	Failed    int64  `json:"failed"`
	Timeout   int64  `json:"timeout"`
	Skipped   int64  `json:"skipped"`

	// Filters
	// Filter: SuiteOnly
	FilterSuite     int64 `json:"filter1Suite"`
	Filter1Excluded int64 `json:"filter1Excluded"`

	// Filter: BaselineArchive (deprecated soon)
	FilterBaseline  int64 `json:"filter2Baseline"`
	Filter2Excluded int64 `json:"filter2Excluded"`

	// Filter: FlakeCI
	FilterFailedPrio int64 `json:"filter3FailedPriority"`
	Filter3Excluded  int64 `json:"filter3Excluded"`

	// Filter: BaselineAPI
	FilterFailedAPI int64 `json:"filter4FailedAPI"`
	Filter4Excluded int64 `json:"filter4Excluded"`

	// Filter: KnownFailures
	Filter5Failures int64 `json:"filter5Failures"`
	Filter5Excluded int64 `json:"filter5Excluded"`

	// Filter: Replay
	Filter6Failures int64 `json:"filter6Failures"`
	Filter6Excluded int64 `json:"filter6Excluded"`

	FilterFailures int64 `json:"filterFailures"`
}

type ReportResult struct {
	Version          *ReportVersion           `json:"version"`
	Infra            *ReportInfra             `json:"infra"`
	ClusterOperators *ReportClusterOperators  `json:"clusterOperators"`
	ClusterHealth    *ReportClusterHealth     `json:"clusterHealth"`
	Plugins          map[string]*ReportPlugin `json:"plugins"`
	HasValidBaseline bool                     `json:"hasValidBaseline"`
	MustGatherInfo   *mustgather.MustGather   `json:"mustGatherInfo,omitempty"`
	ErrorCounters    *archive.ErrorCounter    `json:"errorCounters,omitempty"`
	Runtime          *ReportRuntime           `json:"runtime,omitempty"`
	Nodes            []*summary.Node          `json:"nodes,omitempty"`
	InstallInvoker   *string                  `json:"installInvoker,omitempty"`
}

type ReportRuntime struct {
	ServerLogs   []*archive.RuntimeInfoItem `json:"serverLogs,omitempty"`
	ServerConfig []*archive.RuntimeInfoItem `json:"serverConfig,omitempty"`
	OpctConfig   []*archive.RuntimeInfoItem `json:"opctConfig,omitempty"`
}

type ReportSetup struct {
	Frontend *ReportSetupFrontend `json:"frontend,omitempty"`
	API      *ReportSetupAPI      `json:"api,omitempty"`
}

type ReportSetupAPI struct {
	SummaryName      string `json:"dataPath,omitempty"`
	SummaryArchive   string `json:"summaryArchive,omitempty"`
	UUID             string `json:"uuid,omitempty"`
	ExecutionDate    string `json:"executionDate,omitempty"`
	OpenShiftVersion string `json:"openshiftVersion,omitempty"`
	OpenShiftRelease string `json:"openshiftRelease,omitempty"`
	PlatformType     string `json:"platformType,omitempty"`
	ProviderName     string `json:"providerName,omitempty"`
	InfraTopology    string `json:"infraTopology,omitempty"`
	Workflow         string `json:"workflow,omitempty"`
}

type ReportSetupFrontend struct {
	EmbedData bool
}

type ReportSummary struct {
	Tests    *ReportSummaryTests   `json:"tests"`
	Alerts   *ReportSummaryAlerts  `json:"alerts"`
	Runtime  *ReportSummaryRuntime `json:"runtime,omitempty"`
	Headline string                `json:"headline"`
	Features ReportSummaryFeatures `json:"features,omitempty"`
}

type ReportSummaryAlerts struct {
	PluginK8S             string `json:"pluginK8S,omitempty"`
	PluginK8SMessage      string `json:"pluginK8SMessage,omitempty"`
	PluginOCP             string `json:"pluginOCP,omitempty"`
	PluginOCPMessage      string `json:"pluginOCPMessage,omitempty"`
	SuiteErrors           string `json:"suiteErrors,omitempty"`
	SuiteErrorsMessage    string `json:"suiteErrorsMessage,omitempty"`
	WorkloadErrors        string `json:"workloadErrors,omitempty"`
	WorkloadErrorsMessage string `json:"workloadErrorsMessage,omitempty"`
	Checks                string `json:"checks,omitempty"`
	ChecksMessage         string `json:"checksMessage,omitempty"`
}

type ReportSummaryFeatures struct {
	HasCAMGI         bool `json:"hasCAMGI,omitempty"`
	HasMetricsData   bool `json:"hasMetricsData,omitempty"`
	HasInstallConfig bool `json:"hasInstallConfig,omitempty"`
}

type ReportSummaryRuntime struct {
	Timers        *metrics.Timers   `json:"timers,omitempty"`
	Plugins       map[string]string `json:"plugins,omitempty"`
	ExecutionTime string            `json:"executionTime,omitempty"`
}

type ReportSummaryTests struct {
	Archive     string `json:"archive"`
	ArchiveDiff string `json:"archiveDiff,omitempty"`
}

type ReportTestFailure struct {
	ID            string  `json:"id"`
	Name          string  `json:"name"`
	Documentation string  `json:"documentation"`
	FlakePerc     float64 `json:"flakePerc"`
	FlakeCount    int64   `json:"flakeCount"`
	ErrorsCount   int64   `json:"errorsTotal"`
}

type ReportVersion struct {
	// OpenShift versions
	OpenShift *summary.SummaryClusterVersionOutput `json:"openshift"`

	// Kubernetes Version
	Kubernetes string `json:"kubernetes"`

	// OPCT Version
	OPCTServer string `json:"opctServer,omitempty"`
	OPCTClient string `json:"opctClient,omitempty"`
}

type SLOOutput struct {
	ID  string `json:"id"`
	SLO string `json:"slo"`

	// SLOResult is the target value
	SLOResult string `json:"sloResult"`

	// SLITarget is the target value
	SLITarget string `json:"sliTarget"`

	// SLICurrent is the indicator result. Allowed values: pass|fail|skip
	SLIActual string `json:"sliCurrent"`

	Message string `json:"message"`

	Documentation string `json:"documentation"`
}

type SortedListTestFailure []SortedTestFailure

type SortedTestFailure struct {
	Key   *ReportTestFailure
	Value int
}