Add more unit tests

backend/internal/entity/auth/entity_test.go

@@ -92,6 +92,21 @@ func (s *testsuite) TestGetByUserIDType() {
 	assertModel(s.T(), m)
 }
 
+func (s *testsuite) TestGetByIdenityType() {
+	// goleak is used to detect goroutine leaks
+	defer goleak.VerifyNone(s.T(), goleak.IgnoreAnyFunction("database/sql.(*DB).connectionOpener"))
+
+	s.mock.
+		ExpectQuery(regexp.QuoteMeta(`SELECT * FROM "auth" WHERE identity = $1 AND type = $2 AND "auth"."is_deleted" = $3 ORDER BY "auth"."id" LIMIT $4`)).
+		WithArgs("johndoe", TypeLocal, 0, 1).
+		WillReturnRows(s.singleRow)
+
+	m, err := GetByIdenityType("johndoe", TypeLocal)
+	require.NoError(s.T(), err)
+	require.NoError(s.T(), s.mock.ExpectationsWereMet())
+	assertModel(s.T(), m)
+}
+
 func (s *testsuite) TestSave() {
 	// goleak is used to detect goroutine leaks
 	defer goleak.VerifyNone(s.T(), goleak.IgnoreAnyFunction("database/sql.(*DB).connectionOpener"))

backend/internal/entity/auth/oauth.go

@@ -17,7 +17,10 @@ import (
 )
 
 // AuthCache is a cache item that stores the Admin API data for each admin that has been requesting endpoints
-var OAuthCache *cache.Cache
+var (
+	OAuthCache              *cache.Cache
+	settingGetOAuthSettings = setting.GetOAuthSettings
+)
 
 // OAuthCacheInit will create a new Memory Cache
 func OAuthCacheInit() {
@@ -34,8 +37,7 @@ type OAuthUser struct {
 	Resource   map[string]interface{} `json:"resource"`
 }
 
-// GetEmail will return an email address even if it can't be known in the
-// Resource
+// GetResourceField will attempt to get a field from the resource
 func (m *OAuthUser) GetResourceField(field string) string {
 	if m.Resource != nil {
 		if value, ok := m.Resource[field]; ok {
@@ -45,8 +47,7 @@ func (m *OAuthUser) GetResourceField(field string) string {
 	return ""
 }
 
-// GetEmail will return an email address even if it can't be known in the
-// Resource
+// GetID attempts to get an ID from the resource
 func (m *OAuthUser) GetID() string {
 	if m.Identifier != "" {
 		return m.Identifier
@@ -110,7 +111,7 @@ func (m *OAuthUser) GetEmail() string {
 }
 
 func getOAuth2Config() (*oauth2.Config, *setting.OAuthSettings, error) {
-	oauthSettings, err := setting.GetOAuthSettings()
+	oauthSettings, err := settingGetOAuthSettings()
 	if err != nil {
 		return nil, nil, err
 	}
@@ -130,7 +131,8 @@ func getOAuth2Config() (*oauth2.Config, *setting.OAuthSettings, error) {
 	}, &oauthSettings, nil
 }
 
-// OAuthLogin ...
+// OAuthLogin is hit by the client to generate a URL to redirect to
+// and start the oauth process
 func OAuthLogin(redirectBase, ipAddress string) (string, error) {
 	OAuthCacheInit()
 

backend/internal/entity/auth/oauth_test.go

@@ -0,0 +1,430 @@
+package auth
+
+import (
+	"context"
+	"testing"
+
+	"npm/internal/entity/setting"
+
+	cache "github.com/patrickmn/go-cache"
+	"github.com/rotisserie/eris"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetOAuth2Config(t *testing.T) {
+	tests := []struct {
+		name          string
+		mockSettings  setting.OAuthSettings
+		expectedError error
+	}{
+		{
+			name: "Valid settings",
+			mockSettings: setting.OAuthSettings{
+				ClientID:     "valid-client-id",
+				ClientSecret: "valid-client-secret",
+				AuthURL:      "https://auth.url",
+				TokenURL:     "https://token.url",
+				Scopes:       []string{"scope1", "scope2"},
+			},
+			expectedError: nil,
+		},
+		{
+			name: "Missing ClientID",
+			mockSettings: setting.OAuthSettings{
+				ClientSecret: "valid-client-secret",
+				AuthURL:      "https://auth.url",
+				TokenURL:     "https://token.url",
+				Scopes:       []string{"scope1", "scope2"},
+			},
+			expectedError: eris.New("oauth-settings-incorrect"),
+		},
+		{
+			name: "Missing ClientSecret",
+			mockSettings: setting.OAuthSettings{
+				ClientID: "valid-client-id",
+				AuthURL:  "https://auth.url",
+				TokenURL: "https://token.url",
+				Scopes:   []string{"scope1", "scope2"},
+			},
+			expectedError: eris.New("oauth-settings-incorrect"),
+		},
+		{
+			name: "Missing AuthURL",
+			mockSettings: setting.OAuthSettings{
+				ClientID:     "valid-client-id",
+				ClientSecret: "valid-client-secret",
+				TokenURL:     "https://token.url",
+				Scopes:       []string{"scope1", "scope2"},
+			},
+			expectedError: eris.New("oauth-settings-incorrect"),
+		},
+		{
+			name: "Missing TokenURL",
+			mockSettings: setting.OAuthSettings{
+				ClientID:     "valid-client-id",
+				ClientSecret: "valid-client-secret",
+				AuthURL:      "https://auth.url",
+				Scopes:       []string{"scope1", "scope2"},
+			},
+			expectedError: eris.New("oauth-settings-incorrect"),
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			// Mock the GetOAuthSettings function
+			settingGetOAuthSettings = func() (setting.OAuthSettings, error) {
+				return tt.mockSettings, nil
+			}
+
+			config, settings, err := getOAuth2Config()
+
+			if tt.expectedError != nil {
+				assert.Error(t, err)
+				assert.Equal(t, tt.expectedError.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+				assert.NotNil(t, config)
+				assert.NotNil(t, settings)
+				assert.Equal(t, tt.mockSettings.ClientID, config.ClientID)
+				assert.Equal(t, tt.mockSettings.ClientSecret, config.ClientSecret)
+				assert.Equal(t, tt.mockSettings.AuthURL, config.Endpoint.AuthURL)
+				assert.Equal(t, tt.mockSettings.TokenURL, config.Endpoint.TokenURL)
+				assert.Equal(t, tt.mockSettings.Scopes, config.Scopes)
+			}
+		})
+	}
+}
+
+func TestGetEmail(t *testing.T) {
+	tests := []struct {
+		name      string
+		oauthUser OAuthUser
+		expected  string
+	}{
+		{
+			name: "Email in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"email": "user@example.com",
+				},
+			},
+			expected: "user@example.com",
+		},
+		{
+			name: "Identifier is email",
+			oauthUser: OAuthUser{
+				Identifier: "user@example.com",
+			},
+			expected: "user@example.com",
+		},
+		{
+			name: "Identifier is not email",
+			oauthUser: OAuthUser{
+				Identifier: "user123",
+			},
+			expected: "user123@oauth",
+		},
+		{
+			name: "No email or identifier",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{},
+			},
+			expected: "",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			email := tt.oauthUser.GetEmail()
+			assert.Equal(t, tt.expected, email)
+		})
+	}
+}
+
+func TestGetName(t *testing.T) {
+	tests := []struct {
+		name      string
+		oauthUser OAuthUser
+		expected  string
+	}{
+		{
+			name: "Nickname in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"nickname": "user_nick",
+				},
+			},
+			expected: "user_nick",
+		},
+		{
+			name: "Given name in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"given_name": "User Given",
+				},
+			},
+			expected: "User Given",
+		},
+		{
+			name: "Name in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"name": "User Name",
+				},
+			},
+			expected: "User Name",
+		},
+		{
+			name: "Preferred username in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"preferred_username": "preferred_user",
+				},
+			},
+			expected: "preferred_user",
+		},
+		{
+			name: "Username in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"username": "user123",
+				},
+			},
+			expected: "user123",
+		},
+		{
+			name: "No name fields in resource, fallback to identifier",
+			oauthUser: OAuthUser{
+				Identifier: "fallback_identifier",
+				Resource:   map[string]interface{}{},
+			},
+			expected: "fallback_identifier",
+		},
+		{
+			name: "No name fields and no identifier",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{},
+			},
+			expected: "",
+		},
+		{
+			name: "All fields",
+			oauthUser: OAuthUser{
+				Identifier: "fallback_identifier",
+				Resource: map[string]interface{}{
+					"nickname":           "user_nick",
+					"given_name":         "User Given",
+					"name":               "User Name",
+					"preferred_username": "preferred_user",
+					"username":           "user123",
+				},
+			},
+			expected: "user_nick",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			name := tt.oauthUser.GetName()
+			assert.Equal(t, tt.expected, name)
+		})
+	}
+}
+
+func TestGetID(t *testing.T) {
+	tests := []struct {
+		name      string
+		oauthUser OAuthUser
+		expected  string
+	}{
+		{
+			name: "Identifier is set",
+			oauthUser: OAuthUser{
+				Identifier: "user123",
+			},
+			expected: "user123",
+		},
+		{
+			name: "UID in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"uid": "uid123",
+				},
+			},
+			expected: "uid123",
+		},
+		{
+			name: "User ID in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"user_id": "user_id123",
+				},
+			},
+			expected: "user_id123",
+		},
+		{
+			name: "Username in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"username": "username123",
+				},
+			},
+			expected: "username123",
+		},
+		{
+			name: "Preferred username in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"preferred_username": "preferred_user",
+				},
+			},
+			expected: "preferred_user",
+		},
+		{
+			name: "Email in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"email": "user@example.com",
+				},
+			},
+			expected: "user@example.com",
+		},
+		{
+			name: "Mail in resource",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{
+					"mail": "mail@example.com",
+				},
+			},
+			expected: "mail@example.com",
+		},
+		{
+			name: "No identifier or resource fields",
+			oauthUser: OAuthUser{
+				Resource: map[string]interface{}{},
+			},
+			expected: "",
+		},
+		{
+			name: "All fields",
+			oauthUser: OAuthUser{
+				Identifier: "user123",
+				Resource: map[string]interface{}{
+					"uid":                "uid123",
+					"user_id":            "user_id123",
+					"username":           "username123",
+					"preferred_username": "preferred_user",
+					"mail":               "mail@example.com",
+					"email":              "email@example.com",
+				},
+			},
+			expected: "user123",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			id := tt.oauthUser.GetID()
+			assert.Equal(t, tt.expected, id)
+		})
+	}
+}
+
+func TestOAuthLogin(t *testing.T) {
+	tests := []struct {
+		name          string
+		redirectBase  string
+		ipAddress     string
+		expectedError error
+	}{
+		{
+			name:          "Valid redirect base",
+			redirectBase:  "https://redirect.base",
+			ipAddress:     "127.0.0.1",
+			expectedError: nil,
+		},
+		{
+			name:          "Empty redirect base",
+			redirectBase:  "",
+			ipAddress:     "127.0.0.1",
+			expectedError: nil,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			// Mock the GetOAuthSettings function
+			settingGetOAuthSettings = func() (setting.OAuthSettings, error) {
+				return setting.OAuthSettings{
+					ClientID:     "valid-client-id",
+					ClientSecret: "valid-client-secret",
+					AuthURL:      "https://auth.url",
+					TokenURL:     "https://token.url",
+					Scopes:       []string{"scope1", "scope2"},
+				}, nil
+			}
+
+			url, err := OAuthLogin(tt.redirectBase, tt.ipAddress)
+
+			if tt.expectedError != nil {
+				assert.Error(t, err)
+				assert.Equal(t, tt.expectedError.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+				assert.NotEmpty(t, url)
+			}
+		})
+	}
+}
+
+func TestOAuthReturn(t *testing.T) {
+	var errNotFound = eris.New("oauth-verifier-not-found")
+	tests := []struct {
+		name          string
+		code          string
+		ipAddress     string
+		expectedError error
+	}{
+		{
+			name:          "Invalid code",
+			code:          "invalid-code",
+			ipAddress:     "127.0.0.100",
+			expectedError: errNotFound,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			// Mock the GetOAuthSettings function
+			settingGetOAuthSettings = func() (setting.OAuthSettings, error) {
+				return setting.OAuthSettings{
+					ClientID:     "valid-client-id",
+					ClientSecret: "valid-client-secret",
+					AuthURL:      "https://auth.url",
+					TokenURL:     "https://token.url",
+					Scopes:       []string{"scope1", "scope2"},
+					ResourceURL:  "https://resource.url",
+					Identifier:   "id",
+				}, nil
+			}
+
+			// Initialise the cache and set a verifier
+			OAuthCacheInit()
+			if tt.expectedError != errNotFound {
+				OAuthCache.Set(getCacheKey(tt.ipAddress), "valid-verifier", cache.DefaultExpiration)
+			}
+
+			ctx := context.Background()
+			user, err := OAuthReturn(ctx, tt.code, tt.ipAddress)
+
+			if tt.expectedError != nil {
+				assert.Error(t, err)
+				assert.Equal(t, tt.expectedError.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+				assert.NotNil(t, user)
+			}
+		})
+	}
+}

