Jenkins通知脚本-飞书卡片通知

已于 2023-10-13 17:26:54 修改
阅读量383 收藏 3
点赞数
分类专栏： DevOps 文章标签： jenkins 飞书 运维 devops
于 2023-10-13 11:43:30 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34668238/article/details/133806042
版权

Jenkins通知脚本-飞书卡片通知

目的

使用飞书卡片消息类型将Jenkins任务构建开始和结束时状态进行飞书群通知

关键点

  1. Jenkins构建任务中增加2个过程
    • Build Steps -> Execute shell （添加在主构建脚本（npm/mvn相关脚本）之前，目的是：编译等主要构建过程之前进行通知）
    • 构建后操作-> Post build task（添加在构建后操作，目的是：编译等主要构建过程之后进行通知）
  1. 飞书卡片的制作，必须先在飞书后台自建应用内新建自己的卡片，并且卡片的字段和卡片ID要和脚本内容匹配；

效果截图

  1. 构建开始
    在这里插入图片描述
  2. 构建结束
    在这里插入图片描述

源码

飞书卡片源码

  • 请使用“消息卡片制作工具”进行制作，下述源码会根据卡片组件自动生成；
{
  "config": {
    "wide_screen_mode": true
  },
  "elements": [
    {
      "tag": "hr"
    },
    {
      "tag": "markdown",
      "content": "**任务名称：** **<font >${JOB_NAME}</font>**"
    },
    {
      "tag": "markdown",
      "content": "此次构建启动时间：${BUILD_START_TIME}"
    },
    {
      "tag": "markdown",
      "content": "构建状态：**<font color=${font_color}>${build_status}</font>**"
    },
    {
      "tag": "hr"
    },
    {
      "tag": "markdown",
      "content": "**仓库分支信息如下：**"
    },
    {
      "tag": "column_set",
      "flex_mode": "none",
      "background_style": "grey",
      "columns": [
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "column_set",
              "flex_mode": "none",
              "background_style": "grey",
              "columns": [
                {
                  "tag": "column",
                  "width": "weighted",
                  "weight": 1,
                  "vertical_align": "top",
                  "elements": [
                    {
                      "tag": "markdown",
                      "content": "**地址**"
                    }
                  ]
                },
                {
                  "tag": "column",
                  "width": "weighted",
                  "weight": 1,
                  "vertical_align": "top",
                  "elements": [
                    {
                      "tag": "markdown",
                      "content": "**分支**"
                    }
                  ]
                },
                {
                  "tag": "column",
                  "width": "weighted",
                  "weight": 1,
                  "vertical_align": "top",
                  "elements": [
                    {
                      "tag": "markdown",
                      "content": "**commitId**"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "horizontal_spacing": "default"
    },
    {
      "tag": "column_set",
      "flex_mode": "none",
      "background_style": "default",
      "columns": [
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "${repo_url}"
            }
          ]
        },
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "${repo_branch_name}"
            }
          ]
        },
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "${repo_branch_commit_id}"
            }
          ]
        }
      ],
      "_varloop": "${last_build_info}",
      "horizontal_spacing": "default"
    },
    {
      "tag": "hr"
    },
    {
      "tag": "markdown",
      "content": "**${last_changes_info_text}**"
    },
    {
      "tag": "column_set",
      "flex_mode": "none",
      "background_style": "grey",
      "columns": [
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "**提交ID**"
            }
          ]
        },
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "**提交人**"
            }
          ]
        },
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "**提交内容**"
            }
          ]
        },
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "**提交时间**"
            }
          ]
        }
      ]
    },
    {
      "tag": "column_set",
      "flex_mode": "none",
      "background_style": "default",
      "columns": [
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "${commitId}"
            }
          ]
        },
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "${authorEmail}"
            }
          ]
        },
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "${comment}"
            }
          ]
        },
        {
          "tag": "column",
          "width": "weighted",
          "weight": 1,
          "vertical_align": "top",
          "elements": [
            {
              "tag": "markdown",
              "content": "${date}"
            }
          ]
        }
      ],
      "_varloop": "${last_changes_info}"
    },
    {
      "tag": "hr"
    },
    {
      "tag": "markdown",
      "content": "**😁构建人：**<at email=${user_id}></at>"
    },
    {
      "tag": "markdown",
      "content": "**😁知情人：**${insider_users_email}"
    },
    {
      "tag": "action",
      "actions": [
        {
          "tag": "button",
          "text": {
            "tag": "plain_text",
            "content": "任务链接"
          },
          "type": "primary",
          "multi_url": {
            "url": "${JOB_URL}",
            "pc_url": "",
            "android_url": "",
            "ios_url": ""
          }
        },
        {
          "tag": "button",
          "text": {
            "tag": "plain_text",
            "content": "构建链接"
          },
          "type": "primary",
          "multi_url": {
            "url": "${THIS_BUILD_URL}",
            "pc_url": "",
            "android_url": "",
            "ios_url": ""
          }
        },
        {
          "tag": "button",
          "text": {
            "tag": "plain_text",
            "content": "Jenkins变更记录"
          },
          "type": "primary",
          "multi_url": {
            "url": "${THIS_BUILD_CHANGES}",
            "pc_url": "",
            "android_url": "",
            "ios_url": ""
          }
        }
      ]
    },
    {
      "tag": "hr"
    },
    {
      "tag": "note",
      "elements": [
        {
          "tag": "img",
          "img_key": "img_v2_xxx",
          "alt": {
            "tag": "plain_text",
            "content": ""
          }
        },
        {
          "tag": "plain_text",
          "content": "${short_description}"
        }
      ]
    }
  ],
  "card_link": {
    "url": "",
    "pc_url": "",
    "android_url": "",
    "ios_url": ""
  },
  "header": {
    "title": {
      "content": "Jenkins任务构建通知：",
      "tag": "plain_text"
    },
    "template": "wathet"
  }
}

