mirror of
https://github.com/laravel-ls/uri
synced 2026-06-16 01:54:57 +02:00
219 lines
7.8 KiB
Makefile
219 lines
7.8 KiB
Makefile
# ----------------------------------------------------------------------------
|
|
# global
|
|
|
|
SHELL = /usr/bin/env bash
|
|
|
|
ifneq ($(shell command -v go),)
|
|
GO_PATH ?= $(shell go env GOPATH)
|
|
GO_OS ?= $(shell go env GOOS)
|
|
GO_ARCH ?= $(shell go env GOARCH)
|
|
|
|
PKG := $(subst $(GO_PATH)/src/,,$(CURDIR))
|
|
GO_PKGS := $(shell go list ./... | grep -v -e '.pb.go')
|
|
GO_APP_PKGS := $(shell go list -f '{{if and (or .GoFiles .CgoFiles) (ne .Name "main")}}{{.ImportPath}}{{end}}' ${PKG}/...)
|
|
GO_TEST_PKGS := $(shell go list -f='{{if or .TestGoFiles .XTestGoFiles}}{{.ImportPath}}{{end}}' ./...)
|
|
GO_VENDOR_PKGS := $(shell go list -f '{{if and (or .GoFiles .CgoFiles) (ne .Name "main")}}./vendor/{{.ImportPath}}{{end}}' -mod=vendor ./vendor/...)
|
|
|
|
GO_TEST ?= go test
|
|
ifneq ($(shell command -v gotest),)
|
|
GO_TEST=gotest
|
|
endif
|
|
GO_TEST_FUNC ?= .
|
|
GO_TEST_FLAGS ?=
|
|
GO_BENCH_FUNC ?= .
|
|
GO_BENCH_FLAGS ?= -benchmem
|
|
GO_LINT_FLAGS ?=
|
|
|
|
CGO_ENABLED ?= 1
|
|
GO_LDFLAGS=-s -w
|
|
GO_LDFLAGS_STATIC=-s -w '-extldflags=-static'
|
|
|
|
ifneq ($(wildcard go.mod),) # exist go.mod
|
|
ifeq ($(GO111MODULE),off)
|
|
GO_FLAGS=-mod=vendor
|
|
endif
|
|
endif
|
|
|
|
GO_BUILDTAGS=osusergo
|
|
GO_BUILDTAGS_STATIC=static static_build
|
|
GO_FLAGS ?= -tags='$(GO_BUILDTAGS)' -ldflags="${GO_LDFLAGS}"
|
|
GO_INSTALLSUFFIX_STATIC=netgo
|
|
endif
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# defines
|
|
|
|
GOPHER = ""
|
|
define target
|
|
@printf "$(GOPHER) \\x1b[1;32m$(patsubst ,$@,$(1))\\x1b[0m\\n"
|
|
endef
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# targets
|
|
|
|
## build and install
|
|
|
|
.PHONY: pkg/install
|
|
pkg/install:
|
|
$(call target)
|
|
GO111MODULE=on CGO_ENABLED=$(CGO_ENABLED) GOOS=$(GO_OS) GOARCH=$(GO_ARCH) go install -v ${GO_APP_PKGS}
|
|
|
|
## test, bench and coverage
|
|
|
|
.PHONY: test
|
|
test: GO_LDFLAGS=${GO_LDFLAGS_STATIC}
|
|
test: GO_BUILDTAGS+=${GO_BUILDTAGS_STATIC}
|
|
test: GO_FLAGS+=-installsuffix ${GO_INSTALLSUFFIX_STATIC}
|
|
test: ## Runs package test including race condition.
|
|
$(call target)
|
|
@GO111MODULE=on $(GO_TEST) -v -race $(strip $(GO_FLAGS)) -run=$(GO_TEST_FUNC) $(GO_TEST_PKGS)
|
|
|
|
.PHONY: bench
|
|
bench: GO_LDFLAGS=${GO_LDFLAGS_STATIC}
|
|
bench: GO_BUILDTAGS+=${GO_BUILDTAGS_STATIC}
|
|
bench: GO_FLAGS+=-installsuffix ${GO_INSTALLSUFFIX_STATIC}
|
|
bench: ## Take a package benchmark.
|
|
$(call target)
|
|
@GO111MODULE=on $(GO_TEST) -v $(strip $(GO_FLAGS)) -run='^$$' -bench=$(GO_BENCH_FUNC) -benchmem $(GO_TEST_PKGS)
|
|
|
|
.PHONY: bench/race
|
|
bench/race: ## Takes packages benchmarks with the race condition.
|
|
$(call target)
|
|
@GO111MODULE=on $(GO_TEST) -v -race $(strip $(GO_FLAGS)) -run='^$$' -bench=$(GO_BENCH_FUNC) -benchmem $(GO_TEST_PKGS)
|
|
|
|
.PHONY: bench/trace
|
|
bench/trace: ## Take a package benchmark with take a trace profiling.
|
|
$(GO_TEST) -v -c -o bench-trace.test $(PKG)/stackdriver
|
|
GO111MODULE=on GODEBUG=allocfreetrace=1 ./bench-trace.test -test.run=none -test.bench=$(GO_BENCH_FUNC) -test.benchmem -test.benchtime=10ms 2> trace.log
|
|
|
|
.PHONY: coverage
|
|
coverage: ## Takes packages test coverage.
|
|
$(call target)
|
|
GO111MODULE=on $(GO_TEST) -v -race $(strip $(GO_FLAGS)) -covermode=atomic -coverpkg=$(PKG)/... -coverprofile=coverage.out $(GO_PKGS)
|
|
|
|
$(GO_PATH)/bin/go-junit-report:
|
|
@GO111MODULE=off go get -u github.com/jstemmer/go-junit-report
|
|
|
|
.PHONY: cmd/go-junit-report
|
|
cmd/go-junit-report: $(GO_PATH)/bin/go-junit-report # go get 'go-junit-report' binary
|
|
|
|
.PHONY: coverage/ci
|
|
coverage/ci: GO_LDFLAGS=${GO_LDFLAGS_STATIC}
|
|
coverage/ci: GO_BUILDTAGS+=${GO_BUILDTAGS_STATIC}
|
|
coverage/ci: GO_FLAGS+=-installsuffix ${GO_INSTALLSUFFIX_STATIC}
|
|
coverage/ci: cmd/go-junit-report
|
|
coverage/ci: ## Takes packages test coverage, and output coverage results to CI artifacts.
|
|
$(call target)
|
|
@mkdir -p /tmp/ci/artifacts /tmp/ci/test-results
|
|
GO111MODULE=on $(GO_TEST) -a -v -race $(strip $(GO_FLAGS)) -covermode=atomic -coverpkg=$(PKG)/... -coverprofile=/tmp/ci/artifacts/coverage.out $(GO_PKGS) 2>&1 | tee /dev/stderr | go-junit-report -set-exit-code > /tmp/ci/test-results/junit.xml
|
|
@if [[ -f '/tmp/ci/artifacts/coverage.out' ]]; then go tool cover -html=/tmp/ci/artifacts/coverage.out -o /tmp/ci/artifacts/coverage.html; fi
|
|
|
|
|
|
## lint
|
|
|
|
.PHONY: lint
|
|
lint: lint/golangci-lint ## Run all linters.
|
|
|
|
$(GO_PATH)/bin/golangci-lint:
|
|
@GO111MODULE=off go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
|
|
|
|
.PHONY: cmd/golangci-lint
|
|
cmd/golangci-lint: $(GO_PATH)/bin/golangci-lint # go get 'golangci-lint' binary
|
|
|
|
.PHONY: lint/golangci-lint
|
|
lint/golangci-lint: cmd/golangci-lint .golangci.yml ## Run golangci-lint.
|
|
$(call target)
|
|
@GO111MODULE=on golangci-lint run $(strip ${GO_LINT_FLAGS}) ./...
|
|
|
|
|
|
## mod
|
|
|
|
.PHONY: mod/init
|
|
mod/init: ## Initializes and writes a new `go.mod` to the current directory.
|
|
$(call target)
|
|
@GO111MODULE=on go mod init > /dev/null 2>&1 || true
|
|
|
|
.PHONY: mod/get
|
|
mod/get: ## Updates all module packages and go.mod.
|
|
$(call target)
|
|
@GO111MODULE=on go get -u -m -v -x ./...
|
|
|
|
.PHONY: mod/tidy
|
|
mod/tidy: ## Makes sure go.mod matches the source code in the module.
|
|
$(call target)
|
|
@GO111MODULE=on go mod tidy -v
|
|
|
|
.PHONY: mod/vendor
|
|
mod/vendor: mod/tidy ## Resets the module's vendor directory and fetch all modules packages.
|
|
$(call target)
|
|
@GO111MODULE=on go mod vendor -v
|
|
|
|
.PHONY: mod/graph
|
|
mod/graph: ## Prints the module requirement graph with replacements applied.
|
|
$(call target)
|
|
@GO111MODULE=on go mod graph
|
|
|
|
.PHONY: mod/clean
|
|
mod/clean: ## Cleanups go.sum and vendor/modules.txt files.
|
|
$(call target)
|
|
@$(RM) -r go.sum $(shell find vendor -maxdepth 1 -path "vendor/*" -type d)
|
|
|
|
.PHONY: mod/install
|
|
mod/install: mod/tidy mod/vendor
|
|
mod/install: ## Install the module vendor package as an object file.
|
|
$(call target)
|
|
@GO111MODULE=off go install -v $(strip $(GO_FLAGS)) $(GO_VENDOR_PKGS) || GO111MODULE=on go install -mod=vendor -v $(strip $(GO_FLAGS)) $(GO_VENDOR_PKGS)
|
|
|
|
.PHONY: mod/install/static
|
|
mod/install/static: GO_LDFLAGS=${GO_LDFLAGS_STATIC}
|
|
mod/install/static: GO_BUILDTAGS+=${GO_BUILDTAGS_STATIC}
|
|
mod/install/static: GO_FLAGS+=-installsuffix ${GO_INSTALLSUFFIX_STATIC}
|
|
mod/install/static: mod/install
|
|
mod/install/static: ## Install the module vendor package as an object file with static build.
|
|
|
|
|
|
.PHONY: mod/update
|
|
mod/update: mod/goget mod/tidy mod/vendor mod/install ## Updates all of vendor packages.
|
|
@GO111MODULE=on go mod edit -go 1.12
|
|
|
|
.PHONY: mod
|
|
mod: mod/init mod/tidy mod/vendor mod/install
|
|
mod: ## Updates the vendoring directory using go mod.
|
|
@GO111MODULE=on go mod edit -go 1.12
|
|
|
|
|
|
## clean
|
|
|
|
.PHONY: clean
|
|
clean: ## Cleanups binaries and extra files in the package.
|
|
$(call target)
|
|
@$(RM) $(APP) *.out *.test *.prof trace.log
|
|
|
|
|
|
## boilerplate
|
|
|
|
.PHONY: boilerplate/go/%
|
|
boilerplate/go/%: BOILERPLATE_PKG_DIR=$(shell printf $@ | cut -d'/' -f3- | rev | cut -d'/' -f2- | rev)
|
|
boilerplate/go/%: BOILERPLATE_PKG_NAME=$(if $(findstring main,$@),main,$(shell printf $@ | rev | cut -d/ -f2 | rev))
|
|
boilerplate/go/%: hack/boilerplate/boilerplate.go.txt
|
|
boilerplate/go/%: ## Creates a go file based on boilerplate.go.txt in % location.
|
|
@if [[ ! ${BOILERPLATE_PKG_DIR} == *'.go'* ]] && [ ! -d ${BOILERPLATE_PKG_DIR} ]; then mkdir -p ${BOILERPLATE_PKG_DIR}; fi
|
|
@cat hack/boilerplate/boilerplate.go.txt <(printf "package ${BOILERPLATE_PKG_NAME}\\n") > $*
|
|
@sed -i "s|YEAR|$(shell date '+%Y')|g" $*
|
|
|
|
|
|
## miscellaneous
|
|
|
|
.PHONY: AUTHORS
|
|
AUTHORS: ## Creates AUTHORS file.
|
|
@$(file >$@,# This file lists all individuals having contributed content to the repository.)
|
|
@$(file >>$@,# For how it is generated, see `make AUTHORS`.)
|
|
@printf "$(shell git log --format="\n%aN <%aE>" | LC_ALL=C.UTF-8 sort -uf)" >> $@
|
|
|
|
.PHONY: todo
|
|
TODO: ## Print the all of (TODO|BUG|XXX|FIXME|NOTE) in packages.
|
|
@rg -e '(TODO|BUG|XXX|FIXME|NOTE)(\(.+\):|:)' --follow --hidden --glob='!.git' --glob='!vendor' --glob='!internal' --glob='!Makefile' --glob='!snippets' --glob='!indent'
|
|
|
|
.PHONY: help
|
|
help: ## Show make target help.
|
|
@perl -nle 'BEGIN {printf "Usage:\n make \033[33m<target>\033[0m\n\nTargets:\n"} printf " \033[36m%-30s\033[0m %s\n", $$1, $$2 if /^([a-zA-Z\/_-].+)+:.*?\s+## (.*)/' ${MAKEFILE_LIST}
|