Add ExternalName support

Author: EraYaN

README.md

@@ -21,7 +21,8 @@ For pods it waits until the pod is Ready (`k8s.io/kubectl/pkg/util/podutils.IsPo
 
 For jobs it wait until the `Completed` condition is true.
 
-For services it will wait until all pods that match the service selector are Ready (like above).
+For services it will wait until all pods that match the service selector are Ready (like above). 
+If it is an `ExternalName` service it is always assumed to be ready.
 
 ## Example
 

cmd/wait.go

@@ -235,5 +235,4 @@ func handleEvent[V *corev1.Pod | *corev1.Service | *batchv1.Job](ctx context.Con
 			processCompletion()
 		}
 	}
-
 }

pkg/handlers.go

@@ -37,6 +37,7 @@ func (w *Waitables) ProcessEventAddService(ctx context.Context, svc *corev1.Serv
 		}
 
 		w.SetServiceChildren(&svc.ObjectMeta, pods.Items)
+		w.SetServiceExternality(&svc.ObjectMeta, svc.Spec.Type == corev1.ServiceTypeExternalName)
 		return true, nil
 	}
 	return false, nil
@@ -52,6 +53,7 @@ func (w *Waitables) ProcessEventUpdateService(ctx context.Context, svc *corev1.S
 		}
 
 		w.SetServiceChildren(&svc.ObjectMeta, pods.Items)
+		w.SetServiceExternality(&svc.ObjectMeta, svc.Spec.Type == corev1.ServiceTypeExternalName)
 		return true, nil
 	}
 	return false, nil
@@ -62,6 +64,7 @@ func (w *Waitables) ProcessEventDeleteService(ctx context.Context, svc *corev1.S
 		//log.Printf("Delete %T %s %s", svc, svc.Namespace, svc.Name)
 
 		w.SetServiceChildren(&svc.ObjectMeta, nil)
+		w.SetServiceExternality(&svc.ObjectMeta, svc.Spec.Type == corev1.ServiceTypeExternalName)
 		return true, nil
 	}
 	return false, nil
@@ -71,11 +74,12 @@ func (w *Waitables) ProcessOldPodEvents(ctx context.Context, pod *corev1.Pod) (b
 	if val, ok := w.LastPodEvents[pod.UID]; ok {
 		//log.Printf("Running LastPodEvents for %s/%s of type %v", pod.Namespace, pod.Name, val.EventType)
 		//defer delete(w.LastPodEvents, pod.UID)
-		if val.EventType == EventTypeAdd {
+		switch val.EventType {
+		case EventTypeAdd:
 			return w.ProcessEventAddPod(ctx, pod)
-		} else if val.EventType == EventTypeUpdate {
+		case EventTypeUpdate:
 			return w.ProcessEventUpdatePod(ctx, pod)
-		} else if val.EventType == EventTypeDelete {
+		case EventTypeDelete:
 			return w.ProcessEventDeletePod(ctx, pod)
 		}
 	}

pkg/items/service.go

@@ -21,16 +21,18 @@ type NamespacedServiceCollection map[string]ServiceCollection
 type ServiceCollection map[string]*ServiceItem
 
 type ServiceItem struct {
-	namespace string
-	name      string
-	children  PodCollection
+	namespace  string
+	name       string
+	children   PodCollection
+	isExternal bool
 }
 
 func Service(ns string, n string) *ServiceItem {
 	return &ServiceItem{
-		namespace: ns,
-		name:      n,
-		children:  nil,
+		namespace:  ns,
+		name:       n,
+		children:   nil,
+		isExternal: false,
 	}
 }
 
@@ -43,8 +45,24 @@ func (i *ServiceItem) WithChildren(children PodCollection) *ServiceItem {
 	return i
 }
 
+func (i *ServiceItem) WithExternal(isExternal bool) *ServiceItem {
+	i.isExternal = isExternal
+	if i.isExternal {
+		i.children = nil
+	}
+	return i
+}
+
+func (i *ServiceItem) IsExternal() bool {
+	return i.isExternal
+}
+
 func (i *ServiceItem) IsAvailable() bool {
-	if i.children == nil || len(i.children) == 0 {
+	if i.isExternal {
+		return true
+	}
+
+	if len(i.children) == 0 {
 		return false
 	}
 
@@ -57,7 +75,11 @@ func (i *ServiceItem) IsAvailable() bool {
 }
 
 func (i *ServiceItem) IsAtLeastOneAvailable() bool {
-	if i.children == nil || len(i.children) == 0 {
+	if i.isExternal {
+		return true
+	}
+
+	if len(i.children) == 0 {
 		return false
 	}
 

pkg/waitables.go

@@ -55,13 +55,14 @@ type Waitables struct {
 }
 
 func (w *Waitables) AddItem(kind string, namespace string, name string) error {
-	if kind == "pod" {
+	switch kind {
+	case "pod":
 		w.addPod(namespace, name)
-	} else if kind == "job" {
+	case "job":
 		w.addJob(namespace, name)
-	} else if kind == "service" {
+	case "service":
 		w.addService(namespace, name)
-	} else {
+	default:
 		return fmt.Errorf("unsupported kind '%s'", kind)
 	}
 	return nil
@@ -180,21 +181,31 @@ func (w *Waitables) getStatusTreeString() string {
 			status := "Unavailable"
 			svcIsAvailable := (!w.onlyOnePerServiceRequired && val.IsAvailable()) || (w.onlyOnePerServiceRequired && val.IsAtLeastOneAvailable())
 			if svcIsAvailable {
-				status = "Available"
+				if val.IsExternal() {
+					status = "External"
+				} else {
+					status = "Available"
+				}
 			}
-			svc_branch := branch.AddMetaBranch(TreeStatusUnknown, fmt.Sprintf("service/%s: %s", n, status))
-
-			for podname, pod := range *val.GetChildren() {
-				status := "NotReady"
-				meta := TreeStatusNotDone
-				if pod.IsReady() {
-					status = "Ready"
-					meta = TreeStatusDone
-				} else if w.onlyOnePerServiceRequired && svcIsAvailable {
-					status = "Ignored"
-					meta = TreeStatusIgnored
+			var svc_branch treeprint.Tree
+
+			if val.IsExternal() {
+				svc_branch = branch.AddMetaBranch(TreeStatusDone, fmt.Sprintf("service/%s: %s", n, status))
+			} else {
+				svc_branch = branch.AddMetaBranch(TreeStatusUnknown, fmt.Sprintf("service/%s: %s", n, status))
+
+				for podname, pod := range *val.GetChildren() {
+					status := "NotReady"
+					meta := TreeStatusNotDone
+					if pod.IsReady() {
+						status = "Ready"
+						meta = TreeStatusDone
+					} else if w.onlyOnePerServiceRequired && svcIsAvailable {
+						status = "Ignored"
+						meta = TreeStatusIgnored
+					}
+					svc_branch.AddMetaNode(meta, fmt.Sprintf("pod/%s: %s", podname, status))
 				}
-				svc_branch.AddMetaNode(meta, fmt.Sprintf("pod/%s: %s", podname, status))
 			}
 		}
 	}
@@ -264,6 +275,10 @@ func (w *Waitables) SetServiceChildren(meta *metav1.ObjectMeta, pods []corev1.Po
 	w.Services[meta.Namespace][meta.Name].WithChildren(podItems)
 }
 
+func (w *Waitables) SetServiceExternality(meta *metav1.ObjectMeta, isExternal bool) {
+	w.Services[meta.Namespace][meta.Name].WithExternal(isExternal)
+}
+
 func (w *Waitables) TotalCount() int {
 	return w.Services.TotalCount() + w.Pods.TotalCount() + w.Jobs.TotalCount()
 }