Jenkins 全能实战手册：从安装到高级自动化

6.4. 最佳实践：基于 Python 的 Job 备份与迁移

相比于传统的物理打包 /var/lib/jenkins，使用 Python 脚本备份 Job 更加轻量且易于管理。

6.4.1 备份 Job（提取配置为字典列表）

使用 get_jenkins_jobs 将所有任务的描述参数定时器Shell 脚本提取出来。

import requests
import xml.etree.ElementTree as ET

def get_jenkins_jobs(jenkins_url username password):
    s = requests.Session()
    s.auth = (username password)
    jobs_data = s.get(f"{jenkins_url}/api/json").json()
    result = []

    for job in jobs_data['jobs']:
        config_xml = s.get(f"{jenkins_url}/job/{job['name']}/config.xml").text
        root = ET.fromstring(config_xml)
        
        # 提取核心配置
        job_description = root.find("description").text if root.find("description") is not None else ""
        build_periodically = [bp.text.strip() for bp in root.findall(".//hudson.triggers.TimerTrigger/spec")]
        execute_shell = [es.text.strip() for es in root.findall(".//hudson.tasks.Shell/command")]
        
        # 提取参数
        params = []
        for p in root.findall(".//hudson.model.ParametersDefinitionProperty/parameterDefinitions/*"):
            params.append({
                'name': p.find("name").text if p.find("name") is not None else ""
                'description': p.find("description").text if p.find("description") is not None else ""
                'type': p.tag.split('.')[-1]
                'default_value': p.find("defaultValue").text if p.find("defaultValue") is not None else ""
            })

        result.append({
            'job_name': job['name']
            'job_description': job_description
            'build_periodically': build_periodically
            'execute_shell': execute_shell
            'parameters': params
        })
    return result

6.4.2 还原/创建 Job（利用备份数据迁移）

使用 create_jenkins_jobs 在新环境中批量重建任务。通过 <![CDATA[]]> 完美解决 Shell 中 && 等特殊字符导致的创建失败问题。

from requests.auth import HTTPBasicAuth

def create_jenkins_jobs(jenkins_url user passwd jobs_list):
    print("⚠️ 注意：description 和 execute_shell 中的中文字符不宜过多，以免触发 500 错误。")
    
    for job in jobs_list:
        # 1. 组装参数 XML
        param_xml = "<properties/>"
        if job.get("parameters"):
            inner_xml = "".join([f"""
                <hudson.model.StringParameterDefinition>
                    <name>{p['name']}</name>
                    <description>{p['description']}</description>
                    <defaultValue>{p['default_value']}</defaultValue>
                    <trim>false</trim>
                </hudson.model.StringParameterDefinition>""" for p in job["parameters"] if p['type'] == "StringParameterDefinition"])
            param_xml = f"<properties><hudson.model.ParametersDefinitionProperty><parameterDefinitions>{inner_xml}</parameterDefinitions></hudson.model.ParametersDefinitionProperty></properties>"

        # 2. 组装 Shell XML (使用 CDATA 保护特殊符号)
        shell_cmd = "\n".join(job.get("execute_shell" []))
        builder_xml = f"<builders><hudson.tasks.Shell><command><![CDATA[{shell_cmd}]]></command></hudson.tasks.Shell></builders>" if shell_cmd else "<builders/>"

        # 3. 组装定时器 XML
        trigger_cmd = "\n".join(job.get("build_periodically" []))
        trigger_xml = f"<triggers><hudson.triggers.TimerTrigger><spec>{trigger_cmd}</spec></hudson.triggers.TimerTrigger></triggers>" if trigger_cmd else "<triggers/>"

        config_xml = f"""<project><actions/><description>{job.get('job_description' '')}</description>
          <keepDependencies>false</keepDependencies>{param_xml}
          <scm class="hudson.scm.NullSCM"/><canRoam>true</canRoam><disabled>false</disabled>
          {trigger_xml}<concurrentBuild>false</concurrentBuild>{builder_xml}<publishers/><buildWrappers/>
        </project>"""

        # 4. 发送请求
        s = requests.Session()
        s.auth = HTTPBasicAuth(user passwd)
        crumb = s.get(f"{jenkins_url}/crumbIssuer/api/json").json()
        headers = {'Content-Type': 'application/xml' crumb['crumbRequestField']: crumb['crumb']}
        
        r = s.post(f"{jenkins_url}/createItem?name={job['job_name']}" data=config_xml.encode('utf-8') headers=headers)
        print(f"{job['job_name']} 创建状态: {r.status_code}")

6.4.3. 维护心得与避坑指南

1. 迁移时的“4个汉字”限制：
   在通过 API 创建 Job 时，如果 description 或 shell 中的中文过多（尤其是没有指定 XML header 为 UTF-8 时），Jenkins 可能会解析报错。
   • 对策：尽量保持描述精简，或在生成的 config_xml 字符串最前面加上 <?xml version=Ƈ.1' encoding='UTF-8'?>。
2. 特殊符号问题：
   Shell 脚本中的 & < > 是 XML 的敏感字符。在 Python 拼接时，必须像上面代码中那样使用 <![CDATA[ 脚本内容 ]]> 包裹，否则 Job 配置会损坏。
3. 定时任务检测：
   可以使用 run_jenkins_job_if_not_running 脚本（见笔记第 20 节）定期检测核心任务，确保“全任务”等监控脚本始终在运行。