Merge branch 'main' into lauren/BCDA-9401

Author: laurenkrugen-navapbc

ssas/constants/constants.go

@@ -13,7 +13,7 @@ const TokenEndpoint = "/token"
 
 const HeaderApplicationJSON = "application/json"
 
-const Application = "ssas"
+const Application string = "ssas"
 
 // Sets requesting SGA on admin endpoint requests into context
 type CtxSGAKeyType string

ssas/logger.go

@@ -18,23 +18,27 @@ func SetupLogger() {
 	logInstance := logrus.New()
 	logInstance.SetFormatter(&logrus.JSONFormatter{TimestampFormat: time.RFC3339Nano})
 
-	filePath, success := os.LookupEnv("SSAS_LOG")
-	if success {
-		/* #nosec -- 0664 permissions required for Splunk ingestion */
-		file, err := os.OpenFile(filePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0664)
-
-		if err == nil {
-			logInstance.SetOutput(file)
+	if os.Getenv("LOG_TO_STD_OUT") != "true" {
+		filePath, success := os.LookupEnv("SSAS_LOG")
+		if success {
+			/* #nosec -- 0664 permissions required for Splunk ingestion */
+			file, err := os.OpenFile(filePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0664)
+
+			if err == nil {
+				logInstance.SetOutput(file)
+			} else {
+				logInstance.Info("Failed to open SSAS log file; using default stderr")
+			}
 		} else {
-			logInstance.Info("Failed to open SSAS log file; using default stderr")
+			logInstance.Info("No SSAS log location provided; using default stderr")
 		}
-	} else {
-		logInstance.Info("No SSAS log location provided; using default stderr")
 	}
 
 	Logger = logInstance.WithFields(logrus.Fields{
 		"application": constants.Application,
 		"environment": os.Getenv("DEPLOYMENT_TARGET"),
+		"log_type":    "ssas",
+		"source_app":  "bcda",
 		"version":     constants.Version,
 	})
 }
@@ -46,6 +50,8 @@ func defaultLogger() logrus.FieldLogger {
 	return logInstance.WithFields(logrus.Fields{
 		"application": constants.Application,
 		"environment": os.Getenv("DEPLOYMENT_TARGET"),
+		"log_type":    "ssas",
+		"source_app":  "bcda",
 		"version":     constants.Version,
 	})
 }

ssas/logger_test.go

@@ -0,0 +1,107 @@
+package ssas
+
+import (
+	"encoding/json"
+	"io"
+	"os"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/CMSgov/bcda-ssas-app/ssas/constants"
+	"github.com/pborman/uuid"
+	"github.com/sirupsen/logrus"
+	"github.com/sirupsen/logrus/hooks/test"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSetupLogger(t *testing.T) {
+	env := uuid.New()
+	oldEnvVal := os.Getenv("DEPLOYMENT_TARGET")
+	os.Setenv("DEPLOYMENT_TARGET", env)
+	oldLogVal := os.Getenv("LOG_TO_STD_OUT")
+	os.Unsetenv("LOG_TO_STD_OUT")
+	t.Cleanup(func() {
+		os.Setenv("DEPLOYMENT_TARGET", oldEnvVal)
+		os.Setenv("LOG_TO_STD_OUT", oldLogVal)
+	})
+
+	logFile, err := os.CreateTemp("", "*")
+	assert.NoError(t, err)
+
+	old := os.Getenv("SSAS_LOG")
+	os.Setenv("SSAS_LOG", logFile.Name())
+	t.Cleanup(func() {
+		assert.NoError(t, os.Remove(logFile.Name()))
+		assert.NoError(t, os.Setenv("SSAS_LOG", old))
+	})
+
+	SetupLogger()
+
+	msg := uuid.New()
+	Logger.Info(msg)
+
+	data, err := io.ReadAll(logFile)
+	assert.NoError(t, err)
+
+	logText := strings.Split(string(data), "\n")
+	assert.Len(t, logText, 2) // msg + new line
+
+	var fields logrus.Fields
+	assert.NoError(t, json.Unmarshal([]byte(logText[0]), &fields))
+	assert.Equal(t, constants.Application, fields["application"])
+	assert.Equal(t, env, fields["environment"])
+	assert.Equal(t, msg, fields["msg"])
+	assert.Equal(t, "bcda", fields["source_app"])
+	assert.Equal(t, constants.Version, fields["version"])
+	_, err = time.Parse(time.RFC3339Nano, fields["time"].(string))
+	assert.NoError(t, err)
+}
+
+func TestSetupLogger_ToSTDOut(t *testing.T) {
+	env := uuid.New()
+	oldEnvVal := os.Getenv("DEPLOYMENT_TARGET")
+	os.Setenv("DEPLOYMENT_TARGET", env)
+	oldLogVal := os.Getenv("LOG_TO_STD_OUT")
+	os.Unsetenv("LOG_TO_STD_OUT")
+	t.Cleanup(func() {
+		os.Setenv("DEPLOYMENT_TARGET", oldEnvVal)
+		os.Setenv("LOG_TO_STD_OUT", oldLogVal)
+	})
+
+	SetupLogger()
+	testLogger := test.NewLocal(getLogger(Logger))
+
+	msg := uuid.New()
+	Logger.Info(msg)
+
+	assert.Equal(t, 1, len(testLogger.Entries))
+	assert.Equal(t, msg, testLogger.LastEntry().Message)
+	assert.Equal(t, "ssas", testLogger.LastEntry().Data["log_type"])
+	testLogger.Reset()
+}
+
+func TestDefaultLogger(t *testing.T) {
+	Logger := defaultLogger()
+	testLogger := test.NewLocal(getLogger(Logger))
+
+	msg := uuid.New()
+	Logger.Info(msg)
+
+	assert.Equal(t, 1, len(testLogger.Entries))
+	assert.Equal(t, msg, testLogger.LastEntry().Message)
+	assert.Equal(t, constants.Application, testLogger.LastEntry().Data["application"])
+	assert.Equal(t, os.Getenv("DEPLOYMENT_TARGET"), testLogger.LastEntry().Data["environment"])
+	assert.Equal(t, "ssas", testLogger.LastEntry().Data["log_type"])
+	assert.Equal(t, "bcda", testLogger.LastEntry().Data["source_app"])
+	assert.Equal(t, constants.Version, testLogger.LastEntry().Data["version"])
+}
+
+// GetLogger returns the underlying implementation of the field logger
+func getLogger(logger logrus.FieldLogger) *logrus.Logger {
+	if entry, ok := logger.(*logrus.Entry); ok {
+		return entry.Logger
+	}
+	// Must be a *logrus.Logger
+	return logger.(*logrus.Logger)
+}

ssas/systems_test.go

@@ -32,9 +32,9 @@ type SystemsTestSuite struct {
 }
 
 func (s *SystemsTestSuite) SetupSuite() {
+	SetupLogger()
 	s.db = Connection
 	s.logEntry = MakeTestStructuredLoggerEntry(logrus.Fields{"cms_id": "A9999", "request_id": uuid.NewUUID().String()})
-
 }
 
 func (s *SystemsTestSuite) AfterTest() {