Files
team/server/public/pluginapi/kv_memory_test.go
9ed85b6850 Cherry-pick Go 1.25.8 upgrade and FIPS password fixes to release-11.4 (#36123)
* ci: shard server Postgres tests into 4 parallel runners (#35739)

Cherry-pick of 00296f9b49 from master.

* updated go to version 1.25.8 (#35817)

Cherry-pick of 32a10bac62 from master.

* Move password hashers from server/v8 to server/public (#35805)

Cherry-pick of cca3f08574 from master.

* Generate instead of hard-coding test passwords, enforce new minimum for FIPS, shard CI, fix FIPS builds (#35905)

Cherry-pick of 1bdd985b41 from master.

* upgrade golangci-lint (#35845)

Cherry-pick of 157e0400b2 from master.

On release-11.4 (unlike 11.5), UpdatePostsChannelTypeByChannelId and
BackfillPostsChannelType exist in the elasticsearch/opensearch files,
so the imports they require (fmt, updatebyquery, scriptlanguage) must
be added — they were not in the cherry-pick diff since they already
existed on master.

Also updates html2text/tablewriter/olekukonko deps to fix a workspace
conflict where enterprise's Go 1.25.8 bump pulled in a newer html2text
that requires tablewriter ≥ 1.1 (was pinned to 0.0.5 via a replace
directive). Matches the subset of 866f759e4b (Mm 66662 bump deps)
relevant to this incompatibility.

* Fix FIPS-incompatible passwords and config in e2e test suites (#36001)

Cherry-pick of b51b4a8937 from master.

release-11.4 differences vs release-11.5:
- demo_plugin_installation.spec.ts also deleted (modify/delete conflict, git rm)
- authentication_2_spec.ts conflict: HEAD missing check() call; took
  incoming (check + FIPS-length passwords)
- member_invitation_ui_spec.ts: HEAD has 'Create Account' (capital A)
  matching release-11.4 button text; kept HEAD's button text with
  incoming's newTestPassword()

* fix(cypress): demo plugin (#36056)

Cherry-pick of 39f1979aa5 from master.

demo_plugin_installation.spec.ts was deleted in step 10 (modify/delete);
re-created here with both the FIPS-password change and the URL fix.

* test: clean up channel store data after TestChannelStore (#36066)

TestChannelStore sub-tests create channels, members, and team members
using fake TeamIds and UserIds (model.NewId() for non-existent rows).
These records are left in the database and cause integrity tests
(TestCheck*) running in the same binary to fail their full-table scans.

Register a t.Cleanup on TestChannelStore that purges the affected
tables entirely. A blanket purge is safe: the schema enforces no FK
constraints, and every test suite creates its own data independently.

* Fix command injection in server-test-template workflow (#36080)

Cherry-pick of 9223935f16 from master.

* fix(ci): restore testname format in sharded gotestsum runs (#36078)

run-shard-tests.sh called gotestsum directly without --format, so it
fell back to gotestsum's default (pkgname) instead of the testname
format set by the Makefile. Pass --format "${GOTESTSUM_FORMAT:-testname}"
to match the Makefile default.

Co-authored-by: Mattermost Build <[email protected]>

* fixup: drop demo_plugin playwright specs — master-only APIs

demo_plugin/helpers.ts and demo_plugin_installation.spec.ts use
installAndEnablePlugin and isPluginActive which don't exist on
release-11.4's PlaywrightExtended type. These files were re-created
by the step-11 cherry-pick of 39f1979aa5, but they don't compile on
this branch (same class of problem as actions.spec.ts in step 10).

* fixup: add missing await in PluginLinkTooltip test

The test added in 39f1979aa5 is missing an await on renderWithContext,
causing the pointer-events assertion to race. Fix from 0c7d3f27c6
(on a feature branch, not yet on master).

* fixup: drop pointer-events test incompatible with jsdom@20

The 'should not block interaction with elements outside the tooltip' test
checks getComputedStyle for pointer-events: none, which is set only in SCSS.
release-11.4 uses jest-environment-jsdom@29 (jsdom@20), which does not apply
stylesheets, so getComputedStyle always returns "". The test passes on
release-11.5+ only because they use jest-environment-jsdom@30 (jsdom@25+).

Drop the test rather than backport the jsdom upgrade.

* fixup: add missing i18n keys for elasticsearch/opensearch functions

BackfillPostsChannelType and UpdatePostsChannelTypeByChannelId exist on
release-11.4 (unlike release-11.5+). The golangci-lint cherry-pick added
new error strings to those functions referencing i18n keys that weren't
in en.json.

* fixup: run make i18n-extract to reorder keys correctly

* fixup: drop terms-and-privacy checkbox from MM-T1774 on release-11.4

The #signup-body-card-form-check-terms-and-privacy element did not exist
on release-11.4's signup page. It was added to master after this branch
was cut, so the check() call from the incoming cherry-pick causes the test
to fail with "element never found".

* fixup: remove UpdatePostsChannelTypeByChannelId/BackfillPostsChannelType

These functions were introduced by MM-67540 (allow searching public channel
messages without channel membership), which never landed on release-11.4.
The golangci-lint cherry-pick only modernizes existing code; the rerere
resolution incorrectly added the full function bodies from master.

Remove both functions and their now-unused imports (fmt, updatebyquery,
scriptlanguage) from elasticsearch.go and opensearch.go. Also remove the
two i18n keys added to support them.

Same treatment as release-11.5, where these functions were also absent.

---------

Co-authored-by: Mattermost Build <[email protected]>
2026-04-16 12:10:03 -03:00

464 lines
11 KiB
Go

package pluginapi_test
import (
"fmt"
"strconv"
"strings"
"sync"
"testing"
"time"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/mattermost/mattermost/server/public/pluginapi"
)
// kvStore is used to check that KVService and MemoryStore implement the same interface.
// Methods names are sorted alphabetically for easier comparison.
type kvStore interface {
Delete(key string) error
DeleteAll() error
Get(key string, o any) error
ListKeys(page, count int, options ...pluginapi.ListKeysOption) ([]string, error)
Set(key string, value any, options ...pluginapi.KVSetOption) (bool, error)
SetAtomicWithRetries(key string, valueFunc func(oldValue []byte) (newValue any, err error)) error
}
var _ kvStore = (*pluginapi.MemoryStore)(nil)
var _ kvStore = (*pluginapi.KVService)(nil)
func TestMemoryStoreSet(t *testing.T) {
t.Run("empty key", func(t *testing.T) {
store := pluginapi.MemoryStore{}
ok, err := store.Set("", []byte("value"))
assert.Error(t, err)
assert.False(t, ok)
})
t.Run("key has mmi_ prefix", func(t *testing.T) {
store := pluginapi.MemoryStore{}
ok, err := store.Set("mmi_foo", []byte("value"))
assert.Error(t, err)
assert.False(t, ok)
})
t.Run("nil map", func(t *testing.T) {
store := pluginapi.MemoryStore{}
ok, err := store.Set("key", []byte("value"))
assert.NoError(t, err)
assert.True(t, ok)
var out []byte
err = store.Get("key", &out)
assert.NoError(t, err)
assert.Equal(t, []byte("value"), out)
})
t.Run("atomic with no old value", func(t *testing.T) {
store := pluginapi.MemoryStore{}
ok, err := store.Set("key", []byte("value"), pluginapi.SetAtomic([]byte("old")))
assert.NoError(t, err)
assert.False(t, ok)
isNil(t, &store, "key")
})
t.Run("atomic with same old value", func(t *testing.T) {
store := pluginapi.MemoryStore{}
ok, err := store.Set("key", []byte("old"))
assert.NoError(t, err)
assert.True(t, ok)
ok, err = store.Set("key", []byte("new"), pluginapi.SetAtomic([]byte("old")))
assert.NoError(t, err)
assert.True(t, ok)
var out []byte
err = store.Get("key", &out)
assert.NoError(t, err)
assert.Equal(t, []byte("new"), out)
})
t.Run("setting to nil is deleting", func(t *testing.T) {
store := pluginapi.MemoryStore{}
ok, err := store.Set("key", []byte("value"))
assert.NoError(t, err)
assert.True(t, ok)
ok, err = store.Set("key", nil)
assert.NoError(t, err)
assert.True(t, ok)
isNil(t, &store, "key")
})
t.Run("atomicly setting to nil is deleting", func(t *testing.T) {
store := pluginapi.MemoryStore{}
ok, err := store.Set("key", []byte("old"))
assert.NoError(t, err)
assert.True(t, ok)
ok, err = store.Set("key", nil, pluginapi.SetAtomic([]byte("old")))
assert.NoError(t, err)
assert.True(t, ok)
isNil(t, &store, "key")
})
t.Run("with long expiry", func(t *testing.T) {
store := pluginapi.MemoryStore{}
ok, err := store.Set("key", []byte("value"), pluginapi.SetExpiry(time.Minute))
assert.NoError(t, err)
assert.True(t, ok)
var out []byte
err = store.Get("key", &out)
assert.NoError(t, err)
assert.Equal(t, []byte("value"), out)
ok, err = store.Set("key", []byte("value"), pluginapi.SetExpiry(time.Second))
assert.NoError(t, err)
assert.True(t, ok)
time.Sleep(2 * time.Second)
isNil(t, &store, "key")
})
t.Run("concurrent writes", func(t *testing.T) {
store := pluginapi.MemoryStore{}
var wg sync.WaitGroup
const n = 100
for i := range n {
wg.Go(func() {
ok, err := store.Set(fmt.Sprintf("k_%d", i), []byte("value"))
require.NoError(t, err)
require.True(t, ok)
})
}
wg.Wait()
for i := range n {
var out []byte
err := store.Get(fmt.Sprintf("k_%d", i), &out)
assert.NoError(t, err, "i=%d", i)
assert.Equal(t, []byte("value"), out, "i=%d", i)
}
})
}
func TestMemoryStoreSetAtomicWithRetries(t *testing.T) {
t.Run("nil function", func(t *testing.T) {
store := pluginapi.MemoryStore{}
err := store.SetAtomicWithRetries("key", nil)
assert.Error(t, err)
isNil(t, &store, "key")
})
t.Run("old value not found", func(t *testing.T) {
store := pluginapi.MemoryStore{}
err := store.SetAtomicWithRetries("key", func(oldValue []byte) (any, error) { return []byte("new"), nil })
require.NoError(t, err)
var out []byte
err = store.Get("key", &out)
require.NoError(t, err)
assert.Equal(t, []byte("new"), out)
})
t.Run("old value not found", func(t *testing.T) {
store := pluginapi.MemoryStore{}
err := store.SetAtomicWithRetries("key", func(oldValue []byte) (any, error) { return nil, errors.New("some error") })
require.Error(t, err)
isNil(t, &store, "key")
})
t.Run("two goroutines race", func(t *testing.T) {
store := pluginapi.MemoryStore{}
var wg sync.WaitGroup
const n = 10
for i := range n {
wg.Go(func() {
err := store.SetAtomicWithRetries("key", func(oldValue []byte) (any, error) { return fmt.Sprintf("k_%d", i), nil })
require.NoError(t, err)
})
}
wg.Wait()
// It undefinded, which goroutine wins the final write. Just check that any value was written.
var out string
err := store.Get("key", &out)
require.NoError(t, err)
assert.True(t, strings.HasPrefix(out, "k_"))
})
}
func TestMemoryStoreListKeys(t *testing.T) {
t.Run("nil map", func(t *testing.T) {
store := pluginapi.MemoryStore{}
keys, err := store.ListKeys(0, 200)
assert.NoError(t, err)
assert.Len(t, keys, 0)
})
t.Run("zero count", func(t *testing.T) {
store := pluginapi.MemoryStore{}
for i := range 10 {
ok, err := store.Set(fmt.Sprintf("k_%d", i), "foo")
require.NoError(t, err)
require.True(t, ok)
}
keys, err := store.ListKeys(1, 0)
assert.NoError(t, err)
assert.Len(t, keys, 0)
})
t.Run("negative count", func(t *testing.T) {
store := pluginapi.MemoryStore{}
for i := range 10 {
ok, err := store.Set(fmt.Sprintf("k_%d", i), "foo")
require.NoError(t, err)
require.True(t, ok)
}
keys, err := store.ListKeys(0, -1)
assert.Error(t, err)
assert.Len(t, keys, 0)
})
t.Run("negative page", func(t *testing.T) {
store := pluginapi.MemoryStore{}
for i := range 10 {
ok, err := store.Set(fmt.Sprintf("k_%d", i), "foo")
require.NoError(t, err)
require.True(t, ok)
}
keys, err := store.ListKeys(-1, 200)
assert.Error(t, err)
assert.Len(t, keys, 0)
})
t.Run("single page", func(t *testing.T) {
store := pluginapi.MemoryStore{}
for i := range 10 {
ok, err := store.Set(fmt.Sprintf("k_%d", i), "foo")
require.NoError(t, err)
require.True(t, ok)
}
keys, err := store.ListKeys(0, 200)
assert.NoError(t, err)
assert.Len(t, keys, 10)
})
t.Run("multiple pages", func(t *testing.T) {
store := pluginapi.MemoryStore{}
for i := range 7 {
ok, err := store.Set(fmt.Sprintf("k_%d", i), "foo")
require.NoError(t, err)
require.True(t, ok)
}
keys, err := store.ListKeys(0, 3)
assert.NoError(t, err)
assert.Equal(t, []string{"k_0", "k_1", "k_2"}, keys)
keys, err = store.ListKeys(1, 3)
assert.NoError(t, err)
assert.Equal(t, []string{"k_3", "k_4", "k_5"}, keys)
keys, err = store.ListKeys(2, 3)
assert.NoError(t, err)
assert.Equal(t, []string{"k_6"}, keys)
keys, err = store.ListKeys(5, 100)
assert.NoError(t, err)
assert.Equal(t, []string{}, keys)
})
t.Run("with checker", func(t *testing.T) {
store := pluginapi.MemoryStore{}
odd := func(key string) (bool, error) {
s := strings.Split(key, "_")
if len(s) != 2 {
return false, errors.Errorf("wrongly formated key %v", key)
}
i, err := strconv.Atoi(s[1])
if err != nil {
return false, err
}
return i%2 == 1, nil
}
even := func(key string) (bool, error) {
s := strings.Split(key, "_")
if len(s) != 2 {
return false, errors.Errorf("wrongly formated key %v", key)
}
i, err := strconv.Atoi(s[1])
if err != nil {
return false, err
}
return i%2 == 0, nil
}
for i := range 7 {
ok, err := store.Set(fmt.Sprintf("k_%d", i), "foo")
require.NoError(t, err)
require.True(t, ok)
}
keys, err := store.ListKeys(0, 3, pluginapi.WithChecker(even))
assert.NoError(t, err)
assert.Equal(t, []string{"k_0", "k_2"}, keys)
keys, err = store.ListKeys(0, 3, pluginapi.WithChecker(odd))
assert.NoError(t, err)
assert.Equal(t, []string{"k_1"}, keys)
keys, err = store.ListKeys(0, 3, pluginapi.WithChecker(odd), pluginapi.WithChecker(even))
assert.NoError(t, err)
assert.Equal(t, []string{}, keys)
keys, err = store.ListKeys(1, 3)
assert.NoError(t, err)
assert.Equal(t, []string{"k_3", "k_4", "k_5"}, keys)
keys, err = store.ListKeys(2, 3)
assert.NoError(t, err)
assert.Equal(t, []string{"k_6"}, keys)
})
t.Run("with expired entries", func(t *testing.T) {
store := pluginapi.MemoryStore{}
for i := range 7 {
var opt pluginapi.KVSetOption
if i%2 == 1 {
opt = pluginapi.SetExpiry(1 * time.Second)
}
ok, err := store.Set(fmt.Sprintf("k_%d", i), "foo", opt)
require.NoError(t, err)
require.True(t, ok)
}
time.Sleep(2 * time.Second)
keys, err := store.ListKeys(0, 5)
assert.NoError(t, err)
assert.Equal(t, []string{"k_0", "k_2", "k_4", "k_6"}, keys)
})
}
func TestMemoryStoreGet(t *testing.T) {
t.Run("nil map", func(t *testing.T) {
store := pluginapi.MemoryStore{}
isNil(t, &store, "key")
})
t.Run("set empty byte slice", func(t *testing.T) {
store := pluginapi.MemoryStore{}
in := []byte("")
ok, err := store.Set("key", in)
assert.NoError(t, err)
assert.True(t, ok)
isNil(t, &store, "key")
})
t.Run("set and get byte slice", func(t *testing.T) {
store := pluginapi.MemoryStore{}
in := []byte("foo")
ok, err := store.Set("key", in)
assert.NoError(t, err)
assert.True(t, ok)
var out []byte
err = store.Get("key", &out)
assert.NoError(t, err)
assert.Equal(t, []byte("foo"), out)
})
t.Run("set and get struct slice", func(t *testing.T) {
store := pluginapi.MemoryStore{}
type myStruct struct {
Int int
String string
unExported bool
}
in := myStruct{
Int: 1,
String: "s",
unExported: true,
}
ok, err := store.Set("key", in)
assert.NoError(t, err)
assert.True(t, ok)
var out myStruct
err = store.Get("key", &out)
assert.NoError(t, err)
assert.Equal(t, myStruct{Int: 1, String: "s"}, out)
})
}
func TestMemoryStoreDelete(t *testing.T) {
t.Run("nil map", func(t *testing.T) {
store := pluginapi.MemoryStore{}
err := store.Delete("some key")
assert.NoError(t, err)
})
}
func TestMemoryStoreDeleteAll(t *testing.T) {
t.Run("nil map", func(t *testing.T) {
store := pluginapi.MemoryStore{}
err := store.DeleteAll()
assert.NoError(t, err)
keys, err := store.ListKeys(0, 200)
assert.NoError(t, err)
assert.Empty(t, keys)
})
t.Run("nil map", func(t *testing.T) {
store := pluginapi.MemoryStore{}
ok, err := store.Set("k_1", "foo")
require.NoError(t, err)
require.True(t, ok)
err = store.DeleteAll()
assert.NoError(t, err)
keys, err := store.ListKeys(0, 200)
assert.NoError(t, err)
assert.Empty(t, keys)
})
t.Run("idempotent", func(t *testing.T) {
store := pluginapi.MemoryStore{}
err := store.DeleteAll()
assert.NoError(t, err)
err = store.DeleteAll()
assert.NoError(t, err)
keys, err := store.ListKeys(0, 200)
assert.NoError(t, err)
assert.Empty(t, keys)
})
}
func isNil(t require.TestingT, store *pluginapi.MemoryStore, key string) {
var out []byte
err := store.Get(key, &out)
require.NoError(t, err)
assert.Nil(t, out)
}