framework

type AddLabelsToNamespaceInput struct {
	// ClusterProxy is the cluster proxy object used for interacting with the Kubernetes cluster.
	ClusterProxy framework.ClusterProxy

	// Name is the name of the namespace to which labels will be added.
	Name string

	// Labels is a map of key-value pairs representing the labels to be added to the namespace.
	Labels map[string]string
}

type ApplyFromTemplateInput struct {
	// Template is the content of the template to be applied.
	Template []byte

	// AddtionalEnvironmentVariables is a map of additional environment variables to be set during template application.
	AddtionalEnvironmentVariables map[string]string

	// Proxy is the cluster proxy used for applying the template.
	Proxy framework.ClusterProxy

	// OutputFilePath is the path where the output of the template application will be stored.
	OutputFilePath string
}

type ClusterctlGenerateFromTemplateInput struct {
	// ClusterName is the name of the cluster.
	ClusterName string

	// TemplatePath is the path to the template.
	TemplatePath string

	// OutputFilePath is the path to the output file.
	OutputFilePath string

	// ClusterCtlBinaryPath is the path to the ClusterCtl binary.
	ClusterCtlBinaryPath string

	// EnvironmentVariables are the environment variables to be set.
	EnvironmentVariables map[string]string
}

type CreateDockerRegistrySecretInput struct {
	// BootstrapClusterProxy is the bootstrap cluster proxy.
	BootstrapClusterProxy framework.ClusterProxy

	// Name is the name of the secret.
	Name string `envDefault:"regcred"`

	// Namespace is the namespace where the secret will be created.
	Namespace string `envDefault:"rancher-turtles-system"`

	// DockerServer is the Docker server URL.
	DockerServer string `envDefault:"https://ghcr.io/"`

	// DockerUsername is the username for authenticating with the Docker registry.
	DockerUsername string `env:"GITHUB_USERNAME"`

	// DockerPassword is the password for authenticating with the Docker registry.
	DockerPassword string `env:"GITHUB_TOKEN"`
}

type CreateSecretInput struct {
	// Creator is the framework.Creator responsible for creating the secret.
	Creator framework.Creator

	// Name is the name of the secret.
	Name string

	// Namespace is the namespace in which the secret will be created.
	Namespace string

	// Type is the type of the secret.
	Type corev1.SecretType

	// Data is a map of key-value pairs representing the secret data.
	Data map[string]string

	// Labels is a map of key-value pairs representing the labels associated with the secret.
	Labels map[string]string

	// Annotations is a map of key-value pairs representing the annotations associated with the secret.
	Annotations map[string]string
}

type FleetCreateFleetFileInput struct {
	// Namespace is the namespace in which the fleet file will be created.
	Namespace string

	// FilePath is the file path of the fleet file.
	FilePath string
}

type FleetCreateGitRepoInput struct {
	// Name is the name of the Git repository.
	Name string

	// Namespace is the namespace in which the Git repository will be created.
	Namespace string `envDefault:"fleet-local"`

	// TargetNamespace is the namespace in which the Git repository will apply its content.
	TargetNamespace string

	// TargetClusterNamespace is defining git repo to use cluster namespace as a target namespace by default.
	TargetClusterNamespace bool

	// SourceRepo is the default source URL of the Git repository to use in a CI setting.
	SourceRepo string `env:"SOURCE_REPO"`

	// Repo is the URL of the Git repository.
	Repo string

	// SourceBranch is the default source branch of the Git repository to use in a CI setting.
	SourceBranch string `env:"GITHUB_HEAD_REF"`

	// Branch is the branch of the Git repository to use.
	Branch string `envDefault:"main"`

	// Revision is the specific commit in the Git repository to use.
	Revision string

	// Paths are the paths within the Git repository to sync.
	Paths []string

	// FleetGeneration is the generation of the Fleet instance.
	FleetGeneration int `envDefault:"1"`

	// ClientSecretName is the name of the client secret to use for authentication.
	ClientSecretName string `envDefault:"basic-auth-secret"`

	// ClusterSelectors is a list of optional target selectors. These will override the default target.
	ClusterSelectors []*metav1.LabelSelector

	// ClusterProxy is the ClusterProxy instance for interacting with the cluster.
	ClusterProxy framework.ClusterProxy
}

type FleetDeleteGitRepoInput struct {
	// Name is the name of the Git repository to be deleted.
	Name string

	// Namespace is the namespace of the Git repository to be deleted.
	Namespace string `envDefault:"fleet-local"`

	// ClusterProxy is the cluster proxy used for interacting with the cluster.
	ClusterProxy framework.ClusterProxy
}

type GetClusterctlInput struct {
	// GetLister is a function that returns a lister for accessing Kubernetes resources.
	GetLister framework.GetLister

	// ConfigMapName is the name of the Ingress.
	ConfigMapName string

	// IngressNamespace is the namespace of the Ingress.
	ConfigMapNamespace string
}

type GetIngressHostInput struct {
	// GetLister is a function that returns a lister for accessing Kubernetes resources.
	GetLister framework.GetLister

	// IngressName is the name of the Ingress.
	IngressName string

	// IngressNamespace is the namespace of the Ingress.
	IngressNamespace string

	// IngressRuleIndex is the index of the Ingress rule.
	IngressRuleIndex int
}

