Move logger to separate directory and misc logging fixes (#70)

krishnamiriyala · web-flow · commit cd16ad81ee91 · 2023-09-25T19:15:14.000-07:00
diff --git a/.golangci.yml b/.golangci.yml
@@ -180,7 +180,7 @@ issues:
     - path: pkg/protostore/protostore_test.go
       linters:
         - maintidx
-    - path: pkg/datastore/logger.go
+    - path: pkg/logutils/logger.go
       linters:
         - gochecknoglobals
     - path: pkg/datastore/sql_struct.go
diff --git a/docs/DOCUMENTATION.md b/docs/DOCUMENTATION.md
diff --git a/pkg/authorizer/metadata_authorizer.go b/pkg/authorizer/metadata_authorizer.go
@@ -26,6 +26,7 @@ import (
 
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
 	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/errors"
+	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 )
 
 const (
@@ -106,11 +107,11 @@ func (s *MetadataBasedAuthorizer) GetMatchingDbRole(ctx context.Context, tableNa
 
 func (s *MetadataBasedAuthorizer) Configure(tableName string, roleMapping map[string]dbrole.DbRole) {
 	if s.roleMapping == nil {
-		// TRACE("RoleMapping: setting to NEWMAP")
+		TRACE("RoleMapping: setting to NEWMAP")
 		s.roleMapping = make(map[string]map[string]dbrole.DbRole)
 	}
 	s.roleMapping[tableName] = roleMapping
-	// TRACE("RoleMapping: configured for table %s: %+v", tableName, s.roleMapping)
+	TRACE("RoleMapping: configured for table %s: %+v", tableName, s.roleMapping)
 }
 
 func (s *MetadataBasedAuthorizer) GetAuthContext(orgId string, roles ...string) context.Context {
diff --git a/pkg/datastore/database.go b/pkg/datastore/database.go
@@ -49,6 +49,7 @@ import (
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/authorizer"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
 	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/errors"
+	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 )
 
 const (
diff --git a/pkg/datastore/datastore_test.go b/pkg/datastore/datastore_test.go
@@ -37,6 +37,7 @@ import (
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/datastore"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
 	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/errors"
+	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/test"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/test/pb"
 )
@@ -179,17 +180,17 @@ func testCrud(t *testing.T, ds datastore.DataStore, ctx context.Context, myCokeA
 }
 
 func TestMain(m *testing.M) {
-	LOG = datastore.GetCompLogger()
+	LOG = logutils.GetCompLogger()
 
 	code := m.Run()
 	os.Exit(code)
 }
 
 func BenchmarkCrud(b *testing.B) {
-	logger := datastore.GetLogger()
+	logger := logutils.GetLogger()
 	logger.SetLevel(logrus.FatalLevel)
 	logger.SetOutput(io.Discard)
-	LOG = logger.WithField(datastore.COMP, datastore.SAAS_PERSISTENCE)
+	LOG = logger.WithField(logutils.COMP, logutils.SAAS_PERSISTENCE)
 
 	var t testing.T
 	ds, _ := SetupDataStore("BenchmarkCrud")
diff --git a/pkg/datastore/datastore_with_txcontext_test.go b/pkg/datastore/datastore_with_txcontext_test.go
@@ -31,6 +31,7 @@ import (
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/authorizer"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/datastore"
 	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/errors"
+	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/test"
 )
 
@@ -123,10 +124,10 @@ func testTxCrud(t *testing.T, ds datastore.DataStore, ctx context.Context, user1
 }
 
 func BenchmarkTxCrud(b *testing.B) {
-	logger := datastore.GetLogger()
+	logger := logutils.GetLogger()
 	logger.SetLevel(logrus.FatalLevel)
 	logger.SetOutput(io.Discard)
-	LOG = logger.WithField(datastore.COMP, datastore.SAAS_PERSISTENCE)
+	LOG = logger.WithField(logutils.COMP, logutils.SAAS_PERSISTENCE)
 
 	var t testing.T
 	ds, _ := SetupDataStore("BenchmarkTxCrud")
diff --git a/pkg/datastore/db_user.go b/pkg/datastore/db_user.go
@@ -25,6 +25,7 @@ import (
 	"strconv"
 
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
+	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 )
 
 // Specifications for database user.
@@ -139,7 +140,7 @@ func getDbUsers(tableName string, tenantRole, instancerRole bool, isTableTenante
 		dbUsers[i].password = getPassword(string(dbUsers[i].username))
 		dbUsers[i].policyName = getRlsPolicyName(string(dbUsers[i].username), tableName)
 	}
-	TRACE("Returning DB user specs for table %q:\n\t[roleT=%s, roleI=%s, tableT=%s, tableI=%s]\n\tdbUsers - %+v\n",
+	TRACE("Returning DB user specs for table %q:\n\t[tenantRole=%t, instancerRole=%t, isTableTenanted=%t, isTableInstanced=%t]\n\n\tdbUsers - %+v\n",
 		tableName, tenantRole, instancerRole, isTableTenanted, isTableInstanced, dbUsers)
 	return dbUsers
 }
diff --git a/pkg/datastore/example_multiinstance_test.go b/pkg/datastore/example_multiinstance_test.go
@@ -8,6 +8,7 @@ import (
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/authorizer"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/datastore"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
+	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 )
 
 type Person struct {
@@ -39,7 +40,7 @@ func ExampleDataStore_multiInstance() {
 	ProdInstanceCtx := instancer.WithInstanceId(ServiceAdminCtx, "Prod")
 
 	// Initializes the Datastore using the metadata authorizer and connection details obtained from the ENV variables.
-	ds, err := datastore.FromEnvWithDB(datastore.GetCompLogger(), mdAuthorizer, instancer, "ExampleDataStore_multiInstance")
+	ds, err := datastore.FromEnvWithDB(logutils.GetCompLogger(), mdAuthorizer, instancer, "ExampleDataStore_multiInstance")
 	defer ds.Reset()
 	if err != nil {
 		log.Fatalf("datastore initialization from env errored: %s", err)
diff --git a/pkg/datastore/example_multitenancy_test.go b/pkg/datastore/example_multitenancy_test.go
@@ -8,6 +8,7 @@ import (
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/authorizer"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/datastore"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
+	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 )
 
 type User struct {
@@ -36,7 +37,7 @@ func ExampleDataStore_multiTenancy() {
 	PepsiOrgCtx := mdAuthorizer.GetAuthContext("Pepsi", TENANT_ADMIN)
 
 	// Initializes the Datastore using the metadata authorizer and connection details obtained from the ENV variables.
-	ds, err := datastore.FromEnvWithDB(datastore.GetCompLogger(), mdAuthorizer, nil, "ExampleDataStore_multiTenancy")
+	ds, err := datastore.FromEnvWithDB(logutils.GetCompLogger(), mdAuthorizer, nil, "ExampleDataStore_multiTenancy")
 	defer ds.Reset()
 	if err != nil {
 		log.Fatalf("datastore initialization from env errored: %s", err)
diff --git a/pkg/datastore/helper.go b/pkg/datastore/helper.go
@@ -33,6 +33,7 @@ import (
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/authorizer"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
 	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/errors"
+	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 )
 
 const (
@@ -113,7 +114,7 @@ func FromEnvWithDB(l *logrus.Entry, a authorizer.Authorizer, instancer authorize
 }
 
 func FromConfig(l *logrus.Entry, a authorizer.Authorizer, instancer authorizer.Instancer, cfg DBConfig) (d DataStore, err error) {
-	gl := GetGormLogger(l)
+	gl := logutils.GetGormLogger(l)
 	dbConnInitializer := func(db *relationalDb, dbRole dbrole.DbRole) error {
 		db.Lock()
 		defer db.Unlock()
diff --git a/pkg/datastore/noinstancer_test.go b/pkg/datastore/noinstancer_test.go
@@ -13,6 +13,7 @@ import (
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/authorizer"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/datastore"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
+	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/test"
 )
 
@@ -41,7 +42,7 @@ func TestDataStoreWithoutInstancer(t *testing.T) {
 	DevInstanceCtx := instancer.WithInstanceId(ServiceAdminCtx, "Dev")
 	ProdInstanceCtx := instancer.WithInstanceId(ServiceAdminCtx, "Prod")
 
-	ds, _ := datastore.FromEnv(datastore.GetCompLogger(), mdAuthorizer, nil)
+	ds, _ := datastore.FromEnvWithDB(logutils.GetCompLogger(), mdAuthorizer, nil, "TestDataStoreWithoutInstancer")
 	defer ds.Reset()
 	roleMapping := map[string]dbrole.DbRole{
 		SERVICE_AUDITOR: dbrole.READER,
diff --git a/pkg/datastore/sql_struct.go b/pkg/datastore/sql_struct.go
@@ -24,6 +24,8 @@ import (
 	"sync"
 
 	"gorm.io/gorm/schema"
+
+	. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 )
 
 // Library processing all the golang tags in the struct into SQL domain
diff --git a/pkg/logutils/logger.go b/pkg/logutils/logger.go
@@ -16,7 +16,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package datastore
+package logutils
 
 import (
 	"context"
diff --git a/pkg/protostore/example_protostore_test.go b/pkg/protostore/example_protostore_test.go
@@ -7,13 +7,14 @@ import (
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/authorizer"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/datastore"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
+	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/protostore"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/test/pb"
 )
 
 func ExampleProtoStore() {
 	// Initialize protostore with proper logger, authorizer and datastore
-	myLogger := datastore.GetCompLogger()
+	myLogger := logutils.GetCompLogger()
 	mdAuthorizer := &authorizer.MetadataBasedAuthorizer{}
 	myDatastore, _ := datastore.FromEnvWithDB(myLogger, mdAuthorizer, nil, "ExampleProtoStore")
 	defer myDatastore.Reset()
diff --git a/pkg/protostore/protostore_test.go b/pkg/protostore/protostore_test.go
@@ -304,7 +304,6 @@ The test case will first initialize "producer's" ProtoStore instance and later "
 */
 func TestProtoStoreInDbFindAll_DifferentProducerConsumer_InitProducerFirst(t *testing.T) {
 	const dbName = "TestProtoStoreInDbFindAll_DifferentProducerConsumer"
-	t.Log("Dropping all DB tables...")
 	t.Log("Creating producer's ProtoStore instance (instancer ENABLED)")
 	pNoInstancer := setupDbContextNoInstancer(t, dbName, true /* dropTables */)
 
@@ -318,7 +317,6 @@ func TestProtoStoreInDbFindAll_DifferentProducerConsumer_InitProducerFirst(t *te
 // is initialized first.
 func TestProtoStoreInDbFindAll_DifferentProducerConsumer_InitConsumerFirst(t *testing.T) {
 	const dbName = "TestProtoStoreInDbFindAll_DifferentProducerConsumer"
-	t.Log("Dropping all DB tables...")
 	t.Log("Creating consumer's ProtoStore instance (instancer DISABLED)")
 	pWithInstancer := setupDbContextWithInstancer(t, dbName, true /* dropTables */)
 
@@ -337,7 +335,6 @@ func testProtoStoreInDbFindAll_DifferentProducerConsumer(t *testing.T, pNoInstan
 	t.Helper()
 	assert := assert.New(t)
 
-	t.Log("====================START OF UNIT TEST====================")
 	memMsg1, memMsg2 := pb.Memory{}, pb.Memory{}
 	for _, protoMsg := range []proto.Message{&memMsg1, &memMsg2} {
 		_ = faker.FakeData(protoMsg)
diff --git a/test/helper.go b/test/helper.go
@@ -23,6 +23,7 @@ import (
 
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/datastore"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"
+	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"
 	"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/protostore"
 )
 
@@ -32,11 +33,11 @@ func SetupDataStore(dbName string) (datastore.DataStore, protostore.ProtoStore)
 	if err != nil {
 		log.Fatalf("Failed to create database from cfg %+v", cfg)
 	}
-	ds, err := datastore.FromConfig(datastore.GetCompLogger(), TestMetadataAuthorizer, TestInstancer, cfg)
+	ds, err := datastore.FromConfig(logutils.GetCompLogger(), TestMetadataAuthorizer, TestInstancer, cfg)
 	if err != nil {
 		log.Fatalf("Failed to initialize datastore from cfg %+v", cfg)
 	}
-	ps := protostore.GetProtoStore(datastore.GetCompLogger(), ds)
+	ps := protostore.GetProtoStore(logutils.GetCompLogger(), ds)
 	return ds, ps
 }
 
@@ -46,11 +47,11 @@ func SetupDataStoreNoInstancer(dbName string) (datastore.DataStore, protostore.P
 	if err != nil {
 		log.Fatalf("Failed to create database from cfg %+v", cfg)
 	}
-	ds, err := datastore.FromConfig(datastore.GetCompLogger(), TestMetadataAuthorizer, nil /* instancer */, cfg)
+	ds, err := datastore.FromConfig(logutils.GetCompLogger(), TestMetadataAuthorizer, nil /* instancer */, cfg)
 	if err != nil {
 		log.Fatalf("Failed to initialize datastore from cfg %+v", cfg)
 	}
-	ps := protostore.GetProtoStore(datastore.GetCompLogger(), ds)
+	ps := protostore.GetProtoStore(logutils.GetCompLogger(), ds)
 	return ds, ps
 }
 

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ import (`
`26`	`26`
`27`	`27`	`"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"`
`28`	`28`	`. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/errors"`
	`29`	`+ . "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"`
`29`	`30`	`)`
`30`	`31`
`31`	`32`	`const (`
`@@ -106,11 +107,11 @@ func (s *MetadataBasedAuthorizer) GetMatchingDbRole(ctx context.Context, tableNa`
`106`	`107`
`107`	`108`	`func (s *MetadataBasedAuthorizer) Configure(tableName string, roleMapping map[string]dbrole.DbRole) {`
`108`	`109`	`if s.roleMapping == nil {`
`109`		`- // TRACE("RoleMapping: setting to NEWMAP")`
	`110`	`+ TRACE("RoleMapping: setting to NEWMAP")`
`110`	`111`	`s.roleMapping = make(map[string]map[string]dbrole.DbRole)`
`111`	`112`	`}`
`112`	`113`	`s.roleMapping[tableName] = roleMapping`
`113`		`- // TRACE("RoleMapping: configured for table %s: %+v", tableName, s.roleMapping)`
	`114`	`+ TRACE("RoleMapping: configured for table %s: %+v", tableName, s.roleMapping)`
`114`	`115`	`}`
`115`	`116`
`116`	`117`	`func (s *MetadataBasedAuthorizer) GetAuthContext(orgId string, roles ...string) context.Context {`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ import (`
`49`	`49`	`"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/authorizer"`
`50`	`50`	`"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"`
`51`	`51`	`. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/errors"`
	`52`	`+ . "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"`
`52`	`53`	`)`
`53`	`54`
`54`	`55`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ import (`
`25`	`25`	`"strconv"`
`26`	`26`
`27`	`27`	`"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"`
	`28`	`+ . "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"`
`28`	`29`	`)`
`29`	`30`
`30`	`31`	`// Specifications for database user.`
`@@ -139,7 +140,7 @@ func getDbUsers(tableName string, tenantRole, instancerRole bool, isTableTenante`
`139`	`140`	`dbUsers[i].password = getPassword(string(dbUsers[i].username))`
`140`	`141`	`dbUsers[i].policyName = getRlsPolicyName(string(dbUsers[i].username), tableName)`
`141`	`142`	`}`
`142`		`- TRACE("Returning DB user specs for table %q:\n\t[roleT=%s, roleI=%s, tableT=%s, tableI=%s]\n\tdbUsers - %+v\n",`
	`143`	`+ TRACE("Returning DB user specs for table %q:\n\t[tenantRole=%t, instancerRole=%t, isTableTenanted=%t, isTableInstanced=%t]\n\n\tdbUsers - %+v\n",`
`143`	`144`	`tableName, tenantRole, instancerRole, isTableTenanted, isTableInstanced, dbUsers)`
`144`	`145`	`return dbUsers`
`145`	`146`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ import (`
`33`	`33`	`"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/authorizer"`
`34`	`34`	`"github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/dbrole"`
`35`	`35`	`. "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/errors"`
	`36`	`+ "github.com/vmware-labs/multi-tenant-persistence-for-saas/pkg/logutils"`
`36`	`37`	`)`
`37`	`38`
`38`	`39`	`const (`
`@@ -113,7 +114,7 @@ func FromEnvWithDB(l *logrus.Entry, a authorizer.Authorizer, instancer authorize`
`113`	`114`	`}`
`114`	`115`
`115`	`116`	`func FromConfig(l *logrus.Entry, a authorizer.Authorizer, instancer authorizer.Instancer, cfg DBConfig) (d DataStore, err error) {`
`116`		`- gl := GetGormLogger(l)`
	`117`	`+ gl := logutils.GetGormLogger(l)`
`117`	`118`	`dbConnInitializer := func(db *relationalDb, dbRole dbrole.DbRole) error {`
`118`	`119`	`db.Lock()`
`119`	`120`	`defer db.Unlock()`