Shadow'S Site

心之所愿，无所不至！

0%

Allure报告结果钉钉发送Python实现

发表于 更新于 分类于 阅读次数： Valine：
本文字数： 7.4k 阅读时长 ≈ 7 分钟

Jenkins中的Allure插件，增加Owner插件

  1. Jenkins中配置Allure插件，目录为System Configuation -> Global Tool Configuration，从中找到Allure Commandline

  2. 下载owners-failed-plugin插件
    插件地址 提取码: ifqw

  3. 把插件加入Allure Commandline的安装目录中
    安装完插件后，可以在Jenkins任务的执行机上，也就是jenkins任务真正执行的机器上，会有一个workspace/tools/ru.yandex.qatools.allure.jenkins.tools.AllureCommandlineInstallation/Allure_Commandline/plugins目录，这个workspace也就是Jenkins的一个工作空间
    plugins目录下，就是Allure插件自带的一些插件
    我们把第二步下载的插件解压后的文件夹，放到该目录下，owners-failed-plugin展示如下：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    # shadow @ domain in ~/jenkins_slave/workspace/tools/ru.yandex.qatools.allure.jenkins.tools.AllureCommandlineInstallation/Allure_Commandline/plugins [15:55:35] 
    $ ll
    total 48K
    drwxrwxr-x 3 shadow shadow 4.0K Sep  9 14:45 behaviors-plugin
    drwxrwxr-x 3 shadow shadow 4.0K Sep  9 14:45 custom-logo-plugin
    drwxrwxr-x 3 shadow shadow 4.0K Sep  9 14:45 jira-plugin
    drwxrwxr-x 2 shadow shadow 4.0K Sep  9 14:45 junit-xml-plugin
    drwxr-xr-x 3 shadow shadow 4.0K Sep 10 09:31 owners-failed-plugin
    drwxrwxr-x 3 shadow shadow 4.0K Sep  9 14:45 packages-plugin
    -rwxrwxr-x 1 shadow shadow   85 Jul  7 10:18 README.txt
    drwxrwxr-x 3 shadow shadow 4.0K Sep  9 14:45 screen-diff-plugin
    drwxrwxr-x 2 shadow shadow 4.0K Sep  9 14:45 trx-plugin
    drwxrwxr-x 3 shadow shadow 4.0K Sep  9 14:45 xctest-plugin
    drwxrwxr-x 3 shadow shadow 4.0K Sep  9 14:45 xray-plugin
    drwxrwxr-x 2 shadow shadow 4.0K Sep  9 14:45 xunit-xml-plugin

    然后需要退一层目录，把插件的配置写入配置文件中，不然就无法被调用到

    script
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    # shadow @ domain in ~/jenkins_slave/workspace/tools/ru.yandex.qatools.allure.jenkins.tools.AllureCommandlineInstallation/Allure_Commandline/plugins [15:55:51] 
    $ cd ..

    # shadow @ domain in ~/jenkins_slave/workspace/tools/ru.yandex.qatools.allure.jenkins.tools.AllureCommandlineInstallation/Allure_Commandline [16:03:19] 
    $ ll
    total 16K
    drwxrwxr-x  2 shadow shadow 4.0K Sep  9 14:45 bin
    drwxrwxr-x  2 shadow shadow 4.0K Sep 10 09:32 config
    drwxrwxr-x  3 shadow shadow 4.0K Sep 10 09:06 lib
    drwxrwxr-x 13 shadow shadow 4.0K Sep 10 09:31 plugins

    # shadow @ domain in ~/jenkins_slave/workspace/tools/ru.yandex.qatools.allure.jenkins.tools.AllureCommandlineInstallation/Allure_Commandline [16:03:20] 
    $ cd config 

    # shadow @ domain in ~/jenkins_slave/workspace/tools/ru.yandex.qatools.allure.jenkins.tools.AllureCommandlineInstallation/Allure_Commandline/config [16:03:25] 
    $ ll
    total 8.0K
    -rwxrwxr-x 1 shadow shadow   0 Jul  7 10:18 allure-cucumber.yml
    -rwxrwxr-x 1 shadow shadow  46 Jul  7 10:18 allure-junit.yml
    -rwxrwxr-x 1 shadow shadow 205 Sep 10 09:32 allure.yml

    编辑allure.yml文件，写入owners-failed-plugin配置如下：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    plugins:
      - junit-xml-plugin
      - xunit-xml-plugin
      - trx-plugin
      - behaviors-plugin
      - packages-plugin
      - screen-diff-plugin
      - xctest-plugin
      - jira-plugin
      - xray-plugin
      - owners-failed-plugin

读取报告信息

脚本主要方法说明

  1. getSummary() 方法返回总体信息

    1
    2
    3
    4
    5
    6
    7
    8
    {
        "failed": 108,
        "broken": 25,
        "skipped": 196,
        "passed": 1055,
        "unknown": 0,
        "total": 1384
    }

  2. getResultDetails() 方法返回Owner具体信息，并对异常数据做清理

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    [
        {
            "name": "张三",
            "children": [{"": "", "status": "passed"}, {"": "", "status": "failed"}, {"": "", "status": "broken"}, {"": "", "status": "skipped"}],
            "uid": "e1aaed47c8239f38d3450e9dfd3e7646"
        },
        {
            "name": "李四",
            "children": [{"": "", "status": "passed"}, {"": "", "status": "failed"}, {"": "", "status": "broken"}, {"": "", "status": "skipped"}],
            "uid": "90e00f4c3e58fc50b3766d36fe294203"
        }
    ]

  3. getPersonCounts() 方法返回每个Owner的具体用例数据

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    [
      {
        "name": "张三",
        "total": 111,
        "passed": 110,
        "broken": 0,
        "skipped": 1,
        "failed": 0
      },
      {
        "name": "李四",
        "total": 56,
        "passed": 56,
        "broken": 0,
        "skipped": 0,
        "failed": 0
      }
    ]

  4. spillDingText() 方法返回钉钉发送消息体中的text

  5. sendMarkdownDing() 方法以markdown格式组织消息体，发送钉钉通知

