k8s

func AddConfigContextForServiceAccountE ¶ added in v0.13.24

func AddConfigContextForServiceAccountE(
	t testing.TestingT,
	kubectlOptions *KubectlOptions,
	contextName string,
	serviceAccountName string,
	token string,
) error

AddConfigContextForServiceAccountE will add a new config context that binds the ServiceAccount auth token to the Kubernetes cluster of the current config context.

func AreAllNodesReadyContextE ¶ added in v1.0.0

func AreAllNodesReadyContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions) (bool, error)

AreAllNodesReadyContextE checks if all nodes are ready in the Kubernetes cluster targeted by the current config context. The ctx parameter supports cancellation and timeouts. If false, returns an error indicating the reason.

func CanIDoContext ¶ added in v1.0.0

func CanIDoContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, action authv1.ResourceAttributes) bool

CanIDoContext returns whether or not the provided action is allowed by the client configured by the provided kubectl option. The ctx parameter supports cancellation and timeouts. This will fail if there are any errors accessing the kubernetes API (but not if the action is denied).

func CanIDoContextE ¶ added in v1.0.0

func CanIDoContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, action authv1.ResourceAttributes) (bool, error)

CanIDoContextE returns whether or not the provided action is allowed by the client configured by the provided kubectl option. This will return an error if there are problems accessing the kubernetes API (but not if the action is simply denied). The ctx parameter supports cancellation and timeouts.

func CopyHomeKubeConfigToTemp ¶ added in v0.13.24

func CopyHomeKubeConfigToTemp(t testing.TestingT) string

CopyHomeKubeConfigToTemp will copy the kubeconfig in the home directory to a temp file. This will fail the test if there are any errors.

func CopyHomeKubeConfigToTempE ¶ added in v0.13.24

func CopyHomeKubeConfigToTempE(t testing.TestingT) (string, error)

CopyHomeKubeConfigToTempE will copy the kubeconfig in the home directory to a temp file.

func CreateJobFromCronJobContext ¶ added in v1.0.0

func CreateJobFromCronJobContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, cronJobName, newJobName string) *batchv1.Job

CreateJobFromCronJobContext creates a Job from the specified CronJob in the given namespace and returns the created Job. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func CreateJobFromCronJobContextE ¶ added in v1.0.0

func CreateJobFromCronJobContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, cronJobName, newJobName string) (*batchv1.Job, error)

CreateJobFromCronJobContextE creates a Job from the specified CronJob in the given namespace and returns the created Job. The ctx parameter supports cancellation and timeouts. This function is similar to running `kubectl create job --from=cronjob/<cron-job-name> <new-job-name>`.

func CreateNamespaceContext ¶ added in v1.0.0

func CreateNamespaceContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, namespaceName string)

CreateNamespaceContext will create a new Kubernetes namespace on the cluster targeted by the provided options. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error in creating the namespace.

func CreateNamespaceContextE ¶ added in v1.0.0

func CreateNamespaceContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, namespaceName string) error

CreateNamespaceContextE will create a new Kubernetes namespace on the cluster targeted by the provided options. The ctx parameter supports cancellation and timeouts.

func CreateNamespaceWithMetadataContext ¶ added in v1.0.0

func CreateNamespaceWithMetadataContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, namespaceObjectMeta metav1.ObjectMeta)

CreateNamespaceWithMetadataContext will create a new Kubernetes namespace on the cluster targeted by the provided options and with the provided metadata. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error while creating the namespace.

func CreateNamespaceWithMetadataContextE ¶ added in v1.0.0

func CreateNamespaceWithMetadataContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, namespaceObjectMeta metav1.ObjectMeta) error

CreateNamespaceWithMetadataContextE will create a new Kubernetes namespace on the cluster targeted by the provided options and with the provided metadata. The ctx parameter supports cancellation and timeouts. This method expects the entire namespace ObjectMeta to be passed in, so you'll need to set the name within the ObjectMeta struct yourself.

func CreateServiceAccountContext ¶ added in v1.0.0

func CreateServiceAccountContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, serviceAccountName string)

CreateServiceAccountContext will create a new service account resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func CreateServiceAccountContextE ¶ added in v1.0.0

func CreateServiceAccountContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, serviceAccountName string) error

CreateServiceAccountContextE will create a new service account resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts.

func DeleteConfigContextE ¶

func DeleteConfigContextE(t testing.TestingT, contextName string) error

DeleteConfigContextE will remove the context specified at the provided name, and remove any clusters and authinfos that are orphaned as a result of it. The config path is either specified in the environment variable KUBECONFIG or at the user's home directory under `.kube/config`.

func DeleteConfigContextWithPathE ¶

func DeleteConfigContextWithPathE(t testing.TestingT, kubeConfigPath string, contextName string) error

DeleteConfigContextWithPathE will remove the context specified at the provided name, and remove any clusters and authinfos that are orphaned as a result of it.

func DeleteNamespaceContext ¶ added in v1.0.0

func DeleteNamespaceContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, namespaceName string)

DeleteNamespaceContext will delete the requested namespace from the Kubernetes cluster targeted by the provided options. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func DeleteNamespaceContextE ¶ added in v1.0.0

func DeleteNamespaceContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, namespaceName string) error

DeleteNamespaceContextE will delete the requested namespace from the Kubernetes cluster targeted by the provided options. The ctx parameter supports cancellation and timeouts.

func ExecPodContext ¶ added in v1.0.0

func ExecPodContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, podName string, containerName string, command ...string) string

ExecPodContext executes a command in a container within a Kubernetes pod and returns the output. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error. Set containerName to "" if there is only one container in the pod.

func ExecPodContextE ¶ added in v1.0.0

func ExecPodContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, podName string, containerName string, command ...string) (string, error)

ExecPodContextE executes a command in a container within a Kubernetes pod and returns the output. The ctx parameter supports cancellation and timeouts. Set containerName to "" if there is only one container in the pod.

func FindNodeHostnameContext ¶ added in v1.0.0

func FindNodeHostnameContext(t testing.TestingT, ctx context.Context, node corev1.Node) string

