首页 > 编程语言 > 详解Jenkins 实现Gitlab事件自动触发Jenkins构建及钉钉消息推送
2021
04-27

详解Jenkins 实现Gitlab事件自动触发Jenkins构建及钉钉消息推送

实践环境

GitLab Community Edition 12.6.4

Jenkins 2.284

Post build task 1.9（Jenkins插件）

Generic Webhook Trigger Plugin 1.72（Jenkins插件）

GitLab 1.5.13（Jenkins插件）

实现步骤

钉钉机器人配置

选择要推送的钉钉群 -> 点击群设置按钮 -> 点击智能群助手 -> 点击添加机器人 -> 点击添加机器人+号按钮 -> 点击自定义->填写机器人名字，用于匹配推送消息请求体内容的的关键词

然后，复制出Webhook地址，供下文钉钉消息推送Shell脚本中使用，完成

安装Jenkins插件新建并配置Jenkins项目Build Triggers配置

如下，勾选Generic Webhook Trigger

Post content parameters(因为Gitlab触发的请求为post请求，需要基于请求体内容来判断是否执行Jenkins构建)关键配置项说明：

Variable 自定义变量名称

Expression 用于提取变量值的表达式(支持JSONPath、XPath)，提取的值赋值给上述自定义变量(例中为event_name)。

Option Filter关键配置项说明：

Expression 用于匹配下述Text的正则表达式，如果匹配则执行构建请求，否则不执行。这里配置为^push$，是因为Gitlab merge合并代码操作触发的请求，其请求体为json格式数据，其中包含名为event_name的键，其值为 push

Text 用于匹配上述正则表达式的文本，例中设置为自定义变量$event_name。

以上配置大意为，如果收到构建请求，使用JSONPath表达式从JSON格式的请求体获取键为event_name的值，存储到名为event_name变量，然后取该变量值同正则表达式^push$匹配，如果匹配，则触发Jenkins构建当前项目，否则不构建。

Token：自定义token值，用于请求http://JENKINS_URL/generic-webhook-trigger/invoke触发构建使用，如下，可以用于查询参数、请求头参数

/invoke?token=TOKEN_HEREtoken: TOKEN_HEREAuthorization: Bearer TOKEN_HERE

generic-webhook-trigger配置参考连接

https://plugins.jenkins.io/generic-webhook-trigger/

Post-build Actions配置

点击Add post-build action按钮，弹出界面中选择Post build task可新增以下配置界面。如下，可在Script输入框中编写构建完成后需要执行的Shell命令(该插件会先根据填写的shell命令生成一个临时sh脚本，然后执行该脚本)，例中为钉钉推送命令，具体代码参见下文

如上图，如果只希望构建成功才执行Script，可以勾选Run script only if all previous steps were successful

钉钉消息推送Shell

#!/bin/bash
#################################################################
# 作者：shouke
# 日期：2021-03-07
# 作用：机器人通知
#################################################################
# 钉钉消息变量定义
#################################################################
# 当前时间
TIME_NOW=`date "+%Y年%m月%d日 %H:%M:%S"`
BUILD_STATUS="失败"
LAST_BUILD_BUILD_XML=`curl http://ops.dev.xxxx.com/view/testarch/job/$JOB_NAME/lastBuild/api/xml --user juser_name:123456`
BUILD_RESULT=$(echo $LAST_BUILD_BUILD_XML | grep "<result>SUCCESS</result>") 
if [ "${BUILD_RESULT}" ];then 
    BUILD_STATUS="成功"
else
    BUILD_RESULT=$(echo $LAST_BUILD_BUILD_XML | grep "<result>FAILURE</result>") 
    if [ "${BUILD_RESULT}" ];then 
        BUILD_STATUS="失败"
    else
        BUILD_STATUS="无法获取"     
    fi
fi   
# 机器人 webhook 地址(上文添加钉钉机器人结束时复制的webhook地址)
DINGTALK_WEBHOOK_URL='https://oapi.dingtalk.com/robot/send?access_token=903fcd6c56f301d0a57bee243792a11bb1e42cae89af5a9071bdba890c0a3d2'
# 消息标题 # 实际不起作用，但是不能少，否则发送失败
DINGTALK_TITLE="XX平台有新的构建，请及时查阅"
# 消息正文
# Jenkins Job构建日志地址
JENKINS_JOB_BUILD_LOG_URL="http://ops.dev.xxxx.com/view/testarch/job/${JOB_NAME}/${BUILD_NUMBER}/console"
DINGTALK_TEXT="## xx平台有新的构建，请及时查阅\n\n>\
**【通知时间】**：${TIME_NOW}\n\n>\
**【构建ID】**：${BUILD_DISPLAY_NAME}\n\n>\
**【构建项目】**：${JOB_NAME}\n\n>\
**【构建状态】**：${BUILD_STATUS}\n\n>\
**[点击查看更多](${JENKINS_JOB_BUILD_LOG_URL})**\n
" 
#  
# 发送钉钉消息通知函数
#################################################################
function SEND_MESSAGE_TO_DINGTALK() {
    /usr/bin/curl "$1" -H 'Content-Type: application/json' -d "
    {
        \"markdown\": {
            \"title\": \"$2\", 
            \"text\": \"$3\"
        }, 
        \"at\": {
          \"atMobiles\": [],
          \"isAtAll\": false
        },
        \"msgtype\": \"markdown\"
    }
    " 
}
# 发送钉钉消息
#################################################################
SEND_MESSAGE_TO_DINGTALK "${DINGTALK_WEBHOOK_URL}" "${DINGTALK_TITLE}" "${DINGTALK_TEXT}"

说明：

curl http://ops.dev.xxxx.com/view/testarch/job/$JOB_NAME/lastBuild/api/xml --user juser_name:123456`

以名为juser_name的用户，使用密码123456访问指定项目的最后一次构建相关的信息，返回xml文档

注意：钉钉聊天窗口中要实现消息换行必须使用两个\n

Gitlab自动触发配置

Settings -> Integration，打开如下页面，

  1. 填写URL(http://ops.dev.xxxx.com/generic-webhook-trigger/invoke?token=0771826b93bbd566266bce34f5123ebb)，这里的token值即为generic-webhook-trigger插件中配置在定义token值
  2. 勾选Push events触发器(这里以push、合并代码操作为例子，所以仅勾选该事件)
  3. 勾选 Enable SSL verification 复选框(如果没有勾选的话，默认就是勾选的)

最后点击 Add webhook按钮

添加的配置，会自动显示在下方，可以对其进行事件触发测试

触发的记录会自动在配置编辑页面下方显示，点击 View details按钮，可以查看请求明细

注意：自动触发时Jenkins项目构建时，如果Jenkins使用了参数化构建插件Build With Parameters Plugin，并且使用插件实现的参数有设置默认值，则自动触发时也会自动使用对应参数的默认值进行构建。

钉钉消息推送效果图

到此这篇关于使用Jenkins完成钉钉消息推送及Gitlab事件自动触发的Jenkins构建的文章就介绍到这了,更多相关Jenkins内容请搜索自学编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持自学编程网！

编程技巧