通过Git WebHooks+脚本实现自动更新发布代码之Shell脚本(二)

简介:

依据前文《通过Git WebHooks+脚本实现自动更新发布代码》的解决方案编写的shell脚本,此脚本专门用于更新补丁文件,例如对项目中的文件实现增(add)、删(remove)、改(update),并且执行相关的命令,如清除缓存、重启服务等。

  此Shell脚本目前设计成在本地执行,目前不适合分布式执行的情况。也就是说,此脚本最好与项目在同一个机器上,这个缺陷已经标注在脚本中了,参见脚本中的多个TODO。

  脚本完成的工作:

  • 检查配置文件合规性

  • 备份与恢复

  • 增删改文件

  • 执行命令

  • 失败回滚

  除上述完成的功能外,因为不同的项目其用到的命令或所需要执行的操作以及检查成功与否大有不同,因此其他的功能需要可以继续往上添加,需要的可以自行修改此脚本。此脚本仅作参考之用,欢迎提出改进意见、批评指正。

  此脚本可以略做修改,与前文《通过Git WebHooks+脚本实现自动更新发布代码之shell脚本》提到的部署脚本一起联用。后期改进请关注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
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/env bash
 
# Public header
# =============================================================================================================================
 
# Check that we are root ... so non-root users stop here
[  ` id  -u` - eq   "0"  ] ||   exit  4
 
# resolve links - $0 may be a symbolic link
PRG= "$0"
 
while  [ -h  "$PRG"  ];  do
   ls =` ls  -ld  "$PRG" `
   link=` expr  "$ls"  '.*-> \(.*\)$' `
   if  expr  "$link"  '/.*'  /dev/null then
     PRG= "$link"
   else
     PRG=` dirname  "$PRG" `/ "$link"
   fi
done
 
# Get standard environment variables
PRGDIR=` dirname  "$PRG" `
 
 
# echo color function
function  cecho {
     # Usage:
     # cecho -red sometext     #Error, Failed
     # cecho -green sometext   # Success
     # cecho -yellow sometext  # Warning
     # cecho -blue sometext    # Debug
     # cecho -white sometext   # info
     # cecho -n                # new line
     # end
 
     while  "$1"  ];  do
         case  "$1"  in
             -normal)        color= "\033[00m"  ;;
# -black)         color="\033[30;01m" ;;
-red)           color= "\033[31;01m"  ;;
-green)         color= "\033[32;01m"  ;;
-yellow)        color= "\033[33;01m"  ;;
-blue)          color= "\033[34;01m"  ;;
# -magenta)       color="\033[35;01m" ;;
# -cyan)          color="\033[36;01m" ;;
-white)         color= "\033[37;01m"  ;;
-n)             one_line=1;    shift  continue  ;;
*)               echo  -n  "$1" shift  continue  ;;
esac
 
shift
echo  -en  "$color"
echo  -en  "$1"
echo  -en  "\033[00m"
shift
 
done
if  [ ! $one_line ];  then
         echo
fi
}
# end echo color function
 
