snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

server/channels/testlib/resources.go

@@ -0,0 +1,218 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package testlib
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"path"
+	"path/filepath"
+
+	"github.com/pkg/errors"
+
+	"github.com/mattermost/mattermost/server/public/model"
+	"github.com/mattermost/mattermost/server/public/utils"
+	"github.com/mattermost/mattermost/server/v8"
+	"github.com/mattermost/mattermost/server/v8/channels/utils/fileutils"
+	"github.com/mattermost/mattermost/server/v8/platform/shared/filestore"
+)
+
+const (
+	resourceTypeFile = iota
+	resourceTypeFolder
+)
+
+const (
+	actionCopy = iota
+	actionSymlink
+)
+
+const root = "___mattermost-server"
+
+type testResourceDetails struct {
+	src     string
+	dest    string
+	resType int8
+	action  int8
+}
+
+func findFile(path string) string {
+	// Use the testdata path to search from the root of the monorepo.
+	searchPaths := fileutils.CommonBaseSearchPaths()
+	searchPaths = append(searchPaths, filepath.Join(server.GetPackagePath(), "channels", "testlib", "testdata", "../../../"))
+
+	return fileutils.FindPath(path, searchPaths, func(fileInfo os.FileInfo) bool {
+		return !fileInfo.IsDir()
+	})
+}
+
+func findDir(dir string) (string, bool) {
+	if dir == root {
+		srcPath := findFile("go.mod")
+		if srcPath == "" {
+			return "./", false
+		}
+
+		return path.Dir(srcPath), true
+	}
+
+	// Use the testdata path to search from the root of the monorepo.
+	searchPaths := fileutils.CommonBaseSearchPaths()
+	searchPaths = append(searchPaths, filepath.Join(server.GetPackagePath(), "channels", "testlib", "testdata", "../../../"))
+
+	found := fileutils.FindPath(dir, searchPaths, func(fileInfo os.FileInfo) bool {
+		return fileInfo.IsDir()
+	})
+	if found == "" {
+		return "./", false
+	}
+
+	return found, true
+}
+
+func getTestResourcesToSetup() []testResourceDetails {
+	var srcPath string
+	var found bool
+
+	var testResourcesToSetup = []testResourceDetails{
+		{root, "mattermost-server", resourceTypeFolder, actionSymlink},
+		{"go.mod", "go.mod", resourceTypeFile, actionSymlink},
+		{"i18n", "i18n", resourceTypeFolder, actionSymlink},
+		{"templates", "templates", resourceTypeFolder, actionSymlink},
+		{"tests", "tests", resourceTypeFolder, actionSymlink},
+		{"fonts", "fonts", resourceTypeFolder, actionSymlink},
+		{"channels/app/plugin_api_tests", "channels/app/plugin_api_tests", resourceTypeFolder, actionSymlink},
+		{"channels/utils/policies-roles-mapping.json", "channels/utils/policies-roles-mapping.json", resourceTypeFile, actionSymlink},
+	}
+
+	// Finding resources and setting full path to source to be used for further processing
+	for i, testResource := range testResourcesToSetup {
+		if testResource.resType == resourceTypeFile {
+			srcPath = findFile(testResource.src)
+			if srcPath == "" {
+				panic(fmt.Sprintf("Failed to find file %s", testResource.src))
+			}
+
+			testResourcesToSetup[i].src = srcPath
+		} else if testResource.resType == resourceTypeFolder {
+			srcPath, found = findDir(testResource.src)
+			if !found {
+				panic(fmt.Sprintf("Failed to find folder %s", testResource.src))
+			}
+
+			testResourcesToSetup[i].src = srcPath
+		} else {
+			panic(fmt.Sprintf("Invalid resource type: %d", testResource.resType))
+		}
+	}
+
+	return testResourcesToSetup
+}
+
+func CopyFile(src, dst string) error {
+	fileBackend, err := filestore.NewFileBackend(filestore.FileBackendSettings{DriverName: "local", Directory: ""})
+	if err != nil {
+		return errors.Wrapf(err, "failed to copy file %s to %s", src, dst)
+	}
+	if err = fileBackend.CopyFile(src, dst); err != nil {
+		return errors.Wrapf(err, "failed to copy file %s to %s", src, dst)
+	}
+	return nil
+}
+
+func SetupTestResources() (string, error) {
+	testResourcesToSetup := getTestResourcesToSetup()
+
+	tempDir, err := os.MkdirTemp("", "testlib")
+	if err != nil {
+		return "", errors.Wrap(err, "failed to create temporary directory")
+	}
+
+	pluginsDir := path.Join(tempDir, "plugins")
+	err = os.Mkdir(pluginsDir, 0700)
+	if err != nil {
+		return "", errors.Wrapf(err, "failed to create plugins directory %s", pluginsDir)
+	}
+
+	clientDir := path.Join(tempDir, "client")
+	err = os.Mkdir(clientDir, 0700)
+	if err != nil {
+		return "", errors.Wrapf(err, "failed to create client directory %s", clientDir)
+	}
+
+	logsDir := path.Join(tempDir, "logs")
+	err = os.Mkdir(logsDir, 0700)
+	if err != nil {
+		return "", errors.Wrapf(err, "failed to create logs directory %s", logsDir)
+	}
+
+	err = setupConfig(path.Join(tempDir, "config"))
+	if err != nil {
+		return "", errors.Wrap(err, "failed to setup config")
+	}
+
+	var resourceDestInTemp string
+
+	// Setting up test resources in temp.
+	// Action in each resource tells whether it needs to be copied or just symlinked
+	for _, testResource := range testResourcesToSetup {
+		resourceDestInTemp = filepath.Join(tempDir, testResource.dest)
+
+		if testResource.action == actionCopy {
+			if testResource.resType == resourceTypeFile {
+				if err = CopyFile(testResource.src, resourceDestInTemp); err != nil {
+					return "", err
+				}
+			} else if testResource.resType == resourceTypeFolder {
+				err = utils.CopyDir(testResource.src, resourceDestInTemp)
+				if err != nil {
+					return "", errors.Wrapf(err, "failed to copy folder %s to %s", testResource.src, resourceDestInTemp)
+				}
+			}
+		} else if testResource.action == actionSymlink {
+			destDir := path.Dir(resourceDestInTemp)
+			if destDir != "." {
+				err = os.MkdirAll(destDir, os.ModePerm)
+				if err != nil {
+					return "", errors.Wrapf(err, "failed to make dir %s", destDir)
+				}
+			}
+
+			err = os.Symlink(testResource.src, resourceDestInTemp)
+			if err != nil {
+				return "", errors.Wrapf(err, "failed to symlink %s to %s", testResource.src, resourceDestInTemp)
+			}
+		} else {
+			return "", errors.Wrapf(err, "Invalid action: %d", testResource.action)
+		}
+	}
+
+	return tempDir, nil
+}
+
+func setupConfig(configDir string) error {
+	var err error
+	var config model.Config
+
+	config.SetDefaults()
+
+	err = os.Mkdir(configDir, 0700)
+	if err != nil {
+		return errors.Wrapf(err, "failed to create config directory %s", configDir)
+	}
+
+	buf, err := json.Marshal(config)
+	if err != nil {
+		return fmt.Errorf("failed to marshal config: %v", err)
+	}
+
+	configJSON := path.Join(configDir, "config.json")
+	err = os.WriteFile(configJSON, buf, 0644)
+	if err != nil {
+		return errors.Wrapf(err, "failed to write config to %s", configJSON)
+	}
+
+	return nil
+}