Dockerized build updated tests (#9943)

* testlib: introduce and leverage

This doesn't yet factor out the individual test helpers: many packages
still rely on `api4` directly to do this, but now wire up the test store
setup through this package. `app` and `store`, in particular, don't use
`testlib` because of circular dependencies at the moment.

* cmd: command_test.go: use api4 testlib

* cmd: plugin_test.go: remove dependence on test-config.json

* cmd: config_test.go use configured database settings

* ensure test-(te|ee) exit with status code

* test-server: run all tests, deprecating test-te/test-ee

* cmd/mattermost/commands: fix unit tests

Instead of relying on (and modifying) a config.json found in the current path, explicitly create a temporary one from defaults for each test. This was likely the source of various bugs over time, but specifically allows us to override the SqlSettings to point at the configured test database for all tests simultaneously.

* wrap run/check into a test helper

It was insufficient to set a config for each invocation of CheckCommand or RunCommand: some tests relied on the config having changed in a subsequent assertion. Instead, create a new test helper embedding api4.TestHelper. This has the nice advantage of cleaning up all the teardown.

* additional TestConfigGet granularity

* customized config path to avoid default location

* be explicit if the storetest initialization fails

* generate safe coverprofile names in the presence of subtests

* additional TestConfigShow granularity

* fix permission_test.go typo

* fix webhook tests

* actually flag.Parse() to skip database setup on os.Execed tests

* fix recent regression in #9962, not caught by unit tests

testlib/cluster.go

@@ -0,0 +1,55 @@
+// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package testlib
+
+import (
+	"github.com/mattermost/mattermost-server/einterfaces"
+	"github.com/mattermost/mattermost-server/model"
+)
+
+type FakeClusterInterface struct {
+	clusterMessageHandler einterfaces.ClusterMessageHandler
+}
+
+func (c *FakeClusterInterface) StartInterNodeCommunication() {}
+
+func (c *FakeClusterInterface) StopInterNodeCommunication() {}
+
+func (c *FakeClusterInterface) RegisterClusterMessageHandler(event string, crm einterfaces.ClusterMessageHandler) {
+	c.clusterMessageHandler = crm
+}
+
+func (c *FakeClusterInterface) GetClusterId() string { return "" }
+
+func (c *FakeClusterInterface) IsLeader() bool { return false }
+
+func (c *FakeClusterInterface) GetMyClusterInfo() *model.ClusterInfo { return nil }
+
+func (c *FakeClusterInterface) GetClusterInfos() []*model.ClusterInfo { return nil }
+
+func (c *FakeClusterInterface) SendClusterMessage(cluster *model.ClusterMessage) {}
+
+func (c *FakeClusterInterface) NotifyMsg(buf []byte) {}
+
+func (c *FakeClusterInterface) GetClusterStats() ([]*model.ClusterStats, *model.AppError) {
+	return nil, nil
+}
+
+func (c *FakeClusterInterface) GetLogs(page, perPage int) ([]string, *model.AppError) {
+	return []string{}, nil
+}
+
+func (c *FakeClusterInterface) ConfigChanged(previousConfig *model.Config, newConfig *model.Config, sendToOtherServer bool) *model.AppError {
+	return nil
+}
+
+func (c *FakeClusterInterface) SendClearRoleCacheMessage() {
+	c.clusterMessageHandler(&model.ClusterMessage{
+		Event: model.CLUSTER_EVENT_INVALIDATE_CACHE_FOR_ROLES,
+	})
+}
+
+func (c *FakeClusterInterface) GetPluginStatuses() (model.PluginStatuses, *model.AppError) {
+	return nil, nil
+}

testlib/doc.go

@@ -0,0 +1,5 @@
+// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+// testlib exposes helper methods for running unit tests against a containerized test store.
+package testlib

testlib/helper.go

@@ -0,0 +1,70 @@
+// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package testlib
+
+import (
+	"os"
+	"testing"
+
+	"github.com/mattermost/mattermost-server/mlog"
+	"github.com/mattermost/mattermost-server/model"
+	"github.com/mattermost/mattermost-server/store"
+	"github.com/mattermost/mattermost-server/store/sqlstore"
+	"github.com/mattermost/mattermost-server/store/storetest"
+	"github.com/mattermost/mattermost-server/utils"
+)
+
+type MainHelper struct {
+	Settings         *model.SqlSettings
+	Store            store.Store
+	SqlSupplier      *sqlstore.SqlSupplier
+	ClusterInterface *FakeClusterInterface
+
+	container *storetest.RunningContainer
+	status    int
+}
+
+func NewMainHelper() *MainHelper {
+	// Setup a global logger to catch tests logging outside of app context
+	// The global logger will be stomped by apps initalizing but that's fine for testing.
+	// Ideally this won't happen.
+	mlog.InitGlobalLogger(mlog.NewLogger(&mlog.LoggerConfiguration{
+		EnableConsole: true,
+		ConsoleJson:   true,
+		ConsoleLevel:  "error",
+		EnableFile:    false,
+	}))
+
+	utils.TranslationsPreInit()
+
+	container, settings, err := storetest.NewMySQLContainer()
+	if err != nil {
+		panic("failed to start mysql container: " + err.Error())
+	}
+
+	testClusterInterface := &FakeClusterInterface{}
+	testStoreSqlSupplier := sqlstore.NewSqlSupplier(*settings, nil)
+	testStore := &TestStore{store.NewLayeredStore(testStoreSqlSupplier, nil, testClusterInterface)}
+
+	return &MainHelper{
+		Settings:         settings,
+		Store:            testStore,
+		SqlSupplier:      testStoreSqlSupplier,
+		ClusterInterface: testClusterInterface,
+		container:        container,
+	}
+}
+
+func (h *MainHelper) Main(m *testing.M) {
+	h.status = m.Run()
+}
+
+func (h *MainHelper) Close() error {
+	h.container.Stop()
+	h.container = nil
+
+	os.Exit(h.status)
+
+	return nil
+}

testlib/store.go

@@ -0,0 +1,15 @@
+// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package testlib
+
+import (
+	"github.com/mattermost/mattermost-server/store"
+)
+
+type TestStore struct {
+	store.Store
+}
+
+func (*TestStore) Close() {
+}