Merge pull request #5367 from sbueringer/pr-e2e-timestamps

🌱 E2E: Enable logging to a file with prefixed timestamps

Author: k8s-ci-robot

test/e2e/e2e_suite_test.go

@@ -36,6 +36,7 @@ import (
 	"sigs.k8s.io/cluster-api/test/framework"
 	"sigs.k8s.io/cluster-api/test/framework/bootstrap"
 	"sigs.k8s.io/cluster-api/test/framework/clusterctl"
+	"sigs.k8s.io/cluster-api/test/framework/ginkgoextensions"
 )
 
 // Test suite flags
@@ -49,6 +50,10 @@ var (
 	// artifactFolder is the folder to store e2e test artifacts.
 	artifactFolder string
 
+	// alsoLogToFile enables additional logging to the 'ginkgo-log.txt' file in the artifact folder.
+	// These logs also contain timestamps.
+	alsoLogToFile bool
+
 	// skipCleanup prevents cleanup of test resources e.g. for debug purposes.
 	skipCleanup bool
 )
@@ -75,6 +80,7 @@ var (
 func init() {
 	flag.StringVar(&configPath, "e2e.config", "", "path to the e2e config file")
 	flag.StringVar(&artifactFolder, "e2e.artifacts-folder", "", "folder where e2e test artifact should be stored")
+	flag.BoolVar(&alsoLogToFile, "e2e.also-log-to-file", true, "if true, ginkgo logs are additionally written to the `ginkgo-log.txt` file in the artifacts folder (including timestamps)")
 	flag.BoolVar(&skipCleanup, "e2e.skip-resource-cleanup", false, "if true, the resource cleanup after tests will be skipped")
 	flag.BoolVar(&useExistingCluster, "e2e.use-existing-cluster", false, "if true, the test uses the current cluster instead of creating a new one (default discovery rules apply)")
 }
@@ -87,6 +93,12 @@ func TestE2E(t *testing.T) {
 
 	RegisterFailHandler(Fail)
 
+	if alsoLogToFile {
+		w, err := ginkgoextensions.EnableFileLogging(filepath.Join(artifactFolder, "ginkgo-log.txt"))
+		Expect(err).ToNot(HaveOccurred())
+		defer w.Close()
+	}
+
 	junitReporter := framework.CreateJUnitReporterForProw(artifactFolder)
 	RunSpecsWithDefaultAndCustomReporters(t, "capi-e2e", []Reporter{junitReporter})
 }

test/framework/ginkgoextensions/output.go

@@ -14,19 +14,67 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package ginkgoextensions extends ginko.
+// Package ginkgoextensions extends ginkgo.
 package ginkgoextensions
 
 import (
 	"fmt"
+	"io"
+	"os"
+	"time"
 
 	"github.com/onsi/ginkgo"
+	"github.com/pkg/errors"
 )
 
 // TestOutput can be used for writing testing output.
 var TestOutput = ginkgo.GinkgoWriter
 
-// Byf provides formatted output to the GinkoWriter.
+// Byf provides formatted output to the GinkgoWriter.
 func Byf(format string, a ...interface{}) {
 	ginkgo.By(fmt.Sprintf(format, a...))
 }
+
+type writerRedirecter interface {
+	AndRedirectTo(writer io.Writer)
+}
+
+// EnableFileLogging enables additional file logging.
+// Logs are written to the given path with timestamps.
+func EnableFileLogging(path string) (io.WriteCloser, error) {
+	w, err := newFileWriter(path)
+	if err != nil {
+		return nil, errors.Wrapf(err, "failed to create fileWriter")
+	}
+
+	ginkgoWriter, ok := ginkgo.GinkgoWriter.(writerRedirecter)
+	if !ok {
+		return nil, errors.Errorf("GinkgoWriter does not have an AndRedirectTo method")
+	}
+
+	ginkgoWriter.AndRedirectTo(w)
+
+	return w, nil
+}
+
+func newFileWriter(path string) (io.WriteCloser, error) {
+	f, err := os.Create(path)
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to create file")
+	}
+	return &fileWriter{
+		file: f,
+	}, nil
+}
+
+type fileWriter struct {
+	file *os.File
+}
+
+func (w *fileWriter) Write(data []byte) (n int, err error) {
+	return w.file.Write([]byte("[" + time.Now().Format(time.RFC3339) + "] " + string(data)))
+}
+
+func (w *fileWriter) Close() error {
+	return w.file.Close()
+}