# echo color function, smarter
function  echo_r () {
     #Error, Failed
     [ $ # -ne 1 ] && return 0
     echo  -e  "\033[31m$1\033[0m"
}
function  echo_g () {
     # Success
     [ $ # -ne 1 ] && return 0
     echo  -e  "\033[32m$1\033[0m"
}
function  echo_y () {
     # Warning
     [ $ # -ne 1 ] && return 0
     echo  -e  "\033[33m$1\033[0m"
}
function  echo_b () {\
     # Debug
     [ $ # -ne 1 ] && return 0
     echo  -e  "\033[34m$1\033[0m"
}
# end echo color function, smarter
 
WORKDIR=$PRGDIR
# end public header
# =============================================================================================================================
 
# begin customization for special case
# project directory to waiting for update
config_project_dir=example_projects
# resources directory which contain config file and update files
config_resources_dir=example_resources
config_config_file=$config_resources_dir /config_update .conf
config_backup_dir=example_backup_dir
# log options
config_this_logfile=$WORKDIR/.update_backup.log
# end
 
function  check_dependencies(){
     echo_b  "Checking dependencies for update procedure. "
 
     if  [ -z $config_project_dir ];  then
         echo_r  "Error: config_project_dir is undefined! "
         exit  1
     fi
 
     if  [ ! -d $config_resources_dir ];  then
         echo_r  "Error: config_resources_dir is undefined! "
     fi
 
     if  [ -z $config_config_file ];  then
         echo_r  "Error: config_config_file is undefined! "
         exit  1
     fi
 
     left_disk_space=` df  $config_backup_dir |  tail  -n1 |  awk  '{print $(NF -2)}' `
     # set 2097152 to project directory size
     if  [ -z $config_project_dir -o ! -d $config_project_dir ];  then
         project_file_space_usage=$( du  -s  /root  awk  '{print $1}' )
         required_size=$( expr  $project_file_space_usage \* 2)
     fi
     if  [[ $left_disk_space -lt $required_size ]];  then
         echo_r  "Disk space of $config_backup_dir is smaller than $required_size. "
         exit  1
     fi
 
     echo_g  "All required dependencies check pass! "
 
}
 
function  test_self(){
     # How to use this function:
     # First execute "$0 test_self", then execute "$0 update"
 
     echo_b  "Test purpose begin. "
 
     # clean old test example
     echo_b  "Clean old test example. "
     [ -d $WORKDIR /example_projects  ] &&  rm  -rf $WORKDIR /example_projects
     [ -d $WORKDIR /example_resources  ] &&  rm  -rf $WORKDIR /example_resources
     [ -d $WORKDIR /example_backup_dir  ] &&  rm  -rf $WORKDIR /example_backup_dir
 
     # make an example project directory
     if  [ -z $config_project_dir -o ! -d $config_project_dir ];  then
         echo_b  "Making an example project directory. "
         mkdir  $WORKDIR /example_projects
         config_project_dir=example_projects
         # Padding example_projects directory
         touch  $config_project_dir /example_filename
         mkdir  $config_project_dir /example_directory
     fi
 
     # make an example resources directory
     if  [ -z $config_resources_dir -o ! -d $config_resources_dir ];  then
         echo_b  "Making an example resources directory. "
         mkdir   $WORKDIR /example_resources
         config_resources_dir=$WORKDIR /example_resources
     fi
 
     # make an example config_update.conf
     if  [ -z $config_config_file -o ! -f $config_config_file ];  then
         echo_b  "Making an example config_update.conf file. "
         touch  $config_resources_dir /config_update .conf
         config_config_file=$config_resources_dir /config_update .conf
     # Padding config_update.conf file
     cat  >$config_config_file <<eof
file     filename1          add
file     filename2          remove
file     filename3          update
file     filename4          add
config  cleancachea              enable
config  cleancacheb             disable
config  restartservicea          enable
config  restartserviceb         disable
target  192.168.1.241            ssh
target  192.168.1.242            ssh
eof
     files=` awk  -F  '[ ]+'  '/^file/ { print $2 }'  $config_config_file`
     echo_b  "Making an example files(patches) refer to $config_config_file. "
     for  names  in  $files;  do
         [ ! -f $config_resources_dir/$names ] &&  touch  $config_resources_dir/$names
     done
     fi
 
     # TODO
     # test network and ssh for remote call
 
     # make an example backup directory
     if  [ -z $config_backup_dir -o ! -d $config_backup_dir ];  then
         echo_b  "Making an example backup directory"
         mkdir  $WORKDIR /example_backup_dir
         config_backup_dir=$WORKDIR /example_backup_dir
     fi
 
     echo_g  "Test purpose is finished and successfully! "
}
 
#function parse_config_file(){
#    # unbanned action
#    files=`awk -F '[ ]+' '/^file/ { print $2 }' $config_config_file`
#    configs=`awk -F '[ ]+' '/^config/ { print $2 }' $config_config_file`
#}
 
function  do_cp(){
     SOURCE=$1
#    echo "var: $SOURCE"
#    echo "result: $(dirname $SOURCE | grep ^\/ | awk '{print substr($1,1,1)}' )"
#    exit 0
     if  test  "$(dirname $SOURCE | grep ^\/ | awk '{print substr($1,1,1)}')"  ==  "" then
         echo_b  "Execute copy action. "
         DEST=$config_project_dir/$SOURCE
         \ cp  $SOURCE $DEST
     else
         echo_y  "Self test purpose found! But we can do this action! "
         [ ! -d $config_project_dir/$( dirname  $SOURCE) ] &&  mkdir  -p $config_project_dir/$( dirname  $SOURCE)
         \ cp  $SOURCE $config_project_dir/$( dirname  $SOURCE)
     fi
}
function  do_remove(){
     FILE=$1
     if  test  "$(dirname $SOURCE | awk -F '/' '{print $1}')"  ==  "" then
         rm  -rf $config_project_dir/$FILE
     else
         echo_y  "Self test purpose found! This can NOT do remove action on self test purpose, skipping..."
         return
     fi
 
}
 
# TODO
# for remote call
#function do_remote_cp(){}
#function fo_remote_remove(){}
 
function  file_operation(){
     echo_b  "Begin files operations"
     files=` awk  -F  '[ ]+'  '/^file/ { print $2 }'  $config_config_file`
     for  names  in  $files;  do
         if  grep  $names $config_config_file |  grep  add > /dev/null  2>&1 ;  then
             # do_cp
             do_cp $names
         elif  grep  $names $config_config_file |  grep  update > /dev/null  2>&1 ; then
             # do_cp
             do_cp $names
         elif  grep  $names $config_config_file |  grep  remove > /dev/null  2>&1 ; then
             # do_remove
             do_remove $names
         else
             exit  1
         fi
     done
     echo_g  "Files operations finished successfully! "
}
 
# TODO
# no example here, please refer to your real production environment
#function do_clean_cache(){}
#function do_restart_service(){}
 
function  service_operation(){
     echo_b  "Begin services operations"
     configs=` awk  -F  '[ ]+'  '/^config/ { print $2 }'  $config_config_file`
     for  names  in  $configs;  do
         if  grep  $names $config_config_file |  grep  cleancache |  grep  enable  > /dev/null  2>&1 ;  then
             # do_clean_cache
             echo  do_clean_cache $names
         elif  grep  $names $config_config_file |  grep  cleancache |  grep  disable > /dev/null  2>&1 ;  then
             # echo a warning
             echo_y  "Warning: disable action is NOT recommended, $names skipped."
         elif  grep  $names $config_config_file |  grep  restartservice |  grep  enable  > /dev/null  2>&1 ;  then
             # do_restart_service
             echo  do_restart_service $names
         elif  grep  $names $config_config_file |  grep  restartservice |  grep  disable > /dev/null  2>&1 ;  then
             # echo a warning
             echo_y  "Warning: disable action is NOT recommended, $names skipped."
         else
             echo  $names
             echo_r  "Error: Wrong config file $config_config_file, please check it. "
             exit  1
         fi
     done
     echo_g  "Services operations finished successfully! "
}
 
function  check_remote_server_status(){
     # TODO
     # for remote call
     echo
 
}
 
function  backup(){
     echo_b  "Backup files before update"
#    backup_filename=backup_$(date +%F_%H_%M_%S).tgz
     backup_filename=backup_$( date  +%Y_%m_%d_%H_%M_%S).tgz
     tar  --create -- gzip  --absolute-names -- file =$config_backup_dir/$backup_filename $config_project_dir
     if  [ $? - eq  0 ];  then
         echo_g  "Backup files before update finished and successfully! "
         echo  "restore_least_file=$config_backup_dir/$backup_filename"  > $config_this_logfile
     else
         echo_r  "Error: Backup files before update failed! Please alter to administrator. "
         exit  1
     fi
 
}
 
function  restore(){
     echo_b  "Restore files for rollback"
     if  [ -f $config_this_logfile ];  then
         . $config_this_logfile
     fi
     restore_least_file=${restore_least_file:-1}
     if  [ -s $restore_least_file ];  then
         tar  -C $config_project_dir/.. -zxf $restore_least_file
         if  [ $? - eq  0 ];  then
             echo_g  "Restore files finished and successfully! "
         else
             echo_r  "Restore files failed! Please alter to administrator. "
             exit  1
         fi
     else
         echo_r  "Can NOT find backup files in $config_backup_dir, backup once indeed? "
         exit  1
     fi
 
}
 
# TODO
# for remote call
# function remote_backup(){}
# function remote_restore(){}
 
 
function  rollback(){
     echo_b  "rollback after update failed"
     $0 restore
 
     echo_g  "rollback finished and successfully! "
}
 
function  update_status(){
     # TODO
     # no example here, please refer to your real production environment
     # check if update success or failure
     echo  update_status
     # if failure, do rollback action
         # service_operation
}
 
function  update(){
     # TODO
     # thinking carefully with all exit status, which is not good for automatic update 
     check_dependencies
     backup
     file_operation
     service_operation
     update_status
}
 
function  destroy() {
     # echo a warning message
     echo_y  "Warning: This action will destroy all this project, and this is unrecoverable! "
     answer= "n"
     echo_y  "Do you want to destroy this project? "
     read  -p  "(Default no,if you want please input: y ,if not please press the enter button):"  answer
     case  "$answer"  in
         y|Y|Yes|YES| yes |yES|yEs|YeS|yeS )
         # delete all file expect for this script self
         # find: warning: Unix filenames usually don't contain slashes (though pathnames do).  That means that '-name `./deploy.sh'' will probably evaluate to false all the time on this system.  You might find the '-wholename' test more useful, or perhaps '-samefile'.  Alternatively, if you are using GNU grep, you could use 'find ... -print0 | grep -FzZ `./deploy.sh''.
             # echo $WORKDIR/
             #find -L $WORKDIR -type f ! -name "$(basename $0)" -exec ls --color=auto -al {} \;
             # find -L . -type f ! -name "deploy.sh" -exec ls --color=auto -al {} \;
             # find -L . -type d -exec ls --color=auto -al {} \;
             # find -L ./ -maxdepth 1 ! -name "deploy.sh" ! -wholename "./"
         # ls | grep -v "fielname" |xargs rm -rf
         find  -L $WORKDIR -maxdepth 1 ! -name  "$(basename $0)"  ! -wholename  "$WORKDIR"   - exec  rm  -rf {} \;
         if  [ $? - eq  0 ]; then
             echo_g  "Destory this project successfully! Now will exit with status 0. "
             exit  0
         else
             echo_r  "Error: something go wrong! Please check or alter to Admin user! "
             exit  1
         fi
         ;;
         n|N|No|NO|no|nO)
         echo_g  "destroy action is cancel"
         exit  0
         ;;
         *)
         echo_r  "Are you kidding me? You are a bad kid! "
         exit  1
         ;;
     esac
 
}
 
case  $1  in
     update)
         update
         ;;
     backup)
         backup
         ;;
     restore)
         restore
         ;;
     rollback)
         rollback
         ;;
     destroy)
         destroy
         ;;
     help|*)
         echo  "Usage: $0 {update|backup|restore|rollback|destroy} with $0 itself"
         exit  1
         ;;
