jenkins接入钉钉api接口自动化测试报告自动发送

简介: 该教程介绍了如何在Jenkins上实现接口自动化测试的持续集成,并将可视化报告发送至钉钉工作群。首先,确保准备好了自动化脚本。接着配置Jenkins:安装Git插件,设置源代码管理(如Git)和触发器(定时或推送)。使用Post build task插件处理构建后的报告,读取Allure的prometheusData.txt文件以获取测试结果。最后,安装Ding Talk插件,配置钉钉机器人,通过 Dingtalkchatbot 库发送测试报告信息到钉钉群。整个流程包括Jenkins的定时构建、Git仓库的监听以及自动化报告发送到钉钉的通知。

image.png

一些同学的公司在做接口自动化测试时,难免会要求进行持续集成以及需要将可视化报告发送到诸如钉钉工作群等地方,于是便编写下列相关教程。

jenkins上进行持续集成以及接入钉钉

前提条件

准备好自动化脚本

持续集成

源代码管理模块

安装插件:Git plugin

获取凭证:http拉取链接对应:登录账号密码,id置空,描述任意

指定分支:格式为*/xxx 比如*/dev

触发器模块

定时触发:

jenkins项目中构建触发器->Build periodically

采用五颗*占位符的方式书写。
分别为:分钟,小时,一个月中第几天,第几月,一周中第几天
常用格式:
H/30 * * * *  每30分钟构建一次
H H/2 * * * 每2个小时构建一次
0 8 * * * 每天早上8点构建一次
0,8,12,22 * * * 每天8点,12点,22点构建各一次

推送触发:

当指定远端仓库存在推送或合并行为时,触发jenkins构建

  • 生成对应git仓库的凭证api token
  • gitlab举例:个人头像->Settings->Access TokenPersonal Access Tokens->编写名称,有效期以及勾选权限:api->生成,复制token
  • 安装插件GitLab Plugin
  • 配置token:Manage JenkinsSystemGitLab然后按照要求填写gitlab仓库地址以及获取的token便可创建一个链接凭证
  • 在项目中选中对应链接凭证,便可将该项目和凭证对应的远程仓库关联起来,从而捕获远程仓库的提交合并等行为。
  • 然后就是设置捕获哪些分支的情况作为触发器。

后置处理器插件

插件Post build task

  • 安装插件 Post build task
  • 这个插件是为了提取构建结束后,生成的allure报告信息
  • 通过jenkins中的allure报告插件,生成的数据中存在一个prometheusData.txt的文件,该文件记录着测试用例的通过情况,则可以通过在代码里编写一个读取该文件的方法,然后在构建结束后进行调用。

path = os.path.abspath(os.path.dirname((__file__)))

        try:
            with open(path + r'/allure-results/html/export/prometheusData.txt', 'r') as f:
                for lines in f:  # 通常这里应该是 'line' 而不是 'lines',因为每次迭代都是一行
                    parts = lines.strip('\n').split(' ')  # 去除换行符并按空格分割
                    if len(parts) >= 2:  # 确保至少有两个元素
                        launch_name = parts[0]
                        num = parts[1]
                        d.update({
   
   launch_name: num})  # 更新或添加键值对到字典
            print(d)  # 在文件读取完成后打印字典
        except FileNotFoundError:
            print("文件未找到或无法打开")
        except IOError as e:
            print(f"打开文件时发生I/O错误: {e}")
        print(d)
        retries_run = d.get('launch_retries_run')  # 运行总数
        print('运行总数:{}'.format(retries_run))
        status_passed = d.get('launch_status_passed')  # 通过数量
        print('通过数量:{}'.format(status_passed))
        status_failed = d.get('launch_status_failed')  # 不通过数量
        print('没通过数量:{}'.format(status_failed))
        status_broken = d.get('launch_status_broken')  # 中断数量

接入钉钉api

插件安装:Ding Talk

