Add NFR tests logging

Author: tataruty

tests/framework/crossplane.go

@@ -8,6 +8,7 @@ import (
 	"strings"
 	"time"
 
+	. "github.com/onsi/ginkgo/v2"
 	core "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes"
@@ -42,10 +43,13 @@ const crossplaneImageName = "nginx-crossplane:latest"
 
 // ValidateNginxFieldExists accepts the nginx config and the configuration for the expected field,
 // and returns whether or not that field exists where it should.
-func ValidateNginxFieldExists(conf *Payload, expFieldCfg ExpectedNginxField) error {
+func ValidateNginxFieldExists(conf *Payload, expFieldCfg ExpectedNginxField, opts ...Option) error {
 	b, err := json.Marshal(conf)
 	if err != nil {
-		return fmt.Errorf("error marshaling nginx config: %w", err)
+		marshalErr := fmt.Errorf("error marshaling nginx config: %w", err)
+		GinkgoWriter.Printf("%v\n", marshalErr)
+
+		return marshalErr
 	}
 
 	for _, config := range conf.Config {
@@ -55,7 +59,7 @@ func ValidateNginxFieldExists(conf *Payload, expFieldCfg ExpectedNginxField) err
 
 		for _, directive := range config.Parsed {
 			if expFieldCfg.Server == "" && expFieldCfg.Upstream == "" {
-				if expFieldCfg.fieldFound(directive) {
+				if expFieldCfg.fieldFound(directive, opts...) {
 					return nil
 				}
 				continue
@@ -70,8 +74,10 @@ func ValidateNginxFieldExists(conf *Payload, expFieldCfg ExpectedNginxField) err
 			}
 		}
 	}
+	directiveErr := fmt.Errorf("directive %s not found in: nginx config %s", expFieldCfg.Directive, string(b))
+	GinkgoWriter.Printf("ERROR: %v\n", directiveErr)
 
-	return fmt.Errorf("directive %s not found in: nginx config %s", expFieldCfg.Directive, string(b))
+	return directiveErr
 }
 
 func fieldExistsInServer(
@@ -95,6 +101,12 @@ func fieldExistsInUpstream(
 	expFieldCfg ExpectedNginxField,
 	directive Directive,
 ) bool {
+	GinkgoWriter.Printf(
+		"Checking upstream %q for directive %q with value %q\n",
+		directive.Args[0],
+		expFieldCfg.Directive,
+		expFieldCfg.Value,
+	)
 	if directive.Directive == "upstream" && directive.Args[0] == expFieldCfg.Upstream {
 		for _, directive := range directive.Block {
 			if expFieldCfg.fieldFound(directive) {
@@ -115,15 +127,32 @@ func getServerName(serverBlock Directives) string {
 	return ""
 }
 
-func (e ExpectedNginxField) fieldFound(directive *Directive) bool {
+func (e ExpectedNginxField) fieldFound(directive *Directive, opts ...Option) bool {
+	options := &Options{logEnabled: true}
+	for _, opt := range opts {
+		opt(options)
+	}
 	arg := strings.Join(directive.Args, " ")
 
 	valueMatch := arg == e.Value
 	if e.ValueSubstringAllowed {
 		valueMatch = strings.Contains(arg, e.Value)
 	}
 
-	return directive.Directive == e.Directive && valueMatch
+	if directive.Directive == e.Directive && valueMatch {
+		if options.logEnabled {
+			GinkgoWriter.Printf(
+				"Found field %q with value %q in field %q with value %q\n",
+				e.Directive,
+				e.Value,
+				directive.Directive,
+				arg,
+			)
+		}
+		return true
+	}
+
+	return false
 }
 
 func fieldExistsInLocation(locationDirective *Directive, expFieldCfg ExpectedNginxField) bool {
@@ -201,7 +230,10 @@ func injectCrossplaneContainer(
 
 	podClient := k8sClient.CoreV1().Pods(namespace)
 	if _, err := podClient.UpdateEphemeralContainers(ctx, ngfPodName, pod, metav1.UpdateOptions{}); err != nil {
-		return fmt.Errorf("error adding ephemeral container: %w", err)
+		containerErr := fmt.Errorf("error adding ephemeral container: %w", err)
+		GinkgoWriter.Printf("%v\n", containerErr)
+
+		return containerErr
 	}
 
 	return nil
@@ -231,7 +263,10 @@ func createCrossplaneExecutor(
 
 	exec, err := remotecommand.NewSPDYExecutor(k8sConfig, http.MethodPost, req.URL())
 	if err != nil {
-		return nil, fmt.Errorf("error creating executor: %w", err)
+		executorErr := fmt.Errorf("error creating executor: %w", err)
+		GinkgoWriter.Printf("%v\n", executorErr)
+
+		return nil, executorErr
 	}
 
 	return exec, nil

tests/framework/info.go

@@ -11,6 +11,11 @@ import (
 
 // GetLogs returns the logs for all containers in all pods for a release.
 func GetLogs(rm ResourceManager, namespace string, releaseName string) string {
+	GinkgoWriter.Printf(
+		"Getting logs for all containers in all pods for release %q in namespace %q\n",
+		releaseName,
+		namespace,
+	)
 	var returnLogs string
 	pods, err := rm.GetPods(namespace, client.MatchingLabels{
 		"app.kubernetes.io/instance": releaseName,
@@ -26,6 +31,13 @@ func GetLogs(rm ResourceManager, namespace string, releaseName string) string {
 				Container: container.Name,
 			})
 			if err != nil {
+				GinkgoWriter.Printf(
+					"ERROR occurred during getting logs for container %q in pod %q in namespace %q: %v\n",
+					container.Name,
+					pod.Name,
+					pod.Namespace,
+					err,
+				)
 				returnLogs += fmt.Sprintf("  failed to get logs: %v\n", err)
 				continue
 			}
@@ -40,6 +52,8 @@ func GetEvents(rm ResourceManager, namespace string) string {
 	var returnEvents string
 	events, err := rm.GetEvents(namespace)
 	if err != nil {
+		GinkgoWriter.Printf("ERROR occurred during getting events in namespace %q: %v\n", namespace, err)
+
 		return fmt.Sprintf("failed to get events: %v", err)
 	}
 
@@ -60,6 +74,7 @@ func GetEvents(rm ResourceManager, namespace string) string {
 
 // GetBuildInfo returns the build information.
 func GetBuildInfo() (commitHash string, commitTime string, dirtyBuild string) {
+	GinkgoWriter.Printf("Getting build info\n")
 	commitHash = "unknown"
 	commitTime = "unknown"
 	dirtyBuild = "unknown"
@@ -84,11 +99,12 @@ func GetBuildInfo() (commitHash string, commitTime string, dirtyBuild string) {
 }
 
 // AddNginxLogsAndEventsToReport adds nginx logs and events from the namespace to the report if the spec failed.
-func AddNginxLogsAndEventsToReport(rm ResourceManager, namespace string) {
+func AddNginxLogsAndEventsToReport(rm ResourceManager, namespace string, opts ...Option) {
 	if CurrentSpecReport().Failed() {
+		GinkgoWriter.Printf("Current spec failed. Adding Nginx logs and events to report for namespace %q\n", namespace)
 		var returnLogs string
 
-		nginxPodNames, _ := GetReadyNginxPodNames(rm.K8sClient, namespace, rm.TimeoutConfig.GetStatusTimeout)
+		nginxPodNames, _ := GetReadyNginxPodNames(rm.K8sClient, namespace, rm.TimeoutConfig.GetStatusTimeout, opts...)
 
 		for _, nginxPodName := range nginxPodNames {
 			returnLogs += fmt.Sprintf("Logs for Nginx Pod %s:\n", nginxPodName)

tests/framework/load.go

@@ -7,6 +7,7 @@ import (
 	"net/http"
 	"time"
 
+	. "github.com/onsi/ginkgo/v2"
 	vegeta "github.com/tsenart/vegeta/v12/lib"
 )
 
@@ -49,6 +50,7 @@ type Metrics struct {
 // RunLoadTest uses Vegeta to send traffic to the provided Targets at the given rate for the given duration and writes
 // the results to the provided file.
 func RunLoadTest(cfg LoadTestConfig) (vegeta.Results, Metrics) {
+	GinkgoWriter.Printf("Running load test: %s\n", cfg.Description)
 	vegTargets := convertTargetToVegetaTarget(cfg.Targets)
 	targeter := vegeta.NewStaticTargeter(vegTargets...)
 
@@ -61,7 +63,12 @@ func RunLoadTest(cfg LoadTestConfig) (vegeta.Results, Metrics) {
 		Timeout: vegeta.DefaultTimeout,
 		Transport: &http.Transport{
 			DialContext: func(ctx context.Context, network, _ string) (net.Conn, error) {
-				return dialer.DialContext(ctx, network, cfg.Proxy)
+				conn, err := dialer.DialContext(ctx, network, cfg.Proxy)
+				if err != nil {
+					GinkgoWriter.Printf("ERROR occurred during dialing %q in %q network, error: %s\n", cfg.Proxy, network, err)
+				}
+
+				return conn, err
 			},
 			TLSClientConfig: &tls.Config{
 				InsecureSkipVerify: true, //nolint:gosec // self-signed cert for testing