consul/Makefile

DEPS = $(shell go list -f '{{range .TestImports}}{{.}} {{end}}' ./...)
PACKAGES = $(shell go list ./...)
VETARGS?=-asmdecl -atomic -bool -buildtags -copylocks -methods \
         -nilfunc -printf -rangeloops -shift -structtags -unsafeptr

all: deps format
	@mkdir -p bin/
	@bash --norc -i ./scripts/build.sh

cov:
	gocov test ./... | gocov-html > /tmp/coverage.html
	open /tmp/coverage.html

deps:
	@echo "--> Installing build dependencies"
	@go get -d -v ./... $(DEPS)

updatedeps: deps
	@echo "--> Updating build dependencies"
	@go get -d -f -u ./... $(DEPS)

test: deps
	@./scripts/verify_no_uuid.sh
	@./scripts/test.sh
	@$(MAKE) vet

integ:
	go list ./... | INTEG_TESTS=yes xargs -n1 go test

cover: deps
	./scripts/verify_no_uuid.sh
	go list ./... | xargs -n1 go test --cover

format: deps
	@echo "--> Running go fmt"
	@go fmt $(PACKAGES)

vet:
	@go tool vet 2>/dev/null ; if [ $$? -eq 3 ]; then \
		go get golang.org/x/tools/cmd/vet; \
	fi
	@echo "--> Running go tool vet $(VETARGS) ."
	@go tool vet $(VETARGS) . ; if [ $$? -eq 1 ]; then \
		echo ""; \
		echo "Vet found suspicious constructs. Please check the reported constructs"; \
		echo "and fix them if necessary before submitting the code for reviewal."; \
	fi

web:
	./scripts/website_run.sh

web-push:
	./scripts/website_push.sh

.PHONY: all cov deps integ test vet web web-push test-nodep
Use proper shell expansion in Makefile 11 years ago			`DEPS = $(shell go list -f '{{range .TestImports}}{{.}} {{end}}' ./...)`
Add make format task 11 years ago			`PACKAGES = $(shell go list ./...)`
Makefile: add vet target Add a vet target in order to catch suspicious constructs reported by go vet. Vet has successfully detected problems in the past, for example, see c9333b1b9b472feb5cad80e2c8276d41b64bde88 Some vet flags are noisy. In particular, the following flags reports a large amount of generally unharmful constructs: ``` -assign: check for useless assignments -composites: check that composite literals used field-keyed elements -shadow: check for shadowed variables -shadowstrict: whether to be strict about shadowing -unreachable: check for unreachable code ``` In order to skip running the flags mentioned above, vet is invoked on a directory basis with `go tool vet .` since package- level type-checking with `go vet` doesn't accept flags. Hence, each file is vetted in isolation, which is weaker than package-level type-checking. But nevertheless, it might catch suspicious constructs that pose a real issue. The vet target runs the following flags on the entire repo: ``` -asmdecl: check assembly against Go declarations -atomic: check for common mistaken usages of the sync/atomic package -bool: check for mistakes involving boolean operators -buildtags: check that +build tags are valid -copylocks: check that locks are not passed by value -methods: check that canonically named methods are canonically defined -nilfunc: check for comparisons between functions and nil -printf: check printf-like invocations -rangeloops: check that range loop variables are used correctly -shift: check for useless shifts -structtags: check that struct field tags have canonical format and apply to exported fields as needed -unsafeptr: check for misuse of unsafe.Pointer ``` Now and then, it might make sense to check the output of the disabled flags manually. For example, `VETARGS=-unreachable make vet` can detect several lines of dead code that can be deleted, etc. 10 years ago			`VETARGS?=-asmdecl -atomic -bool -buildtags -copylocks -methods \`
			`-nilfunc -printf -rangeloops -shift -structtags -unsafeptr`
