Pytest-测试报告发送到钉钉群

chinrock

已于 2023-05-12 23:56:58 修改

阅读量734

点赞数

CC 4.0 BY-SA版权

文章标签： pytest 钉钉 jenkins

于 2023-05-12 23:55:49 首次发布

本文链接：https://blog.csdn.net/oqqChin12/article/details/130652015

文章介绍了如何在pytest接口自动化测试结束后，通过钉钉自定义机器人将测试报告发送到指定的钉钉群。主要步骤包括获取webhook地址，设置自定义关键词，在代码中添加发送请求的逻辑，并在pytest的钩子函数中调用。最后，验证发送的报告是否准确。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

记录一下pytest接口自动化结束后，将测试报告发送到钉钉群。

第一步：当然是在群里添加钉钉自定义机器人
在这里插入图片描述
添加时最重要的是 webhook地址（发送消息的请求链接信息）、自定义关键词（发送消息内容必须包含关键词才能发送）

具体可以查看官方的介绍文档

https://open.dingtalk.com/document/robots/custom-robot-access/

第二步：在代码中添加发送钉钉消息的请求
直接上代码，很简单
由于该接口测试框架是集成Jenkins，以BUILD_TAG命名文件夹存每次测试的报告

def send_dingtalk_message(BUILD_TAG):
    '''
    :param BUILD_TAG: 
    :return: 
    '''
   	#获取Jenkins项目名称
    JOB_NAME = basedir2.split("/")[-1]
    #获取Webhook的token
    dingtalk_Webhook = ReadConfig().get_config(file_name=Get_project_path('test_case_config'), section='ENV', option='dingtalk_Webhook')
    logger.write_msg(INFO,"开始发送测试报告到钉钉")
	#测试结果HTML报告链接
    html_report=f'http://jks.qa.xxx.com/job/xxx/view/All/job/{JOB_NAME}/ws/report/{BUILD_TAG}/report.html'
    #读取测试结果文案
    path = basedir2 + '/report/result.txt'
    if os.path.exists(path):
        pass
    else:
        print(" %s 文件不存在" % path)
        exit(0)
    with open(file=path,encoding='utf-8',mode='r') as fp:
        result = fp.read()
	#发送的内容必须包含机器人设置的关键字
    cont = "接口自动化已完成，查看结果\n"+result+"\n"+f"测试报告链接:{html_report}"  # 这里要包含新增机器人时候“安全设置”里的关键字，这里是“自动化测试”
    dates = {
        "msgtype": "text",
        "text": {
            "content": cont
        }
    }
    url = f"https://oapi.dingtalk.com/robot/send?access_token={dingtalk_Webhook}" # 输入上面生成的Webhook地址
    headers = {
        'Content-Type': 'application/json'
    }
    #发送请求
    res = requests.post(url=url,data=json.dumps(dates),headers=headers)
    logger.write_msg(INFO,res.json())

发送钉钉消息是用pytest的钩子函数 pytest_terminal_summary，收集测试结果后直接发送

def pytest_terminal_summary(terminalreporter):
    """
    收集测试结果
    """
    metadata = terminalreporter._session
    logger.write_msg(INFO, metadata.config._metadata)
    if 'BUILD_TAG' in metadata.config._metadata.keys():
        logger.write_msg(INFO, f"build_tag={metadata.config._metadata['BUILD_TAG']}")
        BUILD_TAG = metadata.config._metadata['BUILD_TAG']
        send_dingtalk_message(BUILD_TAG)