Python-jenkins模块批量配置jobs

2024-02-10 15:32
文章标签 python 配置 模块 批量 jenkins jobs

本文主要是介绍Python-jenkins模块批量配置jobs，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章目录

  • 新增配置
  • 配置修改
  • 配置删除

新增配置

以“丢弃旧的构建”配置选项为例，先在web页面手动配置一下相关配置项
在这里插入图片描述
使用python-jenkins获取配置信息如下
在这里插入图片描述
在web页面删掉配置选项，重新获取配置信息
在这里插入图片描述
在这里插入图片描述
分析python-jenkins两次获取的配置信息，通过对比发现此次配置添加会在<properties/>标签下面添加以下标签内容：

  <properties><jenkins.model.BuildDiscarderProperty><strategy class="hudson.tasks.LogRotator"><daysToKeep>2</daysToKeep><numToKeep>3</numToKeep><artifactDaysToKeep>-1</artifactDaysToKeep><artifactNumToKeep>-1</artifactNumToKeep></strategy></jenkins.model.BuildDiscarderProperty></properties>

实现思路：

  • 先获取jobs配置信息，config信息的格式是xml类型的
  • 将获取到的config信息保存到xml文件中
  • 使用xml.etree.ElementTree模块对xml文件进行修改
  • 读取修改后的xml文件信息，使用此信息重新配置jobs

批量添加的代码如下，这里配置的范围是2019文件夹2019-1视图下所有jobs：

#!/usr/bin/env python
# -*- coding:utf-8 -*-
# author: Sudley
# ctime: 2020/01/19import sys
import jenkins
import xml.etree.ElementTree as ETdef add_config_to_jobs(username,password):#此处的server用来获取信息，部分修改操作无法在视图URL下面执行server = jenkins.Jenkins('http://%s:%s@192.168.37.134:8081/job/2019/view/2019-1/',username, password)view_info = server.get_info()fail_count = 0#依次获取对应视图里面的jobs名称及配置信息for num in range(0,len(view_info['jobs'])):job_name = view_info['jobs'][num]['name']print(job_name)#print('aaaaaaaaa')jobs_config = server.get_job_config(job_name)#如果job已经配置过BuildDiscarderProperty则直接进入下一迭代if 'jenkins.model.BuildDiscarderProperty' in jobs_config:print('BuildDiscarderProperty configured')continue#将配置写入xml文件中tmp_xml = '/tmp/job_config.xml'with open(tmp_xml,'w') as f:f.write(jobs_config)f.write('\n')try:#配置xml文件，添加对应的标签add_tag2xml(tmp_xml)with open(tmp_xml,'r') as f:jobs_config_new = f.read()#此处的server用于修改配置，配置的名称在上面定义好server_1 = jenkins.Jenkins('http://%s:%s@192.168.37.134:8081/',username, password)job_name_new = '2019/' + job_name#print(job_name_new)#print(jobs_config_new)#修改job配置前需要先对其执行disable操作#print('bbbbbbbbbbb')server_1.disable_job(job_name_new)server_1 = jenkins.Jenkins('http://%s:%s@192.168.37.134:8081/',username, password)server_1.reconfig_job(job_name_new,jobs_config_new)#print('cccccccccccccccc')server_1.enable_job(job_name_new)except Exception as e:#print(e)#将配置失败的job名称保存到/tmp/config_failed.list列表中fail_list = '/tmp/config_failed.list'if fail_count == 0:with open(fail_list,'w') as f:f.write(job_name + '\n')else:with open(fail_list,'a') as f:f.write(job_name + '\n')fail_count = fail_count + 1def add_tag2xml(tmp_xml):#print(tmp_xml)#使用ET模块解析xml文件tree = ET.parse(tmp_xml)root = tree.getroot()#在properties标签后面添加新标签for properties in root.iter('properties'):BuildDiscarderProperty = ET.SubElement(properties,'jenkins.model.BuildDiscarderProperty')strategy = ET.SubElement(BuildDiscarderProperty,'strategy',attrib={'class':'hudson.tasks.LogRotator'})daysToKeep = ET.SubElement(strategy,'daysToKeep')daysToKeep.text = '2'numToKeep = ET.SubElement(strategy,'numToKeep')numToKeep.text = '3'artifactDaysToKeep = ET.SubElement(strategy,'artifactDaysToKeep')artifactDaysToKeep.text = '-1'artifactNumToKeep = ET.SubElement(strategy,'artifactNumToKeep')artifactNumToKeep.text = '-1'#美化xml格式，添加缩进prettyXml(root, '    ', '\n')tree.write(tmp_xml)def prettyXml(element, indent, newline, level = 0): # elemnt为传进来的Elment类，参数indent用于缩进，newline用于换行if element:  # 判断element是否有子元素if element.text == None or element.text.isspace(): # 如果element的text没有内容element.text = newline + indent * (level + 1)else:element.text = newline + indent * (level + 1) + element.text.strip() + newline + indent * (level + 1)#else:  # 此处两行如果把注释去掉，Element的text也会另起一行#element.text = newline + indent * (level + 1) + element.text.strip() + newline + indent * leveltemp = list(element) # 将elemnt转成listfor subelement in temp:if temp.index(subelement) < (len(temp) - 1): # 如果不是list的最后一个元素，说明下一个行是同级别元素的起始，缩进应一致subelement.tail = newline + indent * (level + 1)else:  # 如果是list的最后一个元素， 说明下一行是母元素的结束，缩进应该少一个subelement.tail = newline + indent * levelprettyXml(subelement, indent, newline, level = level + 1) # 对子元素进行递归操作if __name__ == '__main__' :username = sys.argv[1]password = sys.argv[2]add_config_to_jobs(username,password)

