mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
4a44d23095
* Remove uneeded hack in docker-compose now that problem is solved * Remove obsolete attribute `version` in docker compose configuration files --------- Co-authored-by: Mattermost Build <build@mattermost.com>
849 lines
34 KiB
Makefile
849 lines
34 KiB
Makefile
.PHONY: build package run stop run-client run-server run-node run-haserver stop-haserver stop-client stop-server restart restart-server restart-client restart-haserver start-docker update-docker clean-dist clean nuke check-style check-client-style check-server-style check-unit-tests test dist run-client-tests setup-run-client-tests cleanup-run-client-tests test-client build-linux build-osx build-windows package-prep package-linux package-osx package-windows internal-test-web-client vet run-server-for-web-client-tests diff-config prepackaged-plugins prepackaged-binaries test-server test-server-ee test-server-quick test-server-race test-mmctl-unit test-mmctl-e2e test-mmctl test-mmctl-coverage mmctl-build mmctl-docs new-migration migrations-extract test-public mocks-public
|
|
|
|
ROOT := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
|
|
|
|
ifeq ($(OS),Windows_NT)
|
|
PLATFORM := Windows
|
|
else
|
|
PLATFORM := $(shell uname)
|
|
endif
|
|
|
|
# Detect Apple Silicon and set a flag.
|
|
ifeq ($(shell uname)/$(shell uname -m),Darwin/arm64)
|
|
ARM_BASED_MAC = true
|
|
endif
|
|
|
|
define LICENSE_HEADER
|
|
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
endef
|
|
|
|
IS_CI ?= false
|
|
# Build Flags
|
|
BUILD_NUMBER ?= $(BUILD_NUMBER:)
|
|
BUILD_DATE = $(shell date -u)
|
|
BUILD_HASH = $(shell git rev-parse HEAD)
|
|
BUILD_TAGS =
|
|
|
|
|
|
# Docker
|
|
export COMPOSE_PROJECT_NAME=mattermost-server
|
|
|
|
# If we don't set the build number it defaults to dev
|
|
ifeq ($(BUILD_NUMBER),)
|
|
BUILD_DATE := n/a
|
|
BUILD_NUMBER := dev
|
|
endif
|
|
|
|
# Go test sum configuration
|
|
GOTESTSUM_FORMAT ?= testname
|
|
GOTESTSUM_JUNITFILE ?= report.xml
|
|
GOTESTSUM_JSONFILE ?= gotestsum.json
|
|
|
|
# mmctl
|
|
MMCTL_BUILD_TAGS =
|
|
MMCTL_TESTFLAGS ?= -timeout 30m
|
|
MMCTL_PKG = github.com/mattermost/mattermost/server/v8/cmd/mmctl/commands
|
|
MMCTL_BUILD_DATE = $(shell date -u +'%Y-%m-%dT%H:%M:%SZ')
|
|
MMCTL_LDFLAGS += -X "$(MMCTL_PKG).buildDate=$(MMCTL_BUILD_DATE)"
|
|
|
|
# Enterprise
|
|
BUILD_ENTERPRISE_DIR ?= ../../enterprise
|
|
BUILD_ENTERPRISE ?= true
|
|
BUILD_ENTERPRISE_READY = false
|
|
BUILD_TYPE_NAME = team
|
|
BUILD_HASH_ENTERPRISE = none
|
|
ifneq ($(wildcard $(BUILD_ENTERPRISE_DIR)/.),)
|
|
MMCTL_TESTFLAGS += -ldflags '-X "$(MMCTL_PKG).EnableEnterpriseTests=true" -X "github.com/mattermost/mattermost/server/public/model.BuildEnterpriseReady=true"'
|
|
MMCTL_BUILD_TAGS += enterprise
|
|
|
|
ifeq ($(BUILD_ENTERPRISE),true)
|
|
BUILD_ENTERPRISE_READY = true
|
|
BUILD_TYPE_NAME = enterprise
|
|
BUILD_HASH_ENTERPRISE = $(shell cd $(BUILD_ENTERPRISE_DIR) && git rev-parse HEAD)
|
|
BUILD_TAGS += enterprise
|
|
else
|
|
BUILD_ENTERPRISE_READY = false
|
|
BUILD_TYPE_NAME = team
|
|
endif
|
|
else
|
|
BUILD_ENTERPRISE_READY = false
|
|
BUILD_TYPE_NAME = team
|
|
endif
|
|
|
|
# Clean up the old means of importing enterprise source, if it exists
|
|
ifneq ($(wildcard channels/imports/imports.go),)
|
|
IGNORE := $(shell rm -f channels/imports/imports.go)
|
|
endif
|
|
|
|
# Source available, already included with enterprise but also available during development.
|
|
ifeq ($(BUILD_NUMBER),dev)
|
|
BUILD_TAGS += sourceavailable
|
|
endif
|
|
|
|
# Webapp
|
|
BUILD_WEBAPP_DIR ?= ../webapp
|
|
|
|
# We need current user's UID for `run-haserver` so docker compose does not run server
|
|
# as root and mess up file permissions for devs. When running like this HOME will be blank
|
|
# and docker will add '/', so we need to set the go-build cache location or we'll get
|
|
# permission errors on build as it tries to create a cache in filesystem root.
|
|
export CURRENT_UID = $(shell id -u):$(shell id -g)
|
|
ifeq ($(HOME),/)
|
|
export XDG_CACHE_HOME = /tmp/go-cache/
|
|
endif
|
|
|
|
# Go Flags
|
|
GOFLAGS ?= $(GOFLAGS:)
|
|
# We need to export GOBIN to allow it to be set
|
|
# for processes spawned from the Makefile
|
|
export GOBIN ?= $(PWD)/bin
|
|
GO ?= go
|
|
DELVE ?= dlv
|
|
LDFLAGS += -X "github.com/mattermost/mattermost/server/public/model.BuildNumber=$(BUILD_NUMBER)"
|
|
LDFLAGS += -X "github.com/mattermost/mattermost/server/public/model.BuildDate=$(BUILD_DATE)"
|
|
LDFLAGS += -X "github.com/mattermost/mattermost/server/public/model.BuildHash=$(BUILD_HASH)"
|
|
LDFLAGS += -X "github.com/mattermost/mattermost/server/public/model.BuildHashEnterprise=$(BUILD_HASH_ENTERPRISE)"
|
|
LDFLAGS += -X "github.com/mattermost/mattermost/server/public/model.BuildEnterpriseReady=$(BUILD_ENTERPRISE_READY)"
|
|
|
|
GO_MAJOR_VERSION = $(shell $(GO) version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f1)
|
|
GO_MINOR_VERSION = $(shell $(GO) version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f2)
|
|
MINIMUM_SUPPORTED_GO_MAJOR_VERSION = 1
|
|
MINIMUM_SUPPORTED_GO_MINOR_VERSION = 15
|
|
GO_VERSION_VALIDATION_ERR_MSG = Golang version is not supported, please update to at least $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION).$(MINIMUM_SUPPORTED_GO_MINOR_VERSION)
|
|
|
|
# GOOS/GOARCH of the build host, used to determine whether we're cross-compiling or not
|
|
BUILDER_GOOS_GOARCH="$(shell $(GO) env GOOS)_$(shell $(GO) env GOARCH)"
|
|
|
|
PLATFORM_FILES="./cmd/mattermost"
|
|
|
|
# Output paths
|
|
DIST_ROOT=dist
|
|
DIST_PATH=$(DIST_ROOT)/mattermost
|
|
DIST_PATH_LIN_AMD64=$(DIST_ROOT)/linux_amd64/mattermost
|
|
DIST_PATH_LIN_ARM64=$(DIST_ROOT)/linux_arm64/mattermost
|
|
DIST_PATH_OSX_AMD64=$(DIST_ROOT)/darwin_amd64/mattermost
|
|
DIST_PATH_OSX_ARM64=$(DIST_ROOT)/darwin_arm64/mattermost
|
|
DIST_PATH_WIN=$(DIST_ROOT)/windows/mattermost
|
|
|
|
# Packages lists
|
|
TE_PACKAGES=$(shell $(GO) list ./public/...) $(shell $(GO) list ./... | grep -vE 'server/v8/cmd/mmctl')
|
|
MMCTL_PACKAGES=$(shell $(GO) list ./... | grep -E 'server/v8/cmd/mmctl')
|
|
|
|
TEMPLATES_DIR=templates
|
|
|
|
# Plugins Packages
|
|
PLUGIN_PACKAGES ?= $(PLUGIN_PACKAGES:)
|
|
PLUGIN_PACKAGES += mattermost-plugin-calls-v1.5.1
|
|
PLUGIN_PACKAGES += mattermost-plugin-github-v2.3.0
|
|
PLUGIN_PACKAGES += mattermost-plugin-gitlab-v1.9.1
|
|
PLUGIN_PACKAGES += mattermost-plugin-jira-v4.2.0
|
|
# We need to prepackage both versions of playbooks and install the correct one based on the server license. See MM-60025.
|
|
PLUGIN_PACKAGES += mattermost-plugin-playbooks-v1.40.0
|
|
PLUGIN_PACKAGES += mattermost-plugin-playbooks-v2.0.1
|
|
PLUGIN_PACKAGES += mattermost-plugin-nps-v1.3.3
|
|
PLUGIN_PACKAGES += mattermost-plugin-servicenow-v2.3.4
|
|
PLUGIN_PACKAGES += mattermost-plugin-zoom-v1.8.0
|
|
PLUGIN_PACKAGES += mattermost-plugin-ai-v1.0.0
|
|
PLUGIN_PACKAGES += mattermost-plugin-boards-v9.1.1
|
|
PLUGIN_PACKAGES += mattermost-plugin-msteams-v2.1.0
|
|
PLUGIN_PACKAGES += mattermost-plugin-user-survey-v1.1.1
|
|
PLUGIN_PACKAGES += mattermost-plugin-mscalendar-v1.3.4
|
|
PLUGIN_PACKAGES += mattermost-plugin-msteams-meetings-v2.2.0
|
|
PLUGIN_PACKAGES += mattermost-plugin-metrics-v0.5.3
|
|
PLUGIN_PACKAGES += mattermost-plugin-channel-export-v1.2.1
|
|
|
|
EE_PACKAGES=$(shell $(GO) list $(BUILD_ENTERPRISE_DIR)/...)
|
|
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
ALL_PACKAGES=$(TE_PACKAGES) $(EE_PACKAGES)
|
|
else
|
|
ALL_PACKAGES=$(TE_PACKAGES)
|
|
endif
|
|
|
|
CONFIG_FILE_PATH ?= ./config/config.json
|
|
|
|
all: run ## Alias for 'run'.
|
|
|
|
-include config.override.mk
|
|
|
|
# Make sure not to modify an overridden ENABLED_DOCKER_SERVICES variable
|
|
DOCKER_SERVICES_OVERRIDE=false
|
|
ifneq (,$(ENABLED_DOCKER_SERVICES))
|
|
$(info ENABLED_DOCKER_SERVICES has been overridden)
|
|
DOCKER_SERVICES_OVERRIDE=true
|
|
endif
|
|
|
|
include config.mk
|
|
include build/*.mk
|
|
include public/Makefile
|
|
|
|
LDFLAGS += -X "github.com/mattermost/mattermost/server/public/model.MockCWS=$(MM_ENABLE_CWS_MOCK)"
|
|
LDFLAGS += -X "github.com/mattermost/mattermost/server/public/model.MattermostGiphySdkKey=$(MM_GIPHY_SDK_KEY)"
|
|
|
|
RUN_IN_BACKGROUND ?=
|
|
ifeq ($(RUN_SERVER_IN_BACKGROUND),true)
|
|
RUN_IN_BACKGROUND := &
|
|
endif
|
|
|
|
DOCKER_COMPOSE_OVERRIDE=
|
|
ifneq ("$(wildcard ./docker-compose.override.yaml)","")
|
|
DOCKER_COMPOSE_OVERRIDE=-f docker-compose.override.yaml
|
|
endif
|
|
|
|
ifeq ($(ARM_BASED_MAC),true)
|
|
$(info Apple Silicon detected, applying elasticsearch override)
|
|
DOCKER_COMPOSE_OVERRIDE := -f docker-compose.makefile.m1.yml $(DOCKER_COMPOSE_OVERRIDE)
|
|
endif
|
|
|
|
ifneq ($(DOCKER_SERVICES_OVERRIDE),true)
|
|
ifeq (,$(findstring minio,$(ENABLED_DOCKER_SERVICES)))
|
|
TEMP_DOCKER_SERVICES:=$(TEMP_DOCKER_SERVICES) minio
|
|
endif
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
ifeq (,$(findstring openldap,$(ENABLED_DOCKER_SERVICES)))
|
|
TEMP_DOCKER_SERVICES:=$(TEMP_DOCKER_SERVICES) openldap
|
|
endif
|
|
ifeq (,$(findstring elasticsearch,$(ENABLED_DOCKER_SERVICES)))
|
|
TEMP_DOCKER_SERVICES:=$(TEMP_DOCKER_SERVICES) elasticsearch
|
|
endif
|
|
endif
|
|
ENABLED_DOCKER_SERVICES:=$(ENABLED_DOCKER_SERVICES) $(TEMP_DOCKER_SERVICES)
|
|
endif
|
|
|
|
start-docker: ## Starts the docker containers for local development.
|
|
ifneq ($(IS_CI),false)
|
|
@echo CI Build: skipping docker start
|
|
else ifeq ($(MM_NO_DOCKER),true)
|
|
@echo No Docker Enabled: skipping docker start
|
|
else
|
|
@echo Starting docker containers
|
|
|
|
docker compose rm start_dependencies
|
|
$(GO) run ./build/docker-compose-generator/main.go $(ENABLED_DOCKER_SERVICES) | docker compose -f docker-compose.makefile.yml -f /dev/stdin $(DOCKER_COMPOSE_OVERRIDE) run -T --rm start_dependencies
|
|
ifneq (,$(findstring openldap,$(ENABLED_DOCKER_SERVICES)))
|
|
cat tests/${LDAP_DATA}-data.ldif | docker compose -f docker-compose.makefile.yml $(DOCKER_COMPOSE_OVERRIDE) exec -T openldap bash -c 'ldapadd -x -D "cn=admin,dc=mm,dc=test,dc=com" -w mostest || true';
|
|
endif
|
|
ifneq (,$(findstring mysql-read-replica,$(ENABLED_DOCKER_SERVICES)))
|
|
./scripts/replica-mysql-config.sh
|
|
endif
|
|
endif
|
|
|
|
update-docker: stop-docker ## Updates the docker containers for local development.
|
|
@echo Updating docker containers
|
|
|
|
$(GO) run ./build/docker-compose-generator/main.go $(ENABLED_DOCKER_SERVICES) | docker compose -f docker-compose.makefile.yml -f /dev/stdin $(DOCKER_COMPOSE_OVERRIDE) up --no-start
|
|
|
|
run-haserver:
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
@echo Starting mattermost in an HA topology '(3 node cluster)'
|
|
|
|
docker compose -f docker-compose.yaml $(DOCKER_COMPOSE_OVERRIDE) up --remove-orphans haproxy
|
|
endif
|
|
|
|
stop-haserver:
|
|
@echo Stopping docker containers for HA topology
|
|
docker compose stop
|
|
|
|
stop-docker: ## Stops the docker containers for local development.
|
|
ifeq ($(MM_NO_DOCKER),true)
|
|
@echo No Docker Enabled: skipping docker stop
|
|
else
|
|
@echo Stopping docker containers
|
|
|
|
docker compose stop
|
|
endif
|
|
|
|
clean-docker: ## Deletes the docker containers for local development.
|
|
ifeq ($(MM_NO_DOCKER),true)
|
|
@echo No Docker Enabled: skipping docker clean
|
|
else
|
|
@echo Removing docker containers
|
|
|
|
docker compose down -v
|
|
docker compose rm -v
|
|
endif
|
|
|
|
plugin-checker:
|
|
$(GO) run $(GOFLAGS) ./public/plugin/checker
|
|
|
|
prepackaged-plugins: ## Populate the prepackaged-plugins directory.
|
|
@echo Downloading prepackaged plugins: $(PLUGIN_PACKAGES)
|
|
mkdir -p prepackaged_plugins
|
|
@cd prepackaged_plugins && for plugin_package in $(PLUGIN_PACKAGES) ; do \
|
|
curl -f -O -L https://plugins.releases.mattermost.com/release/$$plugin_package.tar.gz; \
|
|
curl -f -O -L https://plugins.releases.mattermost.com/release/$$plugin_package.tar.gz.sig; \
|
|
done
|
|
|
|
prepackaged-binaries: ## Populate the prepackaged-binaries to the bin directory
|
|
ifeq ($(shell test -f bin/mmctl && printf "yes"),yes)
|
|
@echo "MMCTL already exists in bin/mmctl, not compiling."
|
|
else
|
|
$(MAKE) mmctl-build
|
|
endif
|
|
|
|
golangci-lint: ## Run golangci-lint on codebase
|
|
$(GO) install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.57.1
|
|
|
|
@echo Running golangci-lint
|
|
$(GOBIN)/golangci-lint run ./...
|
|
$(GOBIN)/golangci-lint run ./public/...
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
ifneq ($(MM_NO_ENTERPRISE_LINT),true)
|
|
$(GOBIN)/golangci-lint run $(BUILD_ENTERPRISE_DIR)/...
|
|
endif
|
|
endif
|
|
|
|
i18n-extract: ## Extract strings for translation from the source code
|
|
cd ../tools/mmgotool && $(GO) install .
|
|
$(GOBIN)/mmgotool i18n extract --portal-dir=""
|
|
|
|
i18n-check: ## Exit on empty translation strings and translation source strings
|
|
cd ../tools/mmgotool && $(GO) install .
|
|
$(GOBIN)/mmgotool i18n clean-empty --portal-dir="" --check
|
|
$(GOBIN)/mmgotool i18n check-empty-src --portal-dir=""
|
|
|
|
store-mocks: ## Creates mock files.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config channels/store/.mockery.yaml
|
|
|
|
cache-mocks:
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config platform/services/cache/.mockery.yaml
|
|
|
|
telemetry-mocks: ## Creates mock files.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config platform/services/telemetry/.mockery.yaml
|
|
|
|
store-layers: ## Generate layers for the store
|
|
$(GO) generate $(GOFLAGS) ./channels/store
|
|
|
|
new-migration: ## Creates a new migration. Run with make new-migration name=<>
|
|
$(GO) install github.com/mattermost/morph/cmd/morph@1e0640c
|
|
@echo "Generating new migration for mysql"
|
|
$(GOBIN)/morph new script $(name) --driver mysql --dir channels/db/migrations --sequence
|
|
|
|
@echo "Generating new migration for postgres"
|
|
$(GOBIN)/morph new script $(name) --driver postgres --dir channels/db/migrations --sequence
|
|
|
|
filestore-mocks: ## Creates mock files.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config platform/shared/filestore/.mockery.yaml
|
|
|
|
ldap-mocks: ## Creates mock files for ldap.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --dir $(BUILD_ENTERPRISE_DIR)/ldap --all --inpackage --note 'Regenerate this file using `make ldap-mocks`.'
|
|
|
|
plugin-mocks: ## Creates mock files for plugins.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config public/plugin/.mockery.yaml
|
|
|
|
einterfaces-mocks: ## Creates mock files for einterfaces.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config einterfaces/.mockery.yaml
|
|
|
|
searchengine-mocks: ## Creates mock files for searchengines.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config platform/services/searchengine/.mockery.yaml
|
|
|
|
sharedchannel-mocks: ## Creates mock files for shared channels.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config platform/services/sharedchannel/.mockery.yaml
|
|
|
|
misc-mocks: ## Creates mocks for misc interfaces.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config channels/utils/.mockery.yaml
|
|
|
|
email-mocks: ## Creates mocks for misc interfaces.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config channels/app/email/.mockery.yaml
|
|
|
|
platform-mocks: ## Creates mocks for platform interfaces.
|
|
$(GO) install github.com/vektra/mockery/v2/...@v2.42.2
|
|
$(GOBIN)/mockery --config channels/app/platform/.mockery.yaml
|
|
|
|
mmctl-mocks: ## Creates mocks for mmctl
|
|
$(GO) install github.com/golang/mock/mockgen@v1.6.0
|
|
$(GOBIN)/mockgen -destination=cmd/mmctl/mocks/client_mock.go -copyright_file=cmd/mmctl/mocks/copyright.txt -package=mocks github.com/mattermost/mattermost/server/v8/cmd/mmctl/client Client
|
|
|
|
pluginapi: ## Generates api and hooks glue code for plugins
|
|
cd ./public && $(GO) generate $(GOFLAGS) ./plugin
|
|
|
|
mocks: store-mocks telemetry-mocks filestore-mocks ldap-mocks plugin-mocks einterfaces-mocks searchengine-mocks sharedchannel-mocks misc-mocks email-mocks platform-mocks mmctl-mocks mocks-public cache-mocks
|
|
|
|
layers: store-layers pluginapi
|
|
|
|
generated: mocks layers
|
|
|
|
check-prereqs-enterprise: setup-go-work ## Checks prerequisite software status for enterprise.
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
./scripts/prereq-check-enterprise.sh
|
|
endif
|
|
|
|
setup-go-work: export BUILD_ENTERPRISE_READY := $(BUILD_ENTERPRISE_READY)
|
|
setup-go-work: ## Sets up your go.work file
|
|
ifneq ($(IGNORE_GO_WORK_IF_EXISTS),true)
|
|
@echo "Creating a go.work file"
|
|
rm -f go.work
|
|
$(GO) work init
|
|
$(GO) work use .
|
|
$(GO) work use ./public
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
$(GO) work use ../../enterprise
|
|
endif
|
|
endif
|
|
|
|
check-style: plugin-checker vet golangci-lint ## Runs style/lint checks
|
|
|
|
gotestsum:
|
|
$(GO) install gotest.tools/gotestsum@v1.11.0
|
|
|
|
test-compile: gotestsum ## Compile tests.
|
|
@echo COMPILE TESTS
|
|
|
|
for package in $(TE_PACKAGES) $(EE_PACKAGES); do \
|
|
$(GO) test $(GOFLAGS) -c $$package; \
|
|
done
|
|
|
|
modules-tidy: ## Tidy Go modules
|
|
mv enterprise/external_imports.go enterprise/external_imports.go.orig
|
|
-$(GO) mod tidy
|
|
-cd public && $(GO) mod tidy
|
|
mv enterprise/external_imports.go.orig enterprise/external_imports.go
|
|
|
|
test-server-pre: check-prereqs-enterprise start-docker gotestsum ## Runs tests.
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
@echo Running all tests
|
|
else
|
|
@echo Running only TE tests
|
|
endif
|
|
|
|
test-server-race: export GOTESTSUM_FORMAT := $(GOTESTSUM_FORMAT)
|
|
test-server-race: export GOTESTSUM_JUNITFILE := $(GOTESTSUM_JUNITFILE)
|
|
test-server-race: export GOTESTSUM_JSONFILE := $(GOTESTSUM_JSONFILE)
|
|
test-server-race: test-server-pre
|
|
ifeq ($(IS_CI),true)
|
|
GOMAXPROCS=4 $(GOBIN)/gotestsum --rerun-fails=3 --packages="$(TE_PACKAGES) $(EE_PACKAGES)" -- -race $(GOFLAGS) -timeout=90m
|
|
else
|
|
$(GOBIN)/gotestsum --rerun-fails=3 --packages="$(TE_PACKAGES) $(EE_PACKAGES)" -- -race $(GOFLAGS) -timeout=90m
|
|
endif
|
|
ifneq ($(IS_CI),true)
|
|
ifneq ($(MM_NO_DOCKER),true)
|
|
ifneq ($(TEMP_DOCKER_SERVICES),)
|
|
@echo Stopping temporary docker services
|
|
docker compose stop $(TEMP_DOCKER_SERVICES)
|
|
endif
|
|
endif
|
|
endif
|
|
|
|
test-server: export GOTESTSUM_FORMAT := $(GOTESTSUM_FORMAT)
|
|
test-server: export GOTESTSUM_JUNITFILE := $(GOTESTSUM_JUNITFILE)
|
|
test-server: export GOTESTSUM_JSONFILE := $(GOTESTSUM_JSONFILE)
|
|
test-server: test-server-pre
|
|
$(GOBIN)/gotestsum --rerun-fails=3 --packages="$(TE_PACKAGES) $(EE_PACKAGES)" -- $(GOFLAGS) -timeout=90m
|
|
ifneq ($(IS_CI),true)
|
|
ifneq ($(MM_NO_DOCKER),true)
|
|
ifneq ($(TEMP_DOCKER_SERVICES),)
|
|
@echo Stopping temporary docker services
|
|
docker compose stop $(TEMP_DOCKER_SERVICES)
|
|
endif
|
|
endif
|
|
endif
|
|
|
|
test-server-ee: export GOTESTSUM_FORMAT := $(GOTESTSUM_FORMAT)
|
|
test-server-ee: export GOTESTSUM_JUNITFILE := $(GOTESTSUM_JUNITFILE)
|
|
test-server-ee: export GOTESTSUM_JSONFILE := $(GOTESTSUM_JSONFILE)
|
|
test-server-ee: check-prereqs-enterprise start-docker gotestsum ## Runs EE tests.
|
|
@echo Running only EE tests
|
|
$(GOBIN)/gotestsum --packages="$(EE_PACKAGES)" -- $(GOFLAGS) -timeout=20m
|
|
|
|
test-server-quick: export GOTESTSUM_FORMAT := $(GOTESTSUM_FORMAT)
|
|
test-server-quick: export GOTESTSUM_JUNITFILE := $(GOTESTSUM_JUNITFILE)
|
|
test-server-quick: export GOTESTSUM_JSONFILE := $(GOTESTSUM_JSONFILE)
|
|
test-server-quick: check-prereqs-enterprise ## Runs only quick tests.
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
@echo Running all tests
|
|
$(GOBIN)/gotestsum --packages="$(TE_PACKAGES) $(EE_PACKAGES)" -- $(GOFLAGS) -short
|
|
else
|
|
@echo Running only TE tests
|
|
$(GOBIN)/gotestsum --packages="$(TE_PACKAGES)" -- $(GOFLAGS) -short
|
|
endif
|
|
|
|
internal-test-web-client: ## Runs web client tests.
|
|
$(GO) run $(GOFLAGS) $(PLATFORM_FILES) test web_client_tests
|
|
|
|
run-server-for-web-client-tests: ## Tests the server for web client.
|
|
$(GO) run $(GOFLAGS) $(PLATFORM_FILES) test web_client_tests_server
|
|
|
|
test-client: ## Test client app.
|
|
@echo Running client tests
|
|
|
|
cd $(BUILD_WEBAPP_DIR) && $(MAKE) test
|
|
|
|
test: test-server test-client ## Runs all checks and tests below (except race detection and postgres).
|
|
|
|
cover: ## Runs the golang coverage tool. You must run the unit tests first.
|
|
@echo Opening coverage info in browser. If this failed run make test first
|
|
|
|
$(GO) tool cover -html=cover.out
|
|
$(GO) tool cover -html=ecover.out
|
|
|
|
test-data: export MM_SERVICESETTINGS_ENABLELOCALMODE := true
|
|
test-data: run-server inject-test-data stop-server ## start a local instance and add test data to it.
|
|
|
|
inject-test-data: # add test data to the local instance.
|
|
@if ! ./scripts/wait-for-system-start.sh; then \
|
|
make stop-server; \
|
|
fi
|
|
|
|
bin/mmctl config set TeamSettings.MaxUsersPerTeam 100 --local
|
|
bin/mmctl sampledata -u 60 --local
|
|
|
|
@echo You may need to restart the Mattermost server before using the following
|
|
@echo ========================================================================
|
|
@echo Login with a system admin account username=sysadmin password=Sys@dmin-sample1
|
|
@echo Login with a regular account username=user-1 password=SampleUs@r-1
|
|
@echo ========================================================================
|
|
|
|
test-mmctl-unit: export GOTESTSUM_FORMAT := $(GOTESTSUM_FORMAT)
|
|
test-mmctl-unit: export GOTESTSUM_JUNITFILE := $(GOTESTSUM_JUNITFILE)
|
|
test-mmctl-unit: export GOTESTSUM_JSONFILE := $(GOTESTSUM_JSONFILE)
|
|
test-mmctl-unit: gotestsum
|
|
@echo Running mmctl unit tests
|
|
$(GOBIN)/gotestsum --packages="$(MMCTL_PACKAGES)" -- -tags 'unit $(MMCTL_BUILD_TAGS)' $(MMCTL_TESTFLAGS)
|
|
|
|
test-mmctl-e2e: export GOTESTSUM_FORMAT := $(GOTESTSUM_FORMAT)
|
|
test-mmctl-e2e: export GOTESTSUM_JUNITFILE := $(GOTESTSUM_JUNITFILE)
|
|
test-mmctl-e2e: export GOTESTSUM_JSONFILE := $(GOTESTSUM_JSONFILE)
|
|
test-mmctl-e2e: gotestsum start-docker
|
|
@echo Running mmctl e2e tests
|
|
$(GOBIN)/gotestsum --packages="$(MMCTL_PACKAGES)" -- -tags 'e2e $(MMCTL_BUILD_TAGS)' $(MMCTL_TESTFLAGS)
|
|
|
|
test-mmctl: export GOTESTSUM_FORMAT := $(GOTESTSUM_FORMAT)
|
|
test-mmctl: export GOTESTSUM_JUNITFILE := $(GOTESTSUM_JUNITFILE)
|
|
test-mmctl: export GOTESTSUM_JSONFILE := $(GOTESTSUM_JSONFILE)
|
|
test-mmctl: gotestsum start-docker
|
|
@echo Running all mmctl tests
|
|
$(GOBIN)/gotestsum --packages="$(MMCTL_PACKAGES)" -- -tags 'unit e2e $(MMCTL_BUILD_TAGS)' $(MMCTL_TESTFLAGS)
|
|
|
|
test-mmctl-coverage: export GOTESTSUM_FORMAT := $(GOTESTSUM_FORMAT)
|
|
test-mmctl-coverage: export GOTESTSUM_JUNITFILE := $(GOTESTSUM_JUNITFILE)
|
|
test-mmctl-coverage: export GOTESTSUM_JSONFILE := $(GOTESTSUM_JSONFILE)
|
|
test-mmctl-coverage: gotestsum start-docker
|
|
@echo Running all mmctl tests with coverage
|
|
$(GOBIN)/gotestsum --packages="$(MMCTL_PACKAGES)" -- -tags 'unit e2e $(MMCTL_BUILD_TAGS)' -coverprofile=mmctlcover.out $(MMCTL_TESTFLAGS)
|
|
$(GO) tool cover -html=mmctlcover.out
|
|
|
|
validate-go-version: ## Validates the installed version of go against Mattermost's minimum requirement.
|
|
@if [ $(GO_MAJOR_VERSION) -gt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \
|
|
exit 0 ;\
|
|
elif [ $(GO_MAJOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \
|
|
echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\
|
|
exit 1; \
|
|
elif [ $(GO_MINOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MINOR_VERSION) ] ; then \
|
|
echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\
|
|
exit 1; \
|
|
fi
|
|
|
|
build-templates: ## Compile all mjml email templates
|
|
cd $(TEMPLATES_DIR) && $(MAKE) build
|
|
|
|
run-server: setup-go-work prepackaged-binaries validate-go-version start-docker client ## Starts the server.
|
|
@echo Running mattermost for development
|
|
|
|
mkdir -p $(BUILD_WEBAPP_DIR)/channels/dist/files
|
|
$(GO) run $(GOFLAGS) -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' $(PLATFORM_FILES) $(RUN_IN_BACKGROUND)
|
|
|
|
debug-server: start-docker ## Compile and start server using delve.
|
|
mkdir -p $(BUILD_WEBAPP_DIR)/channels/dist/files
|
|
$(DELVE) debug $(PLATFORM_FILES) --build-flags="-ldflags '\
|
|
-X github.com/mattermost/mattermost/server/public/model.BuildNumber=$(BUILD_NUMBER)\
|
|
-X \"github.com/mattermost/mattermost/server/public/model.BuildDate=$(BUILD_DATE)\"\
|
|
-X github.com/mattermost/mattermost/server/public/model.BuildHash=$(BUILD_HASH)\
|
|
-X github.com/mattermost/mattermost/server/public/model.BuildHashEnterprise=$(BUILD_HASH_ENTERPRISE)\
|
|
-X github.com/mattermost/mattermost/server/public/model.BuildEnterpriseReady=$(BUILD_ENTERPRISE_READY)'\
|
|
-tags '$(BUILD_TAGS)'"
|
|
|
|
debug-server-headless: start-docker ## Debug server from within an IDE like VSCode or IntelliJ.
|
|
mkdir -p $(BUILD_WEBAPP_DIR)/channels/dist/files
|
|
$(DELVE) debug --headless --listen=:2345 --api-version=2 --accept-multiclient $(PLATFORM_FILES) --build-flags="-ldflags '\
|
|
-X github.com/mattermost/mattermost/server/public/model.BuildNumber=$(BUILD_NUMBER)\
|
|
-X \"github.com/mattermost/mattermost/server/public/model.BuildDate=$(BUILD_DATE)\"\
|
|
-X github.com/mattermost/mattermost/server/public/model.BuildHash=$(BUILD_HASH)\
|
|
-X github.com/mattermost/mattermost/server/public/model.BuildHashEnterprise=$(BUILD_HASH_ENTERPRISE)\
|
|
-X github.com/mattermost/mattermost/server/public/model.BuildEnterpriseReady=$(BUILD_ENTERPRISE_READY)'\
|
|
-tags '$(BUILD_TAGS)'"
|
|
|
|
run-node: export MM_SERVICESETTINGS_SITEURL=http://localhost:8066
|
|
run-node: export MM_SERVICESETTINGS_LISTENADDRESS=:8066
|
|
run-node: export MM_SERVICESETTINGS_ENABLELOCALMODE=true
|
|
run-node: export MM_SERVICESETTINGS_LOCALMODESOCKETLOCATION=/var/tmp/mattermost_local_node.socket
|
|
run-node: export MM_SQLSETTINGS_DRIVERNAME=postgres
|
|
run-node: export MM_SQLSETTINGS_DATASOURCE=postgres://mmuser:mostest@localhost/mattermost_node_test?sslmode=disable&sslmode=disable&connect_timeout=10&binary_parameters=yes
|
|
|
|
run-node: start-docker ## Runs a shared channel node.
|
|
@echo Running mattermost node
|
|
|
|
$(GO) run $(GOFLAGS) -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' $(PLATFORM_FILES) $(RUN_IN_BACKGROUND)
|
|
|
|
run-cli: start-docker ## Runs CLI.
|
|
@echo Running mattermost for development
|
|
@echo Example should be like 'make ARGS="-version" run-cli'
|
|
|
|
$(GO) run $(GOFLAGS) -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' $(PLATFORM_FILES) ${ARGS}
|
|
|
|
run-client: client ## Runs the webapp.
|
|
@echo Running mattermost client for development
|
|
|
|
cd $(BUILD_WEBAPP_DIR) && $(MAKE) run
|
|
|
|
client: ## Sets up a symlink to the compiled files generated by the web app
|
|
@echo Setting up symlink to client directory
|
|
ln -nfs $(BUILD_WEBAPP_DIR)/channels/dist client
|
|
|
|
run-client-fullmap: client ## Legacy alias to run-client
|
|
@echo Running mattermost client for development
|
|
|
|
cd $(BUILD_WEBAPP_DIR) && $(MAKE) run
|
|
|
|
run: run-server run-client ## Runs the server and webapp.
|
|
|
|
run-fullmap: run-server run-client ## Legacy alias to run
|
|
|
|
stop-server: ## Stops the server.
|
|
@echo Stopping mattermost
|
|
|
|
ifeq ($(BUILDER_GOOS_GOARCH),"windows_amd64")
|
|
wmic process where "Caption='go.exe' and CommandLine like '%go.exe run%'" call terminate
|
|
wmic process where "Caption='mattermost.exe' and CommandLine like '%go-build%'" call terminate
|
|
else
|
|
@for PID in $$(ps -ef | grep "[g]o run" | grep "mattermost" | awk '{ print $$2 }'); do \
|
|
echo stopping go $$PID; \
|
|
kill $$PID; \
|
|
done
|
|
@for PID in $$(ps -ef | grep "[g]o-build" | grep "mattermost" | awk '{ print $$2 }'); do \
|
|
echo stopping mattermost $$PID; \
|
|
kill $$PID; \
|
|
done
|
|
endif
|
|
|
|
stop-client: ## Stops the webapp.
|
|
@echo Stopping mattermost client
|
|
|
|
cd $(BUILD_WEBAPP_DIR) && $(MAKE) stop
|
|
|
|
stop: stop-server stop-client stop-docker ## Stops server, client and the docker compose.
|
|
|
|
restart: restart-server restart-client ## Restarts the server and webapp.
|
|
|
|
restart-server: | stop-server run-server ## Restarts the mattermost server to pick up development change.
|
|
|
|
restart-haserver:
|
|
@echo Restarting mattermost in an HA topology
|
|
|
|
docker compose restart follower2
|
|
docker compose restart follower
|
|
docker compose restart leader
|
|
docker compose restart haproxy
|
|
|
|
restart-client: | stop-client run-client ## Restarts the webapp.
|
|
|
|
run-job-server: ## Runs the background job server.
|
|
@echo Running job server for development
|
|
$(GO) run $(GOFLAGS) -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' $(PLATFORM_FILES) jobserver &
|
|
|
|
config-ldap: ## Configures LDAP.
|
|
@echo Setting up configuration for local LDAP
|
|
|
|
# Check if jq is installed
|
|
@jq --version > /dev/null 2>&1 || (echo "jq is not installed. Please install jq to continue." && exit 1)
|
|
|
|
$(eval TMPDIR := $(shell mktemp -d))
|
|
jq --slurp '.[0] * .[1]' ${CONFIG_FILE_PATH} build/docker/keycloak/ldap.mmsettings.json > ${TMPDIR}/config.json
|
|
cp ${TMPDIR}/config.json ${CONFIG_FILE_PATH}
|
|
rm ${TMPDIR}/config.json
|
|
|
|
config-saml: ## Configures SAML.
|
|
@echo Setting up configuration for local SAML with keycloak, please ensure your keycloak is running on http://localhost:8484
|
|
|
|
# Check if jq is installed
|
|
@jq --version > /dev/null 2>&1 || (echo "jq is not installed. Please install jq to continue." && exit 1)
|
|
|
|
@cp build/docker/keycloak/keycloak.crt ./config/saml-idp.crt
|
|
|
|
$(eval TMPDIR := $(shell mktemp -d))
|
|
jq --slurp '.[0] * .[1]' ${CONFIG_FILE_PATH} build/docker/keycloak/saml.mmsettings.json > ${TMPDIR}/config.json
|
|
cp ${TMPDIR}/config.json ${CONFIG_FILE_PATH}
|
|
rm ${TMPDIR}/config.json
|
|
|
|
config-openid: ## Configures OpenID.
|
|
@echo Setting up configuration for local OpenID with keycloak, please ensure your keycloak is running on http://localhost:8484
|
|
|
|
# Check if jq is installed
|
|
@jq --version > /dev/null 2>&1 || (echo "jq is not installed. Please install jq to continue." && exit 1)
|
|
|
|
$(eval TMPDIR := $(shell mktemp -d))
|
|
jq --slurp '.[0] * .[1]' ${CONFIG_FILE_PATH} build/docker/keycloak/openid.mmsettings.json > ${TMPDIR}/config.json
|
|
cp ${TMPDIR}/config.json ${CONFIG_FILE_PATH}
|
|
rm ${TMPDIR}/config.json
|
|
|
|
@echo Finished setting up configuration for local OpenID with keycloak
|
|
|
|
config-reset: ## Resets the config/config.json file to the default production values.
|
|
@echo Resetting configuration to production default
|
|
rm -f config/config.json
|
|
OUTPUT_CONFIG=$(PWD)/config/config.json $(GO) $(GOFLAGS) run -tags production ./scripts/config_generator
|
|
|
|
diff-config: ## Compares default configuration between two mattermost versions
|
|
@./scripts/diff-config.sh
|
|
|
|
clean: stop-docker ## Clean up everything except persistent server data.
|
|
@echo Cleaning
|
|
|
|
rm -Rf $(DIST_ROOT)
|
|
$(GO) clean $(GOFLAGS) -i ./...
|
|
|
|
cd $(BUILD_WEBAPP_DIR) && $(MAKE) clean
|
|
|
|
find . -type d -name data | xargs rm -rf
|
|
rm -rf logs
|
|
|
|
rm -f mattermost.log
|
|
rm -f mattermost.log.jsonl
|
|
rm -f npm-debug.log
|
|
rm -f .prepare-go
|
|
rm -f cover.out
|
|
rm -f ecover.out
|
|
rm -f *.out
|
|
rm -f *.test
|
|
rm -f channels/imports/imports.go
|
|
rm -f cmd/mattermost/cprofile*.out
|
|
|
|
nuke: clean clean-docker ## Clean plus removes persistent server data.
|
|
@echo BOOM
|
|
|
|
rm -rf data
|
|
rm -f go.work go.work.sum
|
|
|
|
setup-mac: ## Adds macOS hosts entries for Docker.
|
|
echo $$(boot2docker ip 2> /dev/null) dockerhost | sudo tee -a /etc/hosts
|
|
|
|
update-dependencies: ## Uses go get -u to update all the dependencies while holding back any that require it.
|
|
@echo Updating Dependencies
|
|
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
@echo Enterprise repository detected, temporarily removing external_imports.go
|
|
mv enterprise/external_imports.go enterprise/external_imports.go.orig
|
|
endif
|
|
|
|
# Update all dependencies (does not update across major versions)
|
|
$(GO) get -u ./...
|
|
|
|
# Tidy up
|
|
$(GO) mod tidy
|
|
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
mv enterprise/external_imports.go.orig enterprise/external_imports.go
|
|
endif
|
|
|
|
vet: ## Run mattermost go vet specific checks
|
|
## Note that it is pinned to a specific commit, rather than a branch. This is to prevent
|
|
## having to backport the fix to multiple release branches for any new change.
|
|
$(GO) install github.com/mattermost/mattermost-govet/v2@72e7752bcf59b57688fcb41173a6a1583c405adf
|
|
$(GO) vet -vettool=$(GOBIN)/mattermost-govet -structuredLogging -inconsistentReceiverName -emptyStrCmp -tFatal -configtelemetry -errorAssertions -license -inconsistentReceiverName.ignore=session_serial_gen.go,team_member_serial_gen.go,user_serial_gen.go,utils_serial_gen.go ./...
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
ifneq ($(MM_NO_ENTERPRISE_LINT),true)
|
|
$(GO) vet -vettool=$(GOBIN)/mattermost-govet -structuredLogging -inconsistentReceiverName -emptyStrCmp -tFatal -configtelemetry -errorAssertions -enterpriseLicense $(BUILD_ENTERPRISE_DIR)/...
|
|
endif
|
|
endif
|
|
|
|
vet-api: export GO := $(GO)
|
|
vet-api: export GOBIN := $(GOBIN)
|
|
vet-api: export ROOT := $(ROOT)
|
|
vet-api: ## Run mattermost go vet to verify api4 documentation, currently not passing
|
|
$(GO) install github.com/mattermost/mattermost-govet/v2@72e7752bcf59b57688fcb41173a6a1583c405adf
|
|
make -C ../api build
|
|
./scripts/vet-api-check.sh
|
|
|
|
gen-serialized: export LICENSE_HEADER:=$(LICENSE_HEADER)
|
|
gen-serialized: ## Generates serialization methods for hot structs
|
|
# This tool only works at a file level, not at a package level.
|
|
# There will be some warnings about "unresolved identifiers",
|
|
# but that is because of the above problem. Since we are generating
|
|
# methods for all the relevant files at a package level, all
|
|
# identifiers will be resolved. An alternative to remove the warnings
|
|
# would be to temporarily move all the structs to the same file,
|
|
# but that involves a lot of manual work.
|
|
$(GO) install github.com/tinylib/msgp@v1.1.6
|
|
$(GOBIN)/msgp -file=./public/model/utils.go -tests=false -o=./public/model/utils_serial_gen.go
|
|
@echo "$$LICENSE_HEADER" > tmp.go
|
|
@cat ./public/model/utils_serial_gen.go >> tmp.go
|
|
@mv tmp.go ./public/model/utils_serial_gen.go
|
|
$(GOBIN)/msgp -file=./public/model/session.go -tests=false -o=./public/model/session_serial_gen.go
|
|
@echo "$$LICENSE_HEADER" > tmp.go
|
|
@cat ./public/model/session_serial_gen.go >> tmp.go
|
|
@mv tmp.go ./public/model/session_serial_gen.go
|
|
$(GOBIN)/msgp -file=./public/model/user.go -tests=false -o=./public/model/user_serial_gen.go
|
|
@echo "$$LICENSE_HEADER" > tmp.go
|
|
@cat ./public/model/user_serial_gen.go >> tmp.go
|
|
@mv tmp.go ./public/model/user_serial_gen.go
|
|
$(GOBIN)/msgp -file=./public/model/team_member.go -tests=false -o=./public/model/team_member_serial_gen.go
|
|
@echo "$$LICENSE_HEADER" > tmp.go
|
|
@cat ./public/model/team_member_serial_gen.go >> tmp.go
|
|
@mv tmp.go ./public/model/team_member_serial_gen.go
|
|
|
|
todo: ## Display TODO and FIXME items in the source code.
|
|
@! ag --ignore Makefile --ignore-dir runtime '(TODO|XXX|FIXME|"FIX ME")[: ]+'
|
|
ifeq ($(BUILD_ENTERPRISE_READY),true)
|
|
@! ag --ignore Makefile --ignore-dir runtime '(TODO|XXX|FIXME|"FIX ME")[: ]+' $(BUILD_ENTERPRISE_DIR)/
|
|
endif
|
|
|
|
mmctl-build: ## Compiles and generates the mmctl binary
|
|
go build -trimpath -ldflags '$(MMCTL_LDFLAGS)' -o bin/mmctl ./cmd/mmctl
|
|
|
|
mmctl-docs: ## Generate the mmctl docs
|
|
rm -rf ./cmd/mmctl/docs
|
|
cd ./cmd/mmctl && go run mmctl.go docs
|
|
|
|
## Help documentation à la https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
|
|
help:
|
|
@grep -E '^[0-9a-zA-Z_-]+:.*?## .*$$' ./Makefile | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
|
@echo
|
|
@echo You can modify the default settings for this Makefile creating a file config.mk based on the default-config.mk
|
|
@echo
|
|
|
|
migrations-extract:
|
|
@echo Listing migration files
|
|
@echo "# Autogenerated file to synchronize migrations sequence in the PR workflow, please do not edit." > channels/db/migrations/migrations.list
|
|
find channels/db/migrations -maxdepth 2 -mindepth 2 | sort >> channels/db/migrations/migrations.list
|
|
|
|
test-migration:
|
|
$(GO) install github.com/mattermost/morph/cmd/morph@latest
|
|
# apply postgres migrations to the new db
|
|
bin/morph apply up --driver postgres --dsn "${POSTGRES_DSN}" --path ${POSTGRES_MIGRATIONS_PATH} --number -1
|
|
|
|
# create temporary file for the config
|
|
@cp tests/template.load tests/temp.load
|
|
|
|
# set required values for the pgloader config, these values are read from /build/dotenv/migration.env in the CI
|
|
# do for psql credentials
|
|
@sed -i'' -e 's|{{ .pg_user }}|${PG_USERNAME}|g' tests/temp.load
|
|
@sed -i'' -e 's|{{ .pg_password }}|${PG_PASSWORD}|g' tests/temp.load
|
|
@sed -i'' -e 's|{{ .target_schema }}|${PG_SCHEMA}|g' tests/temp.load
|
|
|
|
# do for mysql credentials
|
|
@sed -i'' -e 's|{{ .mysql_user }}|${MYSQL_USERNAME}|g' tests/temp.load
|
|
@sed -i'' -e 's|{{ .mysql_password }}|${MYSQL_PASSWORD}|g' tests/temp.load
|
|
@sed -i'' -e 's|{{ .source_schema }}|${MYSQL_SCHEMA}|g' tests/temp.load
|
|
|
|
# run pgloader and save the logs
|
|
pgloader --debug tests/temp.load > migration.log
|
|
|
|
$(GO) install github.com/mattermost/dbcmp/cmd/dbcmp@latest
|
|
# compare two database contents
|
|
# db_migrations differ due to a typo in the 92. migration name
|
|
# for now we exclude plugins such as playbooks and focalboard
|
|
# we also exlude systems table temporarily due to adding some keys while running the initial migration
|
|
bin/dbcmp --source "${MYSQL_DSN}" --target "${POSTGRES_DSN}" --exclude="db_migrations","ir_","focalboard","systems"
|