#!/usr/bin/make -f SHELL = bash REPO ?= $(shell go list -m) VERSION ?= $(shell git describe --tags --dirty --match "v*" --always --abbrev=8 2>/dev/null || cat VERSION 2>/dev/null || echo "develop") HUB_IMAGE ?= truecloudlab/frostfs HUB_TAG ?= "$(shell echo ${VERSION} | sed 's/^v//')" GO_VERSION ?= 1.21 LINT_VERSION ?= 1.53.3 BIN = bin RELEASE = release DIRS = $(BIN) $(RELEASE) # List of binaries to build. CMDS = $(notdir $(basename $(wildcard cmd/frostfs-*))) BINS = $(addprefix $(BIN)/, $(CMDS)) # .deb package versioning OS_RELEASE = $(shell lsb_release -cs) PKG_VERSION ?= $(shell echo $(VERSION) | sed "s/^v//" | \ sed -E "s/(.*)-(g[a-fA-F0-9]{6,8})(.*)/\1\3~\2/" | \ sed "s/-/~/")-${OS_RELEASE} OUTPUT_LINT_DIR ?= $(shell pwd)/bin TMP_DIR := .cache .PHONY: help all images dep clean fmts fmt imports test lint docker/lint prepare-release debpackage pre-commit unpre-commit # To build a specific binary, use it's name prefix with bin/ as a target # For example `make bin/frostfs-node` will build only storage node binary # Just `make` will build all possible binaries all: $(DIRS) $(BINS) # help target include help.mk $(BINS): $(DIRS) dep @echo "⇒ Build $@" CGO_ENABLED=0 \ go build -v -trimpath \ -ldflags "-X $(REPO)/misc.Version=$(VERSION)" \ -o $@ ./cmd/$(notdir $@) $(DIRS): @echo "⇒ Ensure dir: $@" @mkdir -p $@ # Prepare binaries and archives for release .ONESHELL: prepare-release: docker/all @for file in `ls -1 $(BIN)/frostfs-*`; do cp $$file $(RELEASE)/`basename $$file`-$(ARCH) strip $(RELEASE)/`basename $$file`-$(ARCH) tar -czf $(RELEASE)/`basename $$file`-$(ARCH).tar.gz $(RELEASE)/`basename $$file`-$(ARCH) done # Pull go dependencies dep: @printf "⇒ Download requirements: " CGO_ENABLED=0 \ go mod download && echo OK @printf "⇒ Tidy requirements : " CGO_ENABLED=0 \ go mod tidy -v && echo OK # Regenerate proto files: protoc: @GOPRIVATE=github.com/TrueCloudLab go mod vendor # Install specific version for protobuf lib @go list -f '{{.Path}}/...@{{.Version}}' -m github.com/golang/protobuf | xargs go install -v @GOBIN=$(abspath $(BIN)) go install -mod=mod -v git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/util/protogen # Protoc generate @for f in `find . -type f -name '*.proto' -not -path './vendor/*'`; do \ echo "⇒ Processing $$f "; \ protoc \ --proto_path=.:./vendor:/usr/local/include \ --plugin=protoc-gen-go-frostfs=$(BIN)/protogen \ --go-frostfs_out=. --go-frostfs_opt=paths=source_relative \ --go_out=. --go_opt=paths=source_relative \ --go-grpc_opt=require_unimplemented_servers=false \ --go-grpc_out=. --go-grpc_opt=paths=source_relative $$f; \ done rm -rf vendor # Build FrostFS component's docker image image-%: @echo "⇒ Build FrostFS $* docker image " @docker build \ --build-arg REPO=$(REPO) \ --build-arg VERSION=$(VERSION) \ --rm \ -f .docker/Dockerfile.$* \ -t $(HUB_IMAGE)-$*:$(HUB_TAG) . # Build all Docker images images: image-storage image-ir image-cli image-adm # Build dirty local Docker images dirty-images: image-dirty-storage image-dirty-ir image-dirty-cli image-dirty-adm # Run `make %` in Golang container docker/%: docker run --rm -t \ -v `pwd`:/src \ -w /src \ -u "$$(id -u):$$(id -g)" \ --env HOME=/src \ golang:$(GO_VERSION) make $* # Run all code formatters fmts: fmt imports # Reformat code fmt: @echo "⇒ Processing gofmt check" @gofmt -s -w cmd/ pkg/ misc/ # Reformat imports imports: @echo "⇒ Processing goimports check" @goimports -w cmd/ pkg/ misc/ # Run Unit Test with go test test: @echo "⇒ Running go test" @go test ./... -count=1 pre-commit-run: @pre-commit run -a --hook-stage manual # Install linters lint-install: @mkdir -p $(TMP_DIR) @rm -rf $(TMP_DIR)/linters @git clone --depth 1 https://git.frostfs.info/TrueCloudLab/linters.git $(TMP_DIR)/linters @make -C $(TMP_DIR)/linters lib CGO_ENABLED=1 OUT_DIR=$(OUTPUT_LINT_DIR) @rm -rf $(TMP_DIR)/linters @rmdir $(TMP_DIR) 2>/dev/null || true @GOBIN=$(OUTPUT_LINT_DIR) go install github.com/golangci/golangci-lint/cmd/golangci-lint@v$(LINT_VERSION) # Run linters lint: NOLITERAL_TARGET_METHODS="reportFlushError,reportError" \ NOLITERAL_DISABLE_PACKAGES="codes,err,res,exec" \ NOLITERAL_CONSTANTS_PACKAGE="git.frostfs.info/TrueCloudLab/frostfs-node/internal/logs" \ $(OUTPUT_LINT_DIR)/golangci-lint --timeout=10m run # Install staticcheck staticcheck-install: @go install honnef.co/go/tools/cmd/staticcheck@latest # Run staticcheck staticcheck-run: @staticcheck ./... # Run linters in Docker docker/lint: docker run --rm -t \ -v `pwd`:/src \ -u `stat -c "%u:%g" .` \ --env HOME=/src \ golangci/golangci-lint:v$(LINT_VERSION) bash -c 'cd /src/ && make lint' # Activate pre-commit hooks pre-commit: pre-commit install -t pre-commit -t commit-msg # Deactivate pre-commit hooks unpre-commit: pre-commit uninstall -t pre-commit -t commit-msg # Print version version: @echo $(VERSION) # Delete built artifacts clean: rm -rf vendor rm -rf .cache rm -rf $(BIN) rm -rf $(RELEASE) # Package for Debian debpackage: dch -b --package frostfs-node \ --controlmaint \ --newversion $(PKG_VERSION) \ --distribution $(OS_RELEASE) \ "Please see CHANGELOG.md for code changes for $(VERSION)" dpkg-buildpackage --no-sign -b debclean: dh clean