脚本源码

  • Build Steps -> Execute shell 和 构建后操作-> Post build task 存放一样的shell脚本
#/bin/bash

feishu_chat_id1="oc_xxx"
feishu_chat_list=($feishu_chat_id1)

function send_msg() {
  for ((i = 0; i < ${#feishu_chat_list[@]}; i++)); do
    feishu_chat_id=${feishu_chat_list[$i]}
    /root/anaconda3/envs/py36/bin/python /jenkins_tools/jenkins_builds_info_notify_feishu.py \
    "${feishu_chat_id}" -job_name "${JOB_NAME}" -job_url "${JOB_URL}" -build_name "${BUILD_ID}" -branch "${GIT_BRANCH}"
  done
}

send_msg
  • Python脚本（该脚本Python版本：3.6.8），存放在Jenkins服务器上，让shell脚本调用。
import argparse
import json
import time

import requests
import validators

parser = argparse.ArgumentParser(description='Jenkins 发送消息到飞书',
                                 epilog="执行示例>>> python ${feishu_chat_id} -job_name ${JOB_NAME} -job_url ${JOB_URL} "
                                        "-branch ${GIT_BRANCH} -build_name ${BUILD_NUMBER}  ")
parser.add_argument('feishu_chat_id', help='机器人webhookURL')  # 必填
parser.add_argument('-job_name', '--JOB_NAME', help='作业Name', )  # 选填
parser.add_argument('-job_url', '--JOB_URL', help='作业URL', required=True, )  # 必填
parser.add_argument('-branch', '--GIT_BRANCH', help='git分支', default='')  # 选填
parser.add_argument('-build_name', '--BUILD_DISPLAY_NAME', help='编译Name')  # 选填

feishu_chat_id = parser.parse_args().feishu_chat_id
JOB_NAME = parser.parse_args().JOB_NAME
JOB_URL = parser.parse_args().JOB_URL
GIT_BRANCH = parser.parse_args().GIT_BRANCH
BUILD_DISPLAY_NAME = parser.parse_args().BUILD_DISPLAY_NAME
BUILD_URL = JOB_URL + '/lastBuild'


def feishu_tools(send_data, app_id, app_secret):
    get_tenant_access_token_url = "https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal"
    payload = json.dumps({
        "app_id": app_id,
        "app_secret": app_secret
    })
    headers = {
        'Content-Type': 'application/json'
    }
    response = requests.request("POST", get_tenant_access_token_url, headers=headers, data=payload)
    tenant_access_token = json.loads(response.text)['tenant_access_token']

    url = "https://open.feishu.cn/open-apis/message/v4/send/"

    headers = {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer ' + str(tenant_access_token)
    }

    response = requests.request("POST", url, headers=headers, data=send_data)
    return response.text


def feishu_notify(jenkins_auth, app_id, app_secret, card_id):
    result = requests.get(f'{BUILD_URL}/api/json', auth=jenkins_auth).json()
    print(json.dumps(result))
    last_build_info = []
    last_changes_info = []
    insider_users_email = ""
    for _ in result['actions']:
        if _ != {}:
            if _['_class'] == "hudson.model.CauseAction":
                for c in _['causes']:
                    if c['_class'] == "hudson.model.Cause$UserIdCause":
                        short_description = c['shortDescription']
                        user_id = c['userId']
                        # user_name = c['userName']

            elif _['_class'] == "hudson.plugins.git.util.BuildData":
                cur_build_info = {
                    "repo_url": _.get('remoteUrls')[0],
                    "repo_branch_name": _['lastBuiltRevision'].get('branch')[0].get('name'),
                    "repo_branch_commit_id": _['lastBuiltRevision'].get('branch')[0].get('SHA1'),

                }
                last_build_info.append(cur_build_info)

            elif _['_class'] == "hudson.model.ParametersAction":
                for p in _['parameters']:
                    if "insider_users_email" == p['name']:
                        insider_users_email = list(p['value'].split(" "))

    print(insider_users_email)
    insider_users_email_formats = ""
    for insider_user_email in insider_users_email:
        insider_users_email_format = "<at email={}></at> "
        if validators.email(insider_user_email):
            insider_users_email_formats += insider_users_email_format.format(insider_user_email)
        else:
            print(validators.email(insider_user_email))


    changesItems = result['changeSet']['items']
    if len(changesItems) > 0:
        for c in changesItems:
            last_change_info = dict()
            last_change_info['commitId'] = c['commitId']
            # last_change_info['affectedPaths'] = '\n'.join(c['affectedPaths'])
            last_change_info['authorEmail'] = c['authorEmail']
            last_change_info['comment'] = c['comment']
            last_change_info['date'] = c['date']
            last_changes_info.append(last_change_info)

    last_changes_info = list(reversed(last_changes_info))
    print(last_changes_info)

    BUILD_START_TIME = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(result['timestamp'] / 1000))
    build_status = "START" if result['result'] is None else result['result']
    estimated_duration = result['estimatedDuration']
    estimated_duration = int(estimated_duration) // 1000
    minutes, seconds = divmod(estimated_duration, 60)
    hours, minutes = divmod(minutes, 60)
    build_duration = f'{hours}小时:{minutes}分:{seconds}秒'
    BUILD_ID = result['id']
    THIS_BUILD_URL = result['url']
    THIS_BUILD_CHANGES = THIS_BUILD_URL + '/changes'


    # # ============ 设置文字颜色 ============
    if "SUCCESS" == build_status:  # 成功
        font_color = "green"
    elif "FAILURE" == build_status:  # 失败
        font_color = "red"
    elif "ABORTED" == build_status:  # 终止
        font_color = "grey"
    else:
        font_color = "default"


    card = {
        "type": "template",
        "data": {
            "template_id": card_id,
            "template_variable":
                {
                    "JOB_NAME": JOB_NAME,
                    "JOB_URL": JOB_URL,
                    "BUILD_START_TIME": BUILD_START_TIME,
                    "build_duration": build_duration,
                    "BUILD_ID": BUILD_ID,
                    "THIS_BUILD_URL": THIS_BUILD_URL,
                    "THIS_BUILD_CHANGES": THIS_BUILD_CHANGES,
                    "build_status": build_status,
                    "short_description": short_description,
                    "font_color": font_color,
                    "last_build_info": last_build_info,
                    "user_id": user_id,
                    "insider_users_email": insider_users_email_formats if insider_users_email_formats is not "" else "*<font color='green'>暂未分配知情人，可携带该构建url联系运维永久添加！当然，也可以在构建的时候，insider_users_email参数下自行覆盖填写知情人邮箱！以空格分隔！</font>*",
                    "last_changes_info": last_changes_info,
                    "last_changes_info_text": "变更记录详情如下：" if len(last_changes_info) > 0 else "此次变更无变更信息"

                }
        }
    }

    send_data = json.dumps({
               "chat_id": feishu_chat_id,
               "msg_type": "interactive",
               "card": card
            })

    res = feishu_tools(send_data=send_data, app_id=app_id, app_secret=app_secret)
    print(res)


if __name__ == '__main__':
    jenkins_auth = ('yuhongchao', 'xxx')
    app_id = "cli_xxx"
    app_secret = "xxx"
    feishu_notify(jenkins_auth=jenkins_auth, app_id=app_id,
                  app_secret=app_secret, card_id="ctp_xxx")

后话

  • 如果构建任务使用“This project is parameterized”，那么，可在脚本接收到的parameters字典列表字段，基础上完善其他通知逻辑。
    parameters
  • 除了本文使用的“脚本执行”方式，还有一种可以使用通知插件实现，这种通知插件的方式更加优雅，配合Python drf框架提供的接口即可实现整个逻辑。但是对Jenkins的版本有要求，我司的生产环境Jenkins版本过低，不想升级，所以无法使用这个通知插件+Python Drf框架来实现；有兴趣的朋友可以尝试一下，我这边在测试环境验证过，比较简单也比较优雅。

在这里插入图片描述

  • 飞书后台消息卡片截图
    在这里插入图片描述
  • Jenkins字符参数配合知情人通知逻辑

在这里插入图片描述

于特洛夫斯基
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
专栏目录
Python - Jenkins构建完成后发送飞书通知
likai0728的博客
05-16 1202
Python - Jenkins构建完成后发送飞书通知
【无标题】jenkins消息模板(飞书)
菜鸡
08-25 2217
自动化测试通知
四、gitlab+Jenkins+nginx实现发布后推送飞书通知
weixin_57670650的博客
07-19 759
本文讲解Jenkins构建完成后通过python脚本测试构建页面的内容和获取内置变量推送飞书通知！！！
Jenkins打包、发布、部署
热门推荐
奕安的博客
12-17 2万+
jenkins的打包、发布、部署
基于飞书webHook机器人实现shell脚本监听端口并报警
s1608818981的博客
08-14 819
无需python环境即可通过飞书webhook报警
基于 Jenkins 定时作业的上线执行人机器人通知
Crg的博客
11-11 194
基于 Jenkins 定时作业的上线执行人机器人通知 1 shell script #!/bin/bash # 参与人员来源可以是文本、网络、数据库都可以 release_personnel_array=('A同学' 'B同学' 'C同学' 'D同学') # 上一个人员 previous_personnel=$(cat ../release.txt) # 当前人员 current_personnel='' break_flag=0 for (( i = 0; i < ${#release_person
jenkins-update-center：詹金斯镜像更新中心生成器
02-21
詹金斯更新中心 詹金斯镜更新中心生成器 更新时间 每天凌晨1点UTC更新 镜像站点 腾讯 华为 清华 ustc 位 文件update-center.json ...wget https://cdn.jsdelivr.net/gh/lework/jenkins-update-center/rootC
jenkins-linter-idea-plugin：jenkins-linter-idea-plugin是一个Intellij Idea插件，用于通过Jenkins服务器的Pipeline Linter验证Jenkinsfiles
02-27
詹金斯·林特的想法插件jenkins-linter-idea-plugin是一个Intellij Idea插件，用于通过Jenkins服务器的验证Jenkinsfiles。特征 仅支持声明性管道 HTTP linter集成 清除错误突出显示安装该插件可以通过“设置” |...
jenkins-jnlp-slave镜像
07-10
jenkins-jnlp-slave镜像
Jenkins安装包，可直接使用 java -jar jenkins.war --httpPort=8080启动
04-11
Jenkins安装包，可直接使用 java -jar jenkins.war --httpPort=8080启动
jenkins-plugin-lan-svn
07-25
jenkins-plugin-lan-svn
jenkins groovy+bash脚本实现linux 机器磁盘监控，并飞书发送告警
qq_42708085的博客
06-22 784
定时监控磁盘空间
【Jenkins】+【飞书机器人】发送通知(带签名)【Linux】
怀着一颗学徒的心
07-28 2550
我这个设置了签名的,具体怎么设置签名可以查看飞书官方文档。可以看到上传去是没有执行权限的,一定要记得叫上执行权限。自定义机器人使用指南飞书官网。
Jenkins+飞书机器人发送通知
jialiu111111的博客
12-24 5007
1. 在飞书群中添加自定义机器人 在飞书群中添加自定义机器人 Jenkins+飞书机器人发送通知_Song_Estelle的博客-CSDN博客_jenkins飞书
Prometheus+Grafana搭建运维平台，通知自定义java服务 实现Jenkins自动构建+飞书告警
yiwenti9793的博客
11-08 235
prometheus+grafana+jenkins+飞书 自动化运维 实时告警
十八、Jenkins（centos7）执行接口自动化测试脚本，飞书推送测试结果消息
默金
07-07 1464
*./target/allure-results ：**指定allure报告的生成路径。
Jenkins 构建后通知到飞书
运维那些事儿
04-20 3036
一、Jenkins 自由风格构建后通知到飞书 1.1、首先安装 Post build task 插件 1.2、使用如下脚本即可 #!/bin/bash JOB_URL="${JENKINS_URL}job/${JOB_NAME}" getBuildState(){ buildNr=$1 curl -u #jenkins账号密码信息 ${JOB_URL}/${buildNr}/api/json |grep -Po '"result":\s*"\K\w+' } state=$(getBuildSta
Jenkins自动发送飞书消息
我的博客
08-17 1148
公司办公软件用的是飞书套壳，本文主要介绍如何通过飞书机器人发送Jenkins构建的进度和消息。本文给出了详细的shell脚本代码，实现了将Jenkins构建消息发送到飞书的功能。欢迎白嫖！！！
Jenkins流水线pipeline--基于上一章的工作流程
最新发布
Djdhdhskn的博客
06-02 399
Jenkinsfile文件内容。
帮我写个python脚本jenkins和飞书集成告警通知
06-06
好的，这里提供一个简单的Python脚本示例，用于将Jenkins构建结果通知到飞书中，您可以根据您的需求进行修改和优化。 ```python import requests import json # Jenkins构建通知 jenkins_url = "JENKINS_URL" job_name = "JOB_NAME" build_number = "BUILD_NUMBER" build_url = "BUILD_URL" status = "STATUS" # 构建状态，可以是 SUCCESS/FAILURE 等 # 飞书机器人webhook地址 robot_url = "ROBOT_WEBHOOK_URL" # 构建信息 build_info = f"Job Name: {job_name}\nBuild Number: {build_number}\nBuild URL: {build_url}\nStatus: {status}" # 飞书机器人消息体 message = { "msg_type": "text", "content": { "text": f"Jenkins构建通知：\n{build_info}" } } # 发送消息 response = requests.post(robot_url, json.dumps(message)) if response.status_code == 200: print("消息发送成功！") else: print(f"消息发送失败，错误码：{response.status_code}") ``` 您需要在脚本中填写Jenkins构建信息、飞书机器人webhook地址等相关信息。然后运行脚本即可将构建结果通知到飞书中。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

于特洛夫斯基

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值