Replace logrus with zap logger (#115)

Signed-off-by: Arrobo, Gabriel <[email protected]>

VERSION

@@ -1 +1 @@
-1.4.3-dev
+1.5.0

ausf.go

@@ -17,16 +17,16 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli"
+	"go.uber.org/zap"
 
 	"github.com/omec-project/ausf/logger"
 	"github.com/omec-project/ausf/service"
 )
 
 var AUSF = &service.AUSF{}
 
-var appLog *logrus.Entry
+var appLog *zap.SugaredLogger
 
 func init() {
 	appLog = logger.AppLog
@@ -35,7 +35,7 @@ func init() {
 func main() {
 	app := cli.NewApp()
 	app.Name = "ausf"
-	fmt.Print(app.Name, "\n")
+	appLog.Infoln(app.Name)
 	app.Usage = "-free5gccfg common configuration file -ausfcfg ausf configuration file"
 	app.Action = action
 	app.Flags = AUSF.GetCliCmd()

ausf_test.go

@@ -54,16 +54,16 @@ func TestRegisterNF(t *testing.T) {
 		consumer.SendSearchNFInstances = origSearchNFInstances
 		consumer.SendUpdateNFInstance = origUpdateNFInstance
 	}()
-	fmt.Printf("test case TestRegisterNF")
+	t.Logf("test case TestRegisterNF")
 	var prof models.NfProfile
 	consumer.SendRegisterNFInstance = func(nrfUri string, nfInstanceId string, profile models.NfProfile) (models.NfProfile, string, string, error) {
 		prof = profile
 		prof.HeartBeatTimer = 1
-		fmt.Printf("test RegisterNFInstance called")
+		t.Logf("test RegisterNFInstance called")
 		return prof, "", "", nil
 	}
 	consumer.SendSearchNFInstances = func(nrfUri string, targetNfType, requestNfType models.NfType, param *Nnrf_NFDiscovery.SearchNFInstancesParamOpts) (models.SearchResult, error) {
-		fmt.Printf("test SearchNFInstance called")
+		t.Logf("test SearchNFInstance called")
 		return models.SearchResult{}, nil
 	}
 	consumer.SendUpdateNFInstance = func(patchItem []models.PatchItem) (nfProfile models.NfProfile, problemDetails *models.ProblemDetails, err error) {
@@ -80,7 +80,7 @@ func TestRegisterNF(t *testing.T) {
 }
 
 func TestGetUDMUri(t *testing.T) {
-	fmt.Printf("test cases for Get UDM URI")
+	t.Logf("test cases for Get UDM URI")
 	callCountSearchNFInstances := 0
 	callCountSendNfDiscovery := 0
 	origNRFCacheSearchNFInstances := consumer.NRFCacheSearchNFInstances
@@ -172,12 +172,12 @@ func TestGetUDMUri(t *testing.T) {
 		consumer.SendNfDiscoveryToNrf = origSendNfDiscoveryToNrf
 	}()
 	consumer.NRFCacheSearchNFInstances = func(nrfUri string, targetNfType, requestNfType models.NfType, param *Nnrf_NFDiscovery.SearchNFInstancesParamOpts) (models.SearchResult, error) {
-		fmt.Printf("test SearchNFInstance called")
+		t.Logf("test SearchNFInstance called")
 		callCountSearchNFInstances++
 		return searchResult1, nil
 	}
 	consumer.SendNfDiscoveryToNrf = func(nrfUri string, targetNfType, requestNfType models.NfType, param *Nnrf_NFDiscovery.SearchNFInstancesParamOpts) (models.SearchResult, error) {
-		fmt.Printf("test SendNfDiscoveryToNrf called")
+		t.Logf("test SendNfDiscoveryToNrf called")
 		callCountSendNfDiscovery++
 		return searchResult2, nil
 	}
@@ -221,7 +221,7 @@ func TestGetUDMUri(t *testing.T) {
 }
 
 func TestCreateSubscriptionSuccess(t *testing.T) {
-	fmt.Printf("test cases for CreateSubscription")
+	t.Logf("test cases for CreateSubscription")
 	udmProfile := models.NfProfile{
 		UdmInfo: &models.UdmInfo{
 			RoutingIndicators: []string{},
@@ -256,11 +256,11 @@ func TestCreateSubscriptionSuccess(t *testing.T) {
 		consumer.CreateSubscription = origCreateSubscription
 	}()
 	consumer.StoreApiSearchNFInstances = func(*Nnrf_NFDiscovery.NFInstancesStoreApiService, context.Context, models.NfType, models.NfType, *Nnrf_NFDiscovery.SearchNFInstancesParamOpts) (models.SearchResult, *http.Response, error) {
-		fmt.Printf("test SearchNFInstances called")
+		t.Logf("test SearchNFInstances called")
 		return searchResult, &httpResponse, nil
 	}
 	consumer.CreateSubscription = func(nrfUri string, nrfSubscriptionData models.NrfSubscriptionData) (nrfSubData models.NrfSubscriptionData, problemDetails *models.ProblemDetails, err error) {
-		fmt.Printf("test SendCreateSubscription called")
+		t.Logf("test SendCreateSubscription called")
 		callCountSendCreateSubscription++
 		return models.NrfSubscriptionData{
 			NfStatusNotificationUri: "https://:0/nausf-callback/v1/nf-status-notify",
@@ -312,7 +312,7 @@ func TestCreateSubscriptionSuccess(t *testing.T) {
 }
 
 func TestCreateSubscriptionFail(t *testing.T) {
-	fmt.Printf("test cases for CreateSubscription")
+	t.Logf("test cases for CreateSubscription")
 	udmProfile := models.NfProfile{
 		UdmInfo: &models.UdmInfo{
 			RoutingIndicators: []string{},
@@ -435,12 +435,12 @@ func TestCreateSubscriptionFail(t *testing.T) {
 	for i := range parameters {
 		t.Run(fmt.Sprintf("CreateSubscription testname %v result %v", parameters[i].testName, parameters[i].result), func(t *testing.T) {
 			consumer.StoreApiSearchNFInstances = func(*Nnrf_NFDiscovery.NFInstancesStoreApiService, context.Context, models.NfType, models.NfType, *Nnrf_NFDiscovery.SearchNFInstancesParamOpts) (models.SearchResult, *http.Response, error) {
-				fmt.Printf("test SearchNFInstances called")
+				t.Logf("test SearchNFInstances called")
 				return parameters[i].searchResult, &parameters[i].httpResponse, nil
 			}
 
 			consumer.CreateSubscription = func(nrfUri string, nrfSubscriptionData models.NrfSubscriptionData) (nrfSubData models.NrfSubscriptionData, problemDetails *models.ProblemDetails, err error) {
-				fmt.Printf("test SendCreateSubscription called")
+				t.Logf("test SendCreateSubscription called")
 				callCountSendCreateSubscription++
 				return parameters[i].nrfSubscriptionData, parameters[i].subscriptionProblem, parameters[i].subscriptionError
 			}
@@ -456,7 +456,7 @@ func TestCreateSubscriptionFail(t *testing.T) {
 }
 
 func TestNfSubscriptionStatusNotify(t *testing.T) {
-	fmt.Printf("test cases for NfSubscriptionStatusNotify")
+	t.Logf("test cases for NfSubscriptionStatusNotify")
 	callCountSendRemoveSubscription := 0
 	callCountNRFCacheRemoveNfProfileFromNrfCache := 0
 	origSendRemoveSubscription := consumer.SendRemoveSubscription
@@ -466,12 +466,12 @@ func TestNfSubscriptionStatusNotify(t *testing.T) {
 		producer.NRFCacheRemoveNfProfileFromNrfCache = origNRFCacheRemoveNfProfileFromNrfCache
 	}()
 	consumer.SendRemoveSubscription = func(subscriptionId string) (problemDetails *models.ProblemDetails, err error) {
-		fmt.Printf("test SendRemoveSubscription called")
+		t.Logf("test SendRemoveSubscription called")
 		callCountSendRemoveSubscription++
 		return nil, nil
 	}
 	producer.NRFCacheRemoveNfProfileFromNrfCache = func(nfInstanceId string) bool {
-		fmt.Printf("test NRFCacheRemoveNfProfileFromNrfCache called")
+		t.Logf("test NRFCacheRemoveNfProfileFromNrfCache called")
 		callCountNRFCacheRemoveNfProfileFromNrfCache++
 		return true
 	}

callback/router.go

@@ -31,7 +31,7 @@ type Routes []Route
 
 // NewRouter returns a new router.
 func NewRouter() *gin.Engine {
-	router := loggerUtil.NewGinWithLogrus(logger.GinLog)
+	router := loggerUtil.NewGinWithZap(logger.GinLog)
 	AddService(router)
 	return router
 }

consumer/nf_management.go

@@ -73,15 +73,15 @@ var SendRegisterNFInstance = func(nrfUri, nfInstanceId string, profile models.Nf
 			retrieveNfInstanceId = resourceUri[strings.LastIndex(resourceUri, "/")+1:]
 			return prof, resourceNrfUri, retrieveNfInstanceId, nil
 		} else {
-			fmt.Println(fmt.Errorf("handler returned wrong status code %d", status))
-			fmt.Println(fmt.Errorf("NRF return wrong status code %d", status))
+			logger.ConsumerLog.Errorf("handler returned wrong status code %d", status)
+			logger.ConsumerLog.Errorf("NRF return wrong status code %d", status)
 		}
 	}
 	return prof, "", "", nil
 }
 
 func SendDeregisterNFInstance() (*models.ProblemDetails, error) {
-	logger.AppLog.Infof("Send Deregister NFInstance")
+	logger.AppLog.Infoln("send Deregister NFInstance")
 
 	ausfSelf := ausfContext.GetSelf()
 	// Set client and set url
@@ -109,7 +109,7 @@ func SendDeregisterNFInstance() (*models.ProblemDetails, error) {
 }
 
 var SendUpdateNFInstance = func(patchItem []models.PatchItem) (nfProfile models.NfProfile, problemDetails *models.ProblemDetails, err error) {
-	logger.ConsumerLog.Debugf("Send Update NFInstance")
+	logger.ConsumerLog.Debugln("send Update NFInstance")
 
 	ausfSelf := ausfContext.GetSelf()
 	configuration := Nnrf_NFManagement.NewConfiguration()
@@ -139,7 +139,7 @@ var SendUpdateNFInstance = func(patchItem []models.PatchItem) (nfProfile models.
 }
 
 var SendCreateSubscription = func(nrfUri string, nrfSubscriptionData models.NrfSubscriptionData) (nrfSubData models.NrfSubscriptionData, problemDetails *models.ProblemDetails, err error) {
-	logger.ConsumerLog.Debugf("send Create Subscription")
+	logger.ConsumerLog.Debugln("send Create Subscription")
 
 	// Set client and set url
 	configuration := Nnrf_NFManagement.NewConfiguration()

context/ausf_context_init.go

@@ -7,7 +7,6 @@
 package context
 
 import (
-	"fmt"
 	"os"
 	"strconv"
 	"time"
@@ -31,7 +30,7 @@ func TestInit() {
 
 func InitAusfContext(context *AUSFContext) {
 	config := factory.AusfConfig
-	logger.InitLog.Infof("ausfconfig Info: Version[%s] Description[%s]\n", config.Info.Version, config.Info.Description)
+	logger.InitLog.Infof("ausfconfig Info: Version[%s] Description[%s]", config.Info.Version, config.Info.Description)
 
 	configuration := config.Configuration
 	sbi := configuration.Sbi
@@ -68,11 +67,11 @@ func InitAusfContext(context *AUSFContext) {
 
 		context.BindingIPv4 = os.Getenv(sbi.BindingIPv4)
 		if context.BindingIPv4 != "" {
-			logger.InitLog.Info("Parsing ServerIPv4 address from ENV Variable.")
+			logger.InitLog.Infoln("parsing ServerIPv4 address from ENV Variable")
 		} else {
 			context.BindingIPv4 = sbi.BindingIPv4
 			if context.BindingIPv4 == "" {
-				logger.InitLog.Warn("Error parsing ServerIPv4 address as string. Using the 0.0.0.0 address as default.")
+				logger.InitLog.Warnln("error parsing ServerIPv4 address as string. Using the 0.0.0.0 address as default")
 				context.BindingIPv4 = "0.0.0.0"
 			}
 		}
@@ -95,7 +94,7 @@ func InitAusfContext(context *AUSFContext) {
 	// context.NfService
 	context.NfService = make(map[models.ServiceName]models.NfService)
 	AddNfServices(&context.NfService, &config, context)
-	fmt.Println("ausf context = ", context)
+	logger.ContextLog.Infoln("ausf context:", context)
 }
 
 func AddNfServices(serviceMap *map[models.ServiceName]models.NfService, config *factory.Config, context *AUSFContext) {

factory/ausf_config_test.go

@@ -7,7 +7,6 @@
 package factory
 
 import (
-	"fmt"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -16,7 +15,7 @@ import (
 // Webui URL is not set then default Webui URL value is returned
 func TestGetDefaultWebuiUrl(t *testing.T) {
 	if err := InitConfigFactory("ausfcfg.yaml"); err != nil {
-		fmt.Printf("Error in InitConfigFactory: %v\n", err)
+		t.Logf("error in InitConfigFactory: %v", err)
 	}
 	got := AusfConfig.Configuration.WebuiUri
 	want := "webui:9876"
@@ -26,7 +25,7 @@ func TestGetDefaultWebuiUrl(t *testing.T) {
 // Webui URL is set to a custom value then custom Webui URL is returned
 func TestGetCustomWebuiUrl(t *testing.T) {
 	if err := InitConfigFactory("ausfcfg_with_custom_webui_url.yaml"); err != nil {
-		fmt.Printf("Error in InitConfigFactory: %v\n", err)
+		t.Logf("error in InitConfigFactory: %v", err)
 	}
 	got := AusfConfig.Configuration.WebuiUri
 	want := "myspecialwebui:9872"

go.mod

@@ -4,18 +4,17 @@ go 1.21
 
 require (
 	github.com/antihax/optional v1.0.0
-	github.com/antonfisher/nested-logrus-formatter v1.3.1
 	github.com/bronze1man/radius v0.0.0-20190516032554-afd8baec892d
 	github.com/gin-gonic/gin v1.10.0
 	github.com/google/gopacket v1.1.19
 	github.com/google/uuid v1.6.0
 	github.com/omec-project/config5g v1.5.0
 	github.com/omec-project/openapi v1.3.1
-	github.com/omec-project/util v1.1.0
+	github.com/omec-project/util v1.2.1
 	github.com/prometheus/client_golang v1.20.4
-	github.com/sirupsen/logrus v1.9.3
 	github.com/stretchr/testify v1.9.0
 	github.com/urfave/cli v1.22.15
+	go.uber.org/zap v1.27.0
 	gopkg.in/yaml.v2 v2.4.0
 )
 
@@ -56,7 +55,6 @@ require (
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/ugorji/go/codec v1.2.12 // indirect
 	go.uber.org/multierr v1.10.0 // indirect
-	go.uber.org/zap v1.27.0 // indirect
 	golang.org/x/arch v0.8.0 // indirect
 	golang.org/x/crypto v0.27.0 // indirect
 	golang.org/x/net v0.29.0 // indirect

go.sum

@@ -1,8 +1,6 @@
 github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
 github.com/antihax/optional v1.0.0 h1:xK2lYat7ZLaVVcIuj82J8kIro4V6kDe0AUDFboUCwcg=
 github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY=
-github.com/antonfisher/nested-logrus-formatter v1.3.1 h1:NFJIr+pzwv5QLHTPyKz9UMEoHck02Q9L0FP13b/xSbQ=
-github.com/antonfisher/nested-logrus-formatter v1.3.1/go.mod h1:6WTfyWFkBc9+zyBaKIqRrg/KwMqBbodBjgbHjDz7zjA=
 github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d h1:Byv0BzEl3/e6D5CLfI0j/7hiIEtvGVFPCZ7Ei2oq8iQ=
 github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
@@ -85,8 +83,8 @@ github.com/omec-project/config5g v1.5.0 h1:VC7uHIdg4S4F5onYvpFfaEAFBttWwWh6OSnNn
 github.com/omec-project/config5g v1.5.0/go.mod h1:yTjqsOjy8KQ8o4AlnPeZfP32CEvlm0kug3bMwZ3IDOQ=
 github.com/omec-project/openapi v1.3.1 h1:NCteMRdMtWnMhf1CXYduuLgeu8fEhc/7XO1CiE7fN3Y=
 github.com/omec-project/openapi v1.3.1/go.mod h1:cR6Iharp2TLOzEmskQ/EdCVFZnpKh0zTvUSSuyXAYLE=
-github.com/omec-project/util v1.1.0 h1:TUuLmzqTLChIEXQlK9g5Ihgmw4FUm/UJnjfu0wT8Gz0=
-github.com/omec-project/util v1.1.0/go.mod h1:BEv8nCokB4j0fgAQ6VVkKuQ2PSP3DJMEmz25pFMw5X8=
+github.com/omec-project/util v1.2.1 h1:+o5kbnZzKBmbqT4oprVGPgL0jH5b8BvRMfLye5srGQ4=
+github.com/omec-project/util v1.2.1/go.mod h1:kUF2LXhmtw+m7Bk5IGOMFLj7CA8VKtilLI/9QBJcfxE=
 github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM=
 github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
@@ -106,8 +104,6 @@ github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjR
 github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
-github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
@@ -150,7 +146,6 @@ golang.org/x/oauth2 v0.23.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbht
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=