make/go/go.mk

# Managed by makego. DO NOT EDIT.

# Must be set
$(call _assert_var,MAKEGO)
$(call _conditional_include,$(MAKEGO)/base.mk)
$(call _conditional_include,$(MAKEGO)/dep_bandeps.mk)
$(call _conditional_include,$(MAKEGO)/dep_bufstyle.mk)
$(call _conditional_include,$(MAKEGO)/dep_bufprivateusage.mk)
$(call _conditional_include,$(MAKEGO)/dep_godoclint.mk)
$(call _conditional_include,$(MAKEGO)/dep_golangci_lint.mk)
$(call _conditional_include,$(MAKEGO)/dep_govulncheck.mk)
$(call _conditional_include,$(MAKEGO)/dep_yq.mk)
# Must be set
$(call _assert_var,GO_MODULE)
$(call _assert_var,GOLANGCI_LINT)
$(call _assert_var,TMP)
$(call _assert_var,OPEN_CMD)

# Settable
GO_BINS ?=
# Settable
GO_TEST_BINS ?=
# Settable
GO_TEST_WASM_BINS ?=
# Settable
GO_GET_PKGS ?=
# Settable
GO_MOD_VERSION ?= 1.24.0
# Settable
GO_MOD_TOOLCHAIN ?=
# Settable
GO_ALL_REPO_PKGS ?= ./cmd/... ./internal/...
# Settable
SKIP_BUFSTYLE ?=
# Settable
SKIP_GODOCLINT ?=
# Settable
SKIP_GOLANGCI_LINT ?=
# Settable
SKIP_GOVULNCHECK ?=
# Settable
DISALLOW_NOLINT ?=
# Settable
BUFPRIVATEUSAGE_PKGS ?=
# Settable
BANDEPS_CONFIG ?=

# Runtime
GOPKGS ?= $(GO_ALL_REPO_PKGS)
# Runtime
GOLANGCILINTTIMEOUT ?= 3m0s
# Runtime GONOTESTCACHE
# Runtime COVEROPEN

COVER_HTML := $(TMP)/cover.html
COVER_TXT := $(TMP)/cover.txt

ifdef GONOTESTCACHE
GO_TEST_FLAGS := -count=1
else
GO_TEST_FLAGS :=
endif


.DEFAULT_GOAL := shortall

.PHONY: all
all: ## Run make lint and make test.
	@$(MAKE) lint
	@$(MAKE) test

postupgrade:: all

.PHONY: shortall
shortall: ## Run make shortlint and make shorttest.
	@$(MAKE) shortlint
	@$(MAKE) shorttest

.PHONY: ci
ci:
	@$(MAKE) lint
	@$(MAKE) test

.PHONY: postupgradegodeps
postupgradegodeps::

.PHONY: upgradegodeps
upgradegodeps:
	rm -f go.mod go.sum
	go mod init $(GO_MODULE)
	go mod edit -go=$(GO_MOD_VERSION)
ifneq ($(GO_MOD_TOOLCHAIN),)
	go mod edit -toolchain=go$(GO_MOD_TOOLCHAIN)
endif
ifneq ($(GO_GET_PKGS),)
	go get $(GO_GET_PKGS)
endif
	go get -u -t $(GO_ALL_REPO_PKGS) $(GO_GET_PKGS)
	go mod tidy -v
	@$(MAKE) postupgradegodeps

preupgrade:: upgradegodeps

initmakego:: upgradegodeps

.PHONY: godeps
godeps: deps
	go mod download

.PHONY: gofmtmodtidy
gofmtmodtidy: $(GOLANGCI_LINT)
	@echo gofmt -s -w ALL_GO_FILES
	@gofmt -s -w .
	go mod tidy -v
ifeq ($(SKIP_GOLANGCI_LINT),)
	golangci-lint fmt
endif

format:: gofmtmodtidy

ifneq ($(BUFPRIVATEUSAGE_PKGS),)
.PHONY: bufprivateusage
bufprivateusage: $(BUFPRIVATEUSAGE)
	bufprivateusage $(BUFPRIVATEUSAGE_PKGS)

postprepostgenerate:: bufprivateusage
endif

.PHONY: checknolintlint
checknolintlint: $(YQ)
ifneq ($(DISALLOW_NOLINT),)
	@if grep -r --include "*.go" '//nolint'; then \
		echo '//nolint directives found, surface ignores in .golangci.yml instead' >&2; \
		exit 1; \
	fi
else
	bash $(MAKEGO)/scripts/checknolintlint.bash
endif

.PHONY: bufstyle
bufstyle: $(BUFSTYLE)
ifneq ($(SKIP_BUFSTYLE),)
	@echo Skipping bufstyle...
else
	@echo bufstyle GOPKGS
	@bufstyle $(GOPKGS)
endif

.PHONY: godoclint
godoclint: $(GODOCLINT)
ifneq ($(SKIP_GODOCLINT),)
	@echo Skipping godoclint...
