upstream/mattermost
1
0
Fork 0
mirror of https://github.com/mattermost/mattermost.git synced 2026-05-23 18:55:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
mattermost/server/config/diff_test.go
Jesse Hallam e3fbf8711f
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

934 lines
19 KiB
Go
Raw Permalink Blame History

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
package config
import (
"testing"
"github.com/mattermost/mattermost/server/public/model"
"github.com/stretchr/testify/require"
)
func defaultConfigGen() *model.Config {
cfg := &model.Config{}
cfg.SetDefaults()
return cfg
}
func BenchmarkDiff(b *testing.B) {
b.Run("equal empty", func(b *testing.B) {
baseCfg := &model.Config{}
actualCfg := &model.Config{}
for b.Loop() {
_, _ = Diff(baseCfg, actualCfg)
}
})
b.Run("equal with defaults", func(b *testing.B) {
baseCfg := defaultConfigGen()
actualCfg := defaultConfigGen()
for b.Loop() {
_, _ = Diff(baseCfg, actualCfg)
}
})
b.Run("actual empty", func(b *testing.B) {
baseCfg := defaultConfigGen()
actualCfg := &model.Config{}
for b.Loop() {
_, _ = Diff(baseCfg, actualCfg)
}
})
b.Run("base empty", func(b *testing.B) {
baseCfg := &model.Config{}
actualCfg := defaultConfigGen()
for b.Loop() {
_, _ = Diff(baseCfg, actualCfg)
}
})
b.Run("some diffs", func(b *testing.B) {
baseCfg := defaultConfigGen()
actualCfg := defaultConfigGen()
baseCfg.ServiceSettings.SiteURL = new("http://localhost")
baseCfg.ServiceSettings.ReadTimeout = new(300)
baseCfg.SqlSettings.QueryTimeout = new(0)
actualCfg.PluginSettings.EnableUploads = nil
actualCfg.TeamSettings.MaxChannelsPerTeam = new(int64(100000))
actualCfg.FeatureFlags = nil
actualCfg.SqlSettings.DataSourceReplicas = []string{
"ds0",
"ds1",
"ds2",
}
for b.Loop() {
_, _ = Diff(baseCfg, actualCfg)
}
})
}
func TestDiffSanitized(t *testing.T) {
tcs := []struct {
name string
base *model.Config
actual *model.Config
diffs ConfigDiffs
err string
}{
{
"nil",
nil,
nil,
nil,
"input configs should not be nil",
},
{
"empty",
&model.Config{},
&model.Config{},
nil,
"",
},
{
"defaults",
defaultConfigGen(),
defaultConfigGen(),
nil,
"",
},
{
"default base, actual empty",
defaultConfigGen(),
&model.Config{},
ConfigDiffs{
{
Path: "",
BaseVal: func() model.Config {
cfg := defaultConfigGen()
cfg.Sanitize(nil, nil)
return *cfg
}(),
ActualVal: model.Config{},
},
},
"",
},
{
"empty base, actual default",
&model.Config{},
defaultConfigGen(),
ConfigDiffs{
{
Path: "",
BaseVal: model.Config{},
ActualVal: func() model.Config {
cfg := defaultConfigGen()
cfg.Sanitize(nil, nil)
return *cfg
}(),
},
},
"",
},
{
"sensitive LdapSettings.BindPassword",
func() *model.Config {
cfg := defaultConfigGen()
cfg.LdapSettings.BindPassword = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.LdapSettings.BindPassword = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "LdapSettings.BindPassword",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive FileSettings.PublicLinkSalt",
func() *model.Config {
cfg := defaultConfigGen()
cfg.FileSettings.PublicLinkSalt = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.FileSettings.PublicLinkSalt = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "FileSettings.PublicLinkSalt",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive FileSettings.AmazonS3SecretAccessKey",
func() *model.Config {
cfg := defaultConfigGen()
cfg.FileSettings.AmazonS3SecretAccessKey = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.FileSettings.AmazonS3SecretAccessKey = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "FileSettings.AmazonS3SecretAccessKey",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive SqlSettings.DataSource",
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSource = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSource = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "SqlSettings.DataSource",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive SqlSettings.AtRestEncryptKey",
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.AtRestEncryptKey = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.AtRestEncryptKey = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "SqlSettings.AtRestEncryptKey",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive SqlSettings.DataSourceReplicas",
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSourceReplicas = []string{
"ds0",
"ds1",
}
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSourceReplicas = []string{
"ds0",
"ds1",
"ds2",
}
return cfg
}(),
ConfigDiffs{
{
Path: "SqlSettings.DataSourceReplicas",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive SqlSettings.DataSourceSearchReplicas",
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSourceSearchReplicas = []string{
"ds0",
"ds1",
}
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSourceSearchReplicas = []string{
"ds0",
"ds1",
"ds2",
}
return cfg
}(),
ConfigDiffs{
{
Path: "SqlSettings.DataSourceSearchReplicas",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive EmailSettings.SMTPPassword",
func() *model.Config {
cfg := defaultConfigGen()
cfg.EmailSettings.SMTPPassword = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.EmailSettings.SMTPPassword = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "EmailSettings.SMTPPassword",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive GitLabSettings.Secret",
func() *model.Config {
cfg := defaultConfigGen()
cfg.GitLabSettings.Secret = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.GitLabSettings.Secret = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "GitLabSettings.Secret",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive GoogleSettings.Secret",
func() *model.Config {
cfg := defaultConfigGen()
cfg.GoogleSettings.Secret = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.GoogleSettings.Secret = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "GoogleSettings.Secret",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive Office365Settings.Secret",
func() *model.Config {
cfg := defaultConfigGen()
cfg.Office365Settings.Secret = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.Office365Settings.Secret = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "Office365Settings.Secret",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive OpenIdSettings.Secret",
func() *model.Config {
cfg := defaultConfigGen()
cfg.OpenIdSettings.Secret = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.OpenIdSettings.Secret = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "OpenIdSettings.Secret",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive ElasticsearchSettings.Password",
func() *model.Config {
cfg := defaultConfigGen()
cfg.ElasticsearchSettings.Password = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.ElasticsearchSettings.Password = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "ElasticsearchSettings.Password",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive MessageExportSettings.GlobalRelaySettings",
func() *model.Config {
cfg := defaultConfigGen()
cfg.MessageExportSettings.GlobalRelaySettings = &model.GlobalRelayMessageExportSettings{
SMTPUsername: new("base"),
SMTPPassword: new("base"),
EmailAddress: new("base"),
}
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.MessageExportSettings.GlobalRelaySettings = &model.GlobalRelayMessageExportSettings{
SMTPUsername: new("actual"),
SMTPPassword: new("actual"),
EmailAddress: new("actual"),
}
return cfg
}(),
ConfigDiffs{
{
Path: "MessageExportSettings.GlobalRelaySettings.SMTPUsername",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
{
Path: "MessageExportSettings.GlobalRelaySettings.SMTPPassword",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
{
Path: "MessageExportSettings.GlobalRelaySettings.EmailAddress",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"sensitive ServiceSettings.SplitKey",
func() *model.Config {
cfg := defaultConfigGen()
cfg.ServiceSettings.SplitKey = new("base")
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.ServiceSettings.SplitKey = new("actual")
return cfg
}(),
ConfigDiffs{
{
Path: "ServiceSettings.SplitKey",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
{
"plugin config",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.PluginSettings.Plugins = map[string]map[string]any{
"com.mattermost.newplugin": {
"key": true,
},
}
return cfg
}(),
ConfigDiffs{
{
Path: "PluginSettings.Plugins",
BaseVal: model.FakeSetting,
ActualVal: model.FakeSetting,
},
},
"",
},
}
for _, tc := range tcs {
t.Run(tc.name, func(t *testing.T) {
diffs, err := Diff(tc.base, tc.actual)
if tc.err != "" {
require.EqualError(t, err, tc.err)
require.Nil(t, diffs)
} else {
require.NoError(t, err)
}
require.Equal(t, tc.diffs, diffs.Sanitize())
})
}
}
func TestDiff(t *testing.T) {
tcs := []struct {
name string
base *model.Config
actual *model.Config
diffs ConfigDiffs
err string
}{
{
"nil",
nil,
nil,
nil,
"input configs should not be nil",
},
{
"empty",
&model.Config{},
&model.Config{},
nil,
"",
},
{
"defaults",
defaultConfigGen(),
defaultConfigGen(),
nil,
"",
},
{
"default base, actual empty",
defaultConfigGen(),
&model.Config{},
ConfigDiffs{
{
Path: "",
BaseVal: *defaultConfigGen(),
ActualVal: model.Config{},
},
},
"",
},
{
"empty base, actual default",
&model.Config{},
defaultConfigGen(),
ConfigDiffs{
{
Path: "",
BaseVal: model.Config{},
ActualVal: *defaultConfigGen(),
},
},
"",
},
{
"string change",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.ServiceSettings.SiteURL = new("http://changed")
return cfg
}(),
ConfigDiffs{
{
Path: "ServiceSettings.SiteURL",
BaseVal: *defaultConfigGen().ServiceSettings.SiteURL,
ActualVal: "http://changed",
},
},
"",
},
{
"string nil",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.ServiceSettings.SiteURL = nil
return cfg
}(),
ConfigDiffs{
{
Path: "ServiceSettings.SiteURL",
BaseVal: defaultConfigGen().ServiceSettings.SiteURL,
ActualVal: func() *string {
return nil
}(),
},
},
"",
},
{
"bool change",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.PluginSettings.Enable = new(!*cfg.PluginSettings.Enable)
return cfg
}(),
ConfigDiffs{
{
Path: "PluginSettings.Enable",
BaseVal: true,
ActualVal: false,
},
},
"",
},
{
"bool nil",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.PluginSettings.Enable = nil
return cfg
}(),
ConfigDiffs{
{
Path: "PluginSettings.Enable",
BaseVal: defaultConfigGen().PluginSettings.Enable,
ActualVal: func() *bool {
return nil
}(),
},
},
"",
},
{
"int change",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.ServiceSettings.ReadTimeout = new(0)
return cfg
}(),
ConfigDiffs{
{
Path: "ServiceSettings.ReadTimeout",
BaseVal: *defaultConfigGen().ServiceSettings.ReadTimeout,
ActualVal: 0,
},
},
"",
},
{
"int nil",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.ServiceSettings.ReadTimeout = nil
return cfg
}(),
ConfigDiffs{
{
Path: "ServiceSettings.ReadTimeout",
BaseVal: defaultConfigGen().ServiceSettings.ReadTimeout,
ActualVal: func() *int {
return nil
}(),
},
},
"",
},
{
"slice addition",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSourceReplicas = []string{
"ds0",
"ds1",
}
return cfg
}(),
ConfigDiffs{
{
Path: "SqlSettings.DataSourceReplicas",
BaseVal: defaultConfigGen().SqlSettings.DataSourceReplicas,
ActualVal: []string{
"ds0",
"ds1",
},
},
},
"",
},
{
"slice deletion",
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSourceReplicas = []string{
"ds0",
"ds1",
}
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSourceReplicas = []string{
"ds0",
}
return cfg
}(),
ConfigDiffs{
{
Path: "SqlSettings.DataSourceReplicas",
BaseVal: []string{
"ds0",
"ds1",
},
ActualVal: []string{
"ds0",
},
},
},
"",
},
{
"slice nil",
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSourceReplicas = []string{
"ds0",
"ds1",
}
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.SqlSettings.DataSourceReplicas = nil
return cfg
}(),
ConfigDiffs{
{
Path: "SqlSettings.DataSourceReplicas",
BaseVal: []string{
"ds0",
"ds1",
},
ActualVal: func() []string {
return nil
}(),
},
},
"",
},
{
"map change",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.PluginSettings.PluginStates["com.mattermost.nps"] = &model.PluginState{
Enable: !cfg.PluginSettings.PluginStates["com.mattermost.nps"].Enable,
}
return cfg
}(),
ConfigDiffs{
{
Path: "PluginSettings.PluginStates",
BaseVal: defaultConfigGen().PluginSettings.PluginStates,
ActualVal: map[string]*model.PluginState{
"com.mattermost.nps": {
Enable: !defaultConfigGen().PluginSettings.PluginStates["com.mattermost.nps"].Enable,
},
"com.mattermost.calls": {
Enable: true,
},
"mattermost-ai": {
Enable: true,
},
"playbooks": {
Enable: true,
},
},
},
},
"",
},
{
"map addition",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.PluginSettings.PluginStates["com.mattermost.newplugin"] = &model.PluginState{
Enable: true,
}
return cfg
}(),
ConfigDiffs{
{
Path: "PluginSettings.PluginStates",
BaseVal: defaultConfigGen().PluginSettings.PluginStates,
ActualVal: map[string]*model.PluginState{
"com.mattermost.nps": {
Enable: defaultConfigGen().PluginSettings.PluginStates["com.mattermost.nps"].Enable,
},
"com.mattermost.newplugin": {
Enable: true,
},
"com.mattermost.calls": {
Enable: true,
},
"mattermost-ai": {
Enable: true,
},
"playbooks": {
Enable: true,
},
},
},
},
"",
},
{
"map deletion",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
delete(cfg.PluginSettings.PluginStates, "com.mattermost.nps")
return cfg
}(),
ConfigDiffs{
{
Path: "PluginSettings.PluginStates",
BaseVal: defaultConfigGen().PluginSettings.PluginStates,
ActualVal: map[string]*model.PluginState{
"com.mattermost.calls": {
Enable: true,
},
"mattermost-ai": {
Enable: true,
},
"playbooks": {
Enable: true,
},
},
},
},
"",
},
{
"map nil",
defaultConfigGen(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.PluginSettings.PluginStates = nil
return cfg
}(),
ConfigDiffs{
{
Path: "PluginSettings.PluginStates",
BaseVal: defaultConfigGen().PluginSettings.PluginStates,
ActualVal: func() map[string]*model.PluginState {
return nil
}(),
},
},
"",
},
{
"map type change",
func() *model.Config {
cfg := defaultConfigGen()
cfg.PluginSettings.Plugins = map[string]map[string]any{
"com.mattermost.newplugin": {
"key": true,
},
}
return cfg
}(),
func() *model.Config {
cfg := defaultConfigGen()
cfg.PluginSettings.Plugins = map[string]map[string]any{
"com.mattermost.newplugin": {
"key": "string",
},
}
return cfg
}(),
ConfigDiffs{
{
Path: "PluginSettings.Plugins",
BaseVal: func() any {
return map[string]map[string]any{
"com.mattermost.newplugin": {
"key": true,
},
}
}(),
ActualVal: func() any {
return map[string]map[string]any{
"com.mattermost.newplugin": {
"key": "string",
},
}
}(),
},
},
"",
},
}
for _, tc := range tcs {
t.Run(tc.name, func(t *testing.T) {
diffs, err := Diff(tc.base, tc.actual)
if tc.err != "" {
require.EqualError(t, err, tc.err)
require.Nil(t, diffs)
} else {
require.NoError(t, err)
}
require.Equal(t, tc.diffs, diffs)
})
}
}
Reference in a new issue View git blame Copy permalink