文档章节

Jenkins API 使用

YanWen
 YanWen
发布于 2019/04/21 21:17
字数 1264
阅读 361
收藏 0

3 月,跳不动了?>>>

Jenkins 是一款流行的开源持续集成工具,可以用来做一些软件开发的自动化工作,如打包,测试,自动部署等。

Jenkins 中有 viewjob 的概念, view 相当于组, job 则是具体的任务。 view 下面可以创建 job ,但 job 可以不在任何 view 下。

这里主要介绍 Jenkins 提供的 HTTP API ,至于如何使用 Jenkins 请参看 Jenkins User Documentation

API

鉴权

Jenkins 使用 Baisc Auth 的权限验证方式,需要传入 usernameapi token 。 其中 api token 需要在用户的设置界面去创建。

但在 Job 的远程触发中,可以设置用于远程触发的 token (在 Job 的配置页面设置),这样在触发 Job 时就不需要传入 Basic Auth 了。 远程触发的 token 使用 urlencode 的方式放在请求的 body 中,其原始数据为: token=<Token Value>

下面给出两种方式触发 Job 的例子:

  • Basic Auth

    curl -X POST <jenkins url>/view/<view name>/job/<job name>/build --user <username>:<api token>

  • Token

    curl -X POST <jenkins url>/view/<view name>/job/<job name>/build --data-urlencode token=<Token Value>

View

  • 创建

    API: <jenkins url>/createView

    curl: curl -X POST <jenkins url>/createView?name=<view name> --data-binary "@viewCofnig.xml" -H "Content-Type: text/xml" --auth <u>:<p>

  • 删除

    API: <jenkins url>/view/<view name>/doDelete

    curl: curl -X POST <jenkins url>/view/<view name>/doDelete --auth <u>:<p>

  • 查询状态

    API: <jenkins url>/view/<view name>/api/json

    curl: curl -X GET <jenkins url>/view/<view name>/api/json --auth <u>:<p>

  • 查询配置

    API: <jenkins url>/view/<view name>/config.xml

    curl: curl -X GET <jenkins url>/view/<view name>/config.xml --auth <u>:<p>

  • 更新配置

    API: <jenkins url>/view/<view name>/config.xml

    curl: curl -X POST <jenkins url>/view/<view name>/config.xml --data-binary "@newCofnig.xml" -H "Content-Type: text/xml" --auth <u>:<p>

Job

  • 创建

    API: <jenkins url>/createItem

    curl: curl -X POST <jenkins url>/createItem?name=<job name> --data-binary "@jobConfig.xml" -H "Content-Type: text/xml" --auth <u>:<p>

  • 删除

    API: <jenkins url>/job/<job name>/doDelete

    curl: curl -X POST <jenkins url>/job/<job name>/doDelete --auth <u>:<p>

  • 查询状态

    API: <jenkins url>/view/<view name>/job/<job name>/api/json

    curl: curl -X GET <jenkins url>/view/<view name>/job/<job name>/api/json --auth <u>:<p>

  • 启用

    API: <jenkins url>/view/<view name>/job/<job name>/enable

  • 禁用

    API: <jenkins url>/view/<view name>/job/<job name>/disable

  • 查询配置

    API: <jenkins url>/view/<view name>/job/<job name>/config.xml

    curl: curl -X GET <jenkins url>/view/<view name>/job/<job name>/config.xml --auth <u>:<p>

  • 更新配置

    API: <jenkins url>/view/<view name>/job/<job name>/config.xml

    curl: curl -X POST <jenkins url>/view/<view name>/job/<job name>/config.xml --data-binary "@newCofnig.xml" -H "Content-Type: text/xml" --auth <u>:<p>

Job Build

为了描述方便,这里先定义 baseURL=<jenkins url>/view/<view name>/job/<job name> ,下面的 API 都需要加上 baseURL 才是完整的 URL

  • 触发构建

    API: /build

    支持 token 触发,支持填入构建参数,构建参数是在 Job 配置页面创建的。

    如使用 token 并有字符参数 branchtarget 的例子:

    curl -X POST <api> --data-urlencode token=<token value> \
    --data-urlencode json='{"parameters": [{"name": "branch", "value": "master"},{"name":"target","value":"mirror"}]}'
    

    触发成功后,会在 headerLocation 字段指明 queue url ,再通过查询 queue 就可获取到 build id 了。

  • 停止构建

    API: /<id>/stop

  • 删除构建

    API: /<id>/doDelete

  • 构建状态

    API: /<id>/api/json

    进度说明: 返回的信息中, timestamp 表示开始时间, estimatedDuration 表示预估的任务耗时,这两个时间再加上当前时间就可估算任务进度。另外 duration 任务实际的耗时,信息中时间的单位都是毫秒(ms)。

  • 最后一次构建

    API: /lastBuild/api/json

附录

