chore: cmd/tsdb: Refactored Makefile to use Makefile.common and fix build issues

Author: Martin Chodur

cmd/tsdb/Makefile

@@ -1,11 +1,50 @@
+# Copyright 2018 The Prometheus Authors
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+include Makefile.common
+
+STATICCHECK_IGNORE =
+TSDB_BIN = "./tsdb"
+NUM_METRICS ?= 1000
+PROJECT_DIR = "../.."
+TEST_DATA_DIR ?= "$(PROJECT_DIR)/testdata"
+TEST_DATASET ?= "20kseries.json"
+BENCH_DIR ?= "./benchout"
+
+ifdef DEBUG
+	bindata_flags = -debug
+endif
+
+# Since tsdb client yet has no tests we can at least try to run benchmark
+test: bench
+
 build:
-	@go build .
-	
-bench: build 
+	@$(GO) build .
+
+bench: build
 	@echo ">> running benchmark"
-	@./tsdb bench write --metrics=$(NUM_METRICS) testdata.1m
-	@go tool pprof -svg ./tsdb benchout/cpu.prof > benchout/cpuprof.svg
-	@go tool pprof --inuse_space -svg ./tsdb benchout/mem.prof > benchout/memprof.inuse.svg
-	@go tool pprof --alloc_space -svg ./tsdb benchout/mem.prof > benchout/memprof.alloc.svg
-	@go tool pprof -svg ./tsdb benchout/block.prof > benchout/blockprof.svg
-	@go tool pprof -svg ./tsdb benchout/mutex.prof > benchout/mutexprof.svg
+	@$(TSDB_BIN) bench write --metrics=$(NUM_METRICS) $(TEST_DATA_DIR)/$(TEST_DATASET)
+
+bench-vizualization: bench
+	@command -v dot >/dev/null 2>&1 || echo "You need to have Graphviz installed to genrate pprof vizualization."
+	@$(GO) tool pprof -svg ./tsdb $(BENCH_DIR)/cpu.prof > $(BENCH_DIR)/cpuprof.svg
+	@$(GO) tool pprof --inuse_space -svg ./tsdb $(BENCH_DIR)/mem.prof > $(BENCH_DIR)/memprof.inuse.svg
+	@$(GO) tool pprof --alloc_space -svg ./tsdb $(BENCH_DIR)/mem.prof > $(BENCH_DIR)/memprof.alloc.svg
+	@$(GO) tool pprof -svg ./tsdb $(BENCH_DIR)/block.prof > $(BENCH_DIR)/blockprof.svg
+	@$(GO) tool pprof -svg ./tsdb $(BENCH_DIR)/mutex.prof > $(BENCH_DIR)/mutexprof.svg
+
+clean:
+	rm -f $(TSDB_BIN)
+	rm -rf $(BENCH_DIR)
+
+.PHONY: clean test

cmd/tsdb/Makefile.common

@@ -0,0 +1,100 @@
+# Copyright 2018 The Prometheus Authors
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# A common Makefile that includes rules to be reused in different prometheus projects.
+# !!! Open PRs only against the prometheus/prometheus/Makefile.common repository!
+
+# Example usage :
+# Create the main Makefile in the root project directory.
+# include Makefile.common
+# customTarget:
+# 	@echo ">> Running customTarget"
+#
+
+# Ensure GOBIN is not set during build so that promu is installed to the correct path
+unexport GOBIN
+
+GO           ?= go
+GOFMT        ?= $(GO)fmt
+FIRST_GOPATH := $(firstword $(subst :, ,$(shell $(GO) env GOPATH)))
+PROMU        := $(FIRST_GOPATH)/bin/promu
+STATICCHECK  := $(FIRST_GOPATH)/bin/staticcheck
+GOVENDOR     := $(FIRST_GOPATH)/bin/govendor
+pkgs          = ./...
+
+PREFIX                  ?= $(shell pwd)
+BIN_DIR                 ?= $(shell pwd)
+DOCKER_IMAGE_TAG        ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD))
+
+all: style staticcheck unused build test
+
+style:
+	@echo ">> checking code style"
+	! $(GOFMT) -d $$(find . -path ./vendor -prune -o -name '*.go' -print) | grep '^'
+
+check_license:
+	@echo ">> checking license header"
+	@licRes=$$(for file in $$(find . -type f -iname '*.go' ! -path './vendor/*') ; do \
+               awk 'NR<=3' $$file | grep -Eq "(Copyright|generated|GENERATED)" || echo $$file; \
+       done); \
+       if [ -n "$${licRes}" ]; then \
+               echo "license header checking failed:"; echo "$${licRes}"; \
+               exit 1; \
+       fi
+
+test-short:
+	@echo ">> running short tests"
+	$(GO) test -short $(pkgs)
+
+test:
+	@echo ">> running all tests"
+	$(GO) test -race $(pkgs)
+
+format:
+	@echo ">> formatting code"
+	$(GO) fmt $(pkgs)
+
+vet:
+	@echo ">> vetting code"
+	$(GO) vet $(pkgs)
+
+staticcheck: $(STATICCHECK)
+	@echo ">> running staticcheck"
+	$(STATICCHECK) -ignore "$(STATICCHECK_IGNORE)" $(pkgs)
+
+unused: $(GOVENDOR)
+	@echo ">> running check for unused packages"
+	@$(GOVENDOR) list +unused | grep . && exit 1 || echo 'No unused packages'
+
+build: promu
+	@echo ">> building binaries"
+	$(PROMU) build --prefix $(PREFIX)
+
+tarball: promu
+	@echo ">> building release tarball"
+	$(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR)
+
+docker:
+	docker build -t "$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)" .
+
+promu:
+	GOOS= GOARCH= $(GO) get -u github.com/prometheus/promu
+
+$(FIRST_GOPATH)/bin/staticcheck:
+	GOOS= GOARCH= $(GO) get -u honnef.co/go/tools/cmd/staticcheck
+
+$(FIRST_GOPATH)/bin/govendor:
+	GOOS= GOARCH= $(GO) get -u github.com/kardianos/govendor
+
+.PHONY: all style check_license format build test vet assets tarball docker promu staticcheck $(FIRST_GOPATH)/bin/staticcheck govendor $(FIRST_GOPATH)/bin/govendor