运行方式：

[root@CSDN /home/Sudley/python-jenkins]#python3 add_config_to_jobs.py ‘username’ ‘passwd’

配置修改

配置的修改和配置添加实现思路类似，比如将原来的“保持构建的最大个数”这一项由3改成30
上述新增配置添加成功后web页面下jobs的配置如下：
在这里插入图片描述

此次的代码在新增配置代码的基础下进行适当的修改，修改了if判断条件以及将add_tag2xml()替换为modify_xml()，详细脚本如下

#!/usr/bin/env python
# -*- coding:utf-8 -*-
# author: Sudley
# ctime: 2020/02/09import sys
import jenkins
import xml.etree.ElementTree as ETdef add_config_to_jobs(username,password):#此处的server用来获取信息，部分修改操作无法在视图URL下面执行server = jenkins.Jenkins('http://%s:%s@192.168.37.134:8081/job/2019/view/2019-1/',username, password)view_info = server.get_info()fail_count = 0#依次获取对应视图里面的jobs名称及配置信息for num in range(0,len(view_info['jobs'])):job_name = view_info['jobs'][num]['name']print(job_name)#print('aaaaaaaaa')jobs_config = server.get_job_config(job_name)#只有numToKeep的配置是3时菜进行修改if '<numToKeep>3</numToKeep>' not in jobs_config:print('numToKeep is not equal 3')continue#将配置写入xml文件中tmp_xml = '/tmp/job_config.xml'with open(tmp_xml,'w') as f:f.write(jobs_config)f.write('\n')try:#配置xml文件，添加对应的标签modify_xml(tmp_xml)with open(tmp_xml,'r') as f:jobs_config_new = f.read()#此处的server用于修改配置，配置的名称在上面定义好server_1 = jenkins.Jenkins('http://%s:%s@192.168.37.134:8081/',username, password)job_name_new = '2019/' + job_name#print(job_name_new)#print(jobs_config_new)#修改job配置前需要先对其执行disable操作#print('bbbbbbbbbbb')server_1.disable_job(job_name_new)server_1 = jenkins.Jenkins('http://%s:%s@192.168.37.134:8081/',username, password)server_1.reconfig_job(job_name_new,jobs_config_new)#print('cccccccccccccccc')server_1.enable_job(job_name_new)except Exception as e:#print(e)#将配置失败的job名称保存到/tmp/config_failed.list列表中fail_list = '/tmp/config_failed.list'if fail_count == 0:with open(fail_list,'w') as f:f.write(job_name + '\n')else:with open(fail_list,'a') as f:f.write(job_name + '\n')fail_count = fail_count + 1def modify_xml(tmp_xml):#print(tmp_xml)#使用ET模块解析xml文件tree = ET.parse(tmp_xml)root = tree.getroot()#修改numToKeep标签文本#方式一：for numToKeep in root.iter('numToKeep'):numToKeep.text = '30'#方式二：#root[3][0][0][1].text = '30'tree.write(tmp_xml)if __name__ == '__main__' :username = sys.argv[1]password = sys.argv[2]add_config_to_jobs(username,password)

