plugin

type OPCTPluginSummary struct {
	Name      string
	NameAlias string
	Status    string
	Total     int64
	Passed    int64
	Failed    int64
	Timeout   int64
	Skipped   int64

	// DocumentationReference
	Documentation *TestDocumentation

	// Definition
	Definition *PluginDefinition

	// ErrorCounters is the map with details for each failure by regex expression.
	ErrorCounters archive.ErrorCounter `json:"errorCounters,omitempty"`

	// FailedItems is the map with details for each failure
	Tests Tests

	// FailedList is the list of tests failures on the original execution
	FailedList []string

	// FailedFiltered is the list of failures **after** filter(s) pipeline.
	// Those tests must raise attention and alerts.
	FailedFiltered []string

	// Filter SuiteOnly:
	// FailedFilter1 is the list of failures (A) included only in the original suite (B): A INTERSECTION B
	// FailedFilterSuite     []string
	FailedFilter1         []string
	FailedExcludedFilter1 []string

	// Filter Baseline:
	// FailedFilter2 is the list of failures (A) excluding the baseline(B): A EXCLUDE B
	// FailedFilterBaseline  []string
	FailedFilter2         []string
	FailedExcludedFilter2 []string

	// Filter FlakeAPI:
	// FailedFilter3 is the priority list of failures - not reporting as flake in OpenShift CI.
	// FailedFilterPrio      []string
	FailedFilter3         []string
	FailedExcludedFilter3 []string

	// Filter BaselineAPI:
	// FailedFilter4 is the list after excluding known failures from OPCT CI.
	// This filter is similar BaseLine, but it's a list of failures collected from
	// processed data (another OPCT execution) on OPCT CI after processed by OPCT report,
	// exposed thorugh the OPCT API. This list is used to exclude known failures,
	// to prevent false positives on the review pipeline.
	// TODO(mtulio): deprecate Filter2 when Filter4 is accurated. Baseline results should
	// not use Filter2.
	FailedFilter4         []string
	FailedExcludedFilter4 []string

	// Filter KnownFailures:
	// FailedFilter5 is the list of failures that are explicitly removed from pipeline.
	// It should not be used to exclude failures from the report of e2e included in suite,
	// but to remove known flake/failures that is not relevant to the pipeline.
	// Example: '[sig-arch] External binary usage'
	// Filter5KnownFailures  []string
	FailedFilter5         []string
	FailedExcludedFilter5 []string

	// Filter Replay:
	// FailedFilter6 is the list of failures which also failed in the second shot: replay plugin/step.
	FailedFilter6         []string
	FailedExcludedFilter6 []string
}

type PluginDefinition struct {
	PluginImage   string `json:"pluginImage"`
	SonobuoyImage string `json:"sonobuoyImage"`
	Name          string `json:"name"`
}

type SortedDict struct {
	Key   string
	Value int
}

type SortedList []SortedDict

type TestDocumentation struct {
	// UserBaseURL is a the User Facing base URL for the documentation.
	UserBaseURL *string

	// SourceBaseURL is the raw URL to be indexed.
	SourceBaseURL *string

	// Raw stores the data extracted from SourceBaseURL.
	Raw *string

	// Tests is the map indexed by test name, with URL fragment (page references) as a value.
	// Example: for the e2e test '[sig-machinery] run instance', the following map will be created:
	// map['[sig-machinery] run instance']='#sig-machinery--run-instance'
	Tests map[string]*TestDocumentationItem
}

type TestDocumentationItem struct {
	Title string
	Name  string
	// URLFragment stores the discovered fragment parsed by the Documentation page,
	// indexed by test name, used to mount the Documentation URL for failed tests.
	URLFragment string
}

type TestItem struct {
	// Name is the name of the e2e test. It is hidden from JSON as Tests is a map, and
	// the key can be used.
	Name string `json:"-"`

	// ID is the unique identifier of the test within the execution.
	ID string `json:"id"`

	// Status store the test result. Valid values: passed, skipped, failed.
	Status string `json:"status"`

	// State represents the state of the test. It can be any status value or filter name.
	State string `json:"state,omitempty"`

	// Failure contains the failure reason extracted from JUnit field 'item.detials.failure'.
	Failure string `json:"-"`

	// SystemOut contains the entire test stdout extracted from JUnit field 'item.detials.system-out'.
	SystemOut string `json:"-"`

	// Offset is the offset of failure from the plugin result file.
	Offset int `json:"-"`

	// Flaky contains the flake information from OpenShift CI - scraped from Sippy API.
	Flake *sippy.SippyTestsResponse `json:"flake,omitempty"`

	// ErrorCounters errors indexed by common error key.
	ErrorCounters archive.ErrorCounter `json:"errorCounters,omitempty"`

	// Reference for documentation.
	Documentation string `json:"documentation"`
}

type TestTags map[string]int

type Tests map[string]*TestItem