使用方法

  • jenkins配置钉钉助手
  • Manage jenkins->钉钉图标(我的jenkins版本是2.4,图标在页面底部)
  • 新增机器人,这里定义机器人的名字然后是最关键的webhook这个是一个凭证来链接对应的钉钉群聊里的小机器人。
  • 安全设置(这个是钉钉app在创建群机器人时的设置):
    • ip设置:钉钉群里的机器人只接收指定ip发送请求
    • 关键字:只接收信息中包含关键字的请求。
  • 项目中便会出现钉钉机器人选项,选择jenkins配置好的机器人,便可发送基本信息,不过此处并不用这种方式来向钉钉群聊发送消息,而是通过代码调用钉钉机器人开放的接口。
  • 代码中使用第三方库:dingtalkchatbot来完成对钉钉机器人发送请求,并且通过关键字的方式通过安全检验。
  • jenkins自动化脚本运行完毕后,通过post build task来触发该后置脚本的运行,便可获取并发送刚刚生成的测试报告的信息到钉钉群里。

from dingtalkchatbot.chatbot import DingtalkChatbot
# jenkins登录地址
jenkins_url = "http://xxxx:8282/"
# 获取jenkins对象
server = jenkins.Jenkins(jenkins_url, username='xxxx', password='xxxx')  # Jenkins登录名 ,密码
# job名称
job_name = "job/xxxxx/"  # Jenkins运行任务名称
# job的url地址
job_url = jenkins_url + job_name
# 获取最后一次构建
job_last_build_url = server.get_info(job_name)['lastBuild']['url']
# 报告地址
report_url = job_last_build_url + 'allure'  # 'allure'为我的Jenkins全局工具配置中allure别名
    def send_dingtalk(self):
        d = {
   
   }
        path = os.path.abspath(os.path.dirname((__file__)))

        try:
            with open(path + r'/allure-results/html/export/prometheusData.txt', 'r') as f:
                for lines in f:  # 通常这里应该是 'line' 而不是 'lines',因为每次迭代都是一行
                    parts = lines.strip('\n').split(' ')  # 去除换行符并按空格分割
                    if len(parts) >= 2:  # 确保至少有两个元素
                        launch_name = parts[0]
                        num = parts[1]
                        d.update({
   
   launch_name: num})  # 更新或添加键值对到字典
            print(d)  # 在文件读取完成后打印字典
        except FileNotFoundError:
            print("文件未找到或无法打开")
        except IOError as e:
            print(f"打开文件时发生I/O错误: {e}")
        print(d)
        retries_run = d.get('launch_retries_run')  # 运行总数
        print('运行总数:{}'.format(retries_run))
        status_passed = d.get('launch_status_passed')  # 通过数量
        print('通过数量:{}'.format(status_passed))
        status_failed = d.get('launch_status_failed')  # 不通过数量
        print('没通过数量:{}'.format(status_failed))
        status_broken = d.get('launch_status_broken')  # 中断数量

        con = {
   
   
            "content": "Pytest_Allure_Demo自动化脚本执行完成。\n"
                       "测试概述:\n"
                       "运行总数: " + retries_run + "\n"
                        "通过数量: " + status_passed + "\n"
                        "失败数量: " + status_failed + "\n"
                        "中断数量: " + status_broken + "\n"                        
                        "构建地址:" + job_url + "\n"
                          "报告地址:" + report_url
        }

        # 获取路径,目的是找到report.html文件的路径
        path = os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))  # 获取当前路径
        html_path = os.path.join(path, "allure-results/html/index.html")  # 获取html格式报告文件的路径
        tile = time.strftime("%Y-%m-%d %H:%M:%S")
        # WebHook地址,你钉钉上创建自定义机器人时生成的值
        webhook = 'xxxx'
        # 初始化机器人小丁
        xiaoding = DingtalkChatbot(webhook)
        ding = DingTalk()
        jd = json.dumps(con)
        # xixi = ding.read_report(html_path)
        xiaoding.send_text(
            # Qa-审核后台自动化是机器人的关键字,必须要保持一致
            msg='Qa-冼喆\n\n' + con["content"] + "\n\n项目url:**/" + "\n\n执行时间:" + tile
        )
