Remove K8sClient

Author: tataruty

tests/framework/crossplane.go

@@ -102,10 +102,7 @@ func fieldExistsInUpstream(
 	directive Directive,
 	opts ...Option,
 ) bool {
-	options := &Options{logEnabled: true}
-	for _, opt := range opts {
-		opt(options)
-	}
+	options := LogOptions(opts...)
 	if options.logEnabled {
 		GinkgoWriter.Printf(
 			"Checking upstream for directive %q with value %q\n",
@@ -134,10 +131,7 @@ func getServerName(serverBlock Directives) string {
 }
 
 func (e ExpectedNginxField) fieldFound(directive *Directive, opts ...Option) bool {
-	options := &Options{logEnabled: true}
-	for _, opt := range opts {
-		opt(options)
-	}
+	options := LogOptions(opts...)
 	arg := strings.Join(directive.Args, " ")
 
 	valueMatch := arg == e.Value

tests/framework/info.go

@@ -11,11 +11,6 @@ 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,
@@ -31,13 +26,6 @@ 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
 			}
@@ -52,8 +40,6 @@ 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)
 	}
 
@@ -74,7 +60,6 @@ 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"
@@ -101,10 +86,9 @@ 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, 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, opts...)
+		nginxPodNames, _ := rm.GetReadyNginxPodNames(namespace, rm.TimeoutConfig.GetStatusTimeout, opts...)
 
 		for _, nginxPodName := range nginxPodNames {
 			returnLogs += fmt.Sprintf("Logs for Nginx Pod %s:\n", nginxPodName)

tests/framework/k8s_client.go

@@ -11,3 +11,12 @@ func WithLoggingDisabled() Option {
 		opts.logEnabled = false
 	}
 }
+
+func LogOptions(opts ...Option) *Options {
+	options := &Options{logEnabled: true}
+	for _, opt := range opts {
+		opt(options)
+	}
+
+	return options
+}

tests/framework/logging.go

@@ -100,7 +100,7 @@ func InstallNGF(cfg InstallationConfig, extraArgs ...string) ([]byte, error) {
 }
 
 // CreateLicenseSecret creates the NGINX Plus JWT secret.
-func CreateLicenseSecret(k8sClient K8sClient, namespace, filename string) error {
+func CreateLicenseSecret(rm ResourceManager, namespace, filename string) error {
 	GinkgoWriter.Printf("Creating NGINX Plus license secret in namespace %q from file %q\n", namespace, filename)
 
 	conf, err := os.ReadFile(filename)
@@ -120,7 +120,7 @@ func CreateLicenseSecret(k8sClient K8sClient, namespace, filename string) error
 		},
 	}
 
-	if err := k8sClient.Create(ctx, ns); err != nil && !apierrors.IsAlreadyExists(err) {
+	if err := rm.Create(ctx, ns); err != nil && !apierrors.IsAlreadyExists(err) {
 		return fmt.Errorf("error creating namespace: %w", err)
 	}
 
@@ -134,7 +134,7 @@ func CreateLicenseSecret(k8sClient K8sClient, namespace, filename string) error
 		},
 	}
 
-	if err := k8sClient.Create(ctx, secret); err != nil && !apierrors.IsAlreadyExists(err) {
+	if err := rm.Create(ctx, secret); err != nil && !apierrors.IsAlreadyExists(err) {
 		createSecretErr := fmt.Errorf("error creating secret: %w", err)
 		GinkgoWriter.Printf("%v\n", createSecretErr)
 
@@ -181,7 +181,7 @@ func UpgradeNGF(cfg InstallationConfig, extraArgs ...string) ([]byte, error) {
 }
 
 // UninstallNGF uninstalls NGF.
-func UninstallNGF(cfg InstallationConfig, k8sClient K8sClient) ([]byte, error) {
+func UninstallNGF(cfg InstallationConfig, rm ResourceManager) ([]byte, error) {
 	args := []string{
 		"uninstall", cfg.ReleaseName, "--namespace", cfg.Namespace,
 	}
@@ -195,20 +195,20 @@ func UninstallNGF(cfg InstallationConfig, k8sClient K8sClient) ([]byte, error) {
 	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 	defer cancel()
 
-	err = k8sClient.Delete(ctx, &core.Namespace{ObjectMeta: metav1.ObjectMeta{Name: cfg.Namespace}}, nil)
+	err = rm.Delete(ctx, &core.Namespace{ObjectMeta: metav1.ObjectMeta{Name: cfg.Namespace}}, nil)
 	if err != nil && !apierrors.IsNotFound(err) {
 		return nil, err
 	}
 
 	var crList apiext.CustomResourceDefinitionList
-	if err := k8sClient.List(ctx, &crList, nil); err != nil {
+	if err := rm.List(ctx, &crList); err != nil {
 		return nil, err
 	}
 
 	for _, cr := range crList.Items {
 		if strings.Contains(cr.Spec.Group, "gateway.nginx.org") {
 			cr := cr
-			if err := k8sClient.Delete(ctx, &cr, nil); err != nil && !apierrors.IsNotFound(err) {
+			if err := rm.Delete(ctx, &cr, nil); err != nil && !apierrors.IsNotFound(err) {
 				return nil, err
 			}
 		}

tests/framework/ngf.go

@@ -475,10 +475,7 @@ func CreateMetricExistChecker(
 ) func() error {
 	return func() error {
 		queryWithTimestamp := fmt.Sprintf("%s @ %d", query, getTime().Unix())
-		options := &Options{logEnabled: true}
-		for _, opt := range opts {
-			opt(options)
-		}
+		options := LogOptions(opts...)
 
 		result, err := promInstance.Query(queryWithTimestamp)
 		if err != nil {
@@ -541,10 +538,7 @@ func CreateEndTimeFinder(
 
 // CreateResponseChecker returns a function that checks if there is a successful response from a url.
 func CreateResponseChecker(url, address string, requestTimeout time.Duration, opts ...Option) func() error {
-	options := &Options{logEnabled: true}
-	for _, opt := range opts {
-		opt(options)
-	}
+	options := LogOptions(opts...)
 	if options.logEnabled {
 		GinkgoWriter.Printf("Starting checking response for url %q and address %q\n", url, address)
 	}

tests/framework/prometheus.go

@@ -24,10 +24,7 @@ func Get(
 	headers, queryParams map[string]string,
 	opts ...Option,
 ) (int, string, error) {
-	options := &Options{logEnabled: true}
-	for _, opt := range opts {
-		opt(options)
-	}
+	options := LogOptions(opts...)
 
 	resp, err := makeRequest(http.MethodGet, url, address, nil, timeout, headers, queryParams, opts...)
 	if err != nil {
@@ -99,11 +96,7 @@ func makeRequest(
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)
 	defer cancel()
 
-	options := &Options{logEnabled: true}
-
-	for _, opt := range opts {
-		opt(options)
-	}
+	options := LogOptions(opts...)
 	if options.logEnabled {
 		requestDetails := fmt.Sprintf(
 			"Method: %s, URL: %s, Address: %s, Headers: %v, QueryParams: %v\n",