fix review comments

Author: aganesh-suse

pkg/testcase/upgradenodereplacement.go

@@ -442,8 +442,10 @@ func validateNodeJoin(ip string) error {
 func serverJoin(cluster *shared.Cluster,
 	awsClient *aws.Client,
 	serverLeaderIP, token, version, channel, newExternalIP, newPrivateIP string) error {
+	// All non-slemicro, we do install and enable services in the same step using 'both' keyword
 	installOrBoth := "both"
 	if cluster.NodeOS == "slemicro" {
+		// For slemicro nodes, we perform only 'install' step at this stage.
 		installOrBoth = "install"
 		shared.LogLevel("debug", "Running Install on: %s", newExternalIP)
 	}
@@ -488,7 +490,7 @@ func joinSteps(cluster *shared.Cluster,
 	} else {
 		delayTime = false
 	}
-	if executeErr := execute(joinCmd, newExternalIP, delayTime); executeErr != nil {
+	if executeErr := executeJoinCmd(joinCmd, newExternalIP, delayTime); executeErr != nil {
 		return shared.ReturnLogError("error performing install or enable action on node: %s %w\n",
 			installEnableOrBoth, executeErr)
 	}
@@ -588,8 +590,10 @@ func deleteAgents(a *aws.Client, c *shared.Cluster) error {
 
 func joinAgent(cluster *shared.Cluster, awsClient *aws.Client,
 	serverIp, token, version, channel, selfExternalIp, selfPrivateIp string) error {
+	// All non-slemicro, we perform install and enable services in the same step with 'both' keyword.
 	installOrBoth := "both"
 	if cluster.NodeOS == "slemicro" {
+		// We do only 'install' first in slemicro case
 		installOrBoth = "install"
 		shared.LogLevel("debug", "Running Install step for ip: %s", selfExternalIp)
 	}
@@ -601,9 +605,9 @@ func joinAgent(cluster *shared.Cluster, awsClient *aws.Client,
 	}
 	var joinErr error
 	if installOrBoth == "both" {
-		joinErr = execute(cmd, selfExternalIp, true)
+		joinErr = executeJoinCmd(cmd, selfExternalIp, true)
 	} else {
-		joinErr = execute(cmd, selfExternalIp, false)
+		joinErr = executeJoinCmd(cmd, selfExternalIp, false)
 	}
 
 	if joinErr != nil {
@@ -620,15 +624,15 @@ func joinAgent(cluster *shared.Cluster, awsClient *aws.Client,
 			return shared.ReturnLogError("error parsing enable commands: %w\n", parseErr)
 		}
 
-		if joinErr := execute(cmd, selfExternalIp, true); joinErr != nil {
+		if joinErr := executeJoinCmd(cmd, selfExternalIp, true); joinErr != nil {
 			return shared.ReturnLogError("error enabling services during join of agent node: %w\n", joinErr)
 		}
 	}
 
 	return nil
 }
 
-func execute(cmd, ip string, delayTime bool) error {
+func executeJoinCmd(cmd, ip string, delayTime bool) error {
 	if cmd == "" {
 		return shared.ReturnLogError("cmd not sent\n")
 	}

shared/aux.go

@@ -552,6 +552,8 @@ func SystemCtlCmd(service, action string) (string, error) {
 	return fmt.Sprintf("%s %s", sysctlPrefix, service), nil
 }
 
+// Create a directory if it does not exist.
+// Optional: If chmodValue is not empty, Run chmod to change permission of the directory.
 func CreateDir(dir, chmodValue, ip string) {
 	cmdPart1 := fmt.Sprintf("test -d '%s' && echo 'directory exists: %s'", dir, dir)
 	cmdPart2 := "sudo mkdir -p " + dir
@@ -570,6 +572,8 @@ func CreateDir(dir, chmodValue, ip string) {
 	}
 }
 
+// Wait for SSH to a node ip to be ready.
+// Default max wait time: 3 mins. Retry 'SSH is ready' check every 10 seconds.
 func WaitForSSHReady(ip string) error {
 	ticker := time.NewTicker(10 * time.Second)
 	timeout := time.After(3 * time.Minute)
@@ -591,6 +595,8 @@ func WaitForSSHReady(ip string) error {
 	}
 }
 
+// Grep for a particular text/string from a filename and log the same.
+// Ex: Log content:'denied' calls in filename:'/var/log/audit/audit.log' file.
 func LogGrepOutput(filename, content, ip string) {
 	cmd := fmt.Sprintf("sudo cat %s | grep %s", filename, content)
 	grepData, grepErr := RunCommandOnNode(cmd, ip)

shared/cluster.go

@@ -723,6 +723,7 @@ func ExtractKubeImageVersion() string {
 	return version
 }
 
+// Runs and logs kubectl describe pod command
 func DescribePod(cluster *Cluster, pod *Pod) {
 	cmd := fmt.Sprintf("%s -n %s", pod.Name, pod.NameSpace)
 	output, describeErr := KubectlCommand(cluster, "node", "describe", "pod", cmd)
@@ -735,6 +736,7 @@ func DescribePod(cluster *Cluster, pod *Pod) {
 	}
 }
 
+// Runs and logs: kubectl logs command output
 func PodLogs(cluster *Cluster, pod *Pod) {
 	if pod.NameSpace == "" || pod.Name == "" {
 		LogLevel("warn", "Name or Namespace info in pod data is empty. kubectl logs cmd may not work")
@@ -750,6 +752,9 @@ func PodLogs(cluster *Cluster, pod *Pod) {
 	}
 }
 
+// Given a namespace, this function:
+// 1.  filters ALL pods in the namespace
+// 2.  logs both kubectl describe pod and kubectl logs output for each pod in the namespace
 func LogAllPodsForNamespace(namespace string) {
 	LogLevel("debug", "logging pod logs and describe pod output for all pods with namespace: %s", namespace)
 	filters := map[string]string{
@@ -768,6 +773,9 @@ func LogAllPodsForNamespace(namespace string) {
 	}
 }
 
+// Search and log for a particular pod(s) given its unique name substring and namespace. Ex: coredns, kube-system
+// 1. Filter based on the name substring, and find the right pod(s)
+// 2. For the pods matching the name, logs: kubectl describe pod and kubectl logs output
 func FindPodAndLog(name, namespace string) {
 	LogLevel("debug",
 		"find and log(pod logs and describe pod) for pod starting with %s for namespace %s", name, namespace)