f2k8s

type ClusterRoleBindingGet struct {
	// Even if not a namespaced resource, the Namespace is
	// required, so the frame can have access to the KubeClient
	//
	// The Namespace will then also be used to confirm that the
	// acquired binding points to this namespace
	Namespace *Namespace
	Name      string
	Ctx       context.Context

	ClusterRole string

	ExpectAbsent bool

	Result *rbacv1.ClusterRoleBinding

	frame2.Log
	frame2.DefaultRunDealer
}

type ClusterType string

type ConfigMapValidate struct {
	Namespace *Namespace
	Name      string
	Ctx       context.Context

	LogContents bool

	Values map[string]string

	AbsentKeys []string

	// JSON verification for the keys on the map
	JSON map[string]f2general.JSON

	// Function to run against the CM, to validate.  Provides a way
	// to execute more complex validations not available above, inline
	CMValidator func(corev1.ConfigMap) error

	Result *[]corev1.ConfigMap

	frame2.Log
	frame2.DefaultRunDealer
}

type ContainerValidate struct {
	Namespace        *Namespace
	PodSelector      string
	ContainerName    string // If empty, check all containers on selected pods
	ExpectNone       bool   // If true, it will be an error if any pods are found
	ExpectExactly    int    // if greater than 0, exactly this number of pods must be found
	CPULimit         string
	CPURequest       string
	MemoryLimit      string
	MemoryRequest    string
	CheckUnrequested bool // Normally an empty CPU/Memory Limit/Request is not checked
	RestartCount     int32
	RestartCheck     bool
	StatusCheck      bool

	Return *v1.Container
	frame2.Log
	frame2.DefaultRunDealer
}

type Curl struct {
	Namespace *Namespace

	// A default of 60s is set for the timeout, if the original value is
	// zero.
	CurlOptions CurlOpts
	Url         string
	Fail400Plus bool
	Podname     string // Passed to tools.Curl.  Generally safe to leave empty.  Check tools.Curl docs
	DeployCurl  bool

	// TODO: Add cli.Expect to inspect results?
	frame2.Log
}

type CurlOpts struct {
	Silent   bool
	Insecure bool
	Username string
	Password string
	Timeout  int
	Verbose  bool
}

type CurlResponse struct {
	HttpVersion  string
	StatusCode   int
	ReasonPhrase string
	Headers      map[string]string
	Body         string
	Output       string
}

type DeployScale struct {
	Namespace     *Namespace
	DeploymentGet DeploymentValidate // Do not populate the Namespace within the DeploymentGet; it will be auto-populated
	Replicas      int32
	Ctx           context.Context
}

type DeploymentAnnotate struct {
	Namespace   *Namespace
	Name        string
	Annotations map[string]string

	Ctx context.Context
}

type DeploymentCreate struct {
	Namespace  *Namespace
	Deployment *appsv1.Deployment

	Result *appsv1.Deployment
	Ctx    context.Context

	frame2.DefaultRunDealer
}

type DeploymentCreateSimple struct {
	Name           string
	Namespace      *Namespace
	DeploymentOpts DeploymentOpts
	Wait           time.Duration // Waits for the deployment to be ready.  Otherwise, returns as soon as the create instruction has been issued.  If the wait lapses, return an error.

	Ctx context.Context

	Result *appsv1.Deployment

	frame2.DefaultRunDealer
}

type DeploymentGet struct {
	Namespace *Namespace
	Name      string
	Ctx       context.Context

	Result *appsv1.Deployment

	frame2.Log
	frame2.DefaultRunDealer
}

type DeploymentOpts struct {
	Image         string
	Labels        map[string]string
	RestartPolicy corev1.RestartPolicy
	Command       []string
	Args          []string
	EnvVars       []corev1.EnvVar
	ResourceReq   corev1.ResourceRequirements
	SecretMounts  []SecretMount
}

type DeploymentValidate struct {
	Namespace        *Namespace
	Name             string
	Ctx              context.Context
	MinReadyReplicas int

	Result *appsv1.Deployment

	frame2.Log
	frame2.DefaultRunDealer
}

type DeploymentWait struct {
	Name      string
	Namespace *Namespace
	Ctx       context.Context

	// On this field, do not set the context.  Use the DeploymentWait.Ctx,
	// instead, it will be used for the underlying Retry
	RetryOptions frame2.RetryOptions
	frame2.DefaultRunDealer
	*frame2.Log
}

type KubeConfig struct {
	Log *frame2.Log
	// contains filtered or unexported fields
}

