Files
Jesse HallamandGitHub edf2075381 MM-68149: Upgrade to Go 1.26.2 (#36418)
* MM-68149: upgrade to Go 1.26.2

Update go directive in go.mod and .go-version.

* MM-68149: replace pointer helpers with Go 1.26 new()

Go 1.26 extends the built-in new() to accept an initial value expression,
making typed-pointer helpers like model.NewPointer(x), bToP(x), and boolPtr(x)
redundant. Replace every call site with new(x) and remove the now-unused
helper functions and their //go:fix inline directives.

* MM-68149: apply go fix for reflect API and format-string changes

- reflect.Ptr → reflect.Pointer (renamed in Go 1.18, deprecated alias removed in 1.26)
- reflect range-over-struct: for i := 0; i < t.NumField(); i++ → for field := range t.Fields()
  and the equivalent for Methods() and interface types
- Fix format-string concatenation and variadic-arg mismatches flagged by go vet

* MM-68149: update JPEG fixtures and test infrastructure for Go 1.26 encoder

Go 1.26 ships a new image/jpeg encoder that produces slightly different output.
Regenerate all JPEG fixture files and switch the comparison helpers from
byte-equality to pixel-level comparison with a small per-channel tolerance,
so minor encoder drift across patch versions is handled automatically.

Add -update-fixtures flag to make it easy to regenerate fixtures after future
major Go upgrades. Document the update procedure in tests/README.md.

* MM-68149: CI check that go fix ./... produces no changes

* Fix real bugs flagged by CodeRabbit review

- group.go: set newGroup.MemberCount not group.MemberCount (member count
  was populated on the wrong variable and lost before publish/return)
- file_test.go: guard compareImage(GetFilePreview) on the preview slice
  length, not the thumbnail slice length (copy-paste error)
- config_test.go: remove duplicate MinimumLength assignment

* fixup! Fix real bugs flagged by CodeRabbit review
2026-05-12 15:59:12 +00:00

321 lines
10 KiB
Go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
package oauthgitlab
import (
"bytes"
"encoding/json"
"strconv"
"strings"
"testing"
"github.com/mattermost/mattermost/server/public/model"
"github.com/mattermost/mattermost/server/public/shared/mlog"
"github.com/mattermost/mattermost/server/public/shared/request"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestGitLabUserFromJSON(t *testing.T) {
rctx := request.TestContext(t)
glu := GitLabUser{
Id: 12345,
Username: "testuser",
Login: "testlogin",
Email: "[email protected]",
Name: "Test User",
}
provider := &GitLabProvider{}
t.Run("valid gitlab user", func(t *testing.T) {
b, err := json.Marshal(glu)
require.NoError(t, err)
userJSON, err := provider.GetUserFromJSON(rctx, bytes.NewReader(b), nil, nil)
require.NoError(t, err)
// We get AuthData via GetUserFromJSON which calls userFromGitLabUser which calls getAuthData
require.Equal(t, strconv.FormatInt(glu.Id, 10), *userJSON.AuthData)
// Check GetAuthDataFromJSON indirectly by ensuring GetUserFromJSON worked,
// as GetAuthDataFromJSON is not directly exported or used elsewhere in a testable way without duplicating logic.
// It relies on gitLabUserFromJSON and glu.IsValid, which are tested separately.
})
t.Run("empty body should fail validation", func(t *testing.T) {
// GetUserFromJSON should return an error because IsValid fails on the empty user
_, err := provider.GetUserFromJSON(rctx, strings.NewReader("{}"), nil, nil)
require.Error(t, err)
assert.Contains(t, err.Error(), "user id can't be 0")
})
t.Run("invalid json", func(t *testing.T) {
_, err := provider.GetUserFromJSON(rctx, strings.NewReader("invalid json"), nil, nil)
require.Error(t, err)
})
}
func TestGitLabUserIsValid(t *testing.T) {
testCases := []struct {
description string
user GitLabUser
isValid bool
expectedErr string
}{
{"valid user", GitLabUser{Id: 1, Email: "[email protected]"}, true, ""},
{"zero id", GitLabUser{Id: 0, Email: "[email protected]"}, false, "user id can't be 0"},
{"empty email", GitLabUser{Id: 1, Email: ""}, false, "user e-mail should not be empty"},
}
for _, tc := range testCases {
t.Run(tc.description, func(t *testing.T) {
err := tc.user.IsValid()
if tc.isValid {
require.NoError(t, err)
} else {
require.Error(t, err)
assert.Equal(t, tc.expectedErr, err.Error())
}
})
}
}
func TestGitLabUserGetAuthData(t *testing.T) {
glu := GitLabUser{Id: 98765}
assert.Equal(t, "98765", glu.getAuthData())
}
func TestUserFromGitLabUser(t *testing.T) {
logger := mlog.CreateConsoleTestLogger(t)
testCases := []struct {
description string
gitlabUser GitLabUser
usePreferredUsername bool
expectedUsername string
expectedFirstName string
expectedLastName string
expectedEmail string
expectedAuthData string
}{
{
description: "Username from PreferredUsername when UsePreferredUsername=true",
gitlabUser: GitLabUser{
Id: 1,
Username: "gitlab.user",
Login: "gitlab.login",
Email: "[email protected]",
Name: "First Last",
PreferredUsername: "preferred.user",
},
usePreferredUsername: true,
expectedUsername: "preferred.user",
expectedFirstName: "First",
expectedLastName: "Last",
expectedEmail: "[email protected]",
expectedAuthData: "1",
},
{
description: "Username from Username when UsePreferredUsername=false even if PreferredUsername exists",
gitlabUser: GitLabUser{
Id: 2,
Username: "gitlab.user",
Login: "gitlab.login",
Email: "[email protected]",
Name: "First Last",
PreferredUsername: "preferred.user",
},
usePreferredUsername: false,
expectedUsername: "gitlab.user",
expectedFirstName: "First",
expectedLastName: "Last",
expectedEmail: "[email protected]",
expectedAuthData: "2",
},
{
description: "Username from Username when PreferredUsername is empty and UsePreferredUsername=true",
gitlabUser: GitLabUser{
Id: 3,
Username: "gitlab.user.only",
Login: "gitlab.login",
Email: "[email protected]",
Name: "Another User",
PreferredUsername: "",
},
usePreferredUsername: true,
expectedUsername: "gitlab.user.only",
expectedFirstName: "Another",
expectedLastName: "User",
expectedEmail: "[email protected]",
expectedAuthData: "3",
},
{
description: "Username from PreferredUsername when Username is empty and UsePreferredUsername=true",
gitlabUser: GitLabUser{
Id: 5,
Username: "",
Login: "gitlab.login.only",
Email: "[email protected]",
Name: "Login User",
PreferredUsername: "preferred.user.again",
},
usePreferredUsername: true,
expectedUsername: "preferred.user.again",
expectedFirstName: "Login",
expectedLastName: "User",
expectedEmail: "[email protected]",
expectedAuthData: "5",
},
{
description: "Username from Login when Username is empty and UsePreferredUsername=false, even if PreferredUsername exists",
gitlabUser: GitLabUser{
Id: 6,
Username: "",
Login: "gitlab.login.only.again",
Email: "[email protected]",
Name: "Login User",
PreferredUsername: "preferred.user.ignored",
},
usePreferredUsername: false,
expectedUsername: "gitlab.login.only.again",
expectedFirstName: "Login",
expectedLastName: "User",
expectedEmail: "[email protected]",
expectedAuthData: "6",
},
{
description: "Username from Login when Username and PreferredUsername are empty and UsePreferredUsername=true",
gitlabUser: GitLabUser{
Id: 7,
Username: "",
Login: "the.login",
Email: "[email protected]",
Name: "Just Login",
PreferredUsername: "",
},
usePreferredUsername: true,
expectedUsername: "the.login",
expectedFirstName: "Just",
expectedLastName: "Login",
expectedEmail: "[email protected]",
expectedAuthData: "7",
},
{
description: "Name splitting: single name",
gitlabUser: GitLabUser{
Id: 9,
Username: "testuser9",
Email: "[email protected]",
Name: "Mononym",
},
usePreferredUsername: false,
expectedUsername: "testuser9",
expectedFirstName: "Mononym",
expectedLastName: "",
expectedEmail: "[email protected]",
expectedAuthData: "9",
},
{
description: "Name splitting: multiple last names",
gitlabUser: GitLabUser{
Id: 10,
Username: "testuser10",
Email: "[email protected]",
Name: "First Middle Van Der Lastname",
},
usePreferredUsername: false,
expectedUsername: "testuser10",
expectedFirstName: "First",
expectedLastName: "Middle Van Der Lastname",
expectedEmail: "[email protected]",
expectedAuthData: "10",
},
{
description: "Email lowercasing",
gitlabUser: GitLabUser{
Id: 11,
Username: "testuser11",
Email: "[email protected]",
Name: "Test User",
},
usePreferredUsername: false,
expectedUsername: "testuser11",
expectedFirstName: "Test",
expectedLastName: "User",
expectedEmail: "[email protected]",
expectedAuthData: "11",
},
{
description: "Username needing cleaning when UsePreferredUsername=true",
gitlabUser: GitLabUser{
Id: 12,
Username: "gitlab.user",
Login: "gitlab.login",
Email: "[email protected]",
Name: "Needs Clean",
PreferredUsername: "preferred@@user!!",
},
usePreferredUsername: true,
expectedUsername: "preferred", // Cleaned
expectedFirstName: "Needs",
expectedLastName: "Clean",
expectedEmail: "[email protected]",
expectedAuthData: "12",
},
{
description: "Username needing cleaning when UsePreferredUsername=false",
gitlabUser: GitLabUser{
Id: 13,
Username: "gitlab@@user!!",
Login: "gitlab.login",
Email: "[email protected]",
Name: "Needs Clean",
PreferredUsername: "preferred.user",
},
usePreferredUsername: false,
expectedUsername: "gitlab--user", // Cleaned
expectedFirstName: "Needs",
expectedLastName: "Clean",
expectedEmail: "[email protected]",
expectedAuthData: "13",
},
{
description: "Login needing cleaning when UsePreferredUsername=false and Username is empty",
gitlabUser: GitLabUser{
Id: 14,
Username: "",
Login: "gitlab@@login!!",
Email: "[email protected]",
Name: "Needs Clean",
PreferredUsername: "preferred.user",
},
usePreferredUsername: false,
expectedUsername: "gitlab--login", // Cleaned
expectedFirstName: "Needs",
expectedLastName: "Clean",
expectedEmail: "[email protected]",
expectedAuthData: "14",
},
}
for _, tc := range testCases {
t.Run(tc.description, func(t *testing.T) {
settings := &model.SSOSettings{
UsePreferredUsername: new(tc.usePreferredUsername),
}
user := userFromGitLabUser(logger, &tc.gitlabUser, settings)
require.NotNil(t, user)
assert.Equal(t, tc.expectedUsername, user.Username)
assert.Equal(t, tc.expectedFirstName, user.FirstName)
assert.Equal(t, tc.expectedLastName, user.LastName)
assert.Equal(t, tc.expectedEmail, user.Email)
require.NotNil(t, user.AuthData)
assert.Equal(t, tc.expectedAuthData, *user.AuthData)
assert.Equal(t, model.UserAuthServiceGitlab, user.AuthService)
})
}
}