type GetNodeAddressInput struct {
	// Lister is an interface used for listing resources.
	Lister framework.Lister

	// NodeIndex is the index of the node to retrieve the address from.
	NodeIndex int

	// AddressIndex is the index of the address to retrieve from the node.
	AddressIndex int
}

type GetServicePortByNameInput struct {
	// GetLister is the function used to retrieve a lister.
	GetLister framework.GetLister

	// ServiceName is the name of the service.
	ServiceName string

	// ServiceNamespace is the namespace of the service.
	ServiceNamespace string

	// PortName is the name of the port.
	PortName string
}

type GetServicePortByNameOutput struct {
	// Port is the port number of the service.
	Port int32

	// NodePort is the node port number of the service.
	NodePort int32
}

type GitCloneRepoInput struct {
	// Address is the URL of the repository to clone.
	Address string

	// CloneLocation is the directory where the repository will be cloned.
	CloneLocation string

	// Username is the username for authentication (optional).
	Username string `env:"GITEA_USER_NAME"`

	// Password is the password for authentication (optional).
	Password string `env:"GITEA_USER_PWD"`
}

type GitCommitAndPushInput struct {
	// CloneLocation is the directory where the repository is cloned.
	CloneLocation string

	// Username is the username for authentication (optional).
	Username string `env:"GITEA_USER_NAME"`

	// Password is the password for authentication (optional).
	Password string `env:"GITEA_USER_PWD"`

	// CommitMessage is the message for the commit.
	CommitMessage string

	// GitPushWait is the wait time for the git push operation.
	GitPushWait []interface{} `envDefault:"3m,10s"`
}

type GitPushInput struct {
	// RepoLocation is the directory where the repository is located.
	RepoLocation string

	// RemoteName is the name of the remote to push to.
	RemoteName string `envDefault:"origin"`

	// RefSpec is the refspec to push (e.g., "refs/heads/main:refs/heads/main").
	// If empty, the default git push behavior is used (push current branch to upstream).
	RefSpec string

	// Username is the username for authentication (optional).
	Username string `env:"GITEA_USER_NAME"`

	// Password is the password for authentication (optional).
	Password string `env:"GITEA_USER_PWD"`

	// Force indicates whether to force push.
	Force bool
}

type GitSetRemoteInput struct {
	// RepoLocation is the directory where the repository is located.
	RepoLocation string

	// RemoteName is the name of the remote (e.g., "origin").
	RemoteName string `envDefault:"origin"`

	// RemoteURL is the URL for the remote repository.
	RemoteURL string

	// Username is the username for authentication (optional).
	Username string `env:"GITEA_USER_NAME"`

	// Password is the password for authentication (optional).
	Password string `env:"GITEA_USER_PWD"`
}

type GiteaCreateRepoInput struct {
	// ServerAddr is the address of the Gitea server.
	ServerAddr string

	// RepoName is the name of the repository to be created.
	RepoName string

	// Username is the username of the user creating the repository.
	Username string `env:"GITEA_USER_NAME"`

	// Password is the password of the user creating the repository.
	Password string `env:"GITEA_USER_PWD"`
}

type RancherGetClusterKubeconfigInput struct {
	// ClusterProxy is the framework cluster proxy used to retrieve the kubeconfig.
	ClusterProxy framework.ClusterProxy

	// SecretName is the name of the secret containing the kubeconfig.
	SecretName string

	// Namespace is the namespace of the secret containing the kubeconfig.
	Namespace string

	// ClusterName is the name of the cluster.
	ClusterName string

	// RancherServerURL is the URL of the Rancher server.
	RancherServerURL string

	// WriteToTempFile indicates whether to write the kubeconfig to a temporary file.
	WriteToTempFile bool

	// WaitInterval is the interval to wait for the secret to be available.
	WaitInterval []interface{}
}

type RancherGetClusterKubeconfigResult struct {
	// KubeconfigData contains the kubeconfig data as a byte array.
	KubeconfigData []byte

	// TempFilePath is the temporary file path where the kubeconfig is stored.
	TempFilePath string
}

type RancherLookupUserInput struct {
	// ClusterProxy is the cluster proxy used for communication with Rancher.
	ClusterProxy framework.ClusterProxy

	// Username is the username of the user to look up.
	Username string
}

type RancherLookupUserResult struct {
	// User is the username of the user found in Rancher.
	User string
}

type RunCommandInput struct {
	// Command is the command to be executed.
	Command string

	// Args are the arguments to be passed to the command.
	Args []string

	// EnvironmentVariables are the environment variables to be set for the command.
	EnvironmentVariables map[string]string
}

type RunCommandResult struct {
	// ExitCode is the exit code of the command.
	ExitCode int

	// Stdout is the standard output of the command.
	Stdout []byte

	// Stderr is the standard error of the command.
	Stderr []byte

	// Error is the error that occurred while running the command.
	Error error
}

type VariableCollection map[string]string

type VariableLookupFunc func(key string) string

type VerifyClusterInput struct {
	BootstrapClusterProxy   capiframework.ClusterProxy
	Name                    string
	DeleteAfterVerification bool
}

type VerifyCustomResourceHasBeenRemovedInput struct {
	capiframework.Lister
	GroupVersionKind schema.GroupVersionKind
}

type WaitForCAPIProviderRolloutInput struct {
	capiframework.Getter
	Deployment                      *appsv1.Deployment
	Name, Namespace, Version, Image string
}

type WaitForDeploymentsRemovedInput = capiframework.WaitForDeploymentsAvailableInput