test: print and save logs in github actions

Signed-off-by: Peter Wilcsinszky <[email protected]>

Author: pepov

.github/workflows/e2e.yaml

@@ -14,7 +14,7 @@ env:
 
 jobs:
   build:
-    name: Build
+    name: Go end2end tests
     runs-on: ubuntu-latest
 
     steps:
@@ -34,8 +34,16 @@ jobs:
       - name: Run e2e tests
         run: make test-e2e
 
+      - name: Archive Test Results
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: go-e2e-test-cluster-logs
+          path: build/_test
+          retention-days: 5
+
   basic_flow:
-    name: Basic flow
+    name: Shell script tests with chart install
     runs-on: ubuntu-latest
 
     steps:
@@ -93,4 +101,15 @@ jobs:
         run: hack/test.sh
 
       - name: Print last 10k kubernetes logs from default and logging namespaces
-        run: bin/stern -n default,logging ".*" --tail 10000 --no-follow
+        if: always()
+        run: |
+          mkdir -p build/_test
+          bin/stern -n default,logging ".*" --tail 100000 --no-follow > build/_test/cluster.logs
+
+      - name: Archive Test Results
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: script-e2e-test-cluster-logs
+          path: build/_test
+          retention-days: 5

Makefile

@@ -157,7 +157,7 @@ test: generate fmt vet manifests ${ENVTEST_BINARY_ASSETS} ${KUBEBUILDER} ## Run
 
 .PHONY: test-e2e
 test-e2e: ${KIND} docker-build generate fmt vet manifests stern ## Run E2E tests
-	cd e2e && LOGGING_OPERATOR_IMAGE="${IMG}" go test -v -timeout ${E2E_TEST_TIMEOUT} ./...
+	cd e2e && LOGGING_OPERATOR_IMAGE="${IMG}" PROJECT_DIR="$(PWD)" go test -v -timeout ${E2E_TEST_TIMEOUT} ./...
 
 .PHONY: tidy
 tidy: ## Tidy Go modules

e2e/common/cluster.go

