const (
    // DefaultFlavor for ConfigClusterInput; use it for getting the cluster-template.yaml file.
    DefaultFlavor = ""
)

const (
    // DefaultInfrastructureProvider for ConfigClusterInput; use it for using the only infrastructure provider installed in a cluster.
    DefaultInfrastructureProvider = ""
)

type ApplyClusterTemplateAndWaitInput struct {
    ClusterProxy                 framework.ClusterProxy
    ConfigCluster                ConfigClusterInput
    CNIManifestPath              string
    WaitForClusterIntervals      []interface{}
    WaitForControlPlaneIntervals []interface{}
    WaitForMachineDeployments    []interface{}
    WaitForMachinePools          []interface{}
}

type ApplyClusterTemplateAndWaitResult struct {
    Cluster            *clusterv1.Cluster
    ControlPlane       *controlplanev1.KubeadmControlPlane
    MachineDeployments []*clusterv1.MachineDeployment
    MachinePools       []*clusterv1exp.MachinePool
}

type ComponentConfig struct {
    // Name is the name of the component.
    // This field is primarily used for logging.
    Name string `json:"name"`

    // Sources is an optional list of component YAML to apply to the management
    // cluster.
    // This field may be omitted when wanting only to block progress via one or
    // more Waiters.
    Sources []ProviderVersionSource `json:"sources,omitempty"`

    // Waiters is an optional list of checks to perform in order to determine
    // whether or not the installed components are ready.
    Waiters []ComponentWaiter `json:"waiters,omitempty"`
}

type ComponentReplacement struct {
    // Old is the pattern to replace.
    // A regular expression may be used.
    Old string `json:"old"`
    // New is the string used to replace the old pattern.
    // An empty string is valid.
    New string `json:"new,omitempty"`
}

type ComponentSourceType string

const (
    // URLSource is component YAML available directly via a URL.
    // The URL may begin with file://, http://, or https://.
    URLSource ComponentSourceType = "url"

    // KustomizeSource is a valid kustomization root that can be used to produce
    // the component YAML.
    KustomizeSource ComponentSourceType = "kustomize"
)

type ComponentWaiter struct {
    // Value varies depending on the specified Type.
    // Please see the documentation for the different WaiterType constants to
    // understand the valid values for this field.
    Value string `json:"value"`

    // Type describes the type of check to perform.
    //
    // Defaults to "pods".
    Type ComponentWaiterType `json:"type,omitempty"`
}

type ComponentWaiterType string

const (
    // ServiceWaiter indicates to wait until a service's condition is Available.
    // When ComponentWaiter.Value is set to "service", the ComponentWaiter.Value
    // should be set to the name of a Service resource.
    ServiceWaiter ComponentWaiterType = "service"

    // PodsWaiter indicates to wait until all the pods in a namespace have a
    // condition of Ready.
    // When ComponentWaiter.Value is set to "pods", the ComponentWaiter.Value
    // should be set to the name of a Namespace resource.
    PodsWaiter ComponentWaiterType = "pods"
)

type ConfigClusterInput struct {
    LogFolder                string
    ClusterctlConfigPath     string
    KubeconfigPath           string
    InfrastructureProvider   string
    Namespace                string
    ClusterName              string
    KubernetesVersion        string
    ControlPlaneMachineCount *int64
    WorkerMachineCount       *int64
    Flavor                   string
}

type ContainerImage struct {
    // Name is the fully qualified name of the image.
    Name string

    // LoadBehavior may be used to dictate whether a failed load operation
    // should fail the test run. This is useful when wanting to load images
    // *if* they exist locally, but not wanting to fail if they don't.
    //
    // Defaults to MustLoadImage.
    LoadBehavior LoadImageBehavior
}

type CreateRepositoryInput struct {
    RepositoryFolder    string
    E2EConfig           *E2EConfig
    FileTransformations []RepositoryFileTransformation
}

type E2EConfig struct {
    // Name is the name of the Kind management cluster.
    // Defaults to test-[random generated suffix].
    ManagementClusterName string `json:"managementClusterName,omitempty"`

    // Images is a list of container images to load into the Kind cluster.
    Images []ContainerImage `json:"images,omitempty"`

    // Providers is a list of providers to be configured in the local repository that will be created for the e2e test.
    // It is required to provide following providers
    // - cluster-api
    // - bootstrap kubeadm
    // - control-plane kubeadm
    // - one infrastructure provider
    // The test will adapt to the selected infrastructure provider
    Providers []ProviderConfig `json:"providers,omitempty"`

    // Variables to be added to the clusterctl config file
    // Please note that clusterctl read variables from OS environment variables as well, so you can avoid to hard code
    // sensitive data in the config file.
    Variables map[string]string `json:"variables,omitempty"`

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

type Files struct {
    // SourcePath path of the file.
    SourcePath string `json:"sourcePath"`

    // TargetName name of the file copied into the local repository. if empty, the source name
    // Will be preserved
    TargetName string `json:"targetName,omitempty"`
}

type InitInput struct {
    LogFolder               string
    ClusterctlConfigPath    string
    KubeconfigPath          string
    CoreProvider            string
    BootstrapProviders      []string
    ControlPlaneProviders   []string
    InfrastructureProviders []string
}

type InitManagementClusterAndWatchControllerLogsInput struct {
    ClusterProxy             framework.ClusterProxy
    ClusterctlConfigPath     string
    InfrastructureProviders  []string
    LogFolder                string
    DisableMetricsCollection bool
}

type LoadE2EConfigInput struct {
    // ConfigPath for the e2e test.
    ConfigPath string
}

type LoadImageBehavior string

const (
    // MustLoadImage causes a load operation to fail if the image cannot be
    // loaded.
    MustLoadImage LoadImageBehavior = "mustLoad"

    // TryLoadImage causes any errors that occur when loading an image to be
    // ignored.
    TryLoadImage LoadImageBehavior = "tryLoad"
)

type MoveInput struct {
    LogFolder            string
    ClusterctlConfigPath string
    FromKubeconfigPath   string
    ToKubeconfigPath     string
    Namespace            string
}

type ProviderConfig struct {
    // Name is the name of the provider.
    Name string `json:"name"`

    // Type is the type of the provider.
    Type string `json:"type"`

    // Versions is a list of component YAML to be added to the local repository, one for each release.
    // Please note that the first source will be used a a default release for this provider.
    Versions []ProviderVersionSource `json:"versions,omitempty"`

    // Files is a list of files to be copied into the local repository for all the releases.
    Files []Files `json:"files,omitempty"`
}

type ProviderVersionSource struct {
    // Name is used for logging when a component has multiple sources.
    Name string `json:"name,omitempty"`

    // Value is the source of the component's YAML.
    // May be a URL or a kustomization root (specified by Type).
    // If a Type=url then Value may begin with file://, http://, or https://.
    // If a Type=kustomize then Value may be any valid go-getter URL. For
    // more information please see https://github.com/hashicorp/go-getter#url-format.
    Value string `json:"value"`

    // Type describes how to process the source of the component's YAML.
    //
    // Defaults to "kustomize".
    Type ComponentSourceType `json:"type,omitempty"`

    // Replacements is a list of patterns to replace in the component YAML
    // prior to application.
    Replacements []ComponentReplacement `json:"replacements,omitempty"`

    // Files is a list of files to be copied into the local repository for this release.
    Files []Files `json:"files,omitempty"`
}

type RepositoryFileTransformation func([]byte) ([]byte, error)