v1

type CIOperatorMetadata struct {
	Org     string `json:"org"`
	Repo    string `json:"repo"`
	Branch  string `json:"branch"`
	Variant string `json:"variant,omitempty"`
}

type ImageTagOverride struct {
	// Name is the name of the image like "machine-os-content"
	Name string `json:"name"`
	// Tag is the tag to override the image with like "4.16-art-latest-2024-02-05-071231"
	Tag string `json:"tag"`
}

type PayloadOverrides struct {
	// BasePullSpec specifies the base payload pullspec for the "latest" release payload
	// (alternate from the default of the 4.x CI payload) to layer changes on top of.
	BasePullSpec string `json:"base,omitempty"`
	// ImageTagOverrides allow specific image tags to be overridden
	ImageTagOverrides []ImageTagOverride `json:"tags,omitempty"`
}

type PullRequest struct {
	Number int    `json:"number"`
	Author string `json:"author"`
	SHA    string `json:"sha"`
	Title  string `json:"title"`
}

type PullRequestPayloadJobSpec struct {
	// ReleaseControllerConfig specifies the source of the selected jobs
	ReleaseControllerConfig ReleaseControllerConfig `json:"releaseControllerConfig"`
	// Jobs is a list of jobs to be executed. This list should be fully specified
	// when the custom resource is created and should not be changed afterwards.
	Jobs []ReleaseJobSpec `json:"releaseJobSpec"`
}

type PullRequestPayloadJobStatus struct {
	// ReleaseJobName is a name of the job that corresponds to the name corresponding to the
	// ReleaseJobSpec tuple. This name is inferred from ReleaseJobSpec data and corresponds to
	// the name which the user would see in e.g. release-controller
	ReleaseJobName string `json:"jobName"`
	// ProwJob is a name of the submitted ProwJob resource
	ProwJob string `json:"prowJob"`

	Status prowv1.ProwJobStatus `json:"status,omitempty"`
}

type PullRequestPayloadQualificationRun struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	// Spec is considered immutable and should be entirely created by the requestor
	Spec   PullRequestPayloadTestSpec   `json:"spec"`
	Status PullRequestPayloadTestStatus `json:"status,omitempty"`
}

type PullRequestPayloadQualificationRunList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []PullRequestPayloadQualificationRun `json:"items"`
}

type PullRequestPayloadTestSpec struct {
	// PullRequests specifies the code to be tested. Immutable and required.
	PullRequests []PullRequestUnderTest `json:"pullRequests"`
	// Jobs specifies the jobs to be executed. Immutable.
	Jobs PullRequestPayloadJobSpec `json:"jobs"`
	// InitialPayloadBase specifies the base payload pullspec for the "initial" release payload
	InitialPayloadBase string `json:"initial,omitempty"`
	// PayloadOverrides specifies overrides to the base payload.
	PayloadOverrides PayloadOverrides `json:"payload,omitempty"`
}

type PullRequestPayloadTestStatus struct {
	Conditions []metav1.Condition            `json:"conditions,omitempty"`
	Jobs       []PullRequestPayloadJobStatus `json:"jobs,omitempty"`
}

type PullRequestUnderTest struct {
	// Org is something like "openshift" in github.com/openshift/kubernetes
	Org string `json:"org"`
	// Repo is something like "kubernetes" in github.com/openshift/kubernetes
	Repo string `json:"repo"`
	// BaseRef identifies the target branch for the PR
	BaseRef string `json:"baseRef"`
	// BaseSHA identifies the HEAD of BaseRef at the time
	BaseSHA string `json:"baseSHA"`

	// PullRequest identifies a pull request, omit to only utilize the repo at the BaseRef and BaseSHA
	PullRequest *PullRequest `json:"pr,omitempty"`
}

type ReleaseControllerConfig struct {
	// OCP is an OCP version, such as "4.10"
	OCP string `json:"ocp"`
	// Release is a release type, such as "nightly" or "ci"
	Release string `json:"release"`
	// Specifier specifies which jobs were selected from the release controller configs. Example: "informing"
	Specifier string `json:"specifier"`
	// Revision is a git revision of the release controller configuration files. Optional.
	Revision string `json:"revision,omitempty"`
}

type ReleaseJobSpec struct {
	// CIOperatorConfig identifies the ci-operator configuration with the test
	CIOperatorConfig CIOperatorMetadata `json:"ciOperatorConfig"`
	// Test is the name of the test in the ci-operator configuration
	Test string `json:"test"`
	// AggregatedCount is a number that specifies how many instances of the job will run in parallel.
	// When the value is 0 it means that the job is not run as aggregated and 1 means that
	// the job is aggregated with a single execution.
	AggregatedCount int `json:"aggregatedCount,omitempty"`
}