本文转自测试人社区，原文链接：https://ceshiren.com/t/topic/29270
Jenkins Api 简介
Jenkins Api 环境准备
使用 curl 调用 获取所有 Jobs 接口
curl -u USERNAME:PASSWORD "JENKINSURL:PORT/api/json?pretty=true"
# 可以加上&tree=jobs[name,url]进行显示内容的展示
复制代码
使用 curl 调用 获取所有构建队列
curl -u USERNAME:PASSWORD JENKINSURL:PORT/queue/api/json?pretty=
使用 curl 调用 获取 Job 信息
# 获取任务所有信息curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/api/json?pretty=true# 获取最后一次构建信息curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastBuild/api/json?pretty=true# 获取最后稳定构建信息curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastStableBuild/api/json?pretty=true# 获取最后成功的构建curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastSuccessfulBuild/api/json?pretty=true# 获取最后完成的构建curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastCompletedBuild/api/json?pretty=true# 最近失败的构建curl -u USERNAME:PASSWORD JENKINSURL:PORT/job/JOBNAME/lastFailedBuild/api/json?pretty=true
复制代码
使用 curl 调用 操作 Job
方式 1：获取 crumb
username_password=“USERNAME:PASSWORD”jenkins_url=“JENKINSURL:PORT”cookie_file=“$(mktemp)”jenkins_crumb=$(curl -s -f -u “${username_password}” --cookie-jar “${cookie_file}” -s “${jenkins_url}/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,%22:%22,//crumb)”)
复制代码
方式 2：使用 token
使用 curl 调用 操作 Job
# 获取job的configcurl -u USERNAME:PASSWORD -O JENKINSURL:PORT/job/JOBNAME/config.xml# 创建jobcurl -u USERNAME:PASSWORD "JENKINSURL:PORT/createItem?name=JOBNAME" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" -H 'Content-Type:text/xml' --data-binary "@./config.xml"# 复制jobcurl -u USERNAME:PASSWORD "JENKINSURL:PORT/createItem?name=NEWJOBNAME&mode=copy&from=JOBNAME" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}"# 修改jobcurl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/config.xml" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" -H 'Content-Type:text/xml' --data-binary "@./config.xml"# 无参构建curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/build" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" # 有参构建curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/buildWithParameters" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}" --data-urlencode json='{"key1":"value1","key2":"value2"}'# 删除jobcurl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/doDelete" --cookie "${cookie_file}" -X POST -H "${jenkins_crumb}"
复制代码
使用 curl 调用 操作指定构建的 Job
# 查看最新构建任务编号curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/son_demo/lastBuild/buildNumber"# 查看某次构建控制台日志curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/ID/logText/progressiveText"# 删除某次构建curl -u USERNAME:PASSWORD "JENKINSURL:PORT/job/JOBNAME/ID/doDelete" -X POST --cookie "${cookie_file}" -H "${jenkins_crumb}"
复制代码
Python Jenkins Api 常用接口操作
jenkinsapi 连接 Jenkins 服务
from jenkinsapi import jenkins
my_jenkins = jenkins.Jenkins(“JENKINSURL”, “USERNAME”, “PASSWORD”, useCrumb=True)
jenkinsapi 获取所有 jobs
需要注意，如果请求的 url 与 Jenkins Location 配置的 Jenkins URL 不一致时，获取到的 key 会拼接上一截地址
print(my_jenkins.keys()) # 获取所有的job名称for info in my_jenkins.get_jobs_info():print(info) # 获取job的url与名称 比较卡
复制代码
jenkinsapi 获取构建队列
print(my_jenkins.get_queue().keys())
jenkinsapi 获取 Job 信息
# 获取job对象my_job = my_jenkins.get_job("JOBSNAME")# 获取最后一次构建对象print(my_job.get_last_build())# 获取最后一次完成的构建对象print(my_job.get_last_completed_build())# 获取最后一次成功的构建对象print(my_job.get_last_good_build())# 获取最后一次失败的构建编号print(my_job.get_last_failed_buildnumber())
复制代码
jenkinsapi 操作 Job 信息
# 获取job的configprint(my_job.get_config())# 创建job# 先获取到job的configwith open("config.xml", "w", encoding="utf-8") as f: my = my_jenkins.get_job("JOBNAME").get_config() f.write(my)my_jenkins.create_job("NEWJOBNAME", open("./config.xml",encoding="utf-8").read())# 复制jobmy_jenkins.copy_job("JOBNAME", "NEWJOBNAME")# 禁用jobmy_job.disable()# 启用jobmy_job.enable()# 重命名jobmy_jenkins.rename_job("JOBNAME", "NEWJOBNAME")# 无参构建my_jenkins.build_job("JOBNAME")# 有参构建my_jenkins.build_job("JOBNAME", params={"key": "value"})# 删除jobmy_jenkins.delete_job("JOBNAME")
复制代码
jenkinsapi 操作指定构建的 Job
# 当前job对象是否在队列/构建中print(my_job.is_queued_or_running())# 获取指定构建ID的对象build_object = my_job.get_build(BUILDID)# 获取构建对象的时间戳print(build_object.get_timestamp())# 获取控制台日志print(build_object.get_console())# 获取构建参数print(build_object.get_params())# 获取构建的状态print(build_object.get_status())# 获取构建的变更日志print(build_object.get_changeset_items())# 删除指定构建my_job.delete_build(BUILDID)
复制代码
评论