chore : simplifying the KubeAid Bootstrap Script temp directory name | fix : returning aggregated stdout contents and erroring out immediately on error, while command execution

Signed-off-by: Archisman <[email protected]>

Author: Archisman-Mridha

pkg/constants/constants.go

@@ -5,6 +5,14 @@ import (
 	"time"
 )
 
+var (
+	TempDirectoryName = "kubeaid-bootstrap-script"
+	TempDirectory     = "/tmp/" + TempDirectoryName
+
+	KubeAidDirectory       = path.Join(TempDirectory, "KubeAid")
+	KubeAidConfigDirectory = path.Join(TempDirectory, "kubeaid-config")
+)
+
 // Environment variable names.
 const (
 	EnvNameAWSAccessKey            = "AWS_ACCESS_KEY_ID"

pkg/core/create_dev_env.go

@@ -43,7 +43,7 @@ func CreateDevEnv(ctx context.Context, args *CreateDevEnvArgs) {
 	// Clone the KubeAid config fork locally (if not already cloned).
 	_ = gitUtils.CloneRepo(ctx,
 		config.ParsedGeneralConfig.Forks.KubeaidConfigForkURL,
-		utils.GetKubeAidConfigDir(),
+		constants.KubeAidConfigDirectory,
 		gitAuthMethod,
 	)
 

pkg/core/setup_cluster.go

@@ -40,7 +40,7 @@ func SetupCluster(ctx context.Context, args SetupClusterArgs) {
 		// Clone the KubeAid fork locally (if not already cloned).
 		kubeAidRepo := gitUtils.CloneRepo(ctx,
 			config.ParsedGeneralConfig.Forks.KubeaidForkURL,
-			utils.GetKubeAidDir(),
+			constants.KubeAidDirectory,
 			args.GitAuthMethod,
 		)
 

pkg/core/setup_kubeaid_config.go

@@ -43,7 +43,7 @@ It expects the KubeAid Config repository to be already cloned in the temp direct
 func SetupKubeAidConfig(ctx context.Context, args SetupKubeAidConfigArgs) {
 	slog.InfoContext(ctx, "Setting up KubeAid config repo")
 
-	repo, err := goGit.PlainOpen(utils.GetKubeAidConfigDir())
+	repo, err := goGit.PlainOpen(constants.KubeAidConfigDirectory)
 	assert.AssertErrNil(ctx, err, "Failed opening existing git repo")
 
 	workTree, err := repo.Worktree()
@@ -249,8 +249,8 @@ func buildKubePrometheus(ctx context.Context, clusterDir string, templateValues
 
 	// Run the KubePrometheus build script.
 	slog.InfoContext(ctx, "Running KubePrometheus build script...")
-	kubePrometheusBuildScriptPath := fmt.Sprintf("%s/build/kube-prometheus/build.sh",
-		utils.GetKubeAidDir(),
+	kubePrometheusBuildScriptPath := path.Join(
+		constants.KubeAidDirectory, "build/kube-prometheus/build.sh",
 	)
 	utils.ExecuteCommandOrDie(fmt.Sprintf("%s %s", kubePrometheusBuildScriptPath, clusterDir))
 }

pkg/core/upgrade_cluster.go

@@ -89,7 +89,7 @@ func updateCapiClusterValuesFile(ctx context.Context, args *UpgradeClusterArgs)
 	// Clone the KubeAid config fork locally (if not already cloned).
 	repo := git.CloneRepo(ctx,
 		config.ParsedGeneralConfig.Forks.KubeaidConfigForkURL,
-		utils.GetKubeAidConfigDir(),
+		constants.KubeAidConfigDirectory,
 		gitAuthMethod,
 	)
 

pkg/globals/globals.go

@@ -11,8 +11,6 @@ import (
 var (
 	ConfigsDirectory,
 
-	TempDir,
-
 	CloudProviderName string
 	CloudProvider cloud.CloudProvider
 

pkg/utils/command.go

@@ -2,6 +2,7 @@ package utils
 
 import (
 	"context"
+	"errors"
 	"log/slog"
 	"strings"
 
@@ -15,33 +16,39 @@ import (
 
 // Executes the given command.
 // The command output is streamed to the standard output.
-func ExecuteCommand(command string) (output string, err error) {
+func ExecuteCommand(command string) (stdOutOutput string, err error) {
 	slog.Info("Executing command", slog.String("command", sensorCredentials(command)))
 
 	commandExecutionOptions := cmd.Options{
-		CombinedOutput: true,
-		Streaming:      true,
+		Streaming: true,
 	}
 	commandExecutor := cmd.NewCmdOptions(commandExecutionOptions,
 		"sh", "-c", command,
 	)
 
-	// Stream the command execution output to the standard output.
+	// Execute the command,
+	// while streaming the stdout contents to the user.
 	for !commandExecutor.Status().Complete {
 		select {
-		case outputLine := <-commandExecutor.Stdout:
-			println(outputLine)
+		case output := <-commandExecutor.Stdout:
+			println(output)
 
-		case outputLine := <-commandExecutor.Stderr:
-			println(outputLine)
+			// Keep aggregating the stdout contents in stdOutOutput.
+			// We need to return the aggregated result to the invoker.
+			stdOutOutput += output
+
+		case output := <-commandExecutor.Stderr:
+			// Error occurred, while execution some portion of the command.
+			// We'll not execute the remaining portion of the command,
+			// but just return the aggregated stdout contents and the error that occurred.
+			if len(output) > 0 {
+				return stdOutOutput, errors.New(output)
+			}
 
 		case <-commandExecutor.Start():
 		}
 	}
-
-	output = strings.Join(commandExecutor.Status().Stdout, "")
-	err = commandExecutor.Status().Error
-	return
+	return stdOutOutput, nil
 }
 
 // Executes the given command. Panics if the command execution fails.

pkg/utils/fs.go

@@ -2,58 +2,45 @@ package utils
 
 import (
 	"context"
-	"fmt"
 	"io"
 	"log/slog"
 	"net/url"
 	"os"
 	"path"
 	"path/filepath"
 	"strings"
-	"time"
 
 	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/config"
-	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/globals"
+	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/constants"
 	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/utils/assert"
+	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/utils/logger"
 )
 
 // Creates a temp dir inside /tmp, where KubeAid Bootstrap Script will clone repos.
 // Then sets the value of constants.TempDir as the temp dir path.
 // If the temp dir already exists, then that gets reused.
 func InitTempDir(ctx context.Context) {
-	namePrefix := "kubeaid-bootstrap-script-"
+	ctx = logger.AppendSlogAttributesToCtx(ctx, []slog.Attr{
+		slog.String("path", constants.TempDirectory),
+	})
 
 	// Check if a temp dir already exists for KubeAid Bootstrap Script.
 	// If yes, then reuse that.
 	filesAndFolders, err := os.ReadDir("/tmp")
 	assert.AssertErrNil(ctx, err, "Failed listing files and folders in /tmp")
 	for _, item := range filesAndFolders {
-		if item.IsDir() && strings.HasPrefix(item.Name(), namePrefix) {
-			path := "/tmp/" + item.Name()
-			slog.InfoContext(ctx,
-				"Skipped creating temp dir, since it already exists",
-				slog.String("path", path),
-			)
-
-			globals.TempDir = path
-
+		if item.IsDir() && (item.Name() == constants.TempDirectory) {
+			slog.InfoContext(ctx, "Skipped creating temp dir, since it already exists")
 			return
 		}
 	}
 
 	// Otherwise, create it.
 
-	dirName := fmt.Sprintf("%s%d", namePrefix, time.Now().Unix())
-
-	path, err := os.MkdirTemp("/tmp", dirName)
-	assert.AssertErrNil(ctx, err,
-		"Failed creating temp dir",
-		slog.String("path", path),
-	)
+	path, err := os.MkdirTemp("/tmp", constants.TempDirectoryName)
+	assert.AssertErrNil(ctx, err, "Failed creating temp dir")
 
 	slog.InfoContext(ctx, "Created temp dir", slog.String("path", path))
-
-	globals.TempDir = path
 }
 
 // Returns path to the parent dir of the given file.
@@ -76,27 +63,15 @@ func CreateIntermediateDirsForFile(ctx context.Context, filePath string) {
 	)
 }
 
-// Returns path to the directory (in temp directory), where the KubeAid repo is / will be cloned.
-func GetKubeAidDir() string {
-	return path.Join(globals.TempDir, "KubeAid")
-}
-
-// Returns path to the directory (in temp directory), where the customer's KubeAid Config repo
-// is / will be cloned.
-func GetKubeAidConfigDir() string {
-	return path.Join(globals.TempDir, "kubeaid-config")
-}
-
 // Returns path to the directory containing cluster specific config, in the KubeAid Config dir.
 func GetClusterDir() string {
-	clusterDir := path.Join(GetKubeAidConfigDir(), "k8s", config.ParsedGeneralConfig.Cluster.Name)
-	return clusterDir
+	return path.Join(constants.KubeAidConfigDirectory, "k8s", config.ParsedGeneralConfig.Cluster.Name)
 }
 
 // Returns the path to the local temp directory, where contents of the given blob storage bucket
 // will be / is downloaded.
 func GetDownloadedStorageBucketContentsDir(bucketName string) string {
-	return path.Join(globals.TempDir, "buckets", bucketName)
+	return path.Join(constants.TempDirectory, "buckets", bucketName)
 }
 
 // Converts the given relative path to an absolute path.

pkg/utils/kubernetes/argo.go

@@ -62,11 +62,14 @@ func InstallAndSetupArgoCD(ctx context.Context, clusterDir string, clusterClient
 		if err == nil {
 			break
 		}
+
+		// Retry after 10 seconds.
+		time.Sleep(10 * time.Second)
 	}
 
 	// Install the ArgoCD Helm chart.
 	HelmInstall(ctx, &HelmInstallArgs{
-		ChartPath: path.Join(utils.GetKubeAidDir(), "argocd-helm-charts/argo-cd"),
+		ChartPath: path.Join(constants.KubeAidDirectory, "argocd-helm-charts/argo-cd"),
 
 		Namespace:   constants.NamespaceArgoCD,
 		ReleaseName: constants.ReleaseNameArgoCD,

pkg/utils/kubernetes/sealed_secrets.go

@@ -15,15 +15,14 @@ import (
 	"k8s.io/client-go/tools/clientcmd"
 
 	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/constants"
-	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/utils"
 	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/utils/assert"
 	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/utils/logger"
 )
 
 // Performs a minimal installation of Sealed Secrets in the underlying Kubernetes cluster.
 func InstallSealedSecrets(ctx context.Context) {
 	HelmInstall(ctx, &HelmInstallArgs{
-		ChartPath:   path.Join(utils.GetKubeAidDir(), "argocd-helm-charts/sealed-secrets"),
+		ChartPath:   path.Join(constants.KubeAidDirectory, "argocd-helm-charts/sealed-secrets"),
 		Namespace:   constants.NamespaceSealedSecrets,
 		ReleaseName: "sealed-secrets",
 		Values: &values.Options{