e2e

type BMC struct {
	// BMC initial username
	User string `yaml:"user,omitempty"`
	// BMC initial password
	Password string `yaml:"password,omitempty"`
	// BMC initial address
	Address string `yaml:"address,omitempty"`
	// BMC Mac address
	BootMacAddress string `yaml:"bootMacAddress,omitempty"`
	// The Hostname of the node, which will be read into BMH object
	HostName string `yaml:"hostName,omitempty"`
	// The IP address of the node
	// Optional. Only needed if e2eConfig variable
	// SSH_CHECK_PROVISIONED is true
	IPAddress string `yaml:"ipAddress,omitempty"`
	// Optional. Only needed if e2eConfig variable
	// SSH_CHECK_PROVISIONED is true
	SSHPort string `yaml:"sshPort,omitempty"`
}

type BMOIronicUpgradeInput struct {
	// DeployIronic determines if Ironic should be installed at the beginning of the test.
	// This should be generally set to `true`, but can be `false` in case Ironic is either pre-installed
	// or not required (for e.g. in `fixture` setup)
	DeployIronic bool `yaml:"deployIronic,omitempty"`
	// DeployBMO determines if BMO should be installed at the beginning of the test.
	// This should be generally set to `true`, but can be `false` in case BMO is pre-installed
	DeployBMO bool `yaml:"deployBMO,omitempty"`
	// Path to the Ironic kustomization that should be installed at the beginning of the test.
	// Not used if DeployIronic is false
	InitIronicKustomization string `yaml:"initIronicKustomization,omitempty"`
	// Path to the BMO kustomization that should be installed at the beginning of the test.
	// Not used if DeployBMO is false
	InitBMOKustomization string `yaml:"initBMOKustomization,omitempty"`
	// Name of the entity that should be upgraded and tested. It should be either `bmo` or `ironic`.
	UpgradeEntityName string `yaml:"upgradeEntityName,omitempty"`
	// Path to the kustomization of the entity that should be used in upgrading.
	UpgradeEntityKustomization string `yaml:"upgradeEntityKustomization,omitempty"`
}

type BuildAndApplyKustomizationInput struct {
	// Path to the kustomization to build
	Kustomization string

	ClusterProxy framework.ClusterProxy

	// If this is set to true. Perform a wait until the deployment specified by
	// DeploymentName and DeploymentNamespace is available or WaitIntervals is timed out
	WaitForDeployment bool

	// If this is set to true. Set up a log watcher for the deployment specified by
	// DeploymentName and DeploymentNamespace
	WatchDeploymentLogs bool

	// DeploymentName and DeploymentNamespace specified a deployment that will be waited and/or logged
	DeploymentName      string
	DeploymentNamespace string

	// Path to store the deployment logs
	LogPath string

	// Intervals to use in checking and waiting for the deployment
	WaitIntervals []interface{}
}

type Config struct {
	// Images is a list of container images to load into the Kind cluster.
	// Note that this not relevant when using an existing cluster.
	Images []clusterctl.ContainerImage `json:"images,omitempty"`

	// Variables to be used in the tests.
	Variables map[string]string `json:"variables,omitempty"`

	// Intervals to be used for long operations during tests.
	Intervals map[string][]string `json:"intervals,omitempty"`

	// BMOIronicUpgradeSpecs
	BMOIronicUpgradeSpecs []BMOIronicUpgradeInput `yaml:"bmoIronicUpgradeSpecs,omitempty"`
}

type LoadImageBehavior string

type PowerState string

type WaitForBmhDeletedInput struct {
	Client          client.Client
	BmhName         string
	Namespace       string
	UndesiredStates []metal3api.ProvisioningState
}

type WaitForBmhInPowerStateInput struct {
	Client client.Client
	Bmh    metal3api.BareMetalHost
	State  PowerState
}

type WaitForBmhInProvisioningStateInput struct {
	Client          client.Client
	Bmh             metal3api.BareMetalHost
	State           metal3api.ProvisioningState
	UndesiredStates []metal3api.ProvisioningState
}

type WaitForNamespaceDeletedInput struct {
	Getter    framework.Getter
	Namespace corev1.Namespace
}