基于 Jenkins 的测试报告获取与处理并写入 Jira Wiki 的技术总结

news2025/1/30 14:02:52

title: 基于 Jenkins 的测试报告获取与处理并写入 Jira Wiki 的技术总结
tags: 
- jenkins
- python
categories:
- jenkins

在软件开发的持续集成与持续交付（CI/CD）流程里，及时、准确地获取并分析测试报告对保障软件质量至关重要。本文将详细阐述如何借助 Jenkins 搭建自动化系统，实现批量触发测试任务、获取测试报告关键信息并写入 Jira Wiki 的全流程自动化，为技术同行提供技术参考与实践经验。

一、功能实现概述

批量任务触发与结果等待

借助jenkins库，通过run_jenkins_task函数实现批量触发 Jenkins 测试自动化任务。关键代码如下：

import asyncio

async def run_jenkins_task(env,testNG_job_name_dict,sosotest_job_name_dict,robot_job_name_dict):
    job_names = testNG_job_name_dict.get(env, [])
    testNG_results, sosotest_results, robot_results = await asyncio.gather(
        *[trigger_and_get_result(server, job_name) for job_name in job_names],
        * [trigger_and_get_result(sosotest_server, job_name, sosotest_params) for job_name,sosotest_params in sosotest_job_name_dict.items()],
        *[trigger_and_get_result(sosotest_server, job_name, sosotest_params) for job_name,sosotest_params in robot_job_name_dict.items()],
        return_exceptions=True)
    return testNG_results, sosotest_results, robot_results

该函数根据不同环境（如gray、cd等）和任务类型（testNG、sosotest、robot），批量触发对应的 Jenkins 任务。利用asyncio.gather并发执行任务，极大提高了执行效率。执行过程中，程序会等待所有任务完成，获取每个任务的执行结果，确保后续处理基于完整的任务数据。

测试报告关键信息提取

针对testNG、sosotest和robot三种不同类型的测试报告，分别编写get_testNG_report、get_sosotest_report和get_robot_report函数，运用正则表达式提取关键信息。以get_testNG_report函数为例：

import re
import requests

def get_testNG_report(testReport_url):
    report_info={}
    report_info['testReport_url'] = testReport_url
    try:
        res = requests.get(testReport_url)
        if res.status_code == 200:
            failures_pattern = r'(\d+) failures'
            failures_match = re.search(failures_pattern, res.text)
            if failures_match:
                failures = int(failures_match.group(1))
            else:
                failures = 0

            tests_pattern = r'(\d+) tests'
            tests_match = re.search(tests_pattern, res.text)
            if tests_match:
                tests = int(tests_match.group(1))
            else:
                tests = 0

            success_num = tests - failures
            if tests!= 0:
                success_rate = "{:.2%}".format(success_num / tests)
                report_info['success_rate'] = success_rate
            report_info['success_num'] = success_num
            report_info['failures'] = failures
            report_info['tests'] = tests
        else:
            print(f"请求失败，状态码: {res.status_code}")
    except requests.RequestException as e:
        print(f"请求时发生异常: {e}")
    return report_info

此函数通过requests库获取测试报告页面内容，然后使用正则表达式匹配(\d+) failures和(\d+) tests，分别提取失败次数和测试总次数，进而计算成功次数和成功率。针对不同类型报告，通过调整正则表达式，精准提取出报告执行数、成功率、失败数等关键信息。

信息组装与 Jira Wiki 写入

利用assembly_content函数将提取的关键信息组装成特定格式的 HTML 表格内容，再通过与 Jira API 交互的函数将其写入 Jira Wiki。assembly_content函数核心代码如下：

def assembly_content(content_list):
    content_header = f'''<table class=\"wrapped confluenceTable\" style=\"width: 2093.0px;\">
    <!-- 省略表格头部详细定义 -->
    </tr>
    '''
    content_body = ""
    for value in content_list:
        content_body += f'''<tr><td class=\"confluenceTd\" style=\"width: 208.0px;\" rowspan=\"3\">{value['functional_domain']}</td>'''
        for key1, value1 in value.items():
            if key1 == "functional_domain":
                continue
            value1 = {} if value1 is None else value1
            # 构建表格行内容
            content_body += f'''
            <td class=\"confluenceTd\" style=\"width: 171.0px;\">{key1}</td>
            <td class=\"confluenceTd\" style=\"width: 125.0px;\">{value1.get("tests")}</td>
            <!-- 省略其他列内容构建 -->
            <td class=\"confluenceTd\" style=\"width: 766.0px;\">
            <a href=\"{value1.get('testReport_url')}">{value1.get('testReport_url')}</a>
            </td></tr><tr>
            '''
        content_body += f'''</tr>'''
    content_fooder = f''' </tbody></table>'''
    content = content_header + content_body + content_fooder
    return content

该函数将不同任务的测试报告关键信息，按照功能域和报告类型进行整理，生成对应的 HTML 表格行。最终将这些行组合成完整的表格内容，其中包含报告执行数、成功率、失败数以及报告链接等信息。在写入 Jira Wiki 时，需要根据 Jira 对内容格式的要求，对生成的 HTML 内容进行适当转义和调整，确保顺利写入。