snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s

This commit is contained in:
upstream-mirror
2026-09-16 00:29:55 +05:00
commit 240db4e2a7
15309 changed files with 2173406 additions and 0 deletions

View File

@@ -0,0 +1,848 @@
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
package model
import (
"fmt"
"net/http"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/mattermost/mattermost/server/public/shared/mlog"
"github.com/mattermost/mattermost/server/public/shared/timezones"
)
func TestUserAuditable(t *testing.T) {
t.Run("zero value", func(t *testing.T) {
var u User
m := u.Auditable()
require.NotNil(t, m)
assert.Equal(t, "", m["remote_id"])
})
t.Run("values set", func(t *testing.T) {
id := NewId()
now := GetMillis()
u := User{
Id: id,
CreateAt: now,
UpdateAt: now,
DeleteAt: now,
Username: "some user_name",
Password: "some password",
AuthData: new("some_auth_data"),
AuthService: UserAuthServiceLdap,
Email: "test@example.org",
EmailVerified: true,
Position: "some position",
Roles: strings.Join([]string{ChannelAdminRoleId, SystemManagerRoleId}, ","),
AllowMarketing: true,
Props: StringMap{
"foo": "bar",
},
NotifyProps: StringMap{
"bar": "foo",
},
Locale: DefaultLocale,
Timezone: timezones.DefaultUserTimezone(),
MfaActive: true,
RemoteId: new("some_remote"),
}
m := u.Auditable()
expected := map[string]any{
"id": id,
"create_at": now,
"update_at": now,
"delete_at": now,
"username": "some user_name",
"auth_service": "ldap",
"email": "test@example.org",
"email_verified": true,
"position": "some position",
"roles": "channel_admin,system_manager",
"allow_marketing": true,
"props": StringMap{
"foo": "bar",
},
"notify_props": StringMap{
"bar": "foo",
},
"last_password_update": int64(0),
"last_picture_update": int64(0),
"failed_attempts": 0,
"locale": "en",
"timezone": StringMap(timezones.DefaultUserTimezone()),
"mfa_active": true,
"remote_id": "some_remote",
"last_activity_at": int64(0),
"is_bot": false,
"bot_description": "",
"bot_last_icon_update": int64(0),
"terms_of_service_id": "",
"terms_of_service_create_at": int64(0),
"disable_welcome_email": false,
}
assert.Equal(t, expected, m)
})
}
func TestUserLogClone(t *testing.T) {
t.Run("zero value", func(t *testing.T) {
var u User
l := u.LogClone()
require.NotNil(t, l)
m, ok := l.(map[string]any)
require.True(t, ok)
assert.Equal(t, "", m["remote_id"])
})
t.Run("values set", func(t *testing.T) {
id := NewId()
now := GetMillis()
u := User{
Id: id,
CreateAt: now,
UpdateAt: now,
DeleteAt: now,
Username: "some user_name",
Password: "some password",
AuthData: new("some_auth_data"),
AuthService: UserAuthServiceLdap,
Email: "test@example.org",
EmailVerified: true,
Position: "some position",
Roles: strings.Join([]string{ChannelAdminRoleId, SystemManagerRoleId}, ","),
AllowMarketing: true,
Props: StringMap{
"foo": "bar",
},
NotifyProps: StringMap{
"bar": "foo",
},
Locale: DefaultLocale,
Timezone: timezones.DefaultUserTimezone(),
MfaActive: true,
RemoteId: new("some_remote"),
}
l := u.LogClone()
m, ok := l.(map[string]any)
require.True(t, ok)
expected := map[string]any{
"id": id,
"create_at": now,
"update_at": now,
"delete_at": now,
"username": "some user_name",
"auth_data": "some_auth_data",
"auth_service": "ldap",
"email": "test@example.org",
"email_verified": true,
"position": "some position",
"roles": "channel_admin,system_manager",
"allow_marketing": true,
"props": StringMap{
"foo": "bar",
},
"notify_props": StringMap{
"bar": "foo",
},
"locale": "en",
"timezone": StringMap(timezones.DefaultUserTimezone()),
"mfa_active": true,
"remote_id": "some_remote",
}
assert.Equal(t, expected, m)
})
}
func TestUserDeepCopy(t *testing.T) {
id := NewId()
authData := "authdata"
mapKey := "key"
mapValue := "key"
user := &User{Id: id, AuthData: new(authData), Props: map[string]string{}, NotifyProps: map[string]string{}, Timezone: map[string]string{}}
user.Props[mapKey] = mapValue
user.NotifyProps[mapKey] = mapValue
user.Timezone[mapKey] = mapValue
copyUser := user.DeepCopy()
copyUser.Id = "someid"
*copyUser.AuthData = "changed"
copyUser.Props[mapKey] = "changed"
copyUser.NotifyProps[mapKey] = "changed"
copyUser.Timezone[mapKey] = "changed"
assert.Equal(t, id, user.Id)
assert.Equal(t, authData, *user.AuthData)
assert.Equal(t, mapValue, user.Props[mapKey])
assert.Equal(t, mapValue, user.NotifyProps[mapKey])
assert.Equal(t, mapValue, user.Timezone[mapKey])
user = &User{Id: id}
copyUser = user.DeepCopy()
assert.Equal(t, id, copyUser.Id)
}
type stubHasherFunc func(password string) (string, error)
func (f stubHasherFunc) Hash(password string) (string, error) { return f(password) }
func TestUserPreSave(t *testing.T) {
hasher := stubHasherFunc(func(password string) (string, error) {
return "hashed_" + password, nil
})
user := User{Password: "test"}
err := user.PreSave(hasher)
require.Nil(t, err)
assert.Equal(t, "hashed_test", user.Password)
user.Etag(true, true)
assert.NotNil(t, user.Timezone, "Timezone is nil")
assert.Equal(t, user.Timezone["useAutomaticTimezone"], "true", "Timezone is not set to default")
// Set default user with notify props
userWithDefaultNotifyProps := User{}
userWithDefaultNotifyProps.SetDefaultNotifications()
for notifyPropKey, expectedNotifyPropValue := range userWithDefaultNotifyProps.NotifyProps {
actualNotifyPropValue, ok := user.NotifyProps[notifyPropKey]
assert.True(t, ok, "Notify prop %s is not set", notifyPropKey)
assert.Equal(t, expectedNotifyPropValue, actualNotifyPropValue, "Notify prop %s is not set to default", notifyPropKey)
}
}
func TestUserPreSavePwdTooLong(t *testing.T) {
hasher := stubHasherFunc(func(password string) (string, error) {
return "", ErrPasswordTooLong
})
user := User{Password: strings.Repeat("1234567890", 8)}
err := user.PreSave(hasher)
require.NotNil(t, err)
assert.Equal(t, "model.user.pre_save.password_too_long.app_error", err.Id)
}
func TestUserPreUpdate(t *testing.T) {
user := User{Password: "test"}
user.PreUpdate()
// Set default user with notify props
userWithDefaultNotifyProps := User{}
userWithDefaultNotifyProps.SetDefaultNotifications()
for notifyPropKey, expectedNotifyPropValue := range userWithDefaultNotifyProps.NotifyProps {
actualNotifyPropValue, ok := user.NotifyProps[notifyPropKey]
assert.True(t, ok, "Notify prop %s is not set", notifyPropKey)
assert.Equal(t, expectedNotifyPropValue, actualNotifyPropValue, "Notify prop %s is not set to default", notifyPropKey)
}
}
func TestUserGetMentionKeys(t *testing.T) {
u := User{NotifyProps: map[string]string{MentionKeysNotifyProp: " Alpha ,\tBETA\n,, "}}
assert.Equal(t, []string{"alpha", "beta"}, u.GetMentionKeys())
}
func TestUserMentionKeysLimits(t *testing.T) {
// An oversized key count survives PreUpdate intact, for IsValid to reject.
// Asserted against the stored value: GetMentionKeys caps on read, so it
// cannot distinguish a capped write from an uncapped one.
keys := make([]string, MentionKeysMaxCount+10)
for i := range keys {
keys[i] = fmt.Sprintf("key%d", i)
}
u := User{NotifyProps: map[string]string{MentionKeysNotifyProp: strings.Join(keys, ",")}}
u.PreUpdate()
assert.Equal(t, strings.Join(keys, ","), u.NotifyProps[MentionKeysNotifyProp])
assert.True(t, MentionKeysExceedLimits(u.NotifyProps[MentionKeysNotifyProp]))
// An oversized byte length likewise survives PreUpdate intact.
keyA := strings.Repeat("a", MentionKeysMaxLength/2+1)
keyB := strings.Repeat("b", MentionKeysMaxLength/2+1)
u2 := User{NotifyProps: map[string]string{MentionKeysNotifyProp: keyA + "," + keyB}}
u2.PreUpdate()
assert.Equal(t, keyA+","+keyB, u2.NotifyProps[MentionKeysNotifyProp])
assert.True(t, MentionKeysExceedLimits(u2.NotifyProps[MentionKeysNotifyProp]))
// GetMentionKeys truncates at MentionKeysMaxCount without PreUpdate.
bigKeys := make([]string, MentionKeysMaxCount+5)
for i := range bigKeys {
bigKeys[i] = fmt.Sprintf("k%d", i)
}
u3 := User{NotifyProps: map[string]string{MentionKeysNotifyProp: strings.Join(bigKeys, ",")}}
assert.Len(t, u3.GetMentionKeys(), MentionKeysMaxCount)
// GetMentionKeys also truncates by byte length: a few very long keys must not
// exceed MentionKeysMaxLength total bytes in the returned slice.
longKey := strings.Repeat("a", MentionKeysMaxLength/2+1)
u4 := User{NotifyProps: map[string]string{
MentionKeysNotifyProp: longKey + "," + longKey + "," + longKey,
}}
got4 := u4.GetMentionKeys()
totalLen := 0
for i, k := range got4 {
if i > 0 {
totalLen++
}
totalLen += len(k)
}
assert.LessOrEqual(t, totalLen, MentionKeysMaxLength)
// A value that normalizes away to nothing is still rejected on raw length,
// otherwise it would be accepted and stored at any size.
assert.True(t, MentionKeysExceedLimits(strings.Repeat(",", MentionKeysMaxLength+1)))
assert.True(t, MentionKeysExceedLimits(strings.Repeat(" , ", MentionKeysMaxLength)))
u5 := User{NotifyProps: map[string]string{
MentionKeysNotifyProp: strings.Repeat(",", MentionKeysMaxLength+1),
}}
assert.Empty(t, u5.GetMentionKeys())
// A raw value at the limit that normalizes within it is still accepted.
assert.False(t, MentionKeysExceedLimits(strings.Repeat("a", MentionKeysMaxLength)))
assert.False(t, MentionKeysExceedLimits(""))
// Keys joining to exactly MentionKeysMaxLength are all kept; one byte more
// and the last no longer fits.
const n = 3
exact := make([]string, n)
for i := range exact {
exact[i] = strings.Repeat("a", (MentionKeysMaxLength-(n-1))/n)
}
atLimit := strings.Join(exact, ",")
require.Equal(t, MentionKeysMaxLength, len(atLimit))
u6 := User{NotifyProps: map[string]string{MentionKeysNotifyProp: atLimit}}
assert.Len(t, u6.GetMentionKeys(), n)
u7 := User{NotifyProps: map[string]string{MentionKeysNotifyProp: atLimit + "a"}}
assert.Len(t, u7.GetMentionKeys(), n-1)
// Lowercasing grows some runes, so a raw value inside the byte limit can
// still normalize past it.
grows := strings.Repeat("\u023a", 20000)
require.LessOrEqual(t, len(grows), MentionKeysMaxLength)
require.Greater(t, len(strings.ToLower(grows)), MentionKeysMaxLength)
assert.True(t, MentionKeysExceedLimits(grows))
}
func TestUserUpdateMentionKeysFromUsername(t *testing.T) {
user := User{Username: "user"}
user.SetDefaultNotifications()
assert.Equalf(t, user.NotifyProps["mention_keys"], "", "default mention keys are invalid: %v", user.NotifyProps["mention_keys"])
user.Username = "person"
user.UpdateMentionKeysFromUsername("user")
assert.Equalf(t, user.NotifyProps["mention_keys"], "", "mention keys are invalid after changing username: %v", user.NotifyProps["mention_keys"])
user.NotifyProps["mention_keys"] += ",mention"
user.UpdateMentionKeysFromUsername("person")
assert.Equalf(t, user.NotifyProps["mention_keys"], ",mention", "mention keys are invalid after adding extra mention keyword: %v", user.NotifyProps["mention_keys"])
user.Username = "user"
user.UpdateMentionKeysFromUsername("person")
assert.Equalf(t, user.NotifyProps["mention_keys"], ",mention", "mention keys are invalid after changing username with extra mention keyword: %v", user.NotifyProps["mention_keys"])
}
func TestUserIsValid(t *testing.T) {
user := User{}
appErr := user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "id", "", user.Id), "expected user is valid error: %s", appErr.Error())
user.Id = NewId()
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "create_at", user.Id, user.CreateAt), "expected user is valid error: %s", appErr.Error())
user.CreateAt = GetMillis()
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "update_at", user.Id, user.UpdateAt), "expected user is valid error: %s", appErr.Error())
user.UpdateAt = GetMillis()
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "username", user.Id, user.Username), "expected user is valid error: %s", appErr.Error())
user.Username = NewUsername() + "^hello#"
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "username", user.Id, user.Username), "expected user is valid error: %s", appErr.Error())
user.Username = NewUsername()
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "email", user.Id, user.Email), "expected user is valid error: %s", appErr.Error())
user.Email = strings.Repeat("01234567890", 20)
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "email", user.Id, user.Email), "expected user is valid error: %s", appErr.Error())
user.Email = "user@example.com"
user.Nickname = strings.Repeat("a", 65)
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "nickname", user.Id, user.Nickname), "expected user is valid error: %s", appErr.Error())
user.Nickname = strings.Repeat("a", 64)
require.Nil(t, user.IsValid())
user.FirstName = ""
user.LastName = ""
require.Nil(t, user.IsValid())
user.Email = NewId()
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "email", user.Id, user.Email), "expected user is valid error: %s", appErr.Error())
user.RemoteId = new(NewId())
require.Nil(t, user.IsValid())
user.FirstName = strings.Repeat("a", 65)
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "first_name", user.Id, user.FirstName), "expected user is valid error: %s", appErr.Error())
user.FirstName = strings.Repeat("a", 64)
user.LastName = strings.Repeat("a", 65)
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "last_name", user.Id, user.LastName), "expected user is valid error: %s", appErr.Error())
user.LastName = strings.Repeat("a", 64)
user.Position = strings.Repeat("a", 128)
require.Nil(t, user.IsValid())
user.Position = strings.Repeat("a", 129)
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "position", user.Id, user.Position), "expected user is valid error: %s", appErr.Error())
user.Position = ""
user.Roles = strings.Repeat("a", UserRolesMaxLength)
appErr = user.IsValid()
require.Nil(t, appErr)
user.Roles = strings.Repeat("a", UserRolesMaxLength+1)
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "roles_limit", user.Id, user.Roles), "expected user is valid error: %s", appErr.Error())
user.Roles = ""
// over the byte-length limit
user.NotifyProps = map[string]string{
MentionKeysNotifyProp: strings.Repeat("a", MentionKeysMaxLength+1),
}
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "mention_keys", user.Id, ""), "expected mention_keys error: %s", appErr.Error())
// blank padding within the raw limit must not trigger the limit
user.NotifyProps = map[string]string{
MentionKeysNotifyProp: strings.Repeat(",", MentionKeysMaxLength),
}
require.Nil(t, user.IsValid())
// blank padding beyond the raw limit is rejected on length alone
user.NotifyProps = map[string]string{
MentionKeysNotifyProp: strings.Repeat(",", MentionKeysMaxLength+1),
}
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "mention_keys", user.Id, ""), "expected mention_keys error: %s", appErr.Error())
// over the key-count limit
keys := make([]string, MentionKeysMaxCount+1)
for i := range keys {
keys[i] = "k"
}
user.NotifyProps = map[string]string{
MentionKeysNotifyProp: strings.Join(keys, ","),
}
appErr = user.IsValid()
require.True(t, HasExpectedUserIsValidError(appErr, "mention_keys", user.Id, ""), "expected mention_keys error: %s", appErr.Error())
// blank padding must not trigger the count limit
user.NotifyProps = map[string]string{
MentionKeysNotifyProp: strings.Repeat(",", MentionKeysMaxCount+1),
}
require.Nil(t, user.IsValid())
// empty mention_keys is fine
user.NotifyProps = map[string]string{MentionKeysNotifyProp: ""}
require.Nil(t, user.IsValid())
// exactly at the count limit is fine
user.NotifyProps = map[string]string{
MentionKeysNotifyProp: strings.Join(keys[:MentionKeysMaxCount], ","),
}
require.Nil(t, user.IsValid())
}
func TestUserSanitizeInput(t *testing.T) {
user := User{}
user.CreateAt = GetMillis()
user.UpdateAt = GetMillis()
user.DeleteAt = GetMillis()
user.LastPasswordUpdate = GetMillis()
user.LastPictureUpdate = GetMillis()
user.Username = "username"
user.Email = " user@example.com "
user.Nickname = "nickname"
user.FirstName = "firstname"
user.LastName = "lastname"
user.RemoteId = new(NewId())
user.Position = "position"
user.Roles = "system_admin"
user.AuthData = new("authdata")
user.AuthService = "saml"
user.EmailVerified = true
user.FailedAttempts = 10
user.LastActivityAt = GetMillis()
user.MfaUsedTimestamps = StringArray{"1234", "4566"}
user.SanitizeInput(false)
// these fields should be reset
require.Equal(t, new(""), user.AuthData)
require.Equal(t, "", user.AuthService)
require.False(t, user.EmailVerified)
require.Equal(t, new(""), user.RemoteId)
require.Equal(t, int64(0), user.CreateAt)
require.Equal(t, int64(0), user.UpdateAt)
require.Equal(t, int64(0), user.DeleteAt)
require.Equal(t, int64(0), user.LastPasswordUpdate)
require.Equal(t, int64(0), user.LastPictureUpdate)
require.Equal(t, int64(0), user.LastActivityAt)
require.Equal(t, 0, user.FailedAttempts)
require.Equal(t, StringArray{}, user.MfaUsedTimestamps)
// these fields should remain intact
require.Equal(t, "user@example.com", user.Email)
require.Equal(t, "username", user.Username)
require.Equal(t, "nickname", user.Nickname)
require.Equal(t, "firstname", user.FirstName)
require.Equal(t, "lastname", user.LastName)
require.Equal(t, "position", user.Position)
}
func HasExpectedUserIsValidError(err *AppError, fieldName, userId string, fieldValue any) bool {
if err == nil {
return false
}
return err.Where == "User.IsValid" &&
err.Id == fmt.Sprintf("model.user.is_valid.%s.app_error", fieldName) &&
err.StatusCode == http.StatusBadRequest &&
(userId == "" || err.DetailedError == fmt.Sprintf("user_id=%s %s=%v", userId, fieldName, fieldValue))
}
func TestUserGetFullName(t *testing.T) {
user := User{}
assert.Equal(t, user.GetFullName(), "", "Full name should be blank")
user.FirstName = "first"
assert.Equal(t, user.GetFullName(), "first", "Full name should be first name")
user.FirstName = ""
user.LastName = "last"
assert.Equal(t, user.GetFullName(), "last", "Full name should be last name")
user.FirstName = "first"
assert.Equal(t, user.GetFullName(), "first last", "Full name should be first name and last name")
}
func TestUserGetDisplayName(t *testing.T) {
user := User{Username: "username"}
assert.Equal(t, user.GetDisplayName(ShowFullName), "username", "Display name should be username")
assert.Equal(t, user.GetDisplayName(ShowNicknameFullName), "username", "Display name should be username")
assert.Equal(t, user.GetDisplayName(ShowUsername), "username", "Display name should be username")
user.FirstName = "first"
user.LastName = "last"
assert.Equal(t, user.GetDisplayName(ShowFullName), "first last", "Display name should be full name")
assert.Equal(t, user.GetDisplayName(ShowNicknameFullName), "first last", "Display name should be full name since there is no nickname")
assert.Equal(t, user.GetDisplayName(ShowUsername), "username", "Display name should be username")
user.Nickname = "nickname"
assert.Equal(t, user.GetDisplayName(ShowNicknameFullName), "nickname", "Display name should be nickname")
}
func TestUserGetDisplayNameWithPrefix(t *testing.T) {
user := User{Username: "username"}
assert.Equal(t, user.GetDisplayNameWithPrefix(ShowFullName, "@"), "@username", "Display name should be username")
assert.Equal(t, user.GetDisplayNameWithPrefix(ShowNicknameFullName, "@"), "@username", "Display name should be username")
assert.Equal(t, user.GetDisplayNameWithPrefix(ShowUsername, "@"), "@username", "Display name should be username")
user.FirstName = "first"
user.LastName = "last"
assert.Equal(t, user.GetDisplayNameWithPrefix(ShowFullName, "@"), "first last", "Display name should be full name")
assert.Equal(t, user.GetDisplayNameWithPrefix(ShowNicknameFullName, "@"), "first last", "Display name should be full name since there is no nickname")
assert.Equal(t, user.GetDisplayNameWithPrefix(ShowUsername, "@"), "@username", "Display name should be username")
user.Nickname = "nickname"
assert.Equal(t, user.GetDisplayNameWithPrefix(ShowNicknameFullName, "@"), "nickname", "Display name should be nickname")
}
type usernamesTest struct {
value string
expected bool
expectedWhenRemote bool
}
var usernames = []usernamesTest{
{"spin-punch", true, true},
{"sp", true, true},
{"s", true, true},
{"1spin-punch", true, true},
{"-spin-punch", true, true},
{".spin-punch", true, true},
{"Spin-punch", false, false},
{"spin punch-", false, false},
{"spin_punch", true, true},
{"spin", true, true},
{"PUNCH", false, false},
{"spin.punch", true, true},
{"spin'punch", false, false},
{"spin*punch", false, false},
{"all", false, false},
{"system", false, false},
{"spin:punch", false, true},
}
func TestValidUsername(t *testing.T) {
for _, v := range usernames {
if IsValidUsername(v.value) != v.expected {
t.Errorf("expect %v as %v", v.value, v.expected)
}
}
for _, v := range usernames {
if IsValidUsernameAllowRemote(v.value) != v.expectedWhenRemote {
t.Errorf("expect %v as %v", v.value, v.expectedWhenRemote)
}
}
}
func TestNormalizeUsername(t *testing.T) {
assert.Equal(t, NormalizeUsername("Spin-punch"), "spin-punch", "didn't normalize username properly")
assert.Equal(t, NormalizeUsername("PUNCH"), "punch", "didn't normalize username properly")
assert.Equal(t, NormalizeUsername("spin"), "spin", "didn't normalize username properly")
}
func TestNormalizeEmail(t *testing.T) {
assert.Equal(t, NormalizeEmail("TEST@EXAMPLE.COM"), "test@example.com", "didn't normalize email properly")
assert.Equal(t, NormalizeEmail("TEST2@example.com"), "test2@example.com", "didn't normalize email properly")
assert.Equal(t, NormalizeEmail("test3@example.com"), "test3@example.com", "didn't normalize email properly")
}
func TestCleanUsername(t *testing.T) {
logger := mlog.CreateConsoleTestLogger(t)
assert.Equal(t, CleanUsername(logger, "Spin-punch"), "spin-punch", "didn't clean name properly")
assert.Equal(t, CleanUsername(logger, "PUNCH"), "punch", "didn't clean name properly")
assert.Equal(t, CleanUsername(logger, "spin'punch"), "spin-punch", "didn't clean name properly")
assert.Equal(t, CleanUsername(logger, "spin"), "spin", "didn't clean name properly")
assert.Len(t, CleanUsername(logger, "all"), 27, "didn't clean name properly")
}
func TestRoles(t *testing.T) {
require.True(t, IsValidUserRoles("team_user"))
require.False(t, IsValidUserRoles("system_admin"))
require.True(t, IsValidUserRoles("system_user system_admin"))
require.False(t, IsInRole("system_admin junk", "admin"))
require.True(t, IsInRole("system_admin junk", "system_admin"))
require.False(t, IsInRole("admin", "system_admin"))
}
func TestIsValidLocale(t *testing.T) {
for _, test := range []struct {
Name string
Locale string
Expected bool
}{
{
Name: "empty locale",
Locale: "",
Expected: true,
},
{
Name: "locale with only language",
Locale: "fr",
Expected: true,
},
{
Name: "locale with region",
Locale: "en-DE", // English, as used in Germany
Expected: true,
},
{
Name: "invalid locale",
Locale: "'",
Expected: false,
},
// Note that the following cases are all valid language tags, but they're considered invalid here because of
// the max length of the User.Locale field.
{
Name: "locale with extended language subtag",
Locale: "zh-yue-HK", // Chinese, Cantonese, as used in Hong Kong
Expected: false,
},
{
Name: "locale with script",
Locale: "hy-Latn-IT-arevela", // Eastern Armenian written in Latin script, as used in Italy
Expected: false,
},
{
Name: "locale with variant",
Locale: "sl-rozaj-biske", // San Giorgio dialect of Resian dialect of Slovenian
Expected: false,
},
{
Name: "locale with extension",
Locale: "de-DE-u-co-phonebk", // German, as used in Germany, using German phonebook sort order
Expected: false,
},
} {
t.Run(test.Name, func(t *testing.T) {
assert.Equal(t, test.Expected, IsValidLocale(test.Locale))
})
}
}
func TestUserSlice(t *testing.T) {
t.Run("FilterByActive", func(t *testing.T) {
user0 := &User{Id: "user0", DeleteAt: 0, IsBot: true}
user1 := &User{Id: "user1", DeleteAt: 0, IsBot: true}
user2 := &User{Id: "user2", DeleteAt: 1, IsBot: false}
slice := UserSlice([]*User{user0, user1, user2})
activeUsers := slice.FilterByActive(true)
assert.Len(t, activeUsers, 2)
for _, user := range activeUsers {
assert.True(t, user.DeleteAt == 0)
}
inactiveUsers := slice.FilterByActive(false)
assert.Len(t, inactiveUsers, 1)
for _, user := range inactiveUsers {
assert.True(t, user.DeleteAt != 0)
}
nonBotUsers := slice.FilterWithoutBots()
assert.Len(t, nonBotUsers, 1)
})
}
func TestValidateCustomStatus(t *testing.T) {
t.Run("ValidateCustomStatus", func(t *testing.T) {
user0 := &User{Id: "user0", DeleteAt: 0, IsBot: true}
user0.Props = map[string]string{UserPropsKeyCustomStatus: ""}
assert.True(t, user0.ValidateCustomStatus())
user0.Props[UserPropsKeyCustomStatus] = "hello"
assert.False(t, user0.ValidateCustomStatus())
user0.Props[UserPropsKeyCustomStatus] = "{\"emoji\":{\"foo\":\"bar\"}}"
assert.True(t, user0.ValidateCustomStatus())
user0.Props[UserPropsKeyCustomStatus] = "{\"text\": \"hello\"}"
assert.True(t, user0.ValidateCustomStatus())
user0.Props[UserPropsKeyCustomStatus] = "{\"wrong\": \"hello\"}"
assert.True(t, user0.ValidateCustomStatus())
})
}
func TestSanitizeProfile(t *testing.T) {
t.Run("should correctly sanitize email and remote email", func(t *testing.T) {
user := &User{
Email: "john@doe.com",
Props: StringMap{UserPropsKeyRemoteEmail: "remote@doe.com"},
}
user.SanitizeProfile(nil, false)
require.Equal(t, "john@doe.com", user.Email)
require.Equal(t, "remote@doe.com", user.Props[UserPropsKeyRemoteEmail])
user.SanitizeProfile(map[string]bool{"email": false}, false)
require.Empty(t, user.Email)
require.Empty(t, user.Props[UserPropsKeyRemoteEmail])
})
}
func TestIsValidUserAuthService(t *testing.T) {
valid := []string{
UserAuthServiceEmail,
UserAuthServiceGitlab,
UserAuthServiceLdap,
UserAuthServiceSaml,
ServiceGoogle,
ServiceOffice365,
ServiceOpenid,
}
for _, s := range valid {
t.Run("valid/"+s, func(t *testing.T) {
require.True(t, IsValidUserAuthService(s))
})
}
invalid := []string{"", "not-a-real-service", UserAuthServiceMagicLink, "EMAIL"}
for _, s := range invalid {
t.Run("invalid/"+s, func(t *testing.T) {
require.False(t, IsValidUserAuthService(s))
})
}
}
func TestUserAuthIsValid(t *testing.T) {
authData := "test@test.com"
tests := []struct {
name string
userAuth UserAuth
expected bool
}{
{
name: "email auth with nil auth data",
userAuth: UserAuth{AuthService: UserAuthServiceEmail},
expected: true,
},
{
name: "email auth with auth data",
userAuth: UserAuth{AuthService: UserAuthServiceEmail, AuthData: &authData},
expected: false,
},
{
name: "sso auth with auth data",
userAuth: UserAuth{AuthService: UserAuthServiceSaml, AuthData: &authData},
expected: true,
},
{
name: "sso auth with nil auth data",
userAuth: UserAuth{AuthService: UserAuthServiceSaml},
expected: false,
},
{
name: "unknown auth service",
userAuth: UserAuth{AuthService: "not-a-real-service", AuthData: &authData},
expected: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
require.Equal(t, tt.expected, tt.userAuth.IsValid())
})
}
}