PR feedback

Author: aphralG

internal/config/config.go

@@ -129,8 +129,7 @@ func ResolveConfig() (*Config, error) {
 }
 
 func checkCollectorConfiguration(collector *Collector, config *Config) {
-	if len(collector.Exporters.OtlpExporters) == 0 && collector.Exporters.PrometheusExporter == nil &&
-		collector.Exporters.Debug == nil && config.IsGrpcClientConfigured() && config.IsAuthConfigured() &&
+	if isOTelExporterConfigured(collector) && config.IsGrpcClientConfigured() && config.IsAuthConfigured() &&
 		config.IsTLSConfigured() {
 		slog.Info("No collector configuration found in NGINX Agent config, command server configuration found." +
 			"Using default collector configuration")
@@ -141,7 +140,8 @@ func checkCollectorConfiguration(collector *Collector, config *Config) {
 func defaultCollector(collector *Collector, config *Config) {
 	token := config.Command.Auth.Token
 	if config.Command.Auth.TokenPath != "" {
-		pathToken, err := file.RetrieveTokenFromFile(config.Command.Auth.TokenPath)
+		slog.Debug("Reading token from file", "path", config.Command.Auth.TokenPath)
+		pathToken, err := file.ReadFromFile(config.Command.Auth.TokenPath)
 		if err != nil {
 			slog.Error("Error adding token to default collector, "+
 				"default collector configuration not started", "error", err)
@@ -970,3 +970,8 @@ func resolveMapStructure(key string, object any) error {
 
 	return nil
 }
+
+func isOTelExporterConfigured(collector *Collector) bool {
+	return len(collector.Exporters.OtlpExporters) == 0 && collector.Exporters.PrometheusExporter == nil &&
+		collector.Exporters.Debug == nil
+}

internal/datasource/file/file.go

@@ -9,29 +9,29 @@ import (
 	"bytes"
 	"errors"
 	"fmt"
-	"log/slog"
 	"os"
 )
 
-func RetrieveTokenFromFile(path string) (string, error) {
+// ReadFromFile reads the contents from a file, trims the white space, trims newlines
+// then returns the contents as a string
+func ReadFromFile(path string) (string, error) {
 	if path == "" {
-		return "", errors.New("token file path is empty")
+		return "", errors.New("failed to read file since file path is empty")
 	}
 
-	slog.Debug("Reading token from file", "path", path)
-	var keyVal string
-	keyBytes, err := os.ReadFile(path)
+	var content string
+	contentBytes, err := os.ReadFile(path)
 	if err != nil {
-		return "", fmt.Errorf("unable to read token from file: %w", err)
+		return "", fmt.Errorf("unable to read from file: %w", err)
 	}
 
-	keyBytes = bytes.TrimSpace(keyBytes)
-	keyBytes = bytes.TrimRight(keyBytes, "\n")
-	keyVal = string(keyBytes)
+	contentBytes = bytes.TrimSpace(contentBytes)
+	contentBytes = bytes.TrimRight(contentBytes, "\n")
+	content = string(contentBytes)
 
-	if keyVal == "" {
-		return "", errors.New("failed to load token, token file is empty")
+	if content == "" {
+		return "", errors.New("failed to read from file, file is empty")
 	}
 
-	return keyVal, nil
+	return content, nil
 }

internal/datasource/file/file_test.go

@@ -44,7 +44,7 @@ func Test_RetrieveTokenFromFile(t *testing.T) {
 			createToken:    false,
 			path:           "",
 			expected:       "",
-			expectedErrMsg: "token file path is empty",
+			expectedErrMsg: "failed to read file since file path is empty",
 		},
 	}
 	for _, tt := range tests {
@@ -54,7 +54,7 @@ func Test_RetrieveTokenFromFile(t *testing.T) {
 				require.NoError(t, writeErr)
 			}
 
-			token, err := RetrieveTokenFromFile(tt.path)
+			token, err := ReadFromFile(tt.path)
 			if err != nil {
 				assert.Equal(t, tt.expectedErrMsg, err.Error())
 			}

internal/grpc/grpc.go

@@ -243,7 +243,8 @@ func addPerRPCCredentials(agentConfig *config.Config, resourceID string, opts []
 	token := agentConfig.Command.Auth.Token
 
 	if agentConfig.Command.Auth.TokenPath != "" {
-		tk, err := file.RetrieveTokenFromFile(agentConfig.Command.Auth.TokenPath)
+		slog.Debug("Reading token from file", "path", agentConfig.Command.Auth.TokenPath)
+		tk, err := file.ReadFromFile(agentConfig.Command.Auth.TokenPath)
 		if err == nil {
 			token = tk
 		} else {