jenkinsapi python - 如何触发和跟踪作业结果

Question

我正在使用 JenkinsAPI 来触发参数化作业。我知道 Jenkins 使用的 REST API，但我们的设置不允许直接这样做；所以我触发工作的主要方式是通过这个库。

到目前为止，我在服务器上查找作业或触发作业没有任何问题，但我面临 2 个问题

1) 当我触发一个工作时，我不知道它的结果。我假设当我运行 build_job 函数时会返回作业的输出，但事实并非如此。我需要知道该作业是否通过或失败，但我找不到获取此信息的方法，因为在触发它时我什至无法检索作业编号。

2) 作业运行时出现错误，尽管作业确实顺利通过：

raise ValueError("Not a Queue URL: %s" % redirect_url)

我读了一点，似乎 Jenkins 在 http 和 https 之间切换 url，这让图书馆感到困惑。如果我理解正确的话，它被认为是 Jenkins 的问题，因此，JenkinsAPI 方面没有修复。

这是目前的代码，它确实连接到我的詹金斯服务器，确实检索了作业列表，确实触发了作业，但不允许我知道作业是通过还是失败，我得到了前面提到的错误。

有什么方法可以让它工作，以便我可以获得我触发的作业的 pass/fail 结果？

jenkins_url = 'http://myjenkins_host:8080'   
# Create server
server = Jenkins(jenkins_url, username='user', password='123456789abcdef')
# Check job and print description
for job_name, job_instance in server.get_jobs():
    if job_name == "testjob":
        print('Job Name:%s' % job_instance.name)
        print('Job Description:%s' % (job_instance.get_description()))

# Trigger job
params = {'a':1, 'b':2, 'c': True}
server.build_job("testjob", params)
# HOW do I get the result of this job???

Answer 1

我不是 Jenkins 的忠实粉丝Python API 老实说，我什至没用过一次。我个人更喜欢使用 raw JSON API 和 Python，它更适合我（这就是为什么我的示例将使用 JSON API，但最后，目标仍然通过 python 脚本实现）。

现在回答您的问题，您可以不时通过 API 查询来跟踪工作状态和结果。但要事第一。

1.Prerequisites

Python 2.7 或 3.x 和 python requests 安装库：

pip install requests

对于python3.x

pip3 install requests

另外：How to install pip

2.Python 触发和跟踪结果的脚本

import requests
import time


jenkins_url = "http://localhost:8080"
auth = ("USERNAME", "PASSWORD")
job_name = "Dummy"
request_url = "{0:s}/job/{1:s}/buildWithParameters".format(
    jenkins_url,
    job_name,
)

print("Determining next build number")
job = requests.get(
    "{0:s}/job/{1:s}/api/json".format(
        jenkins_url,
        job_name,
    ),
    auth=auth,
).json()
next_build_number = job['nextBuildNumber']
next_build_url = "{0:s}/job/{1:s}/{2:d}/api/json".format(
    jenkins_url,
    job_name,
    next_build_number,
)

params = {"Foo": "String param 1", "Bar": "String param 2"}
print("Triggering build: {0:s} #{1:d}".format(job_name, next_build_number))
response = requests.post(request_url, data=params, auth=auth)

response.raise_for_status()
print("Job triggered successfully")

while True:
    print("Querying Job current status...")
    try:
        build_data = requests.get(next_build_url, auth=auth).json()
    except ValueError:
        print("No data, build still in queue")
        print("Sleep for 20 sec")
        time.sleep(20)
        continue

    print("Building: {0}".format(build_data['building']))
    building = build_data['building']
    if building is False:
        break
    else:
        print("Sleep for 60 sec")
        time.sleep(60)

print("Job finished with status: {0:s}".format(build_data['result']))

以上脚本适用于 python 2.7 和 3.x。现在稍微解释一下：

一开始，我们想解决未来构建的数量，以便稍后查询。在触发该构建之后，将检查响应是否有错误。 4XX 客户端错误或 5XX 服务器错误响应将引发异常：requests.exceptions.HTTPError。最后一步只是查询触发构建的状态，只要它没有完成。但请注意，触发构建可能会在 queue 中持续一段时间，因此会在代码中出现 try: except: 块。当然，您可以根据需要调整time.sleep()。

示例输出：

$ python dummy.py 
Determining next build number
Triggering build: Dummy #55
Job triggered successfully
Querying Job current status...
No data, build still in queue
Sleep for 20 sec
Querying Job current status...
Building: True
Sleep for 60 sec
Querying Job current status...
Building: True
Sleep for 60 sec
Querying Job current status...
Building: False
Job finished with status: SUCCESS

！请注意！

根据您的 Jenkins 版本和安全设置，您可能会遇到以下错误：

requests.exceptions.HTTPError: 403 Client Error: No valid crumb was included in the request for url: ...

Jenkins 默认有 CSRF Protection enabled which prevents one-click attacks.

要解决这个问题，您可以：

禁用防止跨站请求伪造利用 Jenkins 配置全局安全中的复选框（不推荐）
使用您的凭据从 /crumbIssuer/api/xml 获取面包屑并将其包含在您的请求中 headers。

以上脚本只需稍作修改即可使用 jenkins crumb：

crumb_data = requests.get(
    "{0:s}/crumbIssuer/api/json".format(jenkins_url),
    auth=auth,
).json()
headers = {'Jenkins-Crumb': crumb_data['crumb']}

并将那些 headers 传递给触发新构建的请求，如下所示：

print("Triggering build: {0:s} #{1:d}".format(job_name, next_build_number))
response = requests.post(
    request_url,
    data=params,
    auth=auth,
    headers=headers,
)

jenkinsapi python - 如何触发和跟踪作业结果

jenkinsapi python - how to trigger and track the job result

python

jenkins

jenkins-api