FindNodeHostnameContext returns the hostname or IP address of the given node using the provided context, preferring the external IP when available. This will fail the test if there is an error.

func FindNodeHostnameContextE ¶ added in v1.0.0

func FindNodeHostnameContextE(t testing.TestingT, ctx context.Context, node corev1.Node) (string, error)

FindNodeHostnameContextE returns the hostname or IP address of the given node using the provided context, preferring the external IP when available.

func FindNodePortContext ¶ added in v1.0.0

func FindNodePortContext(t testing.TestingT, ctx context.Context, service *corev1.Service, servicePort int32) int32

FindNodePortContext returns the allocated NodePort for the given servicePort from the service definition. The ctx parameter is accepted for API consistency but is not used since this is a local struct lookup. This will fail the test if there is an error.

func FindNodePortContextE ¶ added in v1.0.0

func FindNodePortContextE(_ context.Context, service *corev1.Service, servicePort int32) (int32, error)

FindNodePortContextE returns the allocated NodePort for the given servicePort from the service definition. The ctx parameter is accepted for API consistency but is not used since this is a local struct lookup.

func GetAvailablePortContext ¶ added in v1.0.0

func GetAvailablePortContext(t testing.TestingT, ctx context.Context) int

GetAvailablePortContext retrieves an available port on the host machine using the provided context. This delegates the port selection to the golang net library by starting a server and then checking the port that the server is using. This will fail the test if it could not find an available port.

func GetAvailablePortContextE ¶ added in v1.0.0

func GetAvailablePortContextE(t testing.TestingT, ctx context.Context) (int, error)

GetAvailablePortContextE retrieves an available port on the host machine using the provided context. This delegates the port selection to the golang net library by starting a server and then checking the port that the server is using.

func GetClusterRoleContext ¶ added in v1.0.0

func GetClusterRoleContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, roleName string) *rbacv1.ClusterRole

GetClusterRoleContext returns a Kubernetes ClusterRole resource with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetClusterRoleContextE ¶ added in v1.0.0

func GetClusterRoleContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, roleName string) (*rbacv1.ClusterRole, error)

GetClusterRoleContextE returns a Kubernetes ClusterRole resource with the given name. The ctx parameter supports cancellation and timeouts.

func GetConfigMapContext ¶ added in v1.0.0

func GetConfigMapContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, configMapName string) *corev1.ConfigMap

GetConfigMapContext returns a Kubernetes configmap resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetConfigMapContextE ¶ added in v1.0.0

func GetConfigMapContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, configMapName string) (*corev1.ConfigMap, error)

GetConfigMapContextE returns a Kubernetes configmap resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts.

func GetCronJobContext ¶ added in v1.0.0

func GetCronJobContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, cronJobName string) *batchv1.CronJob

GetCronJobContext returns a cron job resource from namespace by name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetCronJobContextE ¶ added in v1.0.0

func GetCronJobContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, cronJobName string) (*batchv1.CronJob, error)

GetCronJobContextE returns a cron job resource from namespace by name. The ctx parameter supports cancellation and timeouts.

func GetDaemonSetContext ¶ added in v1.0.0

func GetDaemonSetContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, daemonSetName string) *appsv1.DaemonSet

GetDaemonSetContext returns a Kubernetes daemonset resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetDaemonSetContextE ¶ added in v1.0.0

func GetDaemonSetContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, daemonSetName string) (*appsv1.DaemonSet, error)

GetDaemonSetContextE returns a Kubernetes daemonset resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts.

func GetDeploymentContext ¶ added in v1.0.0

func GetDeploymentContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, deploymentName string) *appsv1.Deployment

GetDeploymentContext returns a Kubernetes deployment resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetDeploymentContextE ¶ added in v1.0.0

func GetDeploymentContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, deploymentName string) (*appsv1.Deployment, error)

GetDeploymentContextE returns a Kubernetes deployment resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts.

func GetIngressContext ¶ added in v1.0.0

func GetIngressContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, ingressName string) *networkingv1.Ingress

GetIngressContext returns a Kubernetes Ingress resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetIngressContextE ¶ added in v1.0.0

func GetIngressContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, ingressName string) (*networkingv1.Ingress, error)

GetIngressContextE returns a Kubernetes Ingress resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts.

func GetIngressV1Beta1Context ¶ added in v1.0.0

func GetIngressV1Beta1Context(t testing.TestingT, ctx context.Context, options *KubectlOptions, ingressName string) *networkingv1beta1.Ingress

GetIngressV1Beta1Context returns a Kubernetes Ingress resource in the provided namespace with the given name, using networking.k8s.io/v1beta1 API. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetIngressV1Beta1ContextE ¶ added in v1.0.0

func GetIngressV1Beta1ContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, ingressName string) (*networkingv1beta1.Ingress, error)

GetIngressV1Beta1ContextE returns a Kubernetes Ingress resource in the provided namespace with the given name, using networking.k8s.io/v1beta1 API. The ctx parameter supports cancellation and timeouts.

func GetJobContext ¶ added in v1.0.0

func GetJobContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, jobName string) *batchv1.Job

GetJobContext returns a Kubernetes job resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetJobContextE ¶ added in v1.0.0

func GetJobContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, jobName string) (*batchv1.Job, error)

GetJobContextE returns a Kubernetes job resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts.

func GetKubeConfigPathContext ¶ added in v1.0.0

func GetKubeConfigPathContext(t testing.TestingT, ctx context.Context) string

GetKubeConfigPathContext determines which file path to use as the kubectl config path. The ctx parameter is accepted for API consistency. This will fail the test if there is an error.

func GetKubeConfigPathContextE ¶ added in v1.0.0

func GetKubeConfigPathContextE(t testing.TestingT, ctx context.Context) (string, error)

GetKubeConfigPathContextE determines which file path to use as the kubectl config path. The ctx parameter is accepted for API consistency.

func GetKubernetesClientContext ¶ added in v1.0.0

func GetKubernetesClientContext(t testing.TestingT, ctx context.Context) *kubernetes.Clientset