type Kubectl struct {
	Args []string

	// You can configure any aspects of the command configuration.  However,
	// the fields Command, Args and Shell from the exec.Cmd element will be
	// cleared before execution.
	Cmd f2general.Cmd

	frame2.Log
	frame2.DefaultRunDealer
}

type Lookup struct {
	Namespace *Namespace

	Name string

	Cmd f2general.Cmd

	frame2.Log
	frame2.DefaultRunDealer
}

type Namespace struct {
	// contains filtered or unexported fields
}

type NamespaceCreateRaw struct {
	Name    string
	Cluster *KubeConfig

	AutoTearDown bool

	Annotations map[string]string
	Labels      map[string]string

	frame2.DefaultRunDealer
	frame2.Log

	Return corev1.Namespace
}

type NamespaceCreateTestBase struct {
	Id       string
	TestBase *TestBase
	Kind     ClusterType

	AutoTearDown bool

	// Annotations to be applied after the namespace creation
	Annotations map[string]string

	// Labels to be applied after the namespace creation
	Labels map[string]string

	frame2.DefaultRunDealer
	frame2.Log

	Return Namespace
}

type NamespaceDeleteRaw struct {
	Namespace string
	Cluster   *KubeConfig

	// A wait duration of zero will use the default wait
	// for namespace removals; if you want to not wait at all
	// use a very small duration (such as time.Nanosecond)
	Wait time.Duration

	frame2.DefaultRunDealer
	frame2.Log
}

type NamespaceDeleteTestBase struct {
	Namespace *Namespace

	// A wait duration of zero will use the default wait
	// for namespace removals; if you want to not wait at all
	// use a very small duration (such as time.Nanosecond)
	Wait time.Duration

	frame2.DefaultRunDealer
	frame2.Log
}

type Namespacer interface {
	GetNamespace() string
	Kube() configv1.KubeClientConfig
}

type NetworkPolicyValidate struct {
	Namespace *Namespace
	Name      string
	Ctx       context.Context

	Values map[string]string

	// Function to run against the Network Policy, to validate.  Provides a way
	// to execute more complex validations not available above, inline
	NMValidator func(corev1.ConfigMap) error

	Result *[]corev1.ConfigMap

	frame2.Log
	frame2.DefaultRunDealer
}

type NginxDeploy struct {
	Namespace     *Namespace
	Name          string            // default "nginx"
	Labels        map[string]string // default app: nginx
	SecretMount   []SecretMount
	ExposeService bool
	SkupperExpose bool // TODO
	Wait          time.Duration
}

type PodAnnotate struct {
	frame2.Step
}

type PodExecute struct {
	Pod       *PodGet
	Container string
	Command   []string
	Ctx       context.Context
	Expect    frame2.Expect // Configures checks on Stdout and Stderr

	// TODO: use common code with execute.Command
	ForceOutput bool // Shows this command's output on log, regardless of environment config

	frame2.Log

	*f2general.CmdResult
}

type PodGet struct {
	Namespace *Namespace
	Name      string
	Labels    map[string]string
	Ctx       context.Context

	Result *corev1.Pod

	frame2.Log
	frame2.DefaultRunDealer
}

type PodSelector struct {
	Namespace     *Namespace
	Selector      string
	ExpectNone    bool // If true, it will be an error if any pods are found
	ExpectExactly int  // if greater than 0, exactly this number of pods must be found

	// Return value
	Pods []v1.Pod
}

type Pods struct {
	Namespace *Namespace
	Labels    map[string]string
	Ctx       context.Context

	// Ignored if zero
	ExpectMin int

	// Ignored if zero
	ExpectMax int

	// Ignored if zero
	// TODO: use min == max, instead?
	ExpectExactly int

	// Expect no results
	ExpectNone bool

	//ExpectCondition corev1.PodConditionType
	ExpectPhase corev1.PodPhase

	// List of labels expected to _not_ be set on the Pod, regardless of value
	NegativeLabelList []string

	// Other labels expected to be on the Pod, besides those used on the
	// selector, with their expected values
	OtherLabels map[string]string

	// Labels listed on this map must not have the mapped value.  If the
	// label does not exist at all on the pod, the NegativeLabels test is
	// considered successful, unless NegativeLabelsExist is set to true
	NegativeLabels map[string]string

	NegativeLabelsExist bool

	// List of annotations expected to be set on the Pod, regardless of value
	AnnotationList []string

	// List of annotations expected to _not_ be set on the Pod, regardless of value
	NegativeAnnotationList []string

	// Other annotations expected to be on the Pod, besides those used on the
	// selector, with their expected values
	OtherAnnotations map[string]string

	// Annotations listed on this map must not have the mapped value.  If the
	// label does not exist at all on the pod, the NegativeAnnotations test is
	// considered successful, unless NegativeAnnotationsExist is set to true
	NegativeAnnotations map[string]string

	NegativeAnnotationsExist bool

	// A list of strings, all of which must map to a container name on the pod
	ContainerList []string

	// If true, the ContainerList is the complete list of expected containers;
	// any additional containers will cause the validation to fail
	ContainerListComplete bool

	// These containers must not be present on the pod
	NegativeContainerList []string

	// Function to run against each pod, to validate.  Provides a way
	// to execute more complex validations not available above
	PodValidator func(corev1.Pod) error

	// A complex validation on the list as a whole.  Allows, for example
	// to aggregate values from the different pods for verification
	ListValidator func([]corev1.Pod) error

	// List of labels expected to be set on the Pod, regardless of value
	LabelList []string

	Result *[]corev1.Pod

	frame2.Log
	frame2.DefaultRunDealer
}

