Python-Jenkins 获取Job构建信息的方法
5星
- 浏览量: 0
- 大小:None
- 文件类型：PDF
简介：
本文章介绍了如何使用Python脚本来获取Jenkins中Job的构建信息，包括安装必要的库、连接到Jenkins以及提取和解析所需数据的具体方法。
Python-jenkins库用于与Jenkins服务器进行交互，并支持自动化管理作业（job）的各种操作，如启动构建、获取构建状态等。
要使用Python-jenkins来获取Job的构建信息，请首先安装该库：
```
pip install python-jenkins
```
接下来是详细步骤：
1. **初始化连接**：创建一个Jenkins服务器实例，需要提供URL和认证凭据。
```python
from jenkins import Jenkins
server = Jenkins(http://jenkins_url:port, username=username, password=password)
```
2. **获取构建状态**：
- 使用`get_queue_info()`方法检查作业是否在队列中等待构建。如果找到匹配的job名称，则表明该作业正在排队。
- 通过调用`get_build_info(name, build_number)`，可以获取到指定编号的构建详情和结果。
3. **封装功能**：为方便使用，将上述逻辑整合进一个函数如`get_build_state()`中。此函数首先检查job是否在队列等待，并返回相应的状态字符串（例如pending, success, failed, building）。
4. **API接口实现**：
在Web服务环境中创建HTTP接口以调用封装好的功能，使用Flask框架为例:
```python
from flask import Flask, request, jsonify
app = Flask(__name__)
@app.route(/api/getBuildState, methods=[POST])
def get_job_build_state():
data = request.get_json()
job_name = data[job_name]
server = Jenkins(http://jenkins_url:port, username=username, password=password)
lastbuildNumber = server.get_job_info(job_name)[lastBuild][number]
build_state = get_build_state(server, job_name, lastbuildNumber)
build_msg = { SUCCESS: Success, FAILURE: Failed,
ABORTED: Aborted}.get(build_state,Building)
response = {
code: 200,
msg:OK,
build_state : build_msg,
buildNumber : lastbuildNumber
}
return jsonify(response)
if __name__ == __main__:
app.run(debug=True)
```
此接口接收POST请求并返回构建状态和编号的JSON响应。
5. **测试接口**：使用requests库进行测试：
```python
import requests
data = {job_name: your_job_name}
response = requests.post(http://localhost:5000/api/getBuildState, json=data)
print(response.json())
```
这将返回指定作业的构建状态和编号。
总结来说，通过Python-jenkins库可以方便地获取Jenkins Job的状态，在自动化测试、持续集成监控等方面非常有用。结合API实现更复杂的任务如自动触发构建或发布等操作，并确保正确处理异常情况及安全存储认证信息至关重要。
全部评论 (0)
