helpers

type AttachOptions struct {
	// timeout for waiting until container is ready.
	Timeout time.Duration
	// IgnoreIfExists causes AttachEphemeralContainer to return successfully if the ephemeral container already exists
	// when set to true. If set to false, it will exit with an error if the container already exists.
	IgnoreIfExists bool
}

type Command struct {
	Pod       string
	Namespace string
	Container string
	Command   []string
	Stdin     []byte
}

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

type PodCommandExecutor interface {
	// Exec executes a non-interactive command described in options and returns the stdout and stderr outputs
	Exec(
		ctx context.Context,
		pod string,
		namespace string,
		container string,
		command []string,
		stdin []byte,
	) ([]byte, []byte, error)
}

type PodFilter struct {
	// Select Pods that match these labels
	Select map[string]string
	// Select Pods that match these labels
	Exclude map[string]string
}

type PodHelper interface {
	// WaitPodRunning waits for the Pod to be running for up to given timeout and returns a boolean indicating
	// if the status was reached. If the pod is Failed returns error.
	WaitPodRunning(ctx context.Context, name string, timeout time.Duration) (bool, error)
	// WaitPodDeleted waits for the Pod to be deleted for up to given timeout
	WaitPodDeleted(ctx context.Context, name string, timeout time.Duration) error
	// Exec executes a non-interactive command described in options and returns the stdout and stderr outputs
	Exec(ctx context.Context, pod string, container string, command []string, stdin []byte) ([]byte, []byte, error)
	// AttachEphemeralContainer adds an ephemeral container to a running pod
	AttachEphemeralContainer(
		ctx context.Context,
		podName string,
		container corev1.EphemeralContainer,
		options AttachOptions,
	) error
	// List returns a list of pods that match the given PodFilter
	List(ctx context.Context, filter PodFilter) ([]corev1.Pod, error)
	// Terminate terminates the execution of a running Pod
	Terminate(ctx context.Context, name string, timeout time.Duration) error
}

type ServiceHelper interface {
	// WaitServiceReady waits for the given service to have at least one endpoint available
	WaitServiceReady(ctx context.Context, service string, timeout time.Duration) error
	// WaitIngressReady waits for the given service to have a load balancer address assigned
	WaitIngressReady(ctx context.Context, ingress string, timeout time.Duration) error
	// GetTargets returns the list of pods that match the service selector criteria
	GetTargets(ctx context.Context, service string) ([]corev1.Pod, error)
}