215 lines
6.5 KiB
Makefile
215 lines
6.5 KiB
Makefile
.PHONY: pack build help qa critic vet codegen provision docs build
|
|
|
|
include Makefile.inc
|
|
|
|
BUILD_FLAVOUR ?= corteza
|
|
BUILD_TIME ?= $(shell date +%FT%T%z)
|
|
BUILD_VERSION ?= $(shell git describe --tags --abbrev=0)
|
|
BUILD_ARCH ?= $(shell go env GOARCH)
|
|
BUILD_OS ?= $(shell go env GOOS)
|
|
BUILD_OS_is_windows = $(filter windows,$(BUILD_OS))
|
|
BUILD_DEST_DIR ?= build
|
|
BUILD_NAME = $(BUILD_FLAVOUR)-server-$(BUILD_VERSION)-$(BUILD_OS)-$(BUILD_ARCH)
|
|
BUILD_BIN_NAME = $(BUILD_NAME)$(if $(BUILD_OS_is_windows),.exe,)
|
|
|
|
RELEASE_BASEDIR = $(BUILD_DEST_DIR)/pkg/$(BUILD_FLAVOUR)-server
|
|
RELEASE_NAME = $(BUILD_NAME).tar.gz
|
|
RELEASE_EXTRA_FILES ?= README.md LICENSE CONTRIBUTING.md DCO .env.example
|
|
RELEASE_PKEY ?= .upload-rsa
|
|
|
|
LDFLAGS_VERSION = -X github.com/cortezaproject/corteza-server/pkg/version.Version=$(BUILD_VERSION)
|
|
LDFLAGS_EXTRA ?=
|
|
LDFLAGS = -ldflags "$(LDFLAGS_VERSION) $(LDFLAGS_EXTRA)"
|
|
|
|
# Run go test cmd with flags, eg:
|
|
# $> make test.integration TEST_FLAGS="-v"
|
|
# $> make test.integration TEST_FLAGS="-v -run SpecialTest"
|
|
TEST_FLAGS ?=
|
|
|
|
COVER_MODE ?= count
|
|
COVER_PROFILE ?= .cover.out
|
|
COVER_FLAGS ?= -covermode=$(COVER_MODE) -coverprofile=$(COVER_PROFILE)
|
|
|
|
# Cover package maps for tests tasks
|
|
COVER_PKGS_messaging = ./messaging/...
|
|
COVER_PKGS_system = ./system/...
|
|
COVER_PKGS_compose = ./compose/...
|
|
COVER_PKGS_pkg = ./pkg/...
|
|
COVER_PKGS_all = $(COVER_PKGS_pkg),$(COVER_PKGS_messaging),$(COVER_PKGS_system),$(COVER_PKGS_compose)
|
|
COVER_PKGS_integration = $(COVER_PKGS_all)
|
|
|
|
TEST_SUITE_pkg = ./pkg/...
|
|
TEST_SUITE_services = ./compose/... ./messaging/... ./system/...
|
|
TEST_SUITE_unit = $(TEST_SUITE_pkg) $(TEST_SUITE_services)
|
|
TEST_SUITE_integration = ./tests/...
|
|
TEST_SUITE_store = ./store/tests/...
|
|
TEST_SUITE_all = $(TEST_SUITE_unit) $(TEST_SUITE_integration) $(TEST_SUITE_store)
|
|
|
|
# Dev Support apps settings
|
|
DEV_MINIO_PORT ?= 9000
|
|
DEV_MAILHOG_SMTP_ADDR ?= 1025
|
|
DEV_MAILHOG_HTTP_ADDR ?= 8025
|
|
|
|
DOCKER ?= docker
|
|
|
|
help:
|
|
@echo ""
|
|
@echo " Usage: make [target]"
|
|
@echo ""
|
|
@echo " - build build all apps"
|
|
@echo " - build.<app> build a specific app"
|
|
@echo " - vet run go vet on all code"
|
|
@echo " - critic run go critic on all code"
|
|
@echo " - test.all run all tests"
|
|
@echo " - test.unit run all unit tests"
|
|
@echo " - test.integration run all integration tests"
|
|
@echo ""
|
|
@echo " See tests/README.md for more info on running tests"
|
|
@echo ""
|
|
|
|
########################################################################################################################
|
|
# Building & packing
|
|
|
|
build: $(BUILD_DEST_DIR)/$(BUILD_BIN_NAME)
|
|
|
|
$(BUILD_DEST_DIR)/$(BUILD_BIN_NAME):
|
|
GOOS=$(BUILD_OS) GOARCH=$(BUILD_ARCH) go build $(LDFLAGS) -o $@ cmd/corteza/main.go
|
|
|
|
release: build $(BUILD_DEST_DIR)/$(RELEASE_NAME)
|
|
|
|
$(BUILD_DEST_DIR)/$(RELEASE_NAME):
|
|
@ mkdir -p $(RELEASE_BASEDIR) $(RELEASE_BASEDIR)/bin
|
|
@ cp $(RELEASE_EXTRA_FILES) $(RELEASE_BASEDIR)/
|
|
@ cp -r provision $(RELEASE_BASEDIR)
|
|
@ rm -f $(RELEASE_BASEDIR)/provision/README.adoc $(RELEASE_BASEDIR)/provision/update.sh
|
|
@ cp $(BUILD_DEST_DIR)/$(BUILD_BIN_NAME) $(RELEASE_BASEDIR)/bin/$(BUILD_FLAVOUR)-server
|
|
tar -C $(dir $(RELEASE_BASEDIR)) -czf $(BUILD_DEST_DIR)/$(RELEASE_NAME) $(notdir $(RELEASE_BASEDIR))
|
|
|
|
release-clean:
|
|
rm -rf $(BUILD_DEST_DIR)/$(BUILD_BIN_NAME)
|
|
rm -rf $(BUILD_DEST_DIR)/$(RELEASE_NAME)
|
|
|
|
upload: $(RELEASE_PKEY)
|
|
@ echo "put $(BUILD_DEST_DIR)/*.tar.gz" | sftp -q -i $(RELEASE_PKEY) $(RELEASE_SFTP_URI)
|
|
@ rm -f $(RELEASE_PKEY)
|
|
|
|
$(RELEASE_PKEY):
|
|
@ echo $(RELEASE_SFTP_KEY) | base64 -d > $@
|
|
@ chmod 0400 $@
|
|
|
|
########################################################################################################################
|
|
# Development
|
|
|
|
watch: $(GIN)
|
|
$(GIN) --laddr localhost --notifications --immediate --build cmd/corteza run -- serve
|
|
|
|
realize: watch # BC
|
|
|
|
mailhog.up:
|
|
$(DOCKER) run --rm --publish $(DEV_MAILHOG_HTTP_ADDR):8025 --publish $(DEV_MAILHOG_SMTP_ADDR):1025 mailhog/mailhog
|
|
|
|
minio.up:
|
|
# Runs temp minio server
|
|
# No volume mounts because we do not want the data to persist
|
|
$(DOCKER) run --rm --publish $(DEV_MINIO_PORT):9000 --env-file .env minio/minio server /data
|
|
|
|
# Development helper - reruns test when files change
|
|
#
|
|
# make watch.test.unit
|
|
# make watch.test.pkg
|
|
# make watch.test.all
|
|
# make watch.test.pkg TEST_FLAGS="-v"
|
|
watch.test.%: $(FSWATCH)
|
|
( make test.$* || exit 0 ) && ( $(FSWATCH) -o . | xargs -n1 -I{} make test.$* )
|
|
|
|
watch.test: watch.test.unit
|
|
|
|
# codegen: $(PROTOGEN)
|
|
codegen: $(CODEGEN)
|
|
@ $(CODEGEN) -v
|
|
|
|
watch.codegen: $(CODEGEN)
|
|
@ $(CODEGEN) -w -v
|
|
|
|
clean.codegen:
|
|
rm -f $(CODEGEN)
|
|
|
|
provision:
|
|
$(MAKE) --directory=provision clean all
|
|
|
|
docs: $(STATIK)
|
|
$(STATIK) -p docs -m -Z -f -src=./docs
|
|
|
|
#######################################################################################################################
|
|
# Quality Assurance
|
|
|
|
# Adds -coverprofile flag to test flags
|
|
# and executes test.cover... task
|
|
test.coverprofile.%:
|
|
@ TEST_FLAGS="$(TEST_FLAGS) -coverprofile=$(COVER_PROFILE)" make test.cover.$*
|
|
|
|
# Adds -coverpkg flag
|
|
test.cover.%:
|
|
@ TEST_FLAGS="$(TEST_FLAGS) -coverpkg=$(COVER_PKGS_$*)" make test.$*
|
|
|
|
# Runs integration tests
|
|
test.integration: $(GOTEST)
|
|
$(GOTEST) $(TEST_FLAGS) $(TEST_SUITE_integration)
|
|
|
|
# Runs one suite from integration tests
|
|
test.integration.%: $(GOTEST)
|
|
$(GOTEST) $(TEST_FLAGS) ./tests/$*/...
|
|
|
|
# Runs ALL tests
|
|
test.all: $(GOTEST)
|
|
$(GOTEST) $(TEST_FLAGS) $(TEST_SUITE_all)
|
|
|
|
# Unit testing testing messaging, system or compose
|
|
test.unit.%: $(GOTEST)
|
|
$(GOTEST) $(TEST_FLAGS) ./$*/...
|
|
|
|
# Runs ALL tests
|
|
test.unit: $(GOTEST)
|
|
$(GOTEST) $(TEST_FLAGS) $(TEST_SUITE_unit)
|
|
|
|
# Testing pkg
|
|
test.pkg: $(GOTEST)
|
|
$(GOTEST) $(TEST_FLAGS) $(TEST_SUITE_pkg)
|
|
|
|
# Test defaults to test.unit
|
|
test: test.unit
|
|
|
|
|
|
vet:
|
|
$(GO) vet ./...
|
|
|
|
critic: $(GOCRITIC)
|
|
$(GOCRITIC) check-project .
|
|
|
|
staticcheck: $(STATICCHECK)
|
|
$(STATICCHECK) ./pkg/... ./system/... ./messaging/... ./compose/...
|
|
|
|
qa: vet critic test
|
|
|
|
mocks: $(MOCKGEN)
|
|
$(MOCKGEN) -package mail -source pkg/mail/mail.go -destination pkg/mail/mail_mock_test.go
|
|
|
|
|
|
########################################################################################################################
|
|
# Toolset
|
|
|
|
# @todo this will most likely need some special care for other platforms
|
|
$(FSWATCH):
|
|
ifeq ($(UNAME_S),Darwin)
|
|
brew install fswatch
|
|
endif
|
|
|
|
# https://grpc.io/docs/protoc-installation/
|
|
# @todo $ apt install -y protobuf-compiler
|
|
$(PROTOC):
|
|
ifeq ($(UNAME_S),Darwin)
|
|
brew install protobuf
|
|
endif
|
|
|
|
#
|