-
Notifications
You must be signed in to change notification settings - Fork 10
/
commit-msg
496 lines (452 loc) · 16.5 KB
/
commit-msg
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
#!/bin/bash
### commit message helper
### luohao@uama.com.cn 2018 v0.1.0
#######################################################################
### <type>(<scope>): <subject>
### <BLANK LINE>
### <body>
### <BLANK LINE>
### <footer>
#######################################################################
### allowed type:
### feat:
### 新的功能特性
### a new feature
### fix:
### BUG修复
### a bug fix
### docs:
### 文档更新
### Documentation only changes
### style:
### 与代码逻辑无关的样式修改(空格、格式、句尾结束符等)
### Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
### refactor:
### 代码重构,但与修复bug或者新功能无关
### A code change that neither fixes a bug nor adds a feature
### perf:
### 性能优化
### A code change that improves performance
### test:
### 测试用例
### Adding missing tests
### chore:
### 工程化更新(编译脚本、辅助工具等)
### Changes to the build process or auxiliary tools and libraries such as documentation generation
#######################################################################
### fix(#9527-1-2,#9528,@9900-2,@9000): SUBJECT TITLE
###
### contents line1....
### contents line2....
###
### footer line...
#######################################################################
### TODO:
### nothing.
#######################################################################
set -u
set -e
ZT_HOST=""
ZT_USER=""
ZT_PASS=""
DEBUG_LEVEL=1
COMMIT_MSG_FILE=$1
COMMIT_CONTENT=
ENCODE_CONTENT=
COMMIT_FIRST_LINE=
COMMIT_TOTAL_LINE=
COMMIT_SUBJECT=
COMMIT_TYPE=
COMMIT_SCOPE=
SCOPE_TASKS=
SCOPE_TASKS_NUM=
SCOPE_TASK_TYPE=
SCOPE_TASK_PARAM=
SCOPE_TASK_PARAMS=
ZT_LOGIN_OK=
ZT_SESSION=
ZT_SESSION_NAME=
_URL=
_RST=
_URL_CONTENT_TYPE="content-type: application/x-www-form-urlencoded"
ERR_SESSION_RST="[ERROR]101: Get session request error"
ERR_SESSION_DATA="[ERROR]102: Get session result error"
ERR_LOGIN="[ERROR]103: Shit happened when login to zentao with your account, please check account and password in this hook script [prepare-commit-msg] ."
ERR_NO_FILE="[ERROR]105: Commit message file not exist"
ERR_MSG_EMPTY="[ERROR]106: Commit message can not empty"
ERR_MSG_FIRST_EMPTY="[ERROR]107: First line can not empty"
ERR_MSG_LAST_PERIOD="[ERROR]108: Do not end the subject line with a period"
ERR_MSG_BLANK_LINE="[ERROR]109: Separate subject from body with a blank line"
ERR_MSG_TITLE_FORMAT="[ERROR]110: Title line bad format!\r\n<Type>(<Scope>): title\r\nType: feat|fix|docs|style|refactor|perf|test|chore\r\nScope: #taskid | #taskid-usedhours-lefthours | @bugid | @bugid-usedhours\r\nFinish Task Example: \r\nfeat(#1122): title content\r\n\r\ncontent description"
ERR_DEBUG="[ERROR]200: Debug breaking..."
#######################################################################
# util functions
#######################################################################
# remove \" in json, and echo value for given key
_parse_json(){
echo "${1//\\\"/}" | sed "s/.*$2:\([^,}]*\).*/\1/"
}
# simple url encode
_url_encode(){
# echo "$1" | tr -d '\n' | xxd -plain | sed 's/\(..\)/%\1/g'
# echo "$1" | tr -d '\n' | od -An -tx1 | tr ' ' %
# _UE_P=$(python -c "import urllib; print urllib.quote('''$1''')")
_UE_P="$(perl -MURI::Escape -e 'print uri_escape(join(" ",@ARGV));' "$1")"
echo $_UE_P
}
# ouput more info when in debug mode
_curl_bin(){
if [[ $DEBUG_LEVEL -gt 2 ]]; then
echo "curl -k -X"
else
echo "curl -s -k -X"
fi
}
_date_time(){
echo -e `date "+%Y-%m-%d %H:%M:%S"`
}
_date_fmt(){
echo -e `date "+%Y-%m-%d"`
}
log_error_exit(){
echo -e "$(log_title) [ERROR] $@"
exit 1
}
log_info(){
if [[ $DEBUG_LEVEL -gt 0 ]]; then
echo -e "$(log_title) [INFO] $@"
fi
}
log_debug(){
if [[ $DEBUG_LEVEL -gt 1 ]]; then
echo -e "$(log_title) [DEBUG] $@"
fi
}
log_title(){
if [[ $DEBUG_LEVEL -gt 1 ]]; then
echo -e "$(_date_time) (GITBOT)"
else
echo -e "(GITBOT)"
fi
}
#####################################################################
# validator
validator(){
log_debug "validator..."
# 日志信息文件存在
if [ ! -f "$COMMIT_MSG_FILE" ]; then
log_error_exit ${ERR_NO_FILE}
fi
# 读取提交消息内容
COMMIT_CONTENT=`cat ${COMMIT_MSG_FILE}`
ENCODE_CONTENT=$(_url_encode "$COMMIT_CONTENT")
COMMIT_FIRST_LINE=`echo "${COMMIT_CONTENT}" | head -1`
COMMIT_TOTAL_LINE=`echo "${COMMIT_CONTENT}" | wc -l`
validate_base_format
if [[ ${ZT_HOST} == "" || ${ZT_USER} == "" || ${ZT_PASS} == "" ]]; then
log_info "zentao config error, skip scope magic."
else
validate_scope_message
fi
}
validate_base_format(){
# 校验整体格式是否合规
##########################################################
# 1. 禁止空提交
if [[ ${#COMMIT_CONTENT} -lt 1 ]]; then
log_error_exit ${ERR_MSG_EMPTY}
fi
# 2.第一行不能为空
if [[ ${#COMMIT_FIRST_LINE} -lt 1 ]]; then
log_error_exit ${ERR_MSG_FIRST_EMPTY}
fi
# 3. 标题行不能以.结尾
if [[ ${COMMIT_FIRST_LINE} =~ ^.*\.$ ]]; then
log_error_exit ${ERR_MSG_LAST_PERIOD}
fi
# 4. 如果有提交正文说明,则检测标题行与正文之间必须要有空行
if [[ ${COMMIT_TOTAL_LINE} -gt 1 ]]; then
COMMIT_2D_LINE=`echo "${COMMIT_CONTENT}" | head -n 2 | tail -n 1`
# log_debug "2d line: ${COMMIT_2D_LINE}"
if [[ ${#COMMIT_2D_LINE} -gt 0 ]]; then
log_error_exit ${ERR_MSG_BLANK_LINE}
fi
fi
# 5. 检测第一行格式是否正确: Type(scope): title
if [[ ${COMMIT_FIRST_LINE} =~ ^(feat|fix|docs|style|refactor|perf|test|chore)([\(]?[0-9\#\@\,\-]*[\)]?)[[:blank:]]?:[[:blank:]]?(.*)$ ]]; then
COMMIT_TYPE=${BASH_REMATCH[1]}
COMMIT_SCOPE=${BASH_REMATCH[2]}
COMMIT_SUBJECT=${BASH_REMATCH[3]}
else
log_error_exit ${ERR_MSG_TITLE_FORMAT}
fi
}
# 校验socpe格式,处理多个任务
validate_scope_message(){
if [[ ${#COMMIT_SCOPE} -lt 1 ]]; then
log_info "no scope to process"
# validate scope format and get scope content
elif [[ ${COMMIT_SCOPE} =~ ^\(([\#\@][0-9\#\@\,\-]*)\)$ ]]; then
COMMIT_SCOPE_CONTENT=${BASH_REMATCH[1]}
if [[ ${#COMMIT_SCOPE_CONTENT} -lt 2 ]]; then
log_error_exit "scope bad format less 2 ${COMMIT_SCOPE_CONTENT}"
fi
# split to task array
SCOPE_TASKS=(${COMMIT_SCOPE_CONTENT//,/ })
# log_debug "SCOPE_TASKS ${SCOPE_TASKS}"
SCOPE_TASKS_NUM=${#SCOPE_TASKS[@]}
# log_debug "SCOPE_TASKS_NUM ${SCOPE_TASKS_NUM}"
for ((i=0;i<$SCOPE_TASKS_NUM;i++)); do
if [[ ${#SCOPE_TASKS[i]} -lt 2 ]]; then
log_info "scope task bad format less 2 ${SCOPE_TASKS[i]}"
else
log_debug "task: ${SCOPE_TASKS[i]}"
process ${SCOPE_TASKS[i]}
fi
done
else
log_info "scope bad format ${COMMIT_SCOPE}"
fi
}
#####################################################################
# process tasks
process(){
# get first chactor
SCOPE_TASK_TYPE=`echo ${1:0:1}`
# log_debug "task type: ${SCOPE_TASK_TYPE}"
# 截取除第一个字符的余下字符串
SCOPE_TASK_PARAM=${1:1}
if [[ ${SCOPE_TASK_PARAM} =~ ^[0-9]+-*[0-9]*-*[0-9]*$ ]]; then
# log_debug "task param: ${SCOPE_TASK_PARAM}"
# 按 - 分隔获取所有参数 第一个为任务编号,第二个为所用时间,第三个为剩余时间
SCOPE_TASK_PARAMS=(${SCOPE_TASK_PARAM//-/ })
# log_debug "task params: ${SCOPE_TASK_PARAMS}"
# 处理bug
if [[ "$SCOPE_TASK_TYPE" == "@" ]]; then
if [[ ${#SCOPE_TASK_PARAMS[@]} == 1 ]]; then
log_debug "process_bug_finish ${SCOPE_TASK_PARAMS[0]}"
process_bug_finish ${SCOPE_TASK_PARAMS[0]}
elif [[ ${#SCOPE_TASK_PARAMS[@]} == 2 ]]; then
log_debug "process_bug_log ${SCOPE_TASK_PARAMS[0]} ${SCOPE_TASK_PARAMS[1]}"
process_bug_log ${SCOPE_TASK_PARAMS[0]} ${SCOPE_TASK_PARAMS[1]}
else
log_info "bad bug params number, 1 or 3 only"
fi
# 处理任务
elif [[ "$SCOPE_TASK_TYPE" == "#" ]]; then
if [[ ${#SCOPE_TASK_PARAMS[@]} == 1 ]]; then
log_debug "process_feature_finish ${SCOPE_TASK_PARAMS[0]}"
process_feature_finish ${SCOPE_TASK_PARAMS[0]}
elif [[ ${#SCOPE_TASK_PARAMS[@]} == 3 ]]; then
log_debug "process_feature_log ${SCOPE_TASK_PARAMS[0]} ${SCOPE_TASK_PARAMS[1]} ${SCOPE_TASK_PARAMS[2]}"
process_feature_log ${SCOPE_TASK_PARAMS[0]} ${SCOPE_TASK_PARAMS[1]} ${SCOPE_TASK_PARAMS[2]}
else
log_info "bad feature params number, 1 or 3 only"
fi
else
log_info "unknow task type, # or @ only"
fi
else
log_info "task format error ${SCOPE_TASK_PARAM}"
fi
}
#######################################################################
# 记录禅道任务日志 TODO
process_bug_log(){
log_debug "process bug log $1 $2"
# 执行登录,如果已经登录则忽略
do_login
# 发送记录禅道任务日志的请求
_URL="${ZT_HOST}/effort-createForObject-bug-${1}.json?onlybody=yes&${ZT_SESSION_NAME}=${ZT_SESSION}"
log_debug ${_URL}
_URL_FORM_DATA="id%5B1%5D=1&dates%5B1%5D=$(_date_fmt)&objectType%5B1%5D=bug&objectID%5B1%5D=${1}&consumed%5B1%5D=${2}&work%5B1%5D=${ENCODE_CONTENT}"
_RST=`$(_curl_bin) POST "${_URL}" -H "${_URL_CONTENT_TYPE}" -d "${_URL_FORM_DATA}"`
log_debug ${_RST}
if echo "${_RST}" | grep -w "login" &>/dev/null; then
log_info "post new log for bug[${1}] error"
fi
log_info "post log for bug[${1}] OK"
}
# 完成禅道bug TODO
process_bug_finish(){
log_debug "process bug finish $1"
# 执行登录,如果已经登录则忽略
do_login
# 获取禅道BUG解决所需的信息 用时、抄送
_URL="${ZT_HOST}/bug-resolve-${1}.json?onlybody=yes&${ZT_SESSION_NAME}=${ZT_SESSION}"
# get infomations that finish task needed.
_RST=`$(_curl_bin) GET "${_URL}"`
if echo "${_RST}" | grep -vw "success" &>/dev/null; then
log_info "do resolve bug[${1}] error, unknow reason"
fi
# log_debug ${_RST}
CON_FINISH_ASSIGNED=$(_parse_json "${_RST}" "assignedTo")
# 发送完成禅道任务的请求
_URL_FORM_DATA="resolution=fixed&assignedTo=${CON_FINISH_ASSIGNED}&resolvedDate=$(_date_fmt)&comment=${ENCODE_CONTENT}"
_RST=`$(_curl_bin) POST "${_URL}" -H "${_URL_CONTENT_TYPE}" -d "${_URL_FORM_DATA}"`
log_debug ${_RST}
if echo "${_RST}" | grep -w "login" &>/dev/null; then
log_info "do resolve bug[${1}] error, need login"
fi
}
#######################################################################
# 记录禅道任务日志
process_feature_log(){
log_debug "process feature log $1 $2 $3"
# 执行登录,如果已经登录则忽略
do_login
# 发送记录禅道任务日志的请求
_URL="${ZT_HOST}/effort-createForObject-task-${1}.json?onlybody=yes&${ZT_SESSION_NAME}=${ZT_SESSION}"
log_debug ${_URL}
_URL_FORM_DATA="id%5B1%5D=1&dates%5B1%5D=$(_date_fmt)&objectType%5B1%5D=task&consumed%5B1%5D=${2}&left%5B1%5D=${3}&objectID%5B1%5D=${1}&work%5B1%5D=${ENCODE_CONTENT}"
log_debug $_URL_FORM_DATA
_RST=`$(_curl_bin) POST "${_URL}" -H "${_URL_CONTENT_TYPE}" -d "${_URL_FORM_DATA}"`
log_debug ${_RST}
if echo "${_RST}" | grep -w "login" &>/dev/null; then
log_info "post new log for task[${1}] error"
fi
log_info "post log for task[${1}] OK"
}
# 完成禅道任务
process_feature_finish(){
log_debug "process feature finish $1"
# 执行登录,如果已经登录则忽略
do_login
# 获取禅道任务完成所需的信息 用时、抄送
_URL="${ZT_HOST}/task-finish-${1}.json?onlybody=yes&${ZT_SESSION_NAME}=${ZT_SESSION}"
# get infomations that finish task needed.
_RST=`$(_curl_bin) GET "${_URL}"`
if echo "${_RST}" | grep -vw "success" &>/dev/null; then
log_info "do finish task[${1}] error, unknow reason"
fi
# log_debug ${_RST}
CON_FINISH_CONSUMED=$(_parse_json "${_RST}" "consumed")
CON_FINISH_ASSIGNED=$(_parse_json "${_RST}" "assignedTo")
# 发送完成禅道任务的请求
_URL_FORM_DATA="consumed=${CON_FINISH_CONSUMED}&assignedTo=${CON_FINISH_ASSIGNED}&finishedDate=$(_date_fmt)&comment=${ENCODE_CONTENT}"
_RST=`$(_curl_bin) POST "${_URL}" -H "${_URL_CONTENT_TYPE}" -d "${_URL_FORM_DATA}"`
log_debug ${_RST}
if echo "${_RST}" | grep -w "login" &>/dev/null; then
log_info "do finish task[${1}] error, need login"
fi
}
#######################################################################
# 登录禅道
do_login(){
if [[ ${ZT_LOGIN_OK} == 1 ]]; then
log_debug "already login"
else
do_get_session
log_debug "login action begin"
_URL="${ZT_HOST}/user-login.json?onlybody=yes&${ZT_SESSION_NAME}=${ZT_SESSION}"
_RST=`$(_curl_bin) POST "${_URL}" -H "cache-control: no-cache" -H "content-type: application/x-www-form-urlencoded" -d "account=${ZT_USER}&password=${ZT_PASS}&keepLogin=on"`
if echo "${_RST}" | grep -vw "success" &>/dev/null; then
ZT_LOGIN_OK=0
log_error_exit $ERR_LOGIN
else
ZT_LOGIN_OK=1
log_info "Login zentao OK [ ${ZT_USER} ]"
fi
fi
}
# 获取登录session
do_get_session(){
log_debug "get session action begin"
_RST=`$(_curl_bin) GET $ZT_HOST/api-getsessionid.json`
if echo "${_RST}" | grep -vw "success" &>/dev/null; then
log_error_exit ${ERR_SESSION_RST}
fi
ZT_SESSION_NAME=$(_parse_json $_RST "sessionName")
log_debug "GET SESSION NAME: $ZT_SESSION_NAME"
ZT_SESSION=$(_parse_json $_RST "sessionID")
log_debug "GET SESSION ID: $ZT_SESSION"
if [[ $ZT_SESSION_NAME == "" || $ZT_SESSION == "" ]]; then
log_error_exit ${ERR_SESSION_DATA}
fi
}
# rawurlencode() {
# local string="${1}"
# local strlen=${#string}
# local encoded=""
# local pos c o
# for (( pos=0 ; pos<strlen ; pos++ )); do
# c=${string:$pos:1}
# case "$c" in
# [-_.~a-zA-Z0-9] ) o="${c}" ;;
# # * ) printf -v o '%%%02x' "'$c"
# * ) o=`echo "$c" | tr -d '\n' | xxd -plain | sed 's/\(..\)/%\1/g'`
# esac
# encoded+="${o}"
# done
# echo "${encoded}" # You can either set a return variable (FASTER)
# # REPLY="${encoded}" #+or echo the result (EASIER)... or both... :p
# }
# perl_en(){
# echo $(echo "$1" | sed -e 's/%/%25/g' -e 's/ /%20/g' -e 's/!/%21/g' -e 's/"/%22/g' -e 's/#/%23/g' -e 's/\$/%24/g' -e 's/\&/%26/g' -e 's/'\''/%27/g' -e 's/(/%28/g' -e 's/)/%29/g' -e 's/\*/%2a/g' -e 's/+/%2b/g' -e 's/,/%2c/g' -e 's/-/%2d/g' -e 's/\./%2e/g' -e 's/\//%2f/g' -e 's/:/%3a/g' -e 's/;/%3b/g' -e 's//%3e/g' -e 's/?/%3f/g' -e 's/@/%40/g' -e 's/\[/%5b/g' -e 's/\\/%5c/g' -e 's/\]/%5d/g' -e 's/\^/%5e/g' -e 's/_/%5f/g' -e 's/`/%60/g' -e 's/{/%7b/g' -e 's/|/%7c/g' -e 's/}/%7d/g' -e 's/~/%7e/g')
# }
# urlEncode(){
# encoded_str=`echo "$*" | awk '
# BEGIN {
# split ("1 2 3 4 5 6 7 8 9 A B C D E F", hextab, " ")
# hextab [0] = 0
# for ( i=1; i<=255; ++i ) ord [ sprintf ("%c", i) "" ] = i + 0
# }
# {
# encoded = ""
# for ( i=1; i<=length ($0); ++i ) {
# c = substr ($0, i, 1)
# if ( c ~ /[a-zA-Z0-9.-]/ ) {
# encoded = encoded c # safe character
# } else if ( c == " " ) {
# encoded = encoded "+" # special handling
# } else {
# # unsafe character, encode it as a two-digit hex-number
# lo = ord [c] % 16
# hi = int (ord [c] / 16);
# encoded = encoded "%" hextab [hi] hextab [lo]
# }
# }
# print encoded
# }
# ' `
# }
# urlencodeaaa() {
# # urlencode <string>
# # old_lang=$LANG
# # LANG=C
# # old_lc_collate=$LC_COLLATE
# # LC_COLLATE=C
# local length="${#1}"
# for (( i = 0; i < length; i++ )); do
# local c="${1:i:1}"
# case $c in
# [a-zA-Z0-9.~_-]) printf "$c" ;;
# *) printf '%%%02X' "'$c" ;;
# esac
# done
# # LANG=$old_lang
# # LC_COLLATE=$old_lc_collate
# }
# test_run(){
# COMMIT_CONTENT=`cat ${COMMIT_MSG_FILE}`
# DD="work[1]=${COMMIT_CONTENT}"
# DD="id[1]=1&dates[1]=$(_date_fmt)&objectType[1]=task&consumed[1]=11&left[1]=11&objectID[1]=11&work[1]=${COMMIT_CONTENT}"
# D="style (#9761-1-1): 中中"
# log_debug $D
# log_debug $D_D
# log_debug $D_DD
# D_D="$(perl -MURI::Escape -e 'print uri_escape(join(" ",@ARGV));' "$D")"
# log_debug $D_D
# log_debug $(_url_encode $D)
# log_debug $(urlencodeaaa $DD)
# urlEncode $D
# log_debug $encoded_str
# }
#######################################################################
main(){
validator
# test_run
# log_error_exit "main->${ERR_DEBUG}"
}
main
exit 0