Merge pull request #7269 from chrischdi/pr-log-improvements

🌱 Improve logging in test/framework

Author: k8s-ci-robot

docs/book/src/developer/providers/v1.2-to-v1.3.md

@@ -46,3 +46,7 @@ The default value is 0, meaning that the volume can be detached without any time
 - Custer API introduced new [logging guidelines](../../developer/logging.md). All reconcilers in the core repository were updated
   to [log the entire object hierarchy](../../developer/logging.md#keyvalue-pairs). It would be great if providers would be adjusted 
   as well to make it possible to cross-reference log entries across providers (please see CAPD for an infra provider reference implementation). 
+- The `CreateLogFile` function and `CreateLogFileInput` struct in the E2E test framework for clusterctl has been renamed to `OpenLogFile` and `OpenLogFileInput` because the function will now append to the logfile instead of truncating the content.
+- The `Move` function in E2E test framework for clusterctl has been modified to:
+  * print the `clusterctl move` command including the arguments similar to `Init`.
+  * log the output to the a `clusterctl-move.log` file at the subdirectory `logs/<namespace>`.

test/framework/clusterctl/client.go

@@ -21,6 +21,7 @@ import (
 	"fmt"
 	"os"
 	"os/exec"
+	"path"
 	"path/filepath"
 	"strings"
 
@@ -315,11 +316,17 @@ func Move(ctx context.Context, input MoveInput) {
 	Expect(input.ClusterctlConfigPath).To(BeAnExistingFile(), "Invalid argument. input.ClusterctlConfigPath must be an existing file when calling Move")
 	Expect(input.FromKubeconfigPath).To(BeAnExistingFile(), "Invalid argument. input.FromKubeconfigPath must be an existing file when calling Move")
 	Expect(input.ToKubeconfigPath).To(BeAnExistingFile(), "Invalid argument. input.ToKubeconfigPath must be an existing file when calling Move")
-	Expect(os.MkdirAll(input.LogFolder, 0750)).To(Succeed(), "Invalid argument. input.LogFolder can't be created for Move")
+	logDir := path.Join(input.LogFolder, "logs", input.Namespace)
+	Expect(os.MkdirAll(logDir, 0750)).To(Succeed(), "Invalid argument. input.LogFolder can't be created for Move")
 
 	By("Moving workload clusters")
+	log.Logf("clusterctl move --from-kubeconfig %s --to-kubeconfig %s --namespace %s",
+		input.FromKubeconfigPath,
+		input.ToKubeconfigPath,
+		input.Namespace,
+	)
 
-	clusterctlClient, log := getClusterctlClientWithLogger(input.ClusterctlConfigPath, "clusterctl-move.log", input.LogFolder)
+	clusterctlClient, log := getClusterctlClientWithLogger(input.ClusterctlConfigPath, "clusterctl-move.log", logDir)
 	defer log.Close()
 	options := clusterctlclient.MoveOptions{
 		FromKubeconfig: clusterctlclient.Kubeconfig{Path: input.FromKubeconfigPath, Context: ""},
@@ -331,7 +338,7 @@ func Move(ctx context.Context, input MoveInput) {
 }
 
 func getClusterctlClientWithLogger(configPath, logName, logFolder string) (clusterctlclient.Client, *logger.LogFile) {
-	log := logger.CreateLogFile(logger.CreateLogFileInput{
+	log := logger.OpenLogFile(logger.OpenLogFileInput{
 		LogFolder: logFolder,
 		Name:      logName,
 	})

test/framework/clusterctl/logger/log_file.go

@@ -27,16 +27,16 @@ import (
 
 // Provides a log_file that can be used to store the logs generated by clusterctl actions.
 
-type CreateLogFileInput struct {
+type OpenLogFileInput struct {
 	LogFolder string
 	Name      string
 }
 
-func CreateLogFile(input CreateLogFileInput) *LogFile {
+func OpenLogFile(input OpenLogFileInput) *LogFile {
 	filePath := filepath.Join(input.LogFolder, input.Name)
 	Expect(os.MkdirAll(filepath.Dir(filePath), 0750)).To(Succeed(), "Failed to create log folder %s", filepath.Dir(filePath))
 
-	f, err := os.Create(filePath) //nolint:gosec // No security issue: filepath is safe.
+	f, err := os.OpenFile(filePath, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666) //nolint:gosec // No security issue: filepath is safe.
 	Expect(err).ToNot(HaveOccurred(), "Failed to create log file %s", filePath)
 
 	return &LogFile{