python jenkins库 api简介

小灰灰 2021-09-01 05:04 604阅读 0赞

Python Jenkins Guide: [https://python-jenkins.readthedocs.io/en/latest/index.html][https_python-jenkins.readthedocs.io_en_latest_index.html]  
Python-jenkins: [https://pypi.org/project/python-jenkins/][https_pypi.org_project_python-jenkins]  
安装： pip install python-jenkins

API 介绍

*  **`连接Jenkins服务器`**

> server = jenkins.Jenkins(url, username=None, password=None, timeout=30)

url : 指的是所连接的Jenkins的`网络地址`  
username/password : username/password 默认值是`None`， 在内网中不传参数也是可以连接成功的，但应该`只有读`的权限，没有操作权限。所以一般需要用户名和密码。

*  **`账户信息`**

> server.get\_whoami()

获取连接账户的相关信息， 有关私密信息就不打印出来了

> server.get\_version()  
> '2.176.3'

获取连接Jenkins的版本信息

*  **`获取job相关信息`**  
    所谓job的话，指的是在Jenkins里面创建的一系列项目

# 获取所有的job信息
    server.get_jobs()
    
    # 获取job为name的基本信息
    server.get_job_info(name)
    
    #获取job名为name的job的最后次构建号， 不会计算排队中的构建， 
    #例如正在构建的number是3， 在排队的有4和5， 那么最后次构建号是3
    server.get_job_info(name)['lastBuild']['number']
    
    # 正则匹配到相应job的基本信息
    server.get_job_info_regex(pattern)
    
    #判断job是否存在
    server.job_exists(name)
    
    #获取所有job的数量
    server.jobs_count()

*  **`获取build相关信息`**  
    所谓build的话，指的是在Job里面的一次构建

# 获取某次构建信息，举例178， 如果178不存在或者正在排队中， 则会抛出异常
    # JenkinsException: job[name] number[178] does not exist
    server.get_build_info(name, 178)
    
    # result指构建运行的状态， 构建如果是运行完成返回结果FAILURE/ABORTED/SUCCESS/UNSTABLE等
    # 构建如果是正在运行返回结果 None
    server.get_build_info(name, 178)['result']

*  **`操作`**  
    `需要明确该账户在Jenkins中有对应的操作权限，否则在脚本中是无法做相应操作的`

# 获取所有排队的build
    server.get_queue_info()
    
    # 获取所有正在运行的build
    server.get_running_builds()

> server.stop\_build(name, number) \# 停止正在运行的构建

1.  停止掉`queue`排队中的构建， 直接抛出异常`NotFoundException: Requested item could not be found`
2.  停止掉`running`运行中的构建， 无返回值， 无报错，在Jenkins页面上显示该构建被XXX 账户停掉了
3.  停止掉`stopped`已经停止的构建， 无返回值， 无报错，Jenkins页面无变化

> server.cancel\_queue(id) \# 配合server.get\_queue\_info()使用，得到排队构建的id， 可以取消该构建

1.  server.get\_queue\_info() 获取某个排队`构建的id`， 如123.
2.  如果该构`建排队`中直接server.cancel\_queue(123)， 无返回值， 无报错，Jenkins页面上排队的构建直接被撤销，看不出原来有这么一个排队的构建
3.  如果等排队的构建到`运行状态`， 使用server.cancel\_queue(123)， 无返回值， 无报错， 该构建依旧在运行中
4.  如果等排队的构建到`完成状态`， 使用server.cancel\_queue(123)， 无返回值， 无报错， 该构建依旧为完成结束状态

[https_python-jenkins.readthedocs.io_en_latest_index.html]: https://links.jianshu.com/go?to=https%3A%2F%2Fpython-jenkins.readthedocs.io%2Fen%2Flatest%2Findex.html
[https_pypi.org_project_python-jenkins]: https://links.jianshu.com/go?to=https%3A%2F%2Fpypi.org%2Fproject%2Fpython-jenkins%2F