backend/internal/entity/filters.go

@@ -16,14 +16,3 @@ func GetFilterMap(m interface{}, includeBaseEntity bool) map[string]model.Filter
 
 	return filterMap
 }
-
-// func mergeFilterMaps(m1 map[string]model.FilterMapValue, m2 map[string]model.FilterMapValue) map[string]model.FilterMapValue {
-// 	merged := make(map[string]model.FilterMapValue, 0)
-// 	for k, v := range m1 {
-// 		merged[k] = v
-// 	}
-// 	for key, value := range m2 {
-// 		merged[key] = value
-// 	}
-// 	return merged
-// }

backend/internal/entity/scopes_test.go

@@ -0,0 +1,33 @@
+package entity
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestParseBoolValue(t *testing.T) {
+	tests := []struct {
+		input    string
+		expected []string
+	}{
+		{"yes", []string{"1"}},
+		{"true", []string{"1"}},
+		{"on", []string{"1"}},
+		{"t", []string{"1"}},
+		{"1", []string{"1"}},
+		{"y", []string{"1"}},
+		{"no", []string{"0"}},
+		{"false", []string{"0"}},
+		{"off", []string{"0"}},
+		{"f", []string{"0"}},
+		{"0", []string{"0"}},
+		{"n", []string{"0"}},
+		{"random", []string{"0"}},
+	}
+
+	for _, test := range tests {
+		result := parseBoolValue(test.input)
+		assert.Equal(t, test.expected, result, "Input: %s", test.input)
+	}
+}