[关闭]
@cyysu 2017-10-13T09:09:48.000000Z 字数 5076 阅读 967

Makefile-项目篇(二)

  • 时间：2017年10月13日
  • 作者：Kali
  • 邮箱：cyysu.github.io@gmail.com
  • 版本：3.0
  • 描述：Makefile-项目二，介绍一片编译go程序的makefile

Makefile系列教程

项目实战

  1. # 定义模块名字
  2. PACKAGE  = hellogopher
  3. # 设置时间
  4. DATE    ?= $(shell date +%FT%T%z)
  5. # git describe命令显示离当前提交最近的标签。如果第一条命令执行成功 ，那么就不会执行第二条命令
  6. VERSION ?= $(shell git describe --tags --always --dirty --match=v* 2> /dev/null || \
  7.             cat $(CURDIR)/.version 2> /dev/null || echo v0)
  11. GOPATH   = $(CURDIR)/.gopath~
  12. BIN      = $(GOPATH)/bin
  13. BASE     = $(GOPATH)/src/$(PACKAGE)
  14. # 这里的逻辑我们先不分析，后面有需要在去分析
  15. PKGS     = $(or $(PKG),$(shell cd $(BASE) && env GOPATH=$(GOPATH) $(GO) list ./... | grep -v "^$(PACKAGE)/vendor/"))
  16. TESTPKGS = $(shell env GOPATH=$(GOPATH) $(GO) list -f '{{ if or .TestGoFiles .XTestGoFiles }}{{ .ImportPath }}{{ end }}' $(PKGS))
  18. GO      = go
  19. GODOC   = godoc
  20. GOFMT   = gofmt
  21. TIMEOUT = 15
  22. V = 0
  23. # 在V中找到属于1的字符串，如果找到了返回就是空，如果没有找到返回的就是@  如果用在命令前面就是不回显命令
  24. Q = $(if $(filter 1,$V),,@)
  25. M = $(shell printf "\033[34;1m▶\033[0m")
  27. .PHONY: all
  28. # ; 表示这个之后就是命令，这个时本目标开头先执行的  
  29. # | 这个我查找了一下也没有找到具体意义，我写了一个测试发现没什么作用。可能就是一个规范，如果目标时变量，前面就加上 | 这个大家先这么记住，如果后面遇到我会告诉大家
  30. # @ 这个也是没有找到定义的，目前只能当做是规范。
  31. all: fmt lint vendor | $(BASE) ; $(info $(M) building executable…) @ ## Build program binary
  32. 	$Q cd $(BASE) && $(GO) build \
  33.         -tags release \
  34.         -ldflags '-X $(PACKAGE)/cmd.Version=$(VERSION) -X $(PACKAGE)/cmd.BuildDate=$(DATE)' \
  35.         -o bin/$(PACKAGE) main.go
  37. # $@ 表示目标 这里表示$(BASE)
  38. # 这个目标表示将项目文件复制链接到GOPATH目录
  39. $(BASE): ; $(info $(M) setting GOPATH…)
  40. 	@mkdir -p $(dir $@)
  41. 	@ln -sf $(CURDIR) $@
  43. # Tools
  44. GODEP = $(BIN)/dep
  45. GODEPVERSION = 0.3.1
  46. #go get -d 表示让命令只执行下载操作，而不执行安装动作
  47. $(BIN)/dep: | $(BASE) ; $(info $(M) building go dep…)
  48. 	$Q go get -d github.com/golang/dep/cmd/dep
  49.     $Q cd $(GOPATH)/src/github.com/golang/dep ; git checkout -q v$(GODEPVERSION)
  50. 	$Q go get github.com/golang/dep/cmd/dep
  52. GOLINT = $(BIN)/golint
  53. $(BIN)/golint: | $(BASE) ; $(info $(M) building golint…)
  54. 	$Q go get github.com/golang/lint/golint
  56. GOCOVMERGE = $(BIN)/gocovmerge
  57. $(BIN)/gocovmerge: | $(BASE) ; $(info $(M) building gocovmerge…)
  58. 	$Q go get github.com/wadey/gocovmerge
  60. GOCOV = $(BIN)/gocov
  61. $(BIN)/gocov: | $(BASE) ; $(info $(M) building gocov…)
  62. 	$Q go get github.com/axw/gocov/...
  64. GOCOVXML = $(BIN)/gocov-xml
  65. $(BIN)/gocov-xml: | $(BASE) ; $(info $(M) building gocov-xml…)
  66. 	$Q go get github.com/AlekSi/gocov-xml
  68. GO2XUNIT = $(BIN)/go2xunit
  69. $(BIN)/go2xunit: | $(BASE) ; $(info $(M) building go2xunit…)
  70. 	$Q go get github.com/tebeka/go2xunit
  72. # Tests
  74. TEST_TARGETS := test-default test-bench test-short test-verbose test-race
  75. .PHONY: $(TEST_TARGETS) test-xml check test tests
  76. test-bench:   ARGS=-run=__absolutelynothing__ -bench=. ## Run benchmarks
  77. test-short:   ARGS=-short        ## Run only short tests
  78. test-verbose: ARGS=-v            ## Run tests in verbose mode with coverage reporting
  79. test-race:    ARGS=-race         ## Run tests with race detector
  80. $(TEST_TARGETS): NAME=$(MAKECMDGOALS:test-%=%)
  81. $(TEST_TARGETS): test
  82. check test tests: fmt lint vendor | $(BASE) ; $(info $(M) running $(NAME:%=% )tests…) @ ## Run tests
  83.     $Q cd $(BASE) && $(GO) test -timeout $(TIMEOUT)s $(ARGS) $(TESTPKGS)
  85. test-xml: fmt lint vendor | $(BASE) $(GO2XUNIT) ; $(info $(M) running $(NAME:%=% )tests…) @ ## Run tests with xUnit output
  86. 	$Q cd $(BASE) && 2>&1 $(GO) test -timeout 20s -v $(TESTPKGS) | tee test/tests.output
  87. 	$(GO2XUNIT) -fail -input test/tests.output -output test/tests.xml
  89. COVERAGE_MODE = atomic
  90. COVERAGE_PROFILE = $(COVERAGE_DIR)/profile.out
  91. COVERAGE_XML = $(COVERAGE_DIR)/coverage.xml
  92. COVERAGE_HTML = $(COVERAGE_DIR)/index.html
  93. .PHONY: test-coverage test-coverage-tools
  94. test-coverage-tools: | $(GOCOVMERGE) $(GOCOV) $(GOCOVXML)
  95. test-coverage: COVERAGE_DIR := $(CURDIR)/test/coverage.$(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
  96. test-coverage: fmt lint vendor test-coverage-tools | $(BASE) ; $(info $(M) running coverage tests…) @ ## Run coverage tests
  97. 	$Q mkdir -p $(COVERAGE_DIR)/coverage
  98. 	$Q cd $(BASE) && for pkg in $(TESTPKGS); do \
  99.         $(GO) test \
  100. 			-coverpkg=$$($(GO) list -f '{{ join .Deps "\n" }}' $$pkg | \
  101. 					grep '^$(PACKAGE)/' | grep -v '^$(PACKAGE)/vendor/' | \
  102. 					tr '\n' ',')$$pkg \
  103.             -covermode=$(COVERAGE_MODE) \
  104. 			-coverprofile="$(COVERAGE_DIR)/coverage/`echo $$pkg | tr "/" "-"`.cover" $$pkg ;\
  105.      done
  106.     $Q $(GOCOVMERGE) $(COVERAGE_DIR)/coverage/*.cover > $(COVERAGE_PROFILE)
  107.     $Q $(GO) tool cover -html=$(COVERAGE_PROFILE) -o $(COVERAGE_HTML)
  108.     $Q $(GOCOV) convert $(COVERAGE_PROFILE) | $(GOCOVXML) > $(COVERAGE_XML)
  110. .PHONY: lint
  111. lint: vendor | $(BASE) $(GOLINT) ; $(info $(M) running golint…) @ ## Run golint
  112.     $Q cd $(BASE) && ret=0 && for pkg in $(PKGS); do \
  113. 		test -z "$$($(GOLINT) $$pkg | tee /dev/stderr)" || ret=1 ; \
  114. 	 done ; exit $$ret
  116. .PHONY: fmt
  117. fmt: ; $(info $(M) running gofmt…) @ ## Run gofmt on all source files
  118.     @ret=0 && for d in $$($(GO) list -f '{{.Dir}}' ./... | grep -v /vendor/); do \
  119. 		$(GOFMT) -l -w $$d/*.go || ret=$$? ; \
  120. 	 done ; exit $$ret
  122. # Dependency management
  124. vendor: Gopkg.toml Gopkg.lock | $(BASE) $(GODEP) ; $(info $(M) retrieving dependencies…)
  125.     $Q cd $(BASE) && $(GODEP) ensure
  126. 	@ln -nsf . vendor/src
  127. 	@touch $@
  128. .PHONY: vendor-update
  129. vendor-update: vendor | $(BASE) $(GODEP)
  130. ifeq "$(origin PKG)" "command line"
  131. 	$(info $(M) updating $(PKG) dependency…)
  132.     $Q cd $(BASE) && $(GODEP) ensure -update $(PKG)
  133. else
  134.     $(info $(M) updating all dependencies…)
  135.     $Q cd $(BASE) && $(GODEP) ensure -update
  136. endif
  137.     @ln -nsf . vendor/src
  138.     @touch vendor
  140. # Misc
  142. .PHONY: clean
  143. clean: ; $(info $(M) cleaning…)   @ ## Cleanup everything
  144.     @rm -rf $(GOPATH)
  145.     @rm -rf bin
  146.     @rm -rf test/tests.* test/coverage.*
  148. # $(MAKEFILE_LIST) 表示 
  149. # grep -E 将范本样式为延伸的普通表示法来使用，意味着使用能使用扩展正则表达式。
  150. # RS是记录分割符： 表示 \n 符号  awk '{print $0}' test1  //awk 'BEGIN{RS="\n"};{print $0}' test1 这二个是一样的
  151. # FS是指定列分隔符
  152. # printf "\033[36m%-15s\033[0m  %s\n", $$1, $$2 其中的 - 表示左对齐为15和字符   $$1 表示分割出来第一段  $$2 表示分割出来第二段
  153. .PHONY: help
  154. help:
  155. 	@grep -E '^[ a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
  156.         awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m  %s\n", $$1, $$2}'
  158. .PHONY: version
  159. version:
  160.     @echo $(VERSION)

打赏

                    支付宝                                                         微信

微信与支付宝支付

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注