基于gitlab的CICD流程规范

系统管理员 2022-09-13 04:18 393阅读 0赞

**前言：这篇文章主要讲一讲基于gitlab的CICD流程规范**

### 基于gitlab的CICD流程规范 ###

*  一、简介
 *  二、CICD流程图
 *  三、CICD说明
 *  四、结合CICD流程拓展
 *   *  1、业务代码-数据库基于flyway实现版本控制
     *  2、数据库版本控制
     *  3、二进制或内置
 *  五、代码质量检查及自动化测试（未来）
 *  六、疑问解答与加群交流学习

# 一、简介 #

为了提升线下测试效率，缩短测试时间，提升提测代码质量，规范流程，缩短测试准备和执行时间，缩短问题定位时间，提供预测性指标，规范CICD流程，以提升整体团队效率。

# 二、CICD流程图 #

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16]

# 三、CICD说明 #

发布分为大致三个环境：  
1、开发环境对应于dev分支  
2、测试环境对应于test分支  
3、预发布环境对应uat分支  
4、生产环境对应于master分支

CICD流程如下：

> \#开发环境  
> 推送代码->编译->生成的jar包发布到私服->打包为docker镜像->推送到Harbor镜像仓库->部署到k8s集群->健康检查（成功，微信通知，c结束返回成功|失败，微信通知，ci结束返回失败

> \#测试环境  
> 1、推送代码->编译->生成的jar包发布到私服->打包为docker镜像->推送到Harbor镜像仓库（成功，微信通知，c结束返回成功|失败，微信通知，ci结束返回失败）  
> 2、测试人员触发部署到k8s集群->健康检查（成功，微信通知，c结束返回成功|失败，微信通知，ci结束返回失败）

> 预发布环境  
> 1、推送代码->编译->生成的jar包发布到私服->打包为docker镜像->推送到Harbor镜像仓库（成功，微信通知，c结束返回成功|失败，微信通知，ci结束返回失败）  
> 2、测试人员|运维人员 触发部署到k8s集群->健康检查（成功，微信通知，c结束返回成功|失败，微信通知，ci结束返回失败）

> 生产环境  
> 1、推送代码->编译->生成的jar包发布到私服->打包为docker镜像->推送到Harbor镜像仓库（成功，微信通知，c结束返回成功|失败，微信通知，ci结束返回失败）  
> 2、运维人员 触发部署到k8s集群->健康检查（成功，微信通知，c结束返回成功|失败，微信通知，ci结束返回失败）

实现效果如下：  
1、自动触发构建-test  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16 1]  
2、自动触发构建-master（人工确认部署）  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16 2]  
实现细节如下：

> 步骤为：  
> 1、配置环境变量  
> 2、拉取代码  
> 3、编译(打包和推送到私服)  
> 4、编译产物修改名称(用作部署指定版本)  
> 5、运行程序  
> 6、反馈编译状态结果

# 四、结合CICD流程拓展 #

## 1、业务代码-数据库基于flyway实现版本控制 ##

引入原因：

*  Schema 变更往往会添加或重命名多个列或表。如果应用程序版本与 schema 版本不匹配，还有可能彻底破坏应用程序的正常运行。最后，由于存在两套不同的系统，通过应用程序升级来协调数据库变更也比较困难。

## 2、数据库版本控制 ##

FlyWay 允许用户轻松创建各数据库版本、跟踪数据库迁移并轻松完成 schema 变更的前滚与回滚——整个过程无需配合定制构建解决方案。

## 3、二进制或内置 ##

可以选择在应用程序的启动过程中、或者以二进制可执行文件的形式运行 Flyway。用户可以在代码中直接使用此工具，使其在启动时能够检查版本功能并运行适当迁移，从而令数据库与应用程序的版本保持同步。当然也可以临时运行 cmd 行，在无需重建整体应用程序的前提下为现有数据库提供良好的灵活性。

使用后操作数据库的改变：  
对于数据库表接口的变更就要关闭这几个途径

1.  直接通过工具登录数据去修改表结构
2.  已经发布的sql脚本不允许修改

正确的表结构调整途径：  
在flyway脚本配置路径下编写新的脚本，启动程序来执行变更。这样可以获得几个很大的好处：

1.  脚本受Git版本管理控制，可以方便的找到过去的历史
2.  脚本在程序启动的时候先加载，再提供接口服务，一起完成部署步骤
3.  所有表结构的历史变迁，在管理目录中根据版本号就能很好的追溯

# 五、代码质量检查及自动化测试（未来） #

开发层面建议：

1.  每次 Review 的代码量不要太多，控制在 400 行以内
2.  最好的建议是将一次 Review 的时间控制在 60 分钟以内
3.  提交 Review 之前，需要做严格的自我检查，根据 Checklist

引入原因：

*  与动态分析相比，执行速度更快；
 *  可以对代码质量维护进行自动化；
 *  在早期阶段 (尽管不是所有阶段) 可以自动检索 bug；
 *  在早期阶段可以自动发现安全问题；

SonarQube 是一种很流行的静态分析工具，用于持续检查代码库的代码质量和安全性，并在代码评审期间指导开发团队。SonarQube 可与 CI/CD 集成，进行自动化代码检查。它还提供了质量管理工具帮你主动纠正错误：IDE 集成、Jenkins 集成和代码评审工具。

访问地址：https://www.sonarqube.org

关键特性:

*  多语言支持；
 *  安全性分析；
 *  发布质量代码；
 *  可维护性；
 *  可以识别蹊跷的问题

引入集成测试等相关测试平台与Devops结合提升整体项目交付能力

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16 3]

# 六、疑问解答与加群交流学习 #

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16_pic_center]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16]: /images/20220828/3e2d1cc02d5f450cbb2fde2a27d84425.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16 1]: /images/20220828/010e5e48cefe441798b80beee19c53df.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16 2]: /images/20220828/bc191d7faa7e474fb7f4b46491f8fcb4.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16 3]: /images/20220828/77bd664aca8346d29e89c8aac54227dd.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5aW95aW95YWI55SfJk1yLkxp_size_20_color_FF0000_t_70_g_se_x_16_pic_center]: /images/20220828/5675612d71094f17b6702f9df7cbc8ba.png