@@ -34,16 +34,20 @@ import (
 
 const defaultClusterName = "e2e-test"
 
-var NamespacesUsed []string
-
 type Cluster interface {
 	cluster.Cluster
 	LoadImages(images ...string) error
 	Cleanup() error
-	PrintLogs(int) error
+	PrintLogs(config PrintLogConfig) error
+}
+
+type PrintLogConfig struct {
+	Namespaces []string
+	FilePath   string
+	Limit      int
 }
 
-func WithCluster(t *testing.T, fn func(*testing.T, Cluster), opts ...cluster.Option) {
+func WithCluster(t *testing.T, fn func(*testing.T, Cluster), beforeCleanup func(*testing.T, Cluster) error, opts ...cluster.Option) {
 	cluster, err := GetTestCluster(defaultClusterName, opts...)
 	require.NoError(t, err)
 
@@ -53,9 +57,7 @@ func WithCluster(t *testing.T, fn func(*testing.T, Cluster), opts ...cluster.Opt
 	}()
 
 	defer func() {
-		t.Log("CLUSTER LOGS START")
-		assert.NoError(t, cluster.PrintLogs(10000))
-		t.Log("CLUSTER LOGS END")
+		assert.NoError(t, beforeCleanup(t, cluster))
 		assert.NoError(t, cluster.Cleanup())
 		cancel()
 		require.NoError(t, DeleteTestCluster(defaultClusterName))
@@ -112,10 +114,16 @@ type kindCluster struct {
 	clusterName        string
 }
 
-func (c kindCluster) PrintLogs(tail int) error {
-	cmd := exec.Command("stern", "-n", strings.Join(NamespacesUsed, ","), ".*", "--no-follow", "--tail", cast.ToString(tail), "--kubeconfig", c.kubeconfigFilePath)
-	cmd.Stdout = os.Stdout
+func (c kindCluster) PrintLogs(config PrintLogConfig) error {
+	cmd := exec.Command("stern", "-n", strings.Join(config.Namespaces, ","), ".*", "--no-follow", "--tail", cast.ToString(config.Limit), "--kubeconfig", c.kubeconfigFilePath)
+	f, err := os.Create(config.FilePath)
+	if err != nil {
+		return err
+	}
+	cmd.Stdout = f
 	cmd.Stderr = os.Stderr
+
+	defer f.Close()
 	return cmd.Run()
 }
 

e2e/volumedrain/volumedrain_test.go

@@ -16,7 +16,10 @@ package volumedrain
 
 import (
 	"context"
+	"fmt"
+	"os"
 	"os/exec"
+	"path"
 	"strings"
 	"testing"
 	"time"
@@ -43,9 +46,22 @@ import (
 	"github.com/kube-logging/logging-operator/e2e/common/setup"
 )
 
+var TestTempDir string
+
+func init() {
+	var ok bool
+	TestTempDir, ok = os.LookupEnv("PROJECT_DIR")
+	if !ok {
+		TestTempDir = "../.."
+	}
+	TestTempDir = path.Join(TestTempDir, "build/_test")
+	err := os.MkdirAll(TestTempDir, os.FileMode(0755))
+	if err != nil {
+		panic(err)
+	}
+}
 func TestVolumeDrain_Downscale(t *testing.T) {
 	ns := "testing-1"
-	common.NamespacesUsed = []string{ns, "default"}
 	common.WithCluster(t, func(t *testing.T, c common.Cluster) {
 		setup.LoggingOperator(t, c, setup.LoggingOperatorOptionFunc(func(options *setup.LoggingOperatorOptions) {
 			options.Config.DisableWebhook = true
@@ -183,6 +199,14 @@ func TestVolumeDrain_Downscale(t *testing.T) {
 		pvc := common.Resource(new(corev1.PersistentVolumeClaim), ns, logging.Name+"-fluentd-buffer-"+fluentdReplicaName)
 		require.NoError(t, c.GetClient().Get(ctx, client.ObjectKeyFromObject(pvc), pvc))
 		assert.Equal(t, "drained", pvc.GetLabels()["logging.banzaicloud.io/drain-status"])
+	}, func(t *testing.T, c common.Cluster) error {
+		path := fmt.Sprintf("%s/cluster-%s.log", TestTempDir, t.Name())
+		t.Logf("Printing cluster logs to %s", path)
+		return c.PrintLogs(common.PrintLogConfig{
+			Namespaces: []string{ns, "default"},
+			FilePath:   path,
+			Limit:      100 * 1000,
+		})
 	}, func(o *cluster.Options) {
 		if o.Scheme == nil {
 			o.Scheme = runtime.NewScheme()
@@ -198,7 +222,6 @@ func TestVolumeDrain_Downscale(t *testing.T) {
 
 func TestVolumeDrain_Downscale_DeleteVolume(t *testing.T) {
 	ns := "testing-2"
-	common.NamespacesUsed = []string{ns, "default"}
 	common.WithCluster(t, func(t *testing.T, c common.Cluster) {
 		setup.LoggingOperator(t, c, setup.LoggingOperatorOptionFunc(func(options *setup.LoggingOperatorOptions) {
 			options.Config.DisableWebhook = true
@@ -335,6 +358,14 @@ func TestVolumeDrain_Downscale_DeleteVolume(t *testing.T) {
 		require.Eventually(t, cond.ResourceShouldBeAbsent(t, c.GetClient(), common.Resource(new(corev1.Pod), ns, fluentdReplicaName)), 30*time.Second, time.Second/2)
 
 		require.Eventually(t, cond.ResourceShouldBeAbsent(t, c.GetClient(), common.Resource(new(corev1.PersistentVolumeClaim), ns, logging.Name+"-fluentd-buffer-"+fluentdReplicaName)), 30*time.Second, time.Second/2)
+	}, func(t *testing.T, c common.Cluster) error {
+		path := fmt.Sprintf("%s/cluster-%s.log", TestTempDir, t.Name())
+		t.Logf("Printing cluster logs to %s", path)
+		return c.PrintLogs(common.PrintLogConfig{
+			Namespaces: []string{ns, "default"},
+			FilePath:   path,
+			Limit:      100 * 1000,
+		})
 	}, func(o *cluster.Options) {
 		if o.Scheme == nil {
 			o.Scheme = runtime.NewScheme()