python的Jenkins接口调用方式

Python是一门非常强大的语言，广泛应用于各个领域，其中运维自动化也是非常重要的一个方向。Jenkins是一个流行的开源持续集成工具，支持通过API接口来与Jenkins进行通信，然后可以通过python代码来调用Jenkins的API，实现各种自动化操作。本文将详细讲解Python中如何调用Jenkins的API。

步骤

1. 安装Python模块“jenkinsapi”

要使用Python调用Jenkins API，需要安装Python库"jenkinsapi"。在终端或命令提示符上执行以下命令进行安装：

pip install jenkinsapi

1. 获取Jenkins的API Token

Jenkins API使用Token验证的方式进行授权，所以需要先获取Jenkins的API Token。登录Jenkins，并进入“个人设置”->“API Token”，然后复制“API Token”到剪切板以备后面使用。

1. 构建Jenkins API客户端

在Python代码中创建一个Jenkins API客户端对象，这样就可以通过它来与Jenkins进行通信了。通常使用Jenkins API客户端模块(jenkins.Jenkins)构建客户端对象，代码如下：

from jenkins import Jenkins

JENKINS_URL = "http://localhost:8080"
JENKINS_USERNAME = "myuser"
JENKINS_PASSWORD = "mypassword"
JENKINS_API_TOKEN = "myapitoken"

jenkins_client = Jenkins(JENKINS_URL, username=JENKINS_USERNAME, password=JENKINS_PASSWORD,  api_token=JENKINS_API_TOKEN)

其中，将JENKINS_URL更改为你实际使用的Jenkins URL，将JENKINS_USERNAME和JENKINS_PASSWORD更改为实际使用的用户名和密码，将JENKINS_API_TOKEN替换为上面获取的Jenkins的API Token。

Jenkins API客户端对象构建完成后，就可以开始通过它调用Jenkins API了。

示例1：创建Jenkins Job

下面是一个通过Python脚本创建Jenkins Job的示例。假设我们需要根据一份Job的模板，创建新的Job，并将其添加到Jenkins中。

在Jenkins中，我们需要先创建Job的模板，然后通过Python代码将Job的模板复制一份，修改其中的信息，然后创建新的Job。

import time

def create_job(job_name, job_template_name):
    #获取Job的模板
    job_template = jenkins_client.get_job(job_template_name)

    #将Job的模板复制一份，并将新Job的名称更改为job_name
    new_job_config_xml = job_template.get_config()
    new_job_config_xml = new_job_config_xml.replace(job_template_name, job_name)

    #创建新的Job
    jenkins_client.create_job(job_name, new_job_config_xml)

#创建名为test_job的Job，以job_template为模板
create_job("test_job", "job_template")

通过以上代码，就可以创建一个名为“test_job”的新Job，并以“job_template”作为模板。

示例2：触发Jenkins Job构建

下面的示例演示如何使用Python脚本触发Jenkins Job的构建，示例代码如下：

def build_job(job_name):
    #触发Job构建
    jenkins_client.build_job(job_name)

    # 等待Job构建完成
    last_build_number = jenkins_client.get_job_info(job_name)['lastCompletedBuild']['number']
    while jenkins_client.get_build_info(job_name, last_build_number)['building']:
        time.sleep(1)

将要构建的Job名称作为参数传入，然后调用jenkins_client.build_job(job_name)来触发Job构建。如果需要等待Job构建完成，可以使用一个while循环，每秒钟检查一次构建状态，直到Job构建状态为非“正在构建”为止。

总结

上述两个简单的示例展示了如何使用Python调用Jenkins API执行常规任务。事实上，诸如插件管理、节点管理和安全管理等其他任务也能通过API调用完成。需要注意的是，Jenkins API是有一定安全风险的，应当限制调用API的权限，避免恶意调用。