-
Notifications
You must be signed in to change notification settings - Fork 0
/
Golang.mk
426 lines (371 loc) · 11.9 KB
/
Golang.mk
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
#!/usr/bin/make --no-print-directory --jobs=1 --environment-overrides -f
# Copyright (c) 2023 The Go-Enjin 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.
MAKEFILE_KEYS += GOLANG
GOLANG_MK_FILE := Golang.mk
GOLANG_MK_VERSION := v0.2.1
GOLANG_MK_DESCRIPTION := globals, functions and internal targets
.PHONY: __golang __deps __generate
.PHONY: __vet __test __coverage
.PHONY: __tidy __fmt __reportcard
.PHONY: __local __unlocal __be_update
PWD := $(shell pwd)
SHELL := /bin/bash
UNTAGGED_VERSION ?= v0.0.0
UNTAGGED_COMMIT ?= 0000000000
BUILD_OS ?= $(shell uname -s | awk '{print $$1}' | tr '[:upper:]' '[:lower:]')
BUILD_ARCH ?= $(shell uname -m | perl -pe 's!aarch64!arm64!;s!x86_64!amd64!;')
BUILD_NAME := ${BIN_NAME}.${BUILD_OS}.${BUILD_ARCH}
GIT_STATUS := $(git status 2> /dev/null)
UPX_BIN := $(shell which upx)
SHASUM_BIN := $(shell which shasum)
SHASUM_CMD := ${SHASUM_BIN} -a 256
GOPKG_KEYS ?=
GO_ENJIN_PKG ?= github.com/go-enjin/be
DESTDIR ?=
prefix ?= /usr
prefix_etc ?= /etc
INSTALL_BIN_PATH := ${DESTDIR}${prefix}/bin
INSTALL_ETC_PATH := ${DESTDIR}${prefix_etc}
INSTALL_AUTOCOMPLETE_PATH := ${INSTALL_ETC_PATH}/bash_completion.d
GOIMPORTS_LIST ?= github.com/go-curses,github.com/go-corelibs
GOCONVEY_HOST ?= 0.0.0.0
GOCONVEY_PORT ?= 8080
BUILD_EXTRA_LDFLAGS ?=
ifeq (${INCLUDE_CDK_LOG_FLAGS},true)
BUILD_EXTRA_LDFLAGS += -X 'github.com/go-curses/cdk.IncludeLogFile=true'
BUILD_EXTRA_LDFLAGS += -X 'github.com/go-curses/cdk.IncludeLogLevel=true'
BUILD_EXTRA_LDFLAGS += -X 'github.com/go-curses/cdk.IncludeLogLevels=true'
endif
_INTERNAL_BUILD_LOG_ ?= /dev/null
-include Golang.lib.mk
-include Golang.cdk.mk
-include Golang.def.mk
_BUILD_TAGS ?= $(call __build_tags)
define __build_tags
$(shell \
echo "${BUILD_TAGS}" \
| perl -pe 's!\s*\n! !g;s!\s+! !g;' \
| perl -pe 's!\s+!,!g;s!^,!!;s!,\s*$$!!;' \
)
endef
define __clean
for FOUND in $(1); do \
if [ -n "$${FOUND}" ]; then \
${CMD} rm -rfv $${FOUND}; \
fi; \
done
endef
define __install_file
echo "# installing $(2) to: $(3) [$(1)]"; \
${CMD} mkdir -vp `dirname $(3)`; \
${CMD} /usr/bin/install -v -m $(1) "$(2)" "$(3)"; \
${CMD} ${SHASUM_CMD} "$(3)"
endef
define __install_exe
$(call __install_file,0775,$(1),$(2))
endef
define __go_trim_path
$(shell \
if [ "${GOPATH}" != "" ]; then \
echo "${GOPATH};${PWD}"; \
else \
echo "${PWD}"; \
fi)
endef
define __tag_ver
$(shell (git describe 2>/dev/null) || echo "${UNTAGGED_VERSION}")
endef
define __rel_ver
$(shell \
if [ -d .git ]; then \
if [ -z "${GIT_STATUS}" ]; then \
(git rev-parse --short=10 HEAD 2>/dev/null) || echo "${UNTAGGED_COMMIT}"; \
else \
[ -d .git ] && ( git diff 2>/dev/null || true ) \
| ${SHASUM_CMD} - 2>/dev/null \
| perl -pe 's!^\s*([a-f0-9]{10}).*!\1!'; \
fi; \
else \
echo "${UNTAGGED_COMMIT}"; \
fi \
)
endef
define __go_bin
$(shell \
export ENJENV_BIN=`which enjenv`; \
if [ -n "$${ENJENV_BIN}" -a -x "$${ENJENV_BIN}" ]; then \
export ENJENV_PATH=`"$${ENJENV_BIN}"`; \
if [ -n "$${ENJENV_PATH}" -a "$${ENJENV_PATH}/activate" ]; then \
( source "$${ENJENV_PATH}/activate" 2>&1 ) > /dev/null; \
fi; \
fi; \
export GO_BIN=`which go`; \
if [ -z "$${GO_BIN}" -o ! -x "$${GO_BIN}" ]; then \
echo "error: missing go binary" 1>&2; \
false; \
fi; \
echo "$${GO_BIN}" \
)
endef
define __gofmt_bin
$(shell \
export ENJENV_BIN=`which enjenv`; \
if [ -n "$${ENJENV_BIN}" -a -x "$${ENJENV_BIN}" ]; then \
export ENJENV_PATH=`"$${ENJENV_BIN}"`; \
if [ -n "$${ENJENV_PATH}" -a "$${ENJENV_PATH}/activate" ]; then \
( source "$${ENJENV_PATH}/activate" 2>&1 ) > /dev/null; \
fi; \
fi; \
export GOFMT_BIN=`which gofmt`; \
if [ -z "$${GOFMT_BIN}" -o ! -x "$${GOFMT_BIN}" ]; then \
echo "error: missing gofmt binary" 1>&2; \
false; \
fi; \
echo "$${GOFMT_BIN}" \
)
endef
define __goimports_bin
$(shell \
export ENJENV_BIN=`which enjenv`; \
if [ -n "$${ENJENV_BIN}" -a -x "$${ENJENV_BIN}" ]; then \
export ENJENV_PATH=`"$${ENJENV_BIN}"`; \
if [ -n "$${ENJENV_PATH}" -a "$${ENJENV_PATH}/activate" ]; then \
( source "$${ENJENV_PATH}/activate" 2>&1 ) > /dev/null; \
fi; \
fi; \
export GOIMPORTS_BIN=`which goimports`; \
if [ -z "$${GOIMPORTS_BIN}" -o ! -x "$${GOIMPORTS_BIN}" ]; then \
echo "error: missing goimports binary" 1>&2; \
false; \
fi; \
echo "$${GOIMPORTS_BIN}" \
)
endef
# __go_build 1=bin-name, 2=goos, 3=goarch, 4=ldflags, 5=gcflags, 6=asmflags, 7=extra, 8=src
define __go_build
$(shell \
export ERR=false; \
if [ "$(2)" == "linux" ]; then \
if [ "$(3)" == "arm64" ]; then \
export CC_VAL=aarch64-linux-gnu-gcc; \
export CXX_VAL=aarch64-linux-gnu-g++; \
elif [ "$(3)" == "amd64" ]; then \
export CC_VAL=x86_64-linux-gnu-gcc; \
export CXX_VAL=x86_64-linux-gnu-g++; \
else \
echo "error: unsupported architecture: $(3)" 1>&2; \
export ERR=true; \
fi; \
fi; \
if [ "$${ERR}" == "false" ]; then \
if [ -n "${_BUILD_TAGS}" ]; then \
echo "${CMD} \
GOOS=\"$(2)\" GOARCH=\"$(3)\" \
CGO_ENABLED=1 CC=$${CC_VAL} CXX=$${CXX_VAL} \
$(call __go_bin) \
build -v \
-o \"$(1)\" \
-ldflags=\"-buildid='' $(4)\" \
-gcflags=\"$(5)\" \
-asmflags=\"$(6)\" \
-tags \"${_BUILD_TAGS}\" \
$(7) \
$(8)"; \
else \
echo "${CMD} \
GOOS=\"$(2)\" GOARCH=\"$(3)\" \
CGO_ENABLED=1 CC=$${CC_VAL} CXX=$${CXX_VAL} \
$(call __go_bin) \
build -v \
-o \"$(1)\" \
-ldflags=\"-buildid='' $(4)\" \
-gcflags=\"$(5)\" \
-asmflags=\"$(6)\" \
$(7) \
$(8)"; \
fi; \
else \
echo "echo ERROR missing go binary"; \
fi
)
endef
# 1: bin-name, 2: goos, 3: goarch, 4: ldflags, 5: gcflags, 6: asmflags, 7: argv, 8: src
define __cmd_go_build
$(call __go_build,$(1),$(2),$(3),$(4) -X '${BUILD_VERSION_VAR}=${BUILD_VERSION}' -X '${BUILD_RELEASE_VAR}=${BUILD_RELEASE}' ${BUILD_EXTRA_LDFLAGS},$(5),$(6),$(7),$(8))
endef
# 1: bin-name, 2: goos, 3: goarch, 4: ldflags, 5: src
define __cmd_go_build_trimpath
$(call __cmd_go_build,$(1),$(2),$(3),$(4),-trimpath='${TRIM_PATHS}',-trimpath='${TRIM_PATHS}',-trimpath,$(5))
endef
# 1: bin-name, 2: goos, 3: goarch, 4: src
define __go_build_release
echo "# building $(2)-$(3) (release): ${BIN_NAME} (${BUILD_VERSION}, ${BUILD_RELEASE})"; \
echo $(call __cmd_go_build_trimpath,$(1),$(2),$(3),-s -w,$(4)); \
$(call __cmd_go_build_trimpath,$(1),$(2),$(3),-s -w,$(4))
endef
# 1: bin-name, 2: goos, 3: goarch, 4: src
define __go_build_debug
echo "# building $(2)-$(3) (debug): ${BIN_NAME} (${BUILD_VERSION}, ${BUILD_RELEASE})"; \
echo $(call __cmd_go_build,$(1),$(2),$(3),,all="-N -l",,,$(4)); \
$(call __cmd_go_build,$(1),$(2),$(3),,all="-N -l",,,$(4))
endef
define __upx_build
if [ "${BUILD_OS}" == "darwin" ]; then \
echo "# upx command not supported on darwin, nothing to do"; \
elif [ -n "${UPX_BIN}" -a -x "${UPX_BIN}" ]; then \
echo -n "# packing: $(1) - "; \
du -hs "$(1)" | awk '{print $$1}'; \
${UPX_BIN} -qq -7 --no-color --no-progress "$(1)"; \
echo -n "# packed: $(1) - "; \
du -hs "$(1)" | awk '{print $$1}'; \
${SHASUM_CMD} "$(1)"; \
else \
echo "# upx command not found, nothing to do"; \
fi
endef
define __pkg_list_latest
$(ifneq ${GO_ENJIN_PKG},nil,"${GO_ENJIN_PKG}@latest ")\
$(if ${GOPKG_KEYS},$(foreach key,${GOPKG_KEYS},$(shell \
if [ \
-n "$($(key)_GO_PACKAGE)" \
-a "$($(key)_GO_PACKAGE)" != "nil" \
]; then \
echo "$($(key)_GO_PACKAGE)@$(if $($(key)_LATEST_VER),$($(key)_LATEST_VER),latest)"; \
fi \
)))
endef
define __validate_extra_pkgs
$(if ${GOPKG_KEYS},$(foreach key,${GOPKG_KEYS},$(shell \
if [ \
-z "$($(key)_GO_PACKAGE)" \
-o -z "$($(key)_LOCAL_PATH)" \
-o ! -d "$($(key)_LOCAL_PATH)" \
]; then \
echo "echo \"# $(key)_GO_PACKAGE and/or $(key)_LOCAL_PATH not found\"; false;"; \
fi \
)))
endef
define __make_go_local
echo "__make_go_local $(1) $(2)" >> ${_INTERNAL_BUILD_LOG_}; \
if [ -n "$(2)" -a "$(2)" != "nil" ]; then \
echo "# go.mod local: $(1)"; \
${CMD} $(call __go_bin) mod edit -replace "$(1)=$(2)"; \
fi
endef
define __make_go_unlocal
echo "__make_go_unlocal $(1)" >> ${_INTERNAL_BUILD_LOG_}; \
if [ -n "$(1)" -a "$(1)" != "nil" ]; then \
echo "# go.mod unlocal $(1)"; \
${CMD} $(call __go_bin) mod edit -dropreplace "$(1)"; \
fi
endef
define _make_extra_pkgs
$(if ${GOPKG_KEYS},$(foreach key,${GOPKG_KEYS},$($(key)_GO_PACKAGE)@latest))
endef
__golang: export GO_BIN=$(call __go_bin)
__golang:
@if [ -n "${GO_BIN}" -a -x "${GO_BIN}" ]; then \
export GO_BIN_VERSION=`${GO_BIN} version`; \
echo "# $${GO_BIN_VERSION}"; \
else \
echo "# missing go binary" 1>&2; \
echo "# ${GO_BIN} -- $${GO_BIN}"; \
false; \
fi
__deps: __golang
@echo "# installing dependencies"
@echo "#: goimports"
@$(call __go_bin) install golang.org/x/tools/cmd/goimports@latest
@echo "#: goconvey"
@$(call __go_bin) install github.com/smartystreets/goconvey@latest
@echo "#: govulncheck"
@$(call __go_bin) install golang.org/x/vuln/cmd/govulncheck@latest
@echo "#: gocyclo"
@$(call __go_bin) install github.com/fzipp/gocyclo/cmd/gocyclo@latest
@echo "#: ineffassign"
@$(call __go_bin) install github.com/gordonklaus/ineffassign@latest
@echo "#: misspell"
@$(call __go_bin) install github.com/client9/misspell/cmd/misspell@latest
@echo "#: go get ./..."
@$(call __go_bin) get ./...
__tidy: __golang
@echo "# go mod tidy"
@$(call __go_bin) mod tidy
__fmt: __golang
@echo "# gofmt -s"
@$(call __gofmt_bin) -w -s `find * -name "*.go"`
@echo "# goimports"
@$(call __goimports_bin) -w \
-local "$(GOIMPORTS_LIST)" \
`find * -name "*.go"`
__reportcard: export GOFMT_BIN=$(call __gofmt_bin)
__reportcard: __golang
@echo "# code sanity and style report"
@echo "#: go vet"
@$(call __go_bin) vet -tags all ./... || true
@echo "#: gocyclo"
@gocyclo -over 15 `find * -name "*.go"` || true
@echo "#: ineffassign"
@ineffassign ./... || true
@echo "#: misspell"
@misspell ./... || true
@echo "#: gofmt -s"
@echo -e -n `find * -name "*.go" | while read SRC; do \
${GOFMT_BIN} -s "$${SRC}" > "$${SRC}.fmts"; \
if ! cmp "$${SRC}" "$${SRC}.fmts" 2> /dev/null; then \
echo "can simplify: $${SRC}\\n"; \
fi; \
rm -f "$${SRC}.fmts"; \
done`
@echo "#: govulncheck"
@echo -e -n `govulncheck -tags all ./... \
| egrep '^Vulnerability #' \
| sort -u -V \
| while read LINE; do \
echo "$${LINE}\n"; \
done`
__local: __golang
@`echo "_make_extra_locals" >> ${_INTERNAL_BUILD_LOG_}`
@$(call __validate_extra_pkgs)
@$(if ${GOPKG_KEYS},$(foreach key,${GOPKG_KEYS},$(call __make_go_local,$($(key)_GO_PACKAGE),$($(key)_LOCAL_PATH));))
@$(call __make_go_local,${GO_ENJIN_PKG},${BE_LOCAL_PATH})
__unlocal: __golang
@`echo "_make_extra_unlocals" >> ${_INTERNAL_BUILD_LOG_}`
@$(call __validate_extra_pkgs)
@$(if ${GOPKG_KEYS},$(foreach key,${GOPKG_KEYS},$(call __make_go_unlocal,$($(key)_GO_PACKAGE));))
@$(call __make_go_unlocal,${GO_ENJIN_PKG})
__be_update: PKG_LIST=$(call __pkg_list_latest)
__be_update: __golang
@$(call __validate_extra_pkgs)
@echo "# go getting: ${PKG_LIST}"
@GOPROXY=direct $(call __go_bin) get ${PKG_LIST}
__vet: __golang
@echo -n "# go vet ./..."
@go vet ./... && echo " done" || echo " error"
__test:
@echo "# go test -race -v ./..."
@go test -race -v ./...
__coverage: __golang
@echo "# generating coverage reports -v ./..."
@go test -race -coverprofile=coverage.out -covermode=atomic -coverpkg=./... -v ./...
@go tool cover -html=coverage.out -o=coverage.html
__goconvey:
@echo "# running goconvey http://${GOCONVEY_HOST}:${GOCONVEY_PORT}"
@echo "# press <CTRL+c> to stop (takes a moment to exit)"
@goconvey -host=${GOCONVEY_HOST} -port=${GOCONVEY_PORT} \
-launchBrowser=false -depth=-1
__generate:
@echo "# go generate -v ./..."
@go generate -v ./...