相关文章
|
1月前
|
存储 设计模式 测试技术
怎么基于Pytest+Requests+Allure实现接口自动化测试?
该文介绍了一个基于Python的自动化测试框架,主要由pytest、requests和allure构成,采用关键字驱动模式。项目结构分为六层:工具层(api_keyword)封装了如get、post的请求;参数层(params)存储公共参数;用例层(case)包含测试用例;数据驱动层(data_driver)处理数据;数据层(data)提供数据;逻辑层(logic)实现用例逻辑。代码示例展示了如何使用allure装饰器增强测试报告,以及如何使用yaml文件进行数据驱动。
|
8天前
|
JavaScript 前端开发 测试技术
自动化测试在API测试中的深度应用与实践
【7月更文挑战第8天】自动化测试在API测试中的应用极大地提高了测试效率和质量,为软件的快速迭代和持续交付提供了有力保障。通过合理选择测试工具、制定清晰的测试计划并遵循最佳实践,我们可以充分发挥自动化测试的优势,为软件产品的稳定性和可靠性保驾护航。
|
1月前
|
jenkins 测试技术 持续交付
30个接口自动化测试面试题,赶紧收藏
接口自动化测试是使用工具验证接口功能、性能和安全性的自动化过程。它能提升测试效率,减少人工工作量,及时发现问题。常见工具包括Postman、SoapUI和JMeter。测试涉及需求分析、测试计划、用例设计、脚本编写、执行、报告生成及问题跟踪。测试用例涵盖输入数据、预期结果等,脚本包含请求和响应细节。断言验证接口正确性,数据驱动测试使用多数据验证,性能测试检查响应时间等,安全测试关注认证和加密,Mock测试模拟数据,集成测试验证接口交互,回归测试确保修改未破坏原有功能,异常处理确保测试稳定性,并发和压力测试检查系统负载,持续集成通过工具如Jenkins保证软件质量。
|
15天前
|
Java jenkins 持续交付
Jenkins是开源CI/CD工具,用于自动化Java项目构建、测试和部署。通过配置源码管理、构建触发器、执行Maven目标,实现代码提交即触发构建和测试
【7月更文挑战第1天】Jenkins是开源CI/CD工具,用于自动化Java项目构建、测试和部署。通过配置源码管理、构建触发器、执行Maven目标,实现代码提交即触发构建和测试。成功后,Jenkins执行部署任务,发布到服务器或云环境。使用Jenkins能提升效率,保证软件质量,加速上线,并需维护其稳定运行。
54 0
|
18天前
|
测试技术 Python
python接口自动化测试 - unittest框架suite、runner详细使用
python接口自动化测试 - unittest框架suite、runner详细使用
|
2月前
|
Web App开发 JavaScript 测试技术
python自动化测试实战 —— WebDriver API的使用
python自动化测试实战 —— WebDriver API的使用
39 1
|
2月前
|
API
请问下钉钉有能够获取到群聊天和个人聊天历史记录的api嘛?
DingTalk API 文档中的“消息列表创建”链接似乎已失效:https://developers.dingtalk.com/document/app/message-list-creation. 请注意检查更新或寻找替代资源。
|
2月前
|
API
钉钉API调试工具使用
钉钉API调试工具使用
53 0
|
2月前
|
jenkins Java 持续交付
【项目集成工具】Jenkins
【项目集成工具】Jenkins
|
16天前
|
jenkins Java 持续交付
运用Jenkins实现Java项目的持续集成与自动化部署
在新建的Jenkins Job中,我们需要配置源码管理,通常选择Git、SVN等版本控制系统,并填入仓库地址和凭据。接着,设置构建触发器,如定时构建、轮询SCM变更、GitHub Webhook等方式,以便在代码提交后自动触发构建过程。
44 2