GetKubernetesClientContext returns a Kubernetes API client that can be used to make requests. The ctx parameter is accepted for API consistency. This will fail the test if there is an error.

func GetKubernetesClientContextE ¶ added in v1.0.0

func GetKubernetesClientContextE(t testing.TestingT, ctx context.Context) (*kubernetes.Clientset, error)

GetKubernetesClientContextE returns a Kubernetes API client that can be used to make requests. The ctx parameter is accepted for API consistency.

func GetKubernetesClientFromOptionsContext ¶ added in v1.0.0

func GetKubernetesClientFromOptionsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions) *kubernetes.Clientset

GetKubernetesClientFromOptionsContext returns a Kubernetes API client given a configured KubectlOptions object. The ctx parameter is accepted for API consistency. This will fail the test if there is an error.

func GetKubernetesClientFromOptionsContextE ¶ added in v1.0.0

func GetKubernetesClientFromOptionsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions) (*kubernetes.Clientset, error)

GetKubernetesClientFromOptionsContextE returns a Kubernetes API client given a configured KubectlOptions object. The ctx parameter is accepted for API consistency.

func GetKubernetesClusterVersionContext ¶ added in v1.0.0

func GetKubernetesClusterVersionContext(t testing.TestingT, ctx context.Context) string

GetKubernetesClusterVersionContext returns the Kubernetes cluster version. The ctx parameter is accepted for API consistency. This will fail the test if there is an error.

func GetKubernetesClusterVersionContextE ¶ added in v1.0.0

func GetKubernetesClusterVersionContextE(t testing.TestingT, ctx context.Context) (string, error)

GetKubernetesClusterVersionContextE returns the Kubernetes cluster version. The ctx parameter is accepted for API consistency.

func GetKubernetesClusterVersionWithOptionsContext ¶ added in v1.0.0

func GetKubernetesClusterVersionWithOptionsContext(t testing.TestingT, ctx context.Context, kubectlOptions *KubectlOptions) string

GetKubernetesClusterVersionWithOptionsContext returns the Kubernetes cluster version given a configured KubectlOptions object. The ctx parameter is accepted for API consistency. This will fail the test if there is an error.

func GetKubernetesClusterVersionWithOptionsContextE ¶ added in v1.0.0

func GetKubernetesClusterVersionWithOptionsContextE(t testing.TestingT, ctx context.Context, kubectlOptions *KubectlOptions) (string, error)

GetKubernetesClusterVersionWithOptionsContextE returns the Kubernetes cluster version given a configured KubectlOptions object. The ctx parameter is accepted for API consistency.

func GetNamespaceContext ¶ added in v1.0.0

func GetNamespaceContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, namespaceName string) *corev1.Namespace

GetNamespaceContext will query the Kubernetes cluster targeted by the provided options for the requested namespace. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error or if the namespace doesn't exist.

func GetNamespaceContextE ¶ added in v1.0.0

func GetNamespaceContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, namespaceName string) (*corev1.Namespace, error)

GetNamespaceContextE will query the Kubernetes cluster targeted by the provided options for the requested namespace. The ctx parameter supports cancellation and timeouts.

func GetNetworkPolicyContext ¶ added in v1.0.0

func GetNetworkPolicyContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, networkPolicyName string) *networkingv1.NetworkPolicy

GetNetworkPolicyContext returns a Kubernetes networkpolicy resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetNetworkPolicyContextE ¶ added in v1.0.0

func GetNetworkPolicyContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, networkPolicyName string) (*networkingv1.NetworkPolicy, error)

GetNetworkPolicyContextE returns a Kubernetes networkpolicy resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts.

func GetNodesByFilterContext ¶ added in v1.0.0

func GetNodesByFilterContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filter metav1.ListOptions) []corev1.Node

GetNodesByFilterContext queries Kubernetes for information about the worker nodes registered to the cluster, filtering the list of nodes using the provided ListOptions. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetNodesByFilterContextE ¶ added in v1.0.0

func GetNodesByFilterContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filter metav1.ListOptions) ([]corev1.Node, error)

GetNodesByFilterContextE queries Kubernetes for information about the worker nodes registered to the cluster, filtering the list of nodes using the provided ListOptions. The ctx parameter supports cancellation and timeouts.

func GetNodesContext ¶ added in v1.0.0

func GetNodesContext(t testing.TestingT, ctx context.Context, options *KubectlOptions) []corev1.Node

GetNodesContext queries Kubernetes for information about the worker nodes registered to the cluster. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetNodesContextE ¶ added in v1.0.0

func GetNodesContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions) ([]corev1.Node, error)

GetNodesContextE queries Kubernetes for information about the worker nodes registered to the cluster. The ctx parameter supports cancellation and timeouts.

func GetPersistentVolumeClaimContext ¶ added in v1.0.0

func GetPersistentVolumeClaimContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, pvcName string) *corev1.PersistentVolumeClaim

GetPersistentVolumeClaimContext returns a Kubernetes PersistentVolumeClaim resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetPersistentVolumeClaimContextE ¶ added in v1.0.0

func GetPersistentVolumeClaimContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, pvcName string) (*corev1.PersistentVolumeClaim, error)

GetPersistentVolumeClaimContextE returns a Kubernetes PersistentVolumeClaim resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts.

func GetPersistentVolumeContext ¶ added in v1.0.0

func GetPersistentVolumeContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, name string) *corev1.PersistentVolume

GetPersistentVolumeContext returns a Kubernetes PersistentVolume resource with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetPersistentVolumeContextE ¶ added in v1.0.0

func GetPersistentVolumeContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, name string) (*corev1.PersistentVolume, error)

GetPersistentVolumeContextE returns a Kubernetes PersistentVolume resource with the given name. The ctx parameter supports cancellation and timeouts.

func GetPodContext ¶ added in v1.0.0

func GetPodContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, podName string) *corev1.Pod

GetPodContext returns a Kubernetes pod resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetPodContextE ¶ added in v1.0.0

func GetPodContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, podName string) (*corev1.Pod, error)

GetPodContextE returns a Kubernetes pod resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts.

func GetPodLogsContext ¶ added in v1.0.0

func GetPodLogsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, pod *corev1.Pod, containerName string) string

GetPodLogsContext returns the logs of a Pod at the time when the function was called. The ctx parameter supports cancellation and timeouts. Pass container name if there are more containers in the Pod or set to "" if there is only one. This will fail the test if there is an error.

func GetPodLogsContextE ¶ added in v1.0.0

func GetPodLogsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, pod *corev1.Pod, containerName string) (string, error)

GetPodLogsContextE returns the logs of a Pod at the time when the function was called. The ctx parameter supports cancellation and timeouts. Pass container name if there are more containers in the Pod or set to "" if there is only one. If the Pod is not running an Error is returned. If the provided containerName is not the name of a container in the Pod an Error is returned.

func GetReadyNodesContext ¶ added in v1.0.0

func GetReadyNodesContext(t testing.TestingT, ctx context.Context, options *KubectlOptions) []corev1.Node

GetReadyNodesContext queries Kubernetes for information about the worker nodes registered to the cluster and only returns those that are in the ready state. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetReadyNodesContextE ¶ added in v1.0.0

func GetReadyNodesContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions) ([]corev1.Node, error)

GetReadyNodesContextE queries Kubernetes for information about the worker nodes registered to the cluster and only returns those that are in the ready state. The ctx parameter supports cancellation and timeouts.

func GetReplicaSetContext ¶ added in v1.0.0

func GetReplicaSetContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, replicaSetName string) *appsv1.ReplicaSet

GetReplicaSetContext returns a Kubernetes replicaset resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetReplicaSetContextE ¶ added in v1.0.0

func GetReplicaSetContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, replicaSetName string) (*appsv1.ReplicaSet, error)

GetReplicaSetContextE returns a Kubernetes replicaset resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts.

func GetRoleContext ¶ added in v1.0.0

func GetRoleContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, roleName string) *rbacv1.Role

GetRoleContext returns a Kubernetes role resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetRoleContextE ¶ added in v1.0.0

func GetRoleContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, roleName string) (*rbacv1.Role, error)

GetRoleContextE returns a Kubernetes role resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts.

func GetSecretContext ¶ added in v1.0.0

func GetSecretContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, secretName string) *corev1.Secret

GetSecretContext returns a Kubernetes secret resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetSecretContextE ¶ added in v1.0.0

func GetSecretContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, secretName string) (*corev1.Secret, error)

GetSecretContextE returns a Kubernetes secret resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts.

func GetServiceAccountAuthTokenContext ¶ added in v1.0.0

func GetServiceAccountAuthTokenContext(t testing.TestingT, ctx context.Context, kubectlOptions *KubectlOptions, serviceAccountName string) string

GetServiceAccountAuthTokenContext will retrieve the ServiceAccount token from the cluster so it can be used to authenticate requests as that ServiceAccount. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetServiceAccountAuthTokenContextE ¶ added in v1.0.0

func GetServiceAccountAuthTokenContextE(t testing.TestingT, ctx context.Context, kubectlOptions *KubectlOptions, serviceAccountName string) (string, error)

GetServiceAccountAuthTokenContextE will retrieve the ServiceAccount token from the cluster so it can be used to authenticate requests as that ServiceAccount. On K8s 1.24+, service account tokens are no longer auto-created as secrets, so this uses the TokenRequest API. The ctx parameter supports cancellation and timeouts.

func GetServiceAccountContext ¶ added in v1.0.0

func GetServiceAccountContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, serviceAccountName string) *corev1.ServiceAccount

GetServiceAccountContext returns a Kubernetes service account resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetServiceAccountContextE ¶ added in v1.0.0

func GetServiceAccountContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, serviceAccountName string) (*corev1.ServiceAccount, error)

GetServiceAccountContextE returns a Kubernetes service account resource in the provided namespace with the given name. The namespace used is the one provided in the KubectlOptions. The ctx parameter supports cancellation and timeouts.

func GetServiceContext ¶ added in v1.0.0

func GetServiceContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, serviceName string) *corev1.Service

GetServiceContext returns a Kubernetes service resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func GetServiceContextE ¶ added in v1.0.0

func GetServiceContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, serviceName string) (*corev1.Service, error)

GetServiceContextE returns a Kubernetes service resource in the provided namespace with the given name. The ctx parameter supports cancellation and timeouts.

func GetServiceEndpointContext ¶ added in v1.0.0

func GetServiceEndpointContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, service *corev1.Service, servicePort int) string

GetServiceEndpointContext will return the service access point using the provided context. If the service endpoint is not ready, will fail the test immediately.

func GetServiceEndpointContextE ¶ added in v1.0.0

func GetServiceEndpointContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, service *corev1.Service, servicePort int) (string, error)

GetServiceEndpointContextE will return the service access point using the provided context and the following logic:

• For ClusterIP service type, return the URL that maps to ClusterIP and Service Port
• For NodePort service type, identify the public IP of the node (if it exists, otherwise return the bound hostname), and the assigned node port for the provided service port, and return the URL that maps to node ip and node port.
• For LoadBalancer service type, return the publicly accessible hostname of the load balancer. If the hostname is empty, it will return the public IP of the LoadBalancer.
• All other service types are not supported.

func IsCronJobSucceeded ¶ added in v0.50.0

func IsCronJobSucceeded(cronJob *batchv1.CronJob) bool

IsCronJobSucceeded returns true if cron job successfully scheduled and completed job. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/cron-job-v1/#CronJobStatus

func IsDaemonSetAvailable ¶ added in v1.0.0

func IsDaemonSetAvailable(ds *appsv1.DaemonSet) bool

IsDaemonSetAvailable returns true once the daemonset's rollout is complete. The check mirrors `kubectl rollout status ds`: the controller has observed the latest spec, every scheduled pod has been updated to the current generation, and every desired pod is available. Status fields are used directly rather than DaemonSetCondition because the controller does not always populate that field.

A daemonset whose node selector matches zero nodes (DesiredNumberScheduled == 0) is treated as available — this matches the kubectl behavior where such a daemonset is considered "successfully rolled out".