使用 Go 编写触发构建的程序 {#使用-go-编写触发构建的程序}

这里只给出关键代码:

(注意:不同的 Jenkins 版本可能接口的返回值结构并不相同,请自行处理)

// QueueInfo jenkins return's info by queue json api
type QueueInfo struct {
        Executable struct {
                Number int    `json:"number"`
                URL    string `json:"url"`
        } `json:"Executable"`
}

var (
        jenkinsURL   = flag.String("url", "https://ci.deepin.io", "Jenkins site url")
        jenkinsView  = flag.String("view", "", "Jenkins job view")
        jenkinsJob   = flag.String("job", "", "Jenkins job name")
        jenkinsToken = flag.String("token", "", "Jenkins job token")
)

// BuildJob trigger a job build
func BuildJob(params map[string]string) (int, error) {
        var api = *jenkinsURL
        if len(*jenkinsView) != 0 {
                api += fmt.Sprintf("/view/%s", *jenkinsView)
        }
        if len(*jenkinsJob) != 0 {
                api += fmt.Sprintf("/job/%s", *jenkinsJob)
        }
        api += "/build"

        // params must encode by url
        var values = make(url.Values)
        for k, v := range params {
                values.Set(k, v)
        }

        req, err := http.NewRequest(http.MethodPost, api,
                bytes.NewBufferString(values.Encode()))
        if err != nil {
                return -1, err
        }
        // must set 'Content-Type' to 'application/x-www-form-urlencoded'
        req.Header.Set("Content-Type", "application/x-www-form-urlencoded; charset=utf-8")

        resp, err := http.DefaultClient.Do(req)
        if err != nil {
                return -1, err
        }
        if resp.Body != nil {
                defer resp.Body.Close()
                data, err := ioutil.ReadAll(resp.Body)
                if err != nil {
                        fmt.Println("Failed to read response content:", err)
                } else {
                        fmt.Println("Response content:", string(data))
                }
        }
        fmt.Println("Status:", resp.Status)
        if resp.StatusCode < 200 || resp.StatusCode >= 300 {
                fmt.Println("Failed to build job")
                return -1, fmt.Errorf("build job failure")
        }

        fmt.Println("Response headers:", resp.Header)
        queueAPI := resp.Header.Get("Location")
        queue, err := GetQueue(queueAPI)
        if err != nil {
                return -1, err
        }

        return queue.Executable.Number, nil
}

func GetQueue(api string) (*QueueInfo, error) {
        resp, err := http.Get(api + "/api/json")
        if err != nil {
                fmt.Println("Failed to get queue:", err)
                return nil, err
        }
        defer resp.Body.Close()

        data, err := ioutil.ReadAll(resp.Body)
        if err != nil {
                fmt.Println("Failed to read response content:", err)
        }

        if resp.StatusCode < 200 || resp.StatusCode >= 300 {
                fmt.Println("Failed to get queue info")
                return nil, fmt.Errorf("get queue info failure")
        }

        var info QueueInfo
        err = json.Unmarshal(data, &info)
        if err != nil {
                return nil, err
        }
        return &info, nil
}

参考资料

没有在 Jenkins REST API 文档 中找到过多的 API 信息,但在 python-jenkins代码 中找到,所以想要了解更多请看代码。

© 著作权归作者所有

下一篇: Docker 使用简介
YanWen

YanWen

粉丝 3
博文 9
码字总数 17520
作品 0
武汉
程序员
私信 提问
加载中

评论(0)

Jenkins API Token

Jenkins REST API提供了API token,使得可以在程序中使用API token进行认证(而不是使用你真实的密码)。 API token可以在用户个人设置界面查看 到用户→用户id→设置页面,在API Token区域点...

donhui
2015/09/08
5.9K
1
通过Jenkins API获得/检测Jenkins的Version

关于获得/检测Jenkins的Version,下面页面(Jenkins Remote access API)中有说明: https://wiki.jenkins-ci.org/display/JENKINS/Remote+access+API Detecting Jenkins version(检测Jenki......

donhui
2015/06/18
2.2K
0
Jenkins & Docker 持续集成实践

前言 持续集成(CI/CD)是一种软件开发实践。用于帮助团队成员频繁、快速的集成,测试他们的工作成果,以尽快发现集成错误。 更频繁、更早的集成意味着更早的发现问题。通过持续集成,及时发现...

English0523
2017/12/25
0
0
Jenkins & Docker 持续集成实践

Jenkins & Docker 持续集成实践 运维生存时间 - 运维生存时间2017-12-109 阅读 jenkinsdockerLinux 发表评论 A+ 所属分类: Linux 前言 持续集成(CI/CD)是一种软件开发实践。用于帮助团队成员...

运维生存时间 - 运维生存时间
2017/12/10
0
0
Python-Jenkins API使用 —— 在后端代码中操控Jenkins

最近在工作中需要用到在后台代码中触发Jenkins任务的构建,于是想到Jenkins是否有一些已经封装好的API类库提供,用于处理跟Jenkins相关的操作。下面就简单介绍下我的发现。 Linux Curl   首...

yzy121403725
2018/06/27
0
0

没有更多内容

加载失败,请刷新页面

加载更多

MyBatis-Spring:整合Mybatis与Spring方式二:SqlSessionDaoSupport

本文上接《MyBatis-Spring:无缝隙整合Mybatis与Spring方式一:SqlSessionTemplate》, SqlSessionDaoSupport是一个抽象的支持类,用来为你提供SqlSession。调用getSqlSession()方法你会得到一...

明德君
18分钟前
51
0
count(1)、count(*)与count(列名)的执行区别

执行效果: 1. count(1) and count(*) 当表的数据量大些时,对表作分析之后,使用count(1)还要比使用count(*)用时多了! 从执行计划来看,count(1)和count(*)的效果是一样的。 但是在表做过分...

七宝1
26分钟前
11
0
SpringBoot内嵌tomcat(2)- 【Tomcat的启动入口】源码简析

在springboot支持Web模式下启动加载 ApplicationContext 是: org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext extends org.springfram......

noob_fly
31分钟前
12
0
vscode web版 搭建

即在远程编程的基础上,把通过node.js的远程通信转为通过浏览器的通信 通信应该比原有一定局限性 一键搭建代码: systemctl stop firewalld.servicewget https://github.com/cdr/code-ser...

oschinaer
31分钟前
29
0
ElasticSearch(四)Java操作ElasticSearch

今天本来想使用Spring Boot来连接ES的,但是想了想,还是决定用ES官方的Java High Level REST Client,这样可以更好地帮助我理解Spring中ES的原理。 首先,我们在POM文件中引入 <prope...

RaindropBK
32分钟前
11
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部