type PostgresPing struct {
	Namespace *Namespace
	Podname   string
	Labels    map[string]string
	Container string

	DbName   string
	DbHost   string
	DbPort   string // default is 5432
	Username string

	Ctx context.Context

	frame2.Log
	frame2.DefaultRunDealer
}

type PsycopgPing struct {
	Namespace *Namespace
	Podname   string
	Labels    map[string]string
	Container string

	DbName   string
	DbHost   string
	DbPort   string // default is 5432
	Username string
	Password string

	Ctx context.Context

	frame2.Log
	frame2.DefaultRunDealer
}

type SecretCreate struct {
	Namespace *Namespace
	Secret    *core.Secret

	*frame2.Log
	frame2.DefaultRunDealer
}

type SecretDelete struct {
	Namespace *Namespace
	Name      string

	Secret *core.Secret // return

	*frame2.Log
	frame2.DefaultRunDealer
}

type SecretGet struct {
	Namespace *Namespace
	Name      string

	// TODO change all these for a f2general.MapCheck
	// Look for expected contents of the secret (exact)
	Expect map[string][]byte

	// If true, the Expect map should be the full contents
	// of the secret.  If it is empty and ExpectAll is true,
	// for example, the secret must be empty.
	ExpectAll bool

	// Checks that all listed keys are present on the
	// secret, regardless of their values
	Keys []string

	// Checks that listed keys are _not_ present on the
	// Secret
	AbsentKeys []string

	// If set, the Secret is expected to not be present;
	// fail if it exists
	ExpectAbsent bool

	Labels      f2general.MapCheck
	Annotations f2general.MapCheck

	// Function to run against the Secret, to validate.  Provides a way
	// to execute more complex validations not available above, inline
	SecretValidator func(core.Secret) error

	Secret *core.Secret

	*frame2.Log
	frame2.DefaultRunDealer
}

type SecretMount struct {
	Name      string
	Secret    string
	MountPath string
}

type ServiceAnnotate struct {
	Namespace   *Namespace
	Name        string
	Annotations map[string]string

	Ctx context.Context
}

type ServiceCreate struct {
	Namespace                *Namespace
	Name                     string
	Annotations              map[string]string
	Labels                   map[string]string
	Selector                 map[string]string
	Ports                    []int32
	Type                     apiv1.ServiceType
	PublishNotReadyAddresses bool
	Ctx                      context.Context

	// Cluster IP; set this to "None" and Type to ClusterIP for a headless service
	// https://kubernetes.io/docs/concepts/services-networking/service/#headless-services
	ClusterIP string

	AutoTeardown bool
	Wait         time.Duration
}

type ServiceDelete struct {
	Namespace *Namespace
	Name      string

	Ctx context.Context
}

type ServiceGet struct {
	Namespace *Namespace
	Name      string
	Ctx       context.Context

	frame2.Log

	// Return
	Service *apiv1.Service
}

type ServiceRemoveAnnotation struct {
	Namespace   *Namespace
	Name        string
	Annotations []string

	Ctx context.Context
}

type StatefulSetCreate struct {
	Namespace    *Namespace
	StatefulSet  *apps.StatefulSet
	AutoTeardown bool
	Ctx          context.Context

	Result *apps.StatefulSet
}

type StatefulSetRemove struct {
	Namespace *Namespace
	Name      string

	Ctx context.Context
}

type TestBase struct {
	// contains filtered or unexported fields
}

type Undeploy struct {
	Name      string
	Namespace *Namespace
	Wait      time.Duration // Waits for the deployment to be gone.  Otherwise, returns as soon as the delete instruction has been issued.  If the wait lapses, return an error.

	Ctx context.Context
	frame2.DefaultRunDealer
}