func IsDeploymentAvailable ¶ added in v0.41.21

func IsDeploymentAvailable(deploy *appsv1.Deployment) bool

IsDeploymentAvailable returns true if all pods within the deployment are ready and started

func IsIngressAvailable ¶ added in v0.14.5

func IsIngressAvailable(ingress *networkingv1.Ingress) bool

IsIngressAvailable returns true if the Ingress endpoint is provisioned and available.

func IsIngressAvailableV1Beta1 ¶ added in v0.34.0

func IsIngressAvailableV1Beta1(ingress *networkingv1beta1.Ingress) bool

IsIngressAvailableV1Beta1 returns true if the Ingress endpoint is provisioned and available, using networking.k8s.io/v1beta1 API.

func IsJobSucceeded ¶ added in v0.36.7

func IsJobSucceeded(job *batchv1.Job) bool

IsJobSucceeded returns true when the job status condition "Complete" is true. This behavior is documented in the kubernetes API reference: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/job-v1/#JobStatus

func IsMinikubeE ¶ added in v0.23.5

func IsMinikubeE(t testing.TestingT, options *KubectlOptions) (bool, error)

IsMinikubeE returns true if the underlying kubernetes cluster is Minikube. This is determined by getting the associated nodes and checking if all nodes has at least one label namespaced with "minikube.k8s.io".

func IsNodeReady ¶

func IsNodeReady(node corev1.Node) bool

IsNodeReady takes a Kubernetes Node information object and checks if the Node is in the ready state.

func IsPersistentVolumeClaimInStatus ¶ added in v0.41.25

func IsPersistentVolumeClaimInStatus(pvc *corev1.PersistentVolumeClaim, pvcStatusPhase *corev1.PersistentVolumeClaimPhase) bool

IsPersistentVolumeClaimInStatus returns true if the given PersistentVolumeClaim is in the given status phase

func IsPersistentVolumeInStatus ¶ added in v0.41.24

func IsPersistentVolumeInStatus(pv *corev1.PersistentVolume, pvStatusPhase *corev1.PersistentVolumePhase) bool

IsPersistentVolumeInStatus returns true if the given PersistentVolume is in the given status phase

func IsPodAvailable ¶ added in v0.13.21

func IsPodAvailable(pod *corev1.Pod) bool

IsPodAvailable returns true if the all of the containers within the pod are ready and started

func IsServiceAvailable ¶ added in v0.13.16

func IsServiceAvailable(service *corev1.Service) bool

IsServiceAvailable returns true if the service endpoint is ready to accept traffic. Note that for Minikube, this function is moot as all services, even LoadBalancer, is available immediately.

func KubeConfigPathFromHomeDirE ¶ added in v0.13.14

func KubeConfigPathFromHomeDirE() (string, error)

KubeConfigPathFromHomeDirE returns a string to the default Kubernetes config path in the home directory. This will error if the home directory can not be determined.

func KubectlApplyContext ¶ added in v1.0.0

func KubectlApplyContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, configPath string)

KubectlApplyContext applies the resource at configPath to the cluster, using the provided context. Fails the test on error.

func KubectlApplyContextE ¶ added in v1.0.0

func KubectlApplyContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, configPath string) error

KubectlApplyContextE applies the resource at configPath to the cluster, using the provided context.

func KubectlApplyFromKustomizeContext ¶ added in v1.0.0

func KubectlApplyFromKustomizeContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, configPath string)

KubectlApplyFromKustomizeContext applies the kustomization at configPath to the cluster, using the provided context. Fails the test on error.

func KubectlApplyFromKustomizeContextE ¶ added in v1.0.0

func KubectlApplyFromKustomizeContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, configPath string) error

KubectlApplyFromKustomizeContextE applies the kustomization at configPath to the cluster, using the provided context.

func KubectlApplyFromStringContext ¶ added in v1.0.0

func KubectlApplyFromStringContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, configData string)

KubectlApplyFromStringContext applies the kubernetes resource from configData to the cluster, using the provided context. Fails the test on error.

func KubectlApplyFromStringContextE ¶ added in v1.0.0

func KubectlApplyFromStringContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, configData string) error

KubectlApplyFromStringContextE applies the kubernetes resource from configData to the cluster, using the provided context.

func KubectlDeleteContext ¶ added in v1.0.0

func KubectlDeleteContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, configPath string)

KubectlDeleteContext deletes the resource at configPath from the cluster, using the provided context. Fails the test on error.

func KubectlDeleteContextE ¶ added in v1.0.0

func KubectlDeleteContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, configPath string) error

KubectlDeleteContextE deletes the resource at configPath from the cluster, using the provided context.

func KubectlDeleteFromKustomizeContext ¶ added in v1.0.0

func KubectlDeleteFromKustomizeContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, configPath string)

KubectlDeleteFromKustomizeContext deletes the kustomization at configPath from the cluster, using the provided context. Fails the test on error.

func KubectlDeleteFromKustomizeContextE ¶ added in v1.0.0

func KubectlDeleteFromKustomizeContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, configPath string) error

KubectlDeleteFromKustomizeContextE deletes the kustomization at configPath from the cluster, using the provided context.

func KubectlDeleteFromStringContext ¶ added in v1.0.0

func KubectlDeleteFromStringContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, configData string)

KubectlDeleteFromStringContext deletes the kubernetes resource from configData on the cluster, using the provided context. Fails the test on error.

func KubectlDeleteFromStringContextE ¶ added in v1.0.0

func KubectlDeleteFromStringContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, configData string) error

KubectlDeleteFromStringContextE deletes the kubernetes resource from configData on the cluster, using the provided context.

func ListCronJobsContext ¶ added in v1.0.0

func ListCronJobsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []batchv1.CronJob

ListCronJobsContext lists cron jobs in namespace that match provided filters and returns them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListCronJobsContextE ¶ added in v1.0.0

func ListCronJobsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]batchv1.CronJob, error)

ListCronJobsContextE lists cron jobs in namespace that match provided filters and returns them. The ctx parameter supports cancellation and timeouts.

func ListDaemonSetsContext ¶ added in v1.0.0

func ListDaemonSetsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []appsv1.DaemonSet

ListDaemonSetsContext looks up daemonsets in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListDaemonSetsContextE ¶ added in v1.0.0

func ListDaemonSetsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]appsv1.DaemonSet, error)

ListDaemonSetsContextE looks up daemonsets in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func ListDeploymentsContext ¶ added in v1.0.0

func ListDeploymentsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []appsv1.Deployment

ListDeploymentsContext looks up deployments in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListDeploymentsContextE ¶ added in v1.0.0

func ListDeploymentsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]appsv1.Deployment, error)

ListDeploymentsContextE looks up deployments in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func ListEventsContext ¶ added in v1.0.0

func ListEventsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []corev1.Event

ListEventsContext retrieves the Events in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListEventsContextE ¶ added in v1.0.0

func ListEventsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]corev1.Event, error)

ListEventsContextE retrieves the Events in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func ListIngressesContext ¶ added in v1.0.0

func ListIngressesContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []networkingv1.Ingress

ListIngressesContext will look for Ingress resources in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListIngressesContextE ¶ added in v1.0.0

func ListIngressesContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]networkingv1.Ingress, error)

ListIngressesContextE will look for Ingress resources in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func ListIngressesV1Beta1Context ¶ added in v1.0.0

func ListIngressesV1Beta1Context(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []networkingv1beta1.Ingress

ListIngressesV1Beta1Context will look for Ingress resources in the given namespace that match the given filters and return them, using networking.k8s.io/v1beta1 API. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListIngressesV1Beta1ContextE ¶ added in v1.0.0

func ListIngressesV1Beta1ContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]networkingv1beta1.Ingress, error)

ListIngressesV1Beta1ContextE will look for Ingress resources in the given namespace that match the given filters and return them, using networking.k8s.io/v1beta1 API. The ctx parameter supports cancellation and timeouts.

func ListJobsContext ¶ added in v1.0.0

func ListJobsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []batchv1.Job

ListJobsContext looks up Jobs in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListJobsContextE ¶ added in v1.0.0

func ListJobsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]batchv1.Job, error)

ListJobsContextE looks up Jobs in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func ListNamespacesContext ¶ added in v1.0.0

func ListNamespacesContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []corev1.Namespace

ListNamespacesContext lists all namespaces in the Kubernetes cluster that match the given filters and returns them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListNamespacesContextE ¶ added in v1.0.0

func ListNamespacesContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]corev1.Namespace, error)

ListNamespacesContextE lists all namespaces in the Kubernetes cluster that match the given filters and returns them. The ctx parameter supports cancellation and timeouts.

func ListPersistentVolumeClaimsContext ¶ added in v1.0.0

func ListPersistentVolumeClaimsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []corev1.PersistentVolumeClaim

ListPersistentVolumeClaimsContext will look for PersistentVolumeClaims in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListPersistentVolumeClaimsContextE ¶ added in v1.0.0

func ListPersistentVolumeClaimsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]corev1.PersistentVolumeClaim, error)

ListPersistentVolumeClaimsContextE will look for PersistentVolumeClaims in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func ListPersistentVolumesContext ¶ added in v1.0.0

func ListPersistentVolumesContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []corev1.PersistentVolume

ListPersistentVolumesContext will look for PersistentVolumes that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListPersistentVolumesContextE ¶ added in v1.0.0

func ListPersistentVolumesContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]corev1.PersistentVolume, error)

ListPersistentVolumesContextE will look for PersistentVolumes that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func ListPodsContext ¶ added in v1.0.0

func ListPodsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []corev1.Pod

ListPodsContext looks up pods in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListPodsContextE ¶ added in v1.0.0

func ListPodsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]corev1.Pod, error)

ListPodsContextE looks up pods in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func ListReplicaSetsContext ¶ added in v1.0.0

func ListReplicaSetsContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []appsv1.ReplicaSet

ListReplicaSetsContext looks up replicasets in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListReplicaSetsContextE ¶ added in v1.0.0

func ListReplicaSetsContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]appsv1.ReplicaSet, error)

ListReplicaSetsContextE looks up replicasets in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func ListServicesContext ¶ added in v1.0.0

func ListServicesContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) []corev1.Service

ListServicesContext looks up services in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func ListServicesContextE ¶ added in v1.0.0

func ListServicesContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, filters metav1.ListOptions) ([]corev1.Service, error)

ListServicesContextE looks up services in the given namespace that match the given filters and return them. The ctx parameter supports cancellation and timeouts.

func LoadAPIClientConfigE ¶ added in v1.0.0

func LoadAPIClientConfigE(configPath string, contextName string) (*restclient.Config, error)

LoadAPIClientConfigE loads a ClientConfig object from a file path that points to a location on disk containing a kubectl config, with the requested context loaded.

func LoadConfigFromPath ¶

func LoadConfigFromPath(path string) clientcmd.ClientConfig

LoadConfigFromPath will load a ClientConfig object from a file path that points to a location on disk containing a kubectl config.

func RemoveOrphanedClusterAndAuthInfoConfig ¶

func RemoveOrphanedClusterAndAuthInfoConfig(config *api.Config)

RemoveOrphanedClusterAndAuthInfoConfig will remove all configurations related to clusters and users that have no contexts associated with it

func RunKubectlAndGetOutputContextE ¶ added in v1.0.0

func RunKubectlAndGetOutputContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, args ...string) (string, error)

RunKubectlAndGetOutputContextE calls kubectl using the provided context, options, and args, returning the combined output of stdout and stderr.

func RunKubectlContext ¶ added in v1.0.0

func RunKubectlContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, args ...string)

RunKubectlContext calls kubectl using the provided context, options, and args, failing the test on error.

func RunKubectlContextE ¶ added in v1.0.0

func RunKubectlContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, args ...string) error

RunKubectlContextE calls kubectl using the provided context, options, and args.

func StoreConfigToTempFile ¶ added in v0.13.16

func StoreConfigToTempFile(t testing.TestingT, configData string) string