配置后的效果
在这里插入图片描述

配置删除

删除上面添加的配置，即需要删除xml文件中properties标签下的jenkins.model.BuildDiscarderProperty标签，代码在配置修改的基础上面修改modify_xml()
详细代码如下：

#!/usr/bin/env python
# -*- coding:utf-8 -*-
# author: Sudley
# ctime: 2020/02/09import sys
import jenkins
import xml.etree.ElementTree as ETdef add_config_to_jobs(username,password):#此处的server用来获取信息，部分修改操作无法在视图URL下面执行server = jenkins.Jenkins('http://%s:%s@192.168.37.134:8081/job/2019/view/2019-1/',username, password)view_info = server.get_info()fail_count = 0#依次获取对应视图里面的jobs名称及配置信息for num in range(0,len(view_info['jobs'])):job_name = view_info['jobs'][num]['name']print(job_name)jobs_config = server.get_job_config(job_name)#只有numToKeep的配置是3时菜进行修改if 'jenkins.model.BuildDiscarderProperty' not in jobs_config:print('jenkins.model.BuildDiscarderProperty not configured')continue#将配置写入xml文件中tmp_xml = '/tmp/job_config.xml'with open(tmp_xml,'w') as f:f.write(jobs_config)f.write('\n')try:#配置xml文件，添加对应的标签modify_xml(tmp_xml)with open(tmp_xml,'r') as f:jobs_config_new = f.read()#此处的server用于修改配置，配置的名称在上面定义好server_1 = jenkins.Jenkins('http://%s:%s@192.168.37.134:8081/',username, password)job_name_new = '2019/' + job_name#修改job配置前需要先对其执行disable操作server_1.disable_job(job_name_new)server_1 = jenkins.Jenkins('http://%s:%s@192.168.37.134:8081/',username, password)server_1.reconfig_job(job_name_new,jobs_config_new)server_1.enable_job(job_name_new)except Exception as e:#print(e)#将配置失败的job名称保存到/tmp/config_failed.list列表中fail_list = '/tmp/config_failed.list'if fail_count == 0:with open(fail_list,'w') as f:f.write(job_name + '\n')else:with open(fail_list,'a') as f:f.write(job_name + '\n')fail_count = fail_count + 1def modify_xml(tmp_xml):#print(tmp_xml)#使用ET模块解析xml文件tree = ET.parse(tmp_xml)root = tree.getroot()#删除所有properties标签下的jenkins.model.BuildDiscarderProperty标签for properties in root.findall('properties'):for BuildDiscarderProperty in properties.findall('jenkins.model.BuildDiscarderProperty'):properties.remove(BuildDiscarderProperty)tree.write(tmp_xml)if __name__ == '__main__' :username = sys.argv[1]password = sys.argv[2]add_config_to_jobs(username,password)

主要用到的python模块为jenkins和xml.etree.ElementTre
参考文献：
https://python-jenkins.readthedocs.io/en/latest/examples.html
【Python】如何对xml文件进行新增、修改和删除等操作

这篇关于Python-jenkins模块批量配置jobs的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/697469。

相关文章

使用python生成固定格式序号的方法详解

使用python生成固定格式序号的方法详解

