软件测试学习笔记丨 Jenkins api 接口

作者：测试人

2024-04-16
北京
本文字数：1677 字
阅读完需：约 6 分钟

本文转自测试人社区，原文链接：https://ceshiren.com/t/topic/30381

一， Jenkins Api 简介

Jenkins 对外暴露的动作交付入口
为外部程序提供入口，可以控制 Jenkins
支持协议 - Http
Api 接口支持用户名、密码认证
Jenkins Api 支持的典型功能：运行 Job、查看任务状态、返回任务编号…等

二， Jenkins Api 环境准备

2.1 环境准备

创建一个有任务运行和查询权限的用户
较老版本的 Jenkins 操作关闭跨站脚本伪造请求保护，新版本的 Jenkins 无此选项了
官方文档 HTTPS://WWW.JENKINS.IO/DOC/BOOK/USING/REMOTE-ACCESS-API/

2.2 使用 curl 调用获取所有 Jobs 接口

curl -u USERNAME:PASSWORD "JENKINSURL:PORT/api/json?pretty=true"
curl -u USERNAME:PASSWORD -g "JENKINSURL:PORT/api/json?pretty=true&tree=jobs[name,url]"
# 可以加上&tree=jobs[name,url]进行显示内容的展示

复制代码

2.3 使用 curl 调用获取所有构建队列

curl -u USERNAME:PASSWORD JENKINSURL:PORT/queue/api/json?pretty=true

复制代码

2.4 使用 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

复制代码

2.5 使用 curl 调用操作 Job

获取 crumb

操作 Job 需要验证 crumb
获取 crumb 使用使用 token 发起接口

# 方式1：获取crumbusername_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

复制代码

操作 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}"

复制代码

操作指定构建的 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 "$

复制代码

软件测试开发免费视频教程分享

发布于: 刚刚阅读数: 3

原文链接:【http://xie.infoq.cn/article/e3d8f560cb097ee0b40784648】。文章转载请联系作者。

测试人

关注

专注于软件测试开发 2022-08-29 加入

霍格沃兹测试开发学社，测试人社区：https://ceshiren.com/t/topic/22284

发布

暂无评论

创作场景

软件测试学习笔记丨 Jenkins api 接口

一， Jenkins Api 简介

二， Jenkins Api 环境准备

2.1 环境准备

2.2 使用 curl 调用获取所有 Jobs 接口

2.3 使用 curl 调用获取所有构建队列

2.4 使用 curl 调用获取 Job 信息

2.5 使用 curl 调用操作 Job

获取 crumb

操作 job

操作指定构建的 Job

推荐学习

软件测试开发免费视频教程分享

测试人

评论

创作场景

软件测试学习笔记丨 Jenkins api 接口

一， Jenkins Api 简介

二， Jenkins Api 环境准备

2.1 环境准备

2.2 使用 curl 调用 获取所有 Jobs 接口

2.3 使用 curl 调用 获取所有构建队列

2.4 使用 curl 调用 获取 Job 信息

2.5 使用 curl 调用操作 Job

获取 crumb

操作 job

操作指定构建的 Job

推荐学习

软件测试开发免费视频教程分享

测试人

评论

2.2 使用 curl 调用获取所有 Jobs 接口

2.3 使用 curl 调用获取所有构建队列

2.4 使用 curl 调用获取 Job 信息