StoreConfigToTempFile will store the provided config data to a temporary file created on the os and return the filename.

func StoreConfigToTempFileE ¶ added in v0.13.16

func StoreConfigToTempFileE(t testing.TestingT, configData string) (string, error)

StoreConfigToTempFileE will store the provided config data to a temporary file created on the os and return the filename, or error.

func UnmarshalJSONPath ¶ added in v0.30.16

func UnmarshalJSONPath(t testing.TestingT, jsonData []byte, jsonpathStr string, output any)

UnmarshalJSONPath allows you to use an arbitrary JSONPath string to query a json blob and unmarshal the resulting output into a go object. Note that the output will always be a list. That means that if you query a single object, the output will be a list of single element, not the element itself. However, if the json path maps to a list, then the output will be that list. Example:

jsonBlob := []byte(`{"key": {"data": [1,2,3]}}`) jsonPath := "{.key.data[*]}" var output []int UnmarshalJSONPath(t, jsonBlob, jsonPath, &output) // output is []int{1,2,3}

This will fail the test if there is an error.

func UnmarshalJSONPathE ¶ added in v0.30.16

func UnmarshalJSONPathE(t testing.TestingT, jsonData []byte, jsonpathStr string, output any) error

UnmarshalJSONPathE allows you to use an arbitrary JSONPath string to query a json blob and unmarshal the resulting output into a go object. Note that the output will always be a list. That means that if you query a single object, the output will be a list of single element, not the element itself. However, if the json path maps to a list, then the output will be that list. Example:

jsonBlob := []byte(`{"key": {"data": [1,2,3]}}`) jsonPath := "{.key.data[*]}" var output []int UnmarshalJSONPathE(t, jsonBlob, jsonPath, &output) => output = []int{1,2,3}

func UpsertConfigContext ¶ added in v0.13.24

func UpsertConfigContext(config *api.Config, contextName string, clusterName string, userName string)

UpsertConfigContext will update or insert a new context to the provided config, binding the provided cluster to the provided user.

func WaitUntilAllNodesReadyContext ¶ added in v1.0.0

func WaitUntilAllNodesReadyContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, retries int, sleepBetweenRetries time.Duration)

WaitUntilAllNodesReadyContext continuously polls the Kubernetes cluster until all nodes in the cluster reach the ready state, or runs out of retries. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilAllNodesReadyContextE ¶ added in v1.0.0

func WaitUntilAllNodesReadyContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, retries int, sleepBetweenRetries time.Duration) error

WaitUntilAllNodesReadyContextE continuously polls the Kubernetes cluster until all nodes in the cluster reach the ready state, or runs out of retries. The ctx parameter supports cancellation and timeouts.

func WaitUntilConfigMapAvailableContext ¶ added in v1.0.0

func WaitUntilConfigMapAvailableContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, configMapName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilConfigMapAvailableContext waits until the configmap is present on the cluster in cases where it is not immediately available (for example, when using ClusterIssuer to request a certificate). The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilConfigMapAvailableContextE ¶ added in v1.0.0

func WaitUntilConfigMapAvailableContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, configMapName string, retries int, sleepBetweenRetries time.Duration) error

WaitUntilConfigMapAvailableContextE waits until the configmap is present on the cluster in cases where it is not immediately available (for example, when using ClusterIssuer to request a certificate). The ctx parameter supports cancellation and timeouts.

func WaitUntilCronJobSucceedContext ¶ added in v1.0.0

func WaitUntilCronJobSucceedContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, cronJobName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilCronJobSucceedContext waits until cron job will successfully complete a job, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilCronJobSucceedContextE ¶ added in v1.0.0

func WaitUntilCronJobSucceedContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, cronJobName string, retries int, sleepBetweenRetries time.Duration) error

WaitUntilCronJobSucceedContextE waits until cron job will successfully complete a job, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts.

func WaitUntilDaemonSetAvailableContext ¶ added in v1.0.0

func WaitUntilDaemonSetAvailableContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, daemonSetName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilDaemonSetAvailableContext waits until all desired pods of the daemonset are available on their nodes, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilDaemonSetAvailableContextE ¶ added in v1.0.0

func WaitUntilDaemonSetAvailableContextE(
	t testing.TestingT,
	ctx context.Context,
	options *KubectlOptions,
	daemonSetName string,
	retries int,
	sleepBetweenRetries time.Duration,
) error

WaitUntilDaemonSetAvailableContextE waits until all desired pods of the daemonset are available on their nodes, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts.

func WaitUntilDeploymentAvailableContext ¶ added in v1.0.0

func WaitUntilDeploymentAvailableContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, deploymentName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilDeploymentAvailableContext waits until all pods within the deployment are ready and started, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilDeploymentAvailableContextE ¶ added in v1.0.0

func WaitUntilDeploymentAvailableContextE(
	t testing.TestingT,
	ctx context.Context,
	options *KubectlOptions,
	deploymentName string,
	retries int,
	sleepBetweenRetries time.Duration,
) error

WaitUntilDeploymentAvailableContextE waits until all pods within the deployment are ready and started, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts.

func WaitUntilIngressAvailableContext ¶ added in v1.0.0

func WaitUntilIngressAvailableContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, ingressName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilIngressAvailableContext waits until the Ingress resource has an endpoint provisioned for it. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilIngressAvailableContextE ¶ added in v1.0.0

func WaitUntilIngressAvailableContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, ingressName string, retries int, sleepBetweenRetries time.Duration) error

WaitUntilIngressAvailableContextE waits until the Ingress resource has an endpoint provisioned for it. The ctx parameter supports cancellation and timeouts.

func WaitUntilIngressAvailableV1Beta1Context ¶ added in v1.0.0

func WaitUntilIngressAvailableV1Beta1Context(t testing.TestingT, ctx context.Context, options *KubectlOptions, ingressName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilIngressAvailableV1Beta1Context waits until the Ingress resource has an endpoint provisioned for it, using networking.k8s.io/v1beta1 API. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilIngressAvailableV1Beta1ContextE ¶ added in v1.0.0

func WaitUntilIngressAvailableV1Beta1ContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, ingressName string, retries int, sleepBetweenRetries time.Duration) error