《使用python生成固定格式序号的方法详解》这篇文章主要为大家详细介绍了如何使用python生成固定格式序号,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考一下... 目录生成结果验证完整生成代码扩展说明1. 保存到文本文件2. 转换为jsON格式3. 处理特殊序号格式（如带圈数字）4
阅读更多...
win10安装及配置Gradle全过程

win10安装及配置Gradle全过程

《win10安装及配置Gradle全过程》本文详细介绍了Gradle的下载、安装、环境变量配置以及如何修改本地仓库位置,通过这些步骤,用户可以成功安装并配置Gradle,以便进行项目构建... 目录一、Gradle下载1.1、Gradle下载地址1.2、Gradle下载步骤二、Gradle安装步骤2.1、安
阅读更多...
MySQL数据库双机热备的配置方法详解

MySQL数据库双机热备的配置方法详解

《MySQL数据库双机热备的配置方法详解》在企业级应用中,数据库的高可用性和数据的安全性是至关重要的,MySQL作为最流行的开源关系型数据库管理系统之一,提供了多种方式来实现高可用性,其中双机热备（M... 目录1. 环境准备1.1 安装mysql1.2 配置MySQL1.2.1 主服务器配置1.2.2 从
阅读更多...
Python版本信息获取方法详解与实战

Python版本信息获取方法详解与实战

《Python版本信息获取方法详解与实战》在Python开发中,获取Python版本号是调试、兼容性检查和版本控制的重要基础操作,本文详细介绍了如何使用sys和platform模块获取Python的主... 目录1. python版本号获取基础2. 使用sys模块获取版本信息2.1 sys模块概述2.1.1
阅读更多...
一文详解Python如何开发游戏

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,：本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D
阅读更多...
Python函数作用域与闭包举例深度解析

Python函数作用域与闭包举例深度解析

《Python函数作用域与闭包举例深度解析》Python函数的作用域规则和闭包是编程中的关键概念,它们决定了变量的访问和生命周期,：本文主要介绍Python函数作用域与闭包的相关资料,文中通过代码... 目录1. 基础作用域访问示例1：访问全局变量示例2：访问外层函数变量2. 闭包基础示例3：简单闭包示例4
阅读更多...
Python实现字典转字符串的五种方法

Python实现字典转字符串的五种方法

《Python实现字典转字符串的五种方法》本文介绍了在Python中如何将字典数据结构转换为字符串格式的多种方法,首先可以通过内置的str()函数进行简单转换;其次利用ison.dumps()函数能够... 目录1、使用json模块的dumps方法：2、使用str方法：3、使用循环和字符串拼接：4、使用字符
阅读更多...
Python版本与package版本兼容性检查方法总结

Python版本与package版本兼容性检查方法总结

《Python版本与package版本兼容性检查方法总结》：本文主要介绍Python版本与package版本兼容性检查方法的相关资料,文中提供四种检查方法,分别是pip查询、conda管理、PyP... 目录引言为什么会出现兼容性问题方法一：用 pip 官方命令查询可用版本方法二：conda 管理包环境方法
阅读更多...
Linux云服务器手动配置DNS的方法步骤

Linux云服务器手动配置DNS的方法步骤

《Linux云服务器手动配置DNS的方法步骤》在Linux云服务器上手动配置DNS（域名系统）是确保服务器能够正常解析域名的重要步骤,以下是详细的配置方法,包括系统文件的修改和常见问题的解决方案,需要... 目录1. 为什么需要手动配置 DNS？2. 手动配置 DNS 的方法方法 1：修改 /etc/res
阅读更多...
基于Python开发Windows自动更新控制工具

基于Python开发Windows自动更新控制工具

《基于Python开发Windows自动更新控制工具》在当今数字化时代,操作系统更新已成为计算机维护的重要组成部分,本文介绍一款基于Python和PyQt5的Windows自动更新控制工具,有需要的可... 目录设计原理与技术实现系统架构概述数学建模工具界面完整代码实现技术深度分析多层级控制理论服务层控制注
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2