Repository navigation
Expand file tree
/
Copy pathMakefile
More file actions
251 lines (210 loc) · 9.23 KB
/
Copy pathMakefile
File metadata and controls
251 lines (210 loc) · 9.23 KB
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
# init the build information
ifdef HASTAG
GITTAG=${HASTAG}
else
GITTAG=$(shell git describe --tags --always)
endif
# version
PRO_DIR = $(shell pwd)
BUILDTIME = $(shell date +%Y-%m-%dT%T%z)
GITHASH = $(shell git rev-parse HEAD)
VERSION = $(shell echo ${ENV_BK_BSCP_VERSION})
DEBUG = $(shell echo ${ENV_BK_BSCP_ENABLE_DEBUG})
PREFIX ?= $(shell pwd)
GOBIN = ${PREFIX}/bin/proto
PATH := ${PREFIX}/bin/proto:${PATH}
swag = ${PREFIX}/bin/swag
swagger = ${PREFIX}/bin/swagger
# image repo tag
REPO ?= ""
TAG ?= $(shell git describe --tags --match='v*' --dirty='.dirty')
# protoc v4.22.0
export PROTOC_VERSION=25.1
SKIP_FRONTEND_BUILD ?= false
GOBUILD=CGO_ENABLED=0 go build -trimpath
# 定义脚本路径变量
INJECT_SCRIPT = scripts/bk_gateway/inject_bk_gateway.py
# output directory for release package and version for command line
ifeq ("$(VERSION)", "")
export OUTPUT_DIR = ${PRO_DIR}/build/bk-bscp
export LDVersionFLAG = "-X github.com/TencentBlueKing/bk-bscp/pkg/version.BUILDTIME=${BUILDTIME} \
-X github.com/TencentBlueKing/bk-bscp/pkg/version.GITHASH=${GITHASH} \
-X github.com/TencentBlueKing/bk-bscp/pkg/version.GITTAG=${GITTAG} \
-X github.com/TencentBlueKing/bk-bscp/pkg/version.DEBUG=${DEBUG}"
else
export OUTPUT_DIR = ${PRO_DIR}/build/bk-bscp-${VERSION}
export LDVersionFLAG = "-X github.com/TencentBlueKing/bk-bscp/pkg/version.VERSION=${VERSION} \
-X github.com/TencentBlueKing/bk-bscp/pkg/version.BUILDTIME=${BUILDTIME} \
-X github.com/TencentBlueKing/bk-bscp/pkg/version.GITHASH=${GITHASH} \
-X github.com/TencentBlueKing/bk-bscp/pkg/version.DEBUG=${DEBUG}"
endif
include ./scripts/makefile/uname.mk
default: all
.PHONY: init
init:
@echo Download protoc
@mkdir -p ${PREFIX}/bin/proto
@cd ${PREFIX}/bin/proto && \
rm -rf protoc-*.zip* && \
wget -q https://github.com/protocolbuffers/protobuf/releases/download/v${PROTOC_VERSION}/protoc-${PROTOC_VERSION}-linux-x86_64.zip && \
unzip -o protoc-${PROTOC_VERSION}-linux-x86_64.zip && \
mv -f bin/protoc . && \
rm -rf protoc-*.zip* readme.txt bin include
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.35.2
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.3.0
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@v2.18.1
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@v2.27.1
@echo Download gotext
go install golang.org/x/text/cmd/gotext@v0.36.0
.PHONY: tidy
tidy:
go mod tidy -compat=1.17
pre:
@echo -e "\e[34;1mBuilding...\n\033[0m"
mkdir -p ${OUTPUT_DIR}
install: pre
@echo -e "\e[34;1mPackaging Install Tools...\033[0m"
mkdir -p ${OUTPUT_DIR}/install/
@cp -rf ${PRO_DIR}/scripts/install/start_all.sh ${OUTPUT_DIR}/install/
@cp -rf ${PRO_DIR}/scripts/install/stop_all.sh ${OUTPUT_DIR}/install/
@echo -e "\e[34;1mPackaging Install Tools Done\n\033[0m"
pb:
@echo -e "\e[34;1mFormat proto...\033[0m"
@find pkg/protocol -type f -name "*.proto"|xargs clang-format -i --style="{BasedOnStyle: Google, ColumnLimit: 120}"
@echo -e "\e[34;1mMake Protocol...\033[0m"
@cd pkg/protocol && make clean && make
@echo -e "\e[34;1mMake Protocol Done\n\033[0m"
api_docs:
@mkdir -p ${PREFIX}/docs/swagger
@protoc --proto_path=. --proto_path=internal/thirdparty/protobuf/ \
--openapiv2_out docs/swagger \
--openapiv2_opt allow_merge=true \
--openapiv2_opt preserve_rpc_order=true \
--openapiv2_opt merge_file_name=api \
--openapiv2_opt output_format=json \
--openapiv2_opt visibility_restriction_selectors=INTERNAL \
--openapiv2_opt visibility_restriction_selectors=BKAPIGW \
--openapiv2_opt use_go_templates=true pkg/protocol/config-server/*.proto
bkapigw_docs:
@mkdir -p ${PREFIX}/docs/swagger
@protoc --proto_path=. --proto_path=internal/thirdparty/protobuf/ \
--openapiv2_out docs/swagger \
--openapiv2_opt allow_merge=true \
--openapiv2_opt preserve_rpc_order=true \
--openapiv2_opt merge_file_name=bkapigw \
--openapiv2_opt output_format=json \
--openapiv2_opt visibility_restriction_selectors=BKAPIGW \
--openapiv2_opt use_go_templates=true pkg/protocol/config-server/*.proto
.PHONY: gen
gen:
@go run scripts/gen/main.go
# 与 .github/workflows/lint.yml 中 golangci-lint 版本保持一致
GOLANGCI_LINT_IMAGE ?= golangci/golangci-lint:v2.8.0
.PHONY: lint
lint:
@docker run --rm -v ${PRO_DIR}:/app -w /app ${GOLANGCI_LINT_IMAGE} \
sh -c "go mod download && golangci-lint run --issues-exit-code=0 --fix --timeout=5m"
test: pre
@cd test/suite && make && cp -rf suite-test ${OUTPUT_DIR}/ && rm -rf suite-test
@cd test/benchmark && make && cp -rf bench-test ${OUTPUT_DIR}/ && rm -rf bench-test
mock: pre
@cd ${PRO_DIR}/test/mock/repo && make
all: pre validate pb install test mock build_bscp
@echo -e "\e[34;1mBuild All Success!\n\033[0m"
server: validate
@echo -e "\e[34;1mMaking Server...\n\033[0m"
@echo "version: ${VERSION}" > ${OUTPUT_DIR}/VERSION
@cp -rf ${PRO_DIR}/server-CHANGELOG.md ${OUTPUT_DIR}
@mkdir -p ${OUTPUT_DIR}/install/
@mkdir -p ${OUTPUT_DIR}
@mkdir -p ${OUTPUT_DIR}/etc
@cd ${PRO_DIR}/cmd && make server
@echo -e "\e[34;1mMake Server All Success!\n\033[0m"
validate:
@if [ "$(VERSION)" != "" ];then \
if [[ "$(VERSION)" =~ ^(v[0-9]+.[0-9]+.[0-9]+){1}(-alpha[0-9]+)? ]];then \
echo "version: "$(VERSION); \
else \
exit 1; \
fi \
fi
clean:
@cd ${PRO_DIR}/cmd && make clean
@rm -rf ${PRO_DIR}/build
.PHONY: build_bscp
build_bscp:
@cd ${PRO_DIR}/cmd && make all
.PHONY: build_feed
build_feed:
@cd ${PRO_DIR}/cmd && make feed
.PHONY: build_vault
build_vault:
@cd ${PRO_DIR}/cmd && make vault
# 新 UI(ui)产出 ui/dist,供 embed.go 编译期嵌入
.PHONY: build_frontend_new
build_frontend_new:
@echo "tips: ensure you have installed Node.js 22.23.4 and npm"
cd ui; npm install --legacy-peer-deps; npm run build
# 旧 UI(ui_old)产出 ui_old/dist,供 embed.go 编译期嵌入
.PHONY: build_frontend_old
build_frontend_old:
@echo "tips: ensure you have installed Node.js 22.23.4 and npm"
cd ui_old; npm install --legacy-peer-deps; npm run build
# embed.go 编译期同时嵌入 ui/dist 与 ui_old/dist,故默认前端构建必须产出新旧两套,
# 避免调用方漏构建其一导致 build_bscp 报 go:embed 找不到文件
.PHONY: build_frontend
build_frontend: build_frontend_new build_frontend_old
.PHONY: build_ui
build_ui:
@echo -e "\e[34;1mTips: ensure you have execute 'make build_frontend' first\033[0m"
${GOBUILD} -ldflags ${LDVersionFLAG} -o ${OUTPUT_DIR}/bk-bscp-ui/bk-bscp-ui ./cmd/ui
.PHONY: docker
docker:
@docker build -t bk-bscp-hyper:latest .
.PHONY: i18n
i18n:
@go generate ./internal/i18n/translations/translations.go
@cp ./internal/i18n/translations/locales/zh/out.gotext.json ./internal/i18n/translations/locales/zh/messages.gotext.json
${swag}:
@echo ">> downloading swag"
@mkdir -p ${PREFIX}/bin
@wget -q -O ${swag} https://github.com/ifooth/swag/releases/download/v1.16.4-r1/swag && chmod a+x ${swag}
${swagger}:
@echo ">> downloading swagger"
@mkdir -p ${PREFIX}/bin
@wget -q -O ${swagger} https://github.com/ifooth/go-swagger/releases/download/v0.31.0-r1/swagger && chmod a+x ${swagger}
.PHONY: normalize_proto_docs
normalize_proto_docs:
# 修正swagger.json中的default值(字符串布尔 -> JSON布尔)
sed -i 's/"default": "false"/"default": false/g' ./docs/swagger/bkapigw.swagger.json
sed -i 's/"default": "true"/"default": true/g' ./docs/swagger/bkapigw.swagger.json
sed -i 's/"default": "false"/"default": false/g' ./docs/swagger/api.swagger.json
sed -i 's/"default": "true"/"default": true/g' ./docs/swagger/api.swagger.json
# 修正query参数中不合法的type: object(改为type: string)
sed -i '/"in": "query"/,/}/{s/"type": "object"/"type": "string"/}' ./docs/swagger/api.swagger.json
sed -i '/"in": "query"/,/}/{s/"type": "object"/"type": "string"/}' ./docs/swagger/bkapigw.swagger.json
# 修正递归引用(API网关不支持递归解析),去除pbctBizTopoNode自引用
@for f in ./docs/swagger/api.swagger.json ./docs/swagger/bkapigw.swagger.json; do \
python3 -c "import json,sys;f=sys.argv[1];d=json.load(open(f));n=d.get('definitions',{}).get('pbctBizTopoNode',{}).get('properties',{}).get('child',{});n['items']={'type':'object','description':'recursive child node'};json.dump(d,open(f,'w'),ensure_ascii=False,indent=2);print(f+' fixed')" "$$f"; \
done
.PHONY: markdown_docs
markdown_docs: ${swag} ${swagger} normalize_proto_docs
${swag} fmt -d ./cmd
${swag} init -g ./cmd/api-server/api_server.go --parseDependency --parseInternal --outputTypes json,json -o ./docs/swagger/apiserver
${swagger} validate ./docs/swagger/bkapigw.swagger.json
# 合并bkapigw和apiserver的swagger.json
$(swagger) mixin ./docs/swagger/bkapigw.swagger.json ./docs/swagger/apiserver/swagger.json -o ./docs/swagger/bkapigw/swagger.json
@python3 $(INJECT_SCRIPT) ./docs/swagger/bkapigw/swagger.json
${swagger} generate markdown --output=bkapigw_swagger.md -T ./docs/swagger -f ./docs/swagger/bkapigw/swagger.json -t ./docs/swagger/bkapigw
.PHONY: docs
docs: api_docs bkapigw_docs markdown_docs
.PHONY: push-image
push-image:
@if [ "${SKIP_FRONTEND_BUILD}" != "true" ]; then \
echo -e "\e[34;1mBuilding frontend (new + old)...\033[0m"; \
$(MAKE) build_frontend; \
else \
echo -e "\e[33;1mSkipping frontend build as SKIP_FRONTEND_BUILD=true\033[0m"; \
fi
$(MAKE) build_bscp
docker build -t ${REPO}/bk-bscp-hyper:${TAG} . --push