WaitUntilIngressAvailableV1Beta1ContextE waits until the Ingress resource has an endpoint provisioned for it, using networking.k8s.io/v1beta1 API. The ctx parameter supports cancellation and timeouts.

func WaitUntilJobSucceedContext ¶ added in v1.0.0

func WaitUntilJobSucceedContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, jobName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilJobSucceedContext waits until requested job is succeeded, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilJobSucceedContextE ¶ added in v1.0.0

func WaitUntilJobSucceedContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, jobName string, retries int, sleepBetweenRetries time.Duration) error

WaitUntilJobSucceedContextE waits until requested job is succeeded, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts.

func WaitUntilNetworkPolicyAvailableContext ¶ added in v1.0.0

func WaitUntilNetworkPolicyAvailableContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, networkPolicyName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilNetworkPolicyAvailableContext waits until the networkpolicy is present on the cluster in cases where it is not immediately available (for example, when using ClusterIssuer to request a certificate). The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilNetworkPolicyAvailableContextE ¶ added in v1.0.0

func WaitUntilNetworkPolicyAvailableContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, networkPolicyName string, retries int, sleepBetweenRetries time.Duration) error

WaitUntilNetworkPolicyAvailableContextE waits until the networkpolicy is present on the cluster in cases where it is not immediately available (for example, when using ClusterIssuer to request a certificate). The ctx parameter supports cancellation and timeouts.

func WaitUntilNumPodsCreatedContext ¶ added in v1.0.0

func WaitUntilNumPodsCreatedContext(
	t testing.TestingT,
	ctx context.Context,
	options *KubectlOptions,
	filters metav1.ListOptions,
	desiredCount int,
	retries int,
	sleepBetweenRetries time.Duration,
)

WaitUntilNumPodsCreatedContext waits until the desired number of pods are created that match the provided filter. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilNumPodsCreatedContextE ¶ added in v1.0.0

func WaitUntilNumPodsCreatedContextE(
	t testing.TestingT,
	ctx context.Context,
	options *KubectlOptions,
	filters metav1.ListOptions,
	desiredCount int,
	retries int,
	sleepBetweenRetries time.Duration,
) error

WaitUntilNumPodsCreatedContextE waits until the desired number of pods are created that match the provided filter. The ctx parameter supports cancellation and timeouts.

func WaitUntilPersistentVolumeClaimInStatusContext ¶ added in v1.0.0

func WaitUntilPersistentVolumeClaimInStatusContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, pvcName string, pvcStatusPhase *corev1.PersistentVolumeClaimPhase, retries int, sleepBetweenRetries time.Duration)

WaitUntilPersistentVolumeClaimInStatusContext waits until the given PersistentVolumeClaim is the given status phase, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilPersistentVolumeClaimInStatusContextE ¶ added in v1.0.0

func WaitUntilPersistentVolumeClaimInStatusContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, pvcName string, pvcStatusPhase *corev1.PersistentVolumeClaimPhase, retries int, sleepBetweenRetries time.Duration) error

WaitUntilPersistentVolumeClaimInStatusContextE waits until the given PersistentVolumeClaim is the given status phase, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts.

func WaitUntilPersistentVolumeInStatusContext ¶ added in v1.0.0

func WaitUntilPersistentVolumeInStatusContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, pvName string, pvStatusPhase *corev1.PersistentVolumePhase, retries int, sleepBetweenRetries time.Duration)

WaitUntilPersistentVolumeInStatusContext waits until the given PersistentVolume is in the given status phase, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilPersistentVolumeInStatusContextE ¶ added in v1.0.0

func WaitUntilPersistentVolumeInStatusContextE(
	t testing.TestingT,
	ctx context.Context,
	options *KubectlOptions,
	pvName string,
	pvStatusPhase *corev1.PersistentVolumePhase,
	retries int,
	sleepBetweenRetries time.Duration,
) error

WaitUntilPersistentVolumeInStatusContextE waits until the given PersistentVolume is in the given status phase, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts.

func WaitUntilPodAvailableContext ¶ added in v1.0.0

func WaitUntilPodAvailableContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, podName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilPodAvailableContext waits until all of the containers within the pod are ready and started, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilPodAvailableContextE ¶ added in v1.0.0

func WaitUntilPodAvailableContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, podName string, retries int, sleepBetweenRetries time.Duration) error

WaitUntilPodAvailableContextE waits until all of the containers within the pod are ready and started, retrying the check for the specified amount of times, sleeping for the provided duration between each try. The ctx parameter supports cancellation and timeouts.

func WaitUntilSecretAvailableContext ¶ added in v1.0.0

func WaitUntilSecretAvailableContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, secretName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilSecretAvailableContext waits until the secret is present on the cluster in cases where it is not immediately available (for example, when using ClusterIssuer to request a certificate). The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilSecretAvailableContextE ¶ added in v1.0.0

func WaitUntilSecretAvailableContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, secretName string, retries int, sleepBetweenRetries time.Duration) error

WaitUntilSecretAvailableContextE waits until the secret is present on the cluster in cases where it is not immediately available (for example, when using ClusterIssuer to request a certificate). The ctx parameter supports cancellation and timeouts.

func WaitUntilServiceAvailableContext ¶ added in v1.0.0

func WaitUntilServiceAvailableContext(t testing.TestingT, ctx context.Context, options *KubectlOptions, serviceName string, retries int, sleepBetweenRetries time.Duration)

WaitUntilServiceAvailableContext waits until the service endpoint is ready to accept traffic. The ctx parameter supports cancellation and timeouts. This will fail the test if there is an error.

func WaitUntilServiceAvailableContextE ¶ added in v1.0.0

func WaitUntilServiceAvailableContextE(t testing.TestingT, ctx context.Context, options *KubectlOptions, serviceName string, retries int, sleepBetweenRetries time.Duration) error

WaitUntilServiceAvailableContextE waits until the service endpoint is ready to accept traffic. The ctx parameter supports cancellation and timeouts.