peerd/Makefile at main · Azure/peerd · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# Compiler variables.
VERSION = $$(git rev-parse --short HEAD)

# Go build variables.
GOCMD = go
GOTEST = $(GOCMD) test
GOBUILD = $(GOCMD) build -installsuffix 'static' -ldflags "-X main.version=$(VERSION)"
GOLINT = golangci-lint run

# Source repository variables.
ROOT_DIR := $(shell git rev-parse --show-toplevel)
BIN_DIR = $(ROOT_DIR)/bin
 # Exclude generated files, some mocks and CI test apps.
TEST_PKGS = $(shell go list ./... | grep -v 'github.com/azure/peerd/api\|github.com/azure/peerd/pkg/peernet/mocks\|github.com/azure/peerd/tests')
TESTS_BIN_DIR = $(BIN_DIR)/tests
COVERAGE_DIR=$(BIN_DIR)/coverage
SCRIPTS_DIR=$(ROOT_DIR)/build/ci/scripts

# Docker image variables.
REGISTRY ?= localhost
REPO_PREFIX ?=
TAG ?= dev

include $(ROOT_DIR)/build/ci/Makefile
include $(ROOT_DIR)/tests/Makefile

.DEFAULT_GOAL := all

.PHONY: add-copyright
add-copyright: ## Add the copyright header to all Go files.
	@echo "+ $@"
	find $(ROOT_DIR) -type f -name "*.go" -exec sh -c 'grep -q -F "// Copyright (c) Microsoft Corporation." "$0" || sed -i "1i\\// Copyright (c) Microsoft Corporation.\\n// Licensed under the MIT License." "$0"' {} \;

.PHONY: all
all: check test build ## Runs the peerd build targets in the correct order.

.PHONY: build
build: ## Build the peerd packages.
	@echo "+ $@"
	@( $(GOBUILD) -o $(BIN_DIR)/peerd ./cmd/proxy )

.PHONY: build-image
build-image: ## Build the peerd docker image.
	@echo "+ $@"
ifndef CONTAINER_REGISTRY
	$(eval CONTAINER_REGISTRY := $(shell echo "localhost"))
endif
	$(call build-image-internal,$(ROOT_DIR)/build/package/Dockerfile,peerd,$(ROOT_DIR))

.PHONY: changelog
changelog: ## Generate the changelog since last tagged release.
	@echo "+ $@"
	@( $(SCRIPTS_DIR)/generate-changelog.sh )

.PHONY: check
check: check-format lint vet ## Check the source code.

.PHONY: check-format
check-format: ## Format the Go code.
	@echo "+ $@"
	@( test -z $(gofmt -l .) )

.PHONY: coverage
coverage: ## Generates test results for code coverage.
	@echo "+ $@"
	@( COVERAGE_DIR=$(COVERAGE_DIR) $(SCRIPTS_DIR)/coverage.sh "$(ROOT_DIR)" "$(TEST_PKGS)" true )

.PHONY: help
help: info ## Generates help for all targets with a description.
# Read the makefile and print out all targets that have a comment after them.
# If external Makefiles are referenced, trim the external reference from the target name. ex. Makefile:help: -> help:
# Sort the output.
# Split the string based on the Field Separator (FS) and print the first and second fields.
	@grep -E '^[^#[:space:]].*?## .*$$' $(MAKEFILE_LIST) | sed -E 's/^[^:]+:([^:]+:)/\1/' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

.PHONY: info
info: header

.PHONY: install
install: build ## Installs the peerd service in the project bin directory.
	@echo "+ $@"
	@( cp $(ROOT_DIR)/init/systemd/peerd.service $(BIN_DIR)/peerd.service )
	@( cp $(ROOT_DIR)/api/swagger.yaml $(BIN_DIR)/swagger.yaml )

.PHONY: install-gocov
install-gocov: ## Install Go cov.
	@echo "+ $@"
	@( go install github.com/axw/gocov/gocov@latest && \
		go install gotest.tools/gotestsum@latest && \
		go install github.com/jandelgado/gcov2lcov@latest && \
		go install github.com/AlekSi/gocov-xml@latest )

.PHONY: install-linter
install-linter: ## Install Go linter.
	@echo "+ $@"
	@( curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b $(go env GOPATH)/bin v2.0.0 )

.PHONY: lint
lint: ## Run linter.
	@echo "+ $@"
	@( $(GOLINT) --timeout=10m ./... )

.PHONY: swag
swag: ## Generates the swagger documentation of the p2p server.
	@echo "+ $@"
	cd $(ROOT_DIR)/pkg/handlers; swag init --ot go,yaml -o $(ROOT_DIR)/api -g ./root.go

.PHONY: test
test: ## Runs tests.
	@echo "+ $@"
	@( $(GOTEST) ./... )

.PHONY: vet
vet: ## Run go vet.
	@echo "+ $@"
	@( go vet ./... )

define HEADER

	 _____	                _
	|  __ \                | |
	| |__) |__  ___ _ __ __| |
	|  ___/ _ \/ _ \ '__/ _` |
	| |  |  __/  __/ | | (_| |
	|_|   \___|\___|_|  \__,_|

endef

export HEADER

header:
	@echo "$$HEADER"

# build-image-internal takes the dockerfile location, repository name and build context.
# Example:
define build-image-internal
	@echo "\033[92mBuilding image: $(REGISTRY)/$(REPO_PREFIX)$2:$(TAG)\033[0m"

	@echo docker build -f $1 \
	-t $(REGISTRY)/$(REPO_PREFIX)$2:$(TAG) \
	$3

	@docker build -f $1 \
	-t $(REGISTRY)/$(REPO_PREFIX)$2:$(TAG) \
	$3
endef