consul: adding basic skeleton 11 years ago
Add format task to all and silence large output 11 years ago			`all: deps format`
consul: adding basic skeleton 11 years ago			`@mkdir -p bin/`
			`@bash --norc -i ./scripts/build.sh`

			`cov:`
			`gocov test ./... \| gocov-html > /tmp/coverage.html`
			`open /tmp/coverage.html`

			`deps:`
Add format task to all and silence large output 11 years ago			`@echo "--> Installing build dependencies"`
Use separate updatedeps target for Makefile 10 years ago			`@go get -d -v ./... $(DEPS)`
consul: adding basic skeleton 11 years ago
Use separate updatedeps target for Makefile 10 years ago			`updatedeps: deps`
			`@echo "--> Updating build dependencies"`
			`@go get -d -f -u ./... $(DEPS)`
consul: adding basic skeleton 11 years ago
Use separate updatedeps target for Makefile 10 years ago			`test: deps`
Build consul to a temp dir for API tests 10 years ago			`@./scripts/verify_no_uuid.sh`
			`@./scripts/test.sh`
Adding fast-path for testing without depedency updates 10 years ago			`@$(MAKE) vet`

consul: adding basic skeleton 11 years ago			`integ:`
Separate cover target for tests 10 years ago			`go list ./... \| INTEG_TESTS=yes xargs -n1 go test`

			`cover: deps`
			`./scripts/verify_no_uuid.sh`
			`go list ./... \| xargs -n1 go test --cover`
consul: adding basic skeleton 11 years ago
fix make dependency for the format target 11 years ago			`format: deps`
Add format task to all and silence large output 11 years ago			`@echo "--> Running go fmt"`
			`@go fmt $(PACKAGES)`
Add make format task 11 years ago
Makefile: add vet target Add a vet target in order to catch suspicious constructs reported by go vet. Vet has successfully detected problems in the past, for example, see c9333b1b9b472feb5cad80e2c8276d41b64bde88 Some vet flags are noisy. In particular, the following flags reports a large amount of generally unharmful constructs: ``` -assign: check for useless assignments -composites: check that composite literals used field-keyed elements -shadow: check for shadowed variables -shadowstrict: whether to be strict about shadowing -unreachable: check for unreachable code ``` In order to skip running the flags mentioned above, vet is invoked on a directory basis with `go tool vet .` since package- level type-checking with `go vet` doesn't accept flags. Hence, each file is vetted in isolation, which is weaker than package-level type-checking. But nevertheless, it might catch suspicious constructs that pose a real issue. The vet target runs the following flags on the entire repo: ``` -asmdecl: check assembly against Go declarations -atomic: check for common mistaken usages of the sync/atomic package -bool: check for mistakes involving boolean operators -buildtags: check that +build tags are valid -copylocks: check that locks are not passed by value -methods: check that canonically named methods are canonically defined -nilfunc: check for comparisons between functions and nil -printf: check printf-like invocations -rangeloops: check that range loop variables are used correctly -shift: check for useless shifts -structtags: check that struct field tags have canonical format and apply to exported fields as needed -unsafeptr: check for misuse of unsafe.Pointer ``` Now and then, it might make sense to check the output of the disabled flags manually. For example, `VETARGS=-unreachable make vet` can detect several lines of dead code that can be deleted, etc. 10 years ago			`vet:`
			`@go tool vet 2>/dev/null ; if [ $$? -eq 3 ]; then \`
			`go get golang.org/x/tools/cmd/vet; \`
			`fi`
			`@echo "--> Running go tool vet $(VETARGS) ."`
			`@go tool vet $(VETARGS) . ; if [ $$? -eq 1 ]; then \`
			`echo ""; \`
			`echo "Vet found suspicious constructs. Please check the reported constructs"; \`
			`echo "and fix them if necessary before submitting the code for reviewal."; \`
			`fi`

consul: adding basic skeleton 11 years ago			`web:`
			`./scripts/website_run.sh`

			`web-push:`
			`./scripts/website_push.sh`

Adding fast-path for testing without depedency updates 10 years ago			`.PHONY: all cov deps integ test vet web web-push test-nodep`