esac
 
# This is not essential with 'case .. esac' handled no args excutions
# replace "exit 0" with ":"
#exit 0
:

tag: 自动更新shell脚本,自动化部署脚本,Shell部署脚本,脚本实现自动更新和回滚,自动化部署shell脚本实例

--end--






本文转自 urey_pp 51CTO博客,原文链接:http://blog.51cto.com/dgd2010/1737010,如需转载请自行联系原作者


相关文章
|
6月前
|
开发工具 git
使用Git根据日期进行代码版本切换的方法
通过以上步骤,可以有效地根据日期进行Git代码版本的切换。这种方法在需要回溯历史版本进行bug修复或功能复查时特别有用。Git的灵活性和强大功能使其成为现代软件开发不可或缺的工具之一。
448 103
|
9月前
|
数据可视化 Java 测试技术
Git Flow 现代实操指南含从代码提交到 CI/CD 全流程的实用技巧与长尾关键词解析 Git Flow
本指南结合现代技术趋势,详解Git Flow工作流,涵盖GitHub Actions自动化、Conventional Commits规范、Gitmoji可视化等内容,助你实现代码到CI/CD的全流程管理,提升团队开发效率与代码质量。
617 2
|
11月前
|
JavaScript 前端开发 持续交付
实际工作中 Git Commit 代码提交规范是什么样的?
实际工作中 Git Commit 代码提交规范是什么样的?
989 7
|
11月前
|
网络安全 开发工具 git
Git仓库创建与代码上传指南
本教程介绍了将本地项目推送到远程Git仓库的完整流程,包括初始化本地仓库、添加和提交文件、创建远程仓库、关联远程地址及推送代码。同时,还提供了`.gitignore`配置、分支管理等可选步骤,并针对常见问题(如认证失败、分支不匹配、大文件处理及推送冲突)给出了解决方案。适合初学者快速上手Git版本控制。
|
10月前
|
开发工具 git 索引
如何使用Git的暂存区来管理代码更改?
如何使用Git的暂存区来管理代码更改?
1313 0
|
Devops Shell 网络安全
git使用之如何将一套代码同时推送至github|gitee|gitcode|gitlab等多个仓库-含添加ssh-优雅草央千澈完美解决-提供整体提交代码
git使用之如何将一套代码同时推送至github|gitee|gitcode|gitlab等多个仓库-含添加ssh-优雅草央千澈完美解决-提供整体提交代码
689 16
git使用之如何将一套代码同时推送至github|gitee|gitcode|gitlab等多个仓库-含添加ssh-优雅草央千澈完美解决-提供整体提交代码
|
Ubuntu Shell 开发工具
ubuntu/debian shell 脚本自动配置 gitea git 仓库
这是一个自动配置 Gitea Git 仓库的 Shell 脚本,支持 Ubuntu 20+ 和 Debian 12+ 系统。脚本会创建必要的目录、下载并安装 Gitea,创建 Gitea 用户和服务,确保 Gitea 在系统启动时自动运行。用户可以选择从官方或小绿叶技术博客下载安装包。
764 2
|
7月前
|
存储 安全 Unix
七、Linux Shell 与脚本基础
别再一遍遍地敲重复的命令了,把它们写进Shell脚本,就能一键搞定。脚本本质上就是个存着一堆命令的文本文件,但要让它“活”起来,有几个关键点:文件开头最好用#!/usr/bin/env bash来指定解释器,并用chmod +x给它执行权限。执行时也有讲究:./script.sh是在一个新“房间”(子Shell)里跑,不影响你;而source script.sh是在当前“房间”里跑,适合用来加载环境变量和配置文件。
600 9
|
7月前
|
存储 Shell Linux
八、Linux Shell 脚本:变量与字符串
Shell脚本里的变量就像一个个贴着标签的“箱子”。装东西(赋值)时,=两边千万不能有空格。用单引号''装进去的东西会原封不动,用双引号""则会让里面的$变量先“变身”再装箱。默认箱子只能在当前“房间”(Shell进程)用,想让隔壁房间(子进程)也能看到,就得给箱子盖个export的“出口”戳。此外,Shell还自带了$?(上条命令的成绩单)和$1(别人递进来的第一个包裹)等许多特殊箱子,非常有用。
613 2
|
关系型数据库 MySQL Shell
MySQL 备份 Shell 脚本:支持远程同步与阿里云 OSS 备份
一款自动化 MySQL 备份 Shell 脚本,支持本地存储、远程服务器同步(SSH+rsync)、阿里云 OSS 备份,并自动清理过期备份。适用于数据库管理员和开发者,帮助确保数据安全。