|
| 1 | +# Copyright (c) 2021 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9 |
| 2 | + |
| 3 | +# A Self-Documenting Makefile: http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html |
| 4 | +.DEFAULT_GOAL := help |
| 5 | +.PHONY: help |
| 6 | +help: ## Display this help message. |
| 7 | + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' |
| 8 | + |
| 9 | +TOP=$(CURDIR) |
| 10 | + |
| 11 | +# Go build related variables |
| 12 | +GOSRC=$(TOP) |
| 13 | + |
| 14 | +# Set GOBIN to where binaries get picked up while creating RPM/ISO. |
| 15 | +GOBIN?=$(TOP)/bin |
| 16 | +GOCOVER=$(GOSRC)/cover |
| 17 | +GOTOOLSBIN=$(TOP)/tools/go/ |
| 18 | + |
| 19 | +.SILENT: |
| 20 | + |
| 21 | +.PHONY: all |
| 22 | +all: clean analyze build test |
| 23 | + |
| 24 | +.PHONY: clean |
| 25 | +clean: ## Clean Plugin Manager go build & test artifacts |
| 26 | + @echo "Cleaning Plugin Manager Go binaries..."; |
| 27 | + export GOBIN=$(GOBIN); \ |
| 28 | + cd $(GOSRC); \ |
| 29 | + go clean -i -mod=vendor ./...; |
| 30 | + @echo "Cleaning Go test artifacts... "; |
| 31 | + -@rm $(GOSRC)/{,.}*{dot,html,log,svg,xml}; |
| 32 | + -@rm $(GOSRC)/cmd/pm/{,.}*{dot,log,svg}; |
| 33 | + -@rm -rf $(GOSRC)/plugins/ |
| 34 | + -@rm -rf $(GOCOVER); |
| 35 | + |
| 36 | +.PHONY: build |
| 37 | +build: ## Build source code |
| 38 | + # Since go build determines and build only updated sources, no need to run clean all go binaries |
| 39 | + @echo "Building Plugin Manager Go binaries..."; |
| 40 | + export GOBIN=$(GOBIN); \ |
| 41 | + cd $(GOSRC); \ |
| 42 | + go install -ldflags "-X main.buildDate=`date -u +%Y%m%d.%H%M%S`" -mod=vendor -v ./...; \ |
| 43 | + ret=$$?; \ |
| 44 | + if [ $${ret} -ne 0 ]; then \ |
| 45 | + @echo "Failed to build Plugin Manager Go binaries."; \ |
| 46 | + exit 1; \ |
| 47 | + fi |
| 48 | + |
| 49 | + |
| 50 | +.PHONY: analyze |
| 51 | +analyze: gofmt golint govet go-race ## Analyze source code for different errors through gofmt, golint, govet, go-race |
| 52 | + |
| 53 | +.PHONY: golint |
| 54 | +golint: ## Run golint |
| 55 | + @echo Checking Plugin Manager Go code for lint errors... |
| 56 | + $(GOTOOLSBIN)/golint -set_exit_status `cd $(GOSRC); go list -mod=vendor -f '{{.Dir}}' ./...` |
| 57 | + |
| 58 | +.PHONY: gofmt |
| 59 | +gofmt: ## Run gofmt |
| 60 | + @echo Checking Go code for format errors... |
| 61 | + fmterrs=`gofmt -l . | grep -v vendor/ 2>&1`; \ |
| 62 | + if [ "$$fmterrs" ]; then \ |
| 63 | + echo "gofmt must be run on the following files:"; \ |
| 64 | + echo "$$fmterrs"; \ |
| 65 | + exit 1; \ |
| 66 | + fi |
| 67 | + |
| 68 | +.PHONY: govet |
| 69 | +govet: ## Run go vet |
| 70 | + @echo Vetting Plugin Manager Go code for errors... |
| 71 | + cd $(GOSRC); \ |
| 72 | + go vet -mod=vendor -all ./... |
| 73 | + |
| 74 | +.PHONY: test |
| 75 | +test: ## Run all tests |
| 76 | + echo "Running Plugin Manager Go Unit Tests..."; \ |
| 77 | + mkdir -p $(GOCOVER); |
| 78 | + export INTEG_TEST_BIN=$(GOSRC); \ |
| 79 | + export PM_CONF_FILE=$(GOSRC)/docs/sample/pm.config.yaml; \ |
| 80 | + export INTEGRATION_TEST=START; \ |
| 81 | + cd $(GOSRC); \ |
| 82 | + test_failed=0; \ |
| 83 | + d=pm; \ |
| 84 | + go test -mod=vendor -v --cover -covermode=count -coverprofile=$(GOCOVER)/$${d}.out ./... | \ |
| 85 | + $(GOTOOLSBIN)/go-junit-report > TEST-$${d}.xml; \ |
| 86 | + ret=$${PIPESTATUS[0]}; \ |
| 87 | + if [ $${ret} -ne 0 ]; then \ |
| 88 | + echo "Go unit test failed for $${d}."; \ |
| 89 | + test_failed=1; \ |
| 90 | + fi ; \ |
| 91 | + awk -f $(TOP)/tools/gocoverage-collate.awk $(GOCOVER)/* > $(GOCOVER)/cover.out; \ |
| 92 | + go tool cover -html=$(GOCOVER)/cover.out -o go-coverage-$${d}.html; \ |
| 93 | + $(GOTOOLSBIN)/gocov convert $(GOCOVER)/cover.out | $(GOTOOLSBIN)/gocov-xml > go-coverage-$${d}.xml; \ |
| 94 | + rm -rf $(GOCOVER)/*; \ |
| 95 | + export INTEGRATION_TEST=DONE; \ |
| 96 | + if [ $${test_failed} -ne 0 ]; then \ |
| 97 | + echo "Go unit tests failed."; \ |
| 98 | + exit 1; \ |
| 99 | + fi |
| 100 | + |
| 101 | +.PHONY: go-race |
| 102 | +go-race: ## Run Go tests with race detector enabled |
| 103 | + echo "Checking Go code for race conditions..."; |
| 104 | + # NOTE: SUMCOVER directory should be present, along with INTEGRATION_TEST |
| 105 | + # value being set to "START" for integ_test.go to succeed. |
| 106 | + mkdir -p $(GOCOVER); |
| 107 | + export INTEGRATION_TEST=START; \ |
| 108 | + export INTEG_TEST_BIN=$(GOSRC); \ |
| 109 | + cd $(GOSRC); \ |
| 110 | + export PM_CONF_FILE=$(GOSRC)/docs/sample/pm.config.yaml; \ |
| 111 | + go test -mod=vendor -v -race ./...; |
| 112 | + |
| 113 | +.NOTPARALLEL: |
0 commit comments