完整脚本

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
# -*- coding: utf-8 -*-
import json
import sys

import requests


'''
执行方式：python sendDingSummary.py Jenkins_Job webhook mobiles
'''

# Jenkins任务的名称
JOB_NAME = str(sys.argv[1])

# 只需要最后那个Token
WEBHOOK_TOKEN = str(sys.argv[2])

# 手机号用英文逗号分隔，可以不传
try:
    MOBILES = str(sys.argv[3])
except:
    MOBILES = None

reportUrl = 'http://jenkins.shadow.com/job/' + JOB_NAME + '/allure/'

mobiles = ""
if MOBILES:
    atMobiles = MOBILES.split(',')
    for mobile in atMobiles:
        mobiles += "@" + mobile
else:
    atMobiles = None


def getSummary():
    url = 'http://jenkins.shadow.com/job/' + JOB_NAME + '/allure/widgets/summary.json'
    summary = requests.get(url).json()['statistic']
    print(summary)
    return summary


def getResultDetails():
    url = 'http://jenkins.shadow.com/job/' + JOB_NAME + '/allure/data/owners.json'
    resultDetails = requests.get(url).json()['children']
    for resultDetail in resultDetails:
        if resultDetail.get("children") is None:
            resultDetails.remove(resultDetail)

    print(resultDetails)
    return resultDetails


def getPersonCounts():
    resultDetails = getResultDetails()
    personCounts = []
    for resultDetail in resultDetails:
        passed = 0
        broken = 0
        skipped = 0
        failed = 0
        for detail in resultDetail['children']:
            if detail['status'] == 'passed':
                passed += 1
            if detail['status'] == 'broken':
                broken += 1
            if detail['status'] == 'skipped':
                skipped += 1
            if detail['status'] == 'failed':
                failed += 1
        personCounts.append(
            {
                'name': resultDetail['name'],
                'total': len(resultDetail['children']),
                'passed': passed,
                'broken': broken,
                'skipped': skipped,
                'failed': failed
            }
        )

    print(personCounts)
    return personCounts


def spillDingText():
    summary = getSummary()
    Failed = summary['failed']
    Broken = summary['broken']
    Skipped = summary['skipped']
    Passed = summary['passed']
    Total = summary['total']
    PassRate = '%.2f%%' % (Passed / (Total - Skipped) * 100)
    summaryText = "### **『%s』项目接口自动化每日报告！**\n\n" \
                  " >%s\n\n" \
                  " >**[<font color=#0A83D1 >PassRate:%s</font>](%s)**\n\n" \
                  " >**<font color=#000000 >Total:%d</font>**\n\n" \
                  " >**<font color=#97CC64 >Passed:%d</font>, <font color=#AAAAAA >Skipped:%d</font>**\n\n" \
                  " >**<font color=#FF0000 >Failed:%d</font>, <font color=#FFD050 >Broken:%d</font>**\n\n" \
                  % (JOB_NAME, mobiles, PassRate, reportUrl, Total, Passed, Skipped, Failed, Broken)

    personCounts = getPersonCounts()
    personCountsText = ''
    for personCount in personCounts:
        Name = personCount['name']
        Total = personCount['total']
        Failed = personCount['failed']
        Broken = personCount['broken']
        Skipped = personCount['skipped']
        Passed = personCount['passed']
        PassRate = '%.2f%%' % (Passed / (Total - Skipped) * 100)
        personCountText = "**『%s』：**\n\n" \
                          " ><font color=#000000 >Total:%d</font>, <font color=#0A83D1 >PassRate:%s</font>\n\n" \
                          " ><font color=#97CC64 >Passed:%d</font>, <font color=#AAAAAA >Skipped:%d</font>, " \
                          " <font color=#FF0000 >Failed:%d</font>, <font color=#FFD050 >Broken:%d</font>\n\n" \
                          % (Name, Total, PassRate, Passed, Skipped, Failed, Broken)
        personCountsText += personCountText
    text = summaryText + personCountsText
    print(text)
    return text


def sendMarkdownDing():
    # 1、构建url
    webhook = "https://oapi.dingtalk.com/robot/send?access_token=" + WEBHOOK_TOKEN
    # 2、构建一下请求头部
    header = {
        "Content-Type": "application/json",
        "Charset": "UTF-8"
    }
    # 3、构建请求数据
    data = {
        "msgtype": "markdown",
        "markdown": {
            "title": "接口自动化执行报告，请及时跟进处理！",
            "text": spillDingText()
        },
        "at": {
            "atMobiles": atMobiles,
            "isAtAll": False
        }
    }
    print(data)
    # 4、对请求的数据进行json封装
    sendData = json.dumps(data)  # 将字典类型数据转化为json格式
    sendData = sendData.encode("utf-8")  # python3的Request要求data为byte类型
    # 5、发送请求
    resp = requests.post(url=webhook, data=sendData, headers=header)
    print(resp.json())
    return resp.json()


if __name__ == '__main__':
    sendMarkdownDing()