else
	@echo godoclint GOPKGS
	@godoclint $(GOPKGS)
endif

.PHONY: golangcilint
golangcilint: $(GOLANGCI_LINT)
ifneq ($(SKIP_GOLANGCI_LINT),)
	@echo Skipping golangci-lint...
else
	golangci-lint fmt --diff
	golangci-lint run --timeout $(GOLANGCILINTTIMEOUT)
endif

.PHONY: govulncheck
govulncheck: $(GOVULNCHECK)
	@echo govulncheck GOPKGS
	@govulncheck $(GOPKGS)

.PHONY: postlint
postlint::

.PHONY: postlonglint
postlonglint::

ifneq ($(BANDEPS_CONFIG),)
.PHONY: bandeps
bandeps: $(BANDEPS)
	bandeps -f $(BANDEPS_CONFIG)

postlonglint:: bandeps
endif

.PHONY: shortlint
shortlint: ## Run all linters but exclude long-running linters.
	@$(MAKE) checknodiffgenerated
	@$(MAKE) checknolintlint bufstyle godoclint golangcilint govulncheck postlint

.PHONY: lint
lint: ## Run all linters.
	@$(MAKE) shortlint
	@$(MAKE) postlonglint

.PHONY: prebuild
prebuild::

.PHONY: build
build: prebuild ## Run go build.
	go build ./...

.PHONY: pretest
pretest::

.PHONY: test
test: pretest installtest installtestwasm ## Run all go tests.
	go test $(GO_TEST_FLAGS) $(GOPKGS)

.PHONY: testrace
testrace: pretest installtest
	go test -race $(GO_TEST_FLAGS) $(GOPKGS)

.PHONY: shorttest
shorttest: pretest installtest ## Run all go tests but exclude long-running tests.
	go test -test.short $(GO_TEST_FLAGS) $(GOPKGS)

.PHONY: deppkgs
deppkgs:
	@go list -f '{{join .Deps "\n"}}' $(GOPKGS) | xargs go list -f '{{if not .Standard}}{{.ImportPath}}{{end}}'

.PHONY: coverpkgs
coverpkgs:
	@go list $(GOPKGS) | grep -v \/gen\/ | tr '\n' ',' | sed "s/,$$//"

.PHONY: cover
cover: pretest installtest
	@mkdir -p $(dir $(COVER_HTML)) $(dir $(COVER_TXT))
	@rm -f $(COVER_HTML) $(COVER_TXT)
	go test -race -coverprofile=$(COVER_TXT) -coverpkg=$(shell GOPKGS=$(GOPKGS) $(MAKE) -s coverpkgs) $(GOPKGS)
	@go tool cover -html=$(COVER_TXT) -o $(COVER_HTML)
	@echo
	@go tool cover -func=$(COVER_TXT) | grep total
	@echo
ifndef COVEROPEN
	@echo $(OPEN_CMD) $(COVER_HTML)
else
	$(OPEN_CMD) $(COVER_HTML)
endif

.PHONY: install
install:: ## Install all go binaries.

define gobinfunc
.PHONY: install$(notdir $(1))
install$(notdir $(1)):
	go install ./$(1)

install:: install$(notdir $(1))

.PHONY: lint$(notdir $(1))
lint$(notdir $(1)):
	bash $(MAKEGO)/scripts/checkcmdpackage.bash ./$(1)

postlint:: lint$(notdir $(1))
endef

$(foreach gobin,$(sort $(GO_BINS)),$(eval $(call gobinfunc,$(gobin))))
$(foreach gobin,$(sort $(GO_BINS)),$(eval FILE_IGNORES := $(FILE_IGNORES) $(gobin)/$(notdir $(gobin))))

.PHONY: installtest
installtest::

define gotestbinfunc
.PHONY: installtest$(notdir $(1))
installtest$(notdir $(1)):
	go install ./$(1)

installtest:: installtest$(notdir $(1))
endef

$(foreach gobin,$(sort $(GO_TEST_BINS)),$(eval $(call gotestbinfunc,$(gobin))))
$(foreach gobin,$(sort $(GO_TEST_BINS)),$(eval FILE_IGNORES := $(FILE_IGNORES) $(gobin)/$(notdir $(gobin))))

.PHONY: installtestwasm
installtestwasm::

define gotestwasmfunc
.PHONY: installtestwasm$(notdir $(1))
installtestwasm$(notdir $(1)):
	GOOS=wasip1 GOARCH=wasm go build -o $(GOBIN)/$(notdir $(1)).wasm ./$(1)

installtestwasm:: installtestwasm$(notdir $(1))
endef

$(foreach gobin,$(sort $(GO_TEST_WASM_BINS)),$(eval $(call gotestwasmfunc,$(gobin))))
$(foreach gobin,$(sort $(GO_TEST_WASM_BINS)),$(eval FILE_IGNORES := $(FILE_IGNORES) $(gobin)/$(notdir $(gobin))))