From d74acdf98e7a7b0a3a270e3e0ad042ff1f021791 Mon Sep 17 00:00:00 2001 From: Abdul Wahab Date: Wed, 13 Mar 2024 00:33:51 +0500 Subject: [PATCH] Added UTs for db config --- db/config.go | 20 ++++-- db/config_test.go | 154 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 169 insertions(+), 5 deletions(-) create mode 100644 db/config_test.go diff --git a/db/config.go b/db/config.go index 19b948254..d3d7c4425 100644 --- a/db/config.go +++ b/db/config.go @@ -11,7 +11,17 @@ import ( ) type database struct { - db *gorm.DB + db *gorm.DB + getOrganizationByUuid func(uuid string) Organization + getUserRoles func(uuid string, pubkey string) []UserRoles +} + +func NewDatabaseConfig(db *gorm.DB) *database { + return &database{ + db: db, + getOrganizationByUuid: DB.GetOrganizationByUuid, + getUserRoles: DB.GetUserRoles, + } } // DB is the object @@ -264,10 +274,10 @@ func UserHasAccess(pubKeyFromAuth string, uuid string, role string) bool { } func (db database) UserHasAccess(pubKeyFromAuth string, uuid string, role string) bool { - org := DB.GetOrganizationByUuid(uuid) + org := db.getOrganizationByUuid(uuid) var hasRole bool = false if pubKeyFromAuth != org.OwnerPubKey { - userRoles := DB.GetUserRoles(uuid, pubKeyFromAuth) + userRoles := db.getUserRoles(uuid, pubKeyFromAuth) hasRole = RolesCheck(userRoles, role) return hasRole } @@ -276,9 +286,9 @@ func (db database) UserHasAccess(pubKeyFromAuth string, uuid string, role string func (db database) UserHasManageBountyRoles(pubKeyFromAuth string, uuid string) bool { var manageRolesCount = len(ManageBountiesGroup) - org := DB.GetOrganizationByUuid(uuid) + org := db.getOrganizationByUuid(uuid) if pubKeyFromAuth != org.OwnerPubKey { - userRoles := DB.GetUserRoles(uuid, pubKeyFromAuth) + userRoles := db.getUserRoles(uuid, pubKeyFromAuth) for _, role := range ManageBountiesGroup { // check for the manage bounty roles diff --git a/db/config_test.go b/db/config_test.go new file mode 100644 index 000000000..1b78d8002 --- /dev/null +++ b/db/config_test.go @@ -0,0 +1,154 @@ +package db + +import ( + "testing" + "time" + + "github.com/stretchr/testify/assert" + "gorm.io/gorm" +) + +func TestRolesCheck_UserHasRole(t *testing.T) { + // Mock user roles + userRoles := []UserRoles{ + {Role: "ADD BOUNTY", OwnerPubKey: "user1", OrgUuid: "org1", Created: &time.Time{}}, + } + + // Role to check + roleToCheck := "ADD BOUNTY" + + // Call the function + result := RolesCheck(userRoles, roleToCheck) + + // Assert that it returns true + if !result { + t.Errorf("Expected RolesCheck to return true for user with role %s, got false", roleToCheck) + } +} + +func TestRolesCheck_UserDoesNotHaveRole(t *testing.T) { + // Mock user roles + userRoles := []UserRoles{ + {Role: "DELETE BOUNTY", OwnerPubKey: "user2", OrgUuid: "org1", Created: &time.Time{}}, + } + + // Role to check + roleToCheck := "ADD BOUNTY" + + // Call the function + result := RolesCheck(userRoles, roleToCheck) + + // Assert that it returns false + if result { + t.Errorf("Expected RolesCheck to return false for user without role %s, got true", roleToCheck) + } +} + +func TestCheckUser(t *testing.T) { + userRoles := []UserRoles{ + {OwnerPubKey: "userPublicKey"}, + } + + // if in the user roles, one of the owner_pubkey belongs to the user return true else return false + assert.True(t, CheckUser(userRoles, "userPublicKey")) + assert.False(t, CheckUser(userRoles, "anotherPublicKey")) +} + +func TestUserHasAccess(t *testing.T) { + mockGetOrganizationByUuid := func(uuid string) Organization { + return Organization{ + Uuid: uuid, + OwnerPubKey: "org_admin", + } + } + + mockGetUserRoles := func(uuid string, pubkey string) []UserRoles { + return []UserRoles{ + {Role: "ADD BOUNTY", OwnerPubKey: pubkey, OrgUuid: uuid, Created: &time.Time{}}, + } + } + + mockDB := &gorm.DB{} + + databaseConfig := NewDatabaseConfig(mockDB) + databaseConfig.getOrganizationByUuid = mockGetOrganizationByUuid + databaseConfig.getUserRoles = mockGetUserRoles + + t.Run("Should test that if the user is the admin of an organization returns true", func(t *testing.T) { + result := databaseConfig.UserHasAccess("org_admin", "org_uuid", "ADD BOUNTY") + + // Assert that it returns true since the user is the org admin + if !result { + t.Errorf("Expected UserHasAccess to return true for organization admin, got false") + } + }) + + t.Run("Should test that if the user is not the organization admin, and the user has the required role it should return true", func(t *testing.T) { + result := databaseConfig.UserHasAccess("user_pubkey", "org_uuid", "ADD BOUNTY") + + // Assert that it returns true since the user has the required role + if !result { + t.Errorf("Expected UserHasAccess to return true for user with required role, got false") + } + }) + + t.Run("Should test that if the user is not the organization admin, and the user has not the required role it should return false", func(t *testing.T) { + result := databaseConfig.UserHasAccess("user_pubkey", "org_uuid", "DELETE BOUNTY") + + // Assert that it returns false since the user does not have the required role + if result { + t.Errorf("Expected UserHasAccess to return false for user without required role, got true") + } + }) +} + +func TestUserHasManageBountyRoles(t *testing.T) { + mockGetOrganizationByUuid := func(uuid string) Organization { + return Organization{ + Uuid: uuid, + OwnerPubKey: "org_admin", + } + } + + mockGetUserRoles := func(uuid string, pubkey string) []UserRoles { + if uuid == "org_uuid" { + return []UserRoles{ + {Role: "ADD BOUNTY", OwnerPubKey: pubkey, OrgUuid: uuid, Created: &time.Time{}}, + } + } else { + return []UserRoles{ + {Role: "ADD BOUNTY", OwnerPubKey: pubkey, OrgUuid: uuid, Created: &time.Time{}}, + {Role: "UPDATE BOUNTY", OwnerPubKey: pubkey, OrgUuid: uuid, Created: &time.Time{}}, + {Role: "DELETE BOUNTY", OwnerPubKey: pubkey, OrgUuid: uuid, Created: &time.Time{}}, + {Role: "PAY BOUNTY", OwnerPubKey: pubkey, OrgUuid: uuid, Created: &time.Time{}}, + } + } + } + + mockDB := &gorm.DB{} + + databaseConfig := NewDatabaseConfig(mockDB) + databaseConfig.getOrganizationByUuid = mockGetOrganizationByUuid + databaseConfig.getUserRoles = mockGetUserRoles + + t.Run("Should test that if the user is the organization admin return true", func(t *testing.T) { + result := databaseConfig.UserHasManageBountyRoles("org_admin", "org_uuid") + + // Assert that it returns true since the user is the org admin + assert.True(t, result, "Expected UserHasManageBountyRoles to return true for organization admin") + }) + + t.Run("Should test that if the user has all bounty roles return true", func(t *testing.T) { + result := databaseConfig.UserHasManageBountyRoles("user_pubkey", "org_uuid2") + + // Assert that it returns true since the user has all bounty roles + assert.True(t, result, "Expected UserHasManageBountyRoles to return true for user with all bounty roles") + }) + + t.Run("Should test that if the user don't have all bounty roles return false.", func(t *testing.T) { + result := databaseConfig.UserHasManageBountyRoles("user_pubkey", "org_uuid") + + // Assert that it returns false since the user does not have all bounty roles + assert.False(t, result, "Expected UserHasManageBountyRoles to return false for user without all bounty roles") + }) +}