2022-10-21 20:56:26 +02:00
|
|
|
.PHONY: all clean build swagger test lint run fmt docker-build help
|
|
|
|
.DEFAULT_GOAL:=help
|
2021-09-09 22:57:05 +02:00
|
|
|
|
2022-10-21 20:56:26 +02:00
|
|
|
VERSION?=$(shell git describe --always --tags)
|
|
|
|
BUILD_TIME?=$(shell date '+%Y%m%d-%H%M%S')
|
2022-09-08 22:34:08 +02:00
|
|
|
DOCKER_IMAGE_NAME=spx01/blocky
|
2022-10-21 20:56:26 +02:00
|
|
|
|
|
|
|
BINARY_NAME:=blocky
|
|
|
|
BIN_OUT_DIR?=bin
|
|
|
|
|
2022-10-21 23:59:35 +02:00
|
|
|
GOARCH?=$(shell go env GOARCH)
|
|
|
|
GOARM?=$(shell go env GOARM)
|
2022-10-21 20:56:26 +02:00
|
|
|
|
2022-10-21 23:59:35 +02:00
|
|
|
GO_BUILD_FLAGS?=-v
|
2022-10-21 20:56:26 +02:00
|
|
|
GO_BUILD_LD_FLAGS:=\
|
|
|
|
-w \
|
|
|
|
-s \
|
|
|
|
-X github.com/0xERR0R/blocky/util.Version=${VERSION} \
|
|
|
|
-X github.com/0xERR0R/blocky/util.BuildTime=${BUILD_TIME} \
|
2022-10-21 21:13:54 +02:00
|
|
|
-X github.com/0xERR0R/blocky/util.Architecture=${GOARCH}${GOARM}
|
2022-10-21 20:56:26 +02:00
|
|
|
|
|
|
|
GO_BUILD_OUTPUT:=$(BIN_OUT_DIR)/$(BINARY_NAME)$(BINARY_SUFFIX)
|
2020-01-12 18:23:35 +01:00
|
|
|
|
2021-09-09 22:57:05 +02:00
|
|
|
export PATH=$(shell go env GOPATH)/bin:$(shell echo $$PATH)
|
|
|
|
|
2021-11-10 21:44:52 +01:00
|
|
|
all: build test lint ## Build binary (with tests)
|
2020-01-12 18:23:35 +01:00
|
|
|
|
|
|
|
clean: ## cleans output directory
|
2022-10-21 20:56:26 +02:00
|
|
|
rm -rf $(BIN_OUT_DIR)/*
|
2020-01-12 18:23:35 +01:00
|
|
|
|
2021-03-05 08:02:00 +01:00
|
|
|
swagger: ## creates swagger documentation as html file
|
2021-01-08 21:56:06 +01:00
|
|
|
npm install bootprint bootprint-openapi html-inline
|
2022-08-03 22:10:07 +02:00
|
|
|
go run github.com/swaggo/swag/cmd/swag init -g api/api.go
|
2021-01-08 21:56:06 +01:00
|
|
|
$(shell) node_modules/bootprint/bin/bootprint.js openapi docs/swagger.json /tmp/swagger/
|
|
|
|
$(shell) node_modules/html-inline/bin/cmd.js /tmp/swagger/index.html > docs/swagger.html
|
|
|
|
|
2021-03-05 08:02:00 +01:00
|
|
|
serve_docs: ## serves online docs
|
2022-11-18 15:29:33 +01:00
|
|
|
pip install mkdocs-material
|
2021-03-05 08:02:00 +01:00
|
|
|
mkdocs serve
|
|
|
|
|
2021-01-08 21:56:06 +01:00
|
|
|
build: ## Build binary
|
2022-10-21 20:56:26 +02:00
|
|
|
ifdef GO_SKIP_GENERATE
|
|
|
|
$(info skipping go generate)
|
|
|
|
else
|
2021-09-09 22:57:05 +02:00
|
|
|
go generate ./...
|
2022-10-21 20:56:26 +02:00
|
|
|
endif
|
|
|
|
go build $(GO_BUILD_FLAGS) -ldflags="$(GO_BUILD_LD_FLAGS)" -o $(GO_BUILD_OUTPUT)
|
|
|
|
ifdef BIN_USER
|
2022-10-21 21:07:40 +02:00
|
|
|
$(info setting owner of $(GO_BUILD_OUTPUT) to $(BIN_USER))
|
|
|
|
chown $(BIN_USER) $(GO_BUILD_OUTPUT)
|
2022-10-21 20:56:26 +02:00
|
|
|
endif
|
|
|
|
ifdef BIN_AUTOCAB
|
|
|
|
$(info setting cap_net_bind_service to $(GO_BUILD_OUTPUT))
|
|
|
|
setcap 'cap_net_bind_service=+ep' $(GO_BUILD_OUTPUT)
|
|
|
|
endif
|
2022-09-08 22:34:08 +02:00
|
|
|
|
2020-01-12 18:23:35 +01:00
|
|
|
test: ## run tests
|
2022-08-03 22:10:07 +02:00
|
|
|
go run github.com/onsi/ginkgo/v2/ginkgo -v --coverprofile=coverage.txt --covermode=atomic -cover ./...
|
2020-01-12 18:23:35 +01:00
|
|
|
|
2022-05-06 22:34:08 +02:00
|
|
|
race: ## run tests with race detector
|
2022-08-03 22:10:07 +02:00
|
|
|
go run github.com/onsi/ginkgo/v2/ginkgo --race ./...
|
2022-05-06 22:34:08 +02:00
|
|
|
|
2022-08-03 22:10:07 +02:00
|
|
|
lint: ## run golangcli-lint checks
|
2022-11-05 22:27:52 +01:00
|
|
|
go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.50.1
|
|
|
|
golangci-lint run --timeout 5m
|
2020-01-12 18:23:35 +01:00
|
|
|
|
|
|
|
run: build ## Build and run binary
|
|
|
|
./$(BIN_OUT_DIR)/$(BINARY_NAME)
|
|
|
|
|
2021-08-25 22:12:12 +02:00
|
|
|
fmt: ## gofmt and goimports all go files
|
|
|
|
find . -name '*.go' | while read -r file; do gofmt -w -s "$$file"; goimports -w "$$file"; done
|
|
|
|
|
2022-09-17 13:28:33 +02:00
|
|
|
docker-build: ## Build docker image
|
2022-09-20 18:57:02 +02:00
|
|
|
go generate ./...
|
2022-10-22 00:26:20 +02:00
|
|
|
docker buildx build \
|
2022-10-22 00:31:52 +02:00
|
|
|
--build-arg VERSION=${VERSION} \
|
|
|
|
--build-arg BUILD_TIME=${BUILD_TIME} \
|
|
|
|
--network=host \
|
|
|
|
-o type=docker \
|
|
|
|
-t ${DOCKER_IMAGE_NAME} \
|
|
|
|
.
|
2020-02-13 17:18:24 +01:00
|
|
|
|
2020-01-12 18:23:35 +01:00
|
|
|
help: ## Shows help
|
2020-02-12 21:38:08 +01:00
|
|
|
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|