CICD | Jenkins Shared Libraries & Http-request插件使用

前篇:
1、Jenkins的搭建和简介:https://www.jianshu.com/p/ca4886e11720
2、Jenkins Gitlab集成,使用WebHook触发构建:https://www.jianshu.com/p/ca4886e11720

之前我搭建的开发环境的Jenkins,经过一年多时间的积累和组内使用,已经为二十多个项目提供了部署运维环境。在需要快速迭代部署的时候,Jenkins的规范化和自动化执行节约了大量的时间成本。

目前存在问题

1、搭建流水线时,大部分步骤和代码都是可以复用的,但没有复用的方法,不得不进行大段代码的复制粘贴。
2、代码部署到托管平台逻辑未能解耦,如果托管平台变更,目前所有存量脚本都需要变更。
3、调用HTTP接口的脚本都使用shell中的curl指令实现,存在较多的转义字符和参数拼接,代码可读性较低,不容易维护,并且很容易出错,接口的请求结果也需要自己处理。

经过调研,使用了公用共享库( Shared Libraries )和http-request插件,完美解决了这些问题。

Shared Libraries 配置和使用

配置

进入Jenkins首页后,点击左侧【系统管理】;


系统管理

搜索“Global pipeline Libraries”,找到共享仓库配置。

配置的地址是gitlab上的代码仓库,方便公用脚本的版本管理和维护。


配置图

脚本编写

编写规范和目录结构,参考:https://www.jenkins.io/zh/doc/book/pipeline/shared-libraries/
以下为简单的使用示范:
1、在脚本代码仓库中,添加:src/deploy/DeployHelper.groovy

def hello() {
    echo "Hello World!!!!"
}

2、在流水线脚本中,头部增加引入:

@Library('SharedLibraries')
import deploy.DeployHelper

在流水线脚本中使用:

script {
    DeployHelper deployHelper = new DeployHelper()
    deployHelper.hello()   
}

优点:
1、可以灵活使用Jenkins中已经安装的插件,不需要另外的依赖。
2、不需要另外给脚本授权(原本脚本在sandbox中执行,使用部分groovy公共类库时需要另外的授权。)

http-request

在脚本内部声明式地调用HTTP接口。
https://www.jenkins.io/doc/pipeline/steps/http_request/
使用该插件要求的Jenkins版本较高,进行了升级。由于之前配置了清华镜像,无法自动升级,选择去官网下载了安装包后,替换Jenkins内安装包,之后重启即可。
http-request使用较为简单,下面给出两个比较特别的范例:
1、上传文件(注意:multipartName 为文件参数的名称)

 def uploadBuildFile = httpRequest contentType: 'APPLICATION_OCTETSTREAM',
            httpMode: 'POST',
            consoleLogResponseBody: true,
            customHeaders: [[name: 'Authorization', value: "basic ${token}"]],
            url: "http://${ip}/upload/${repoName}",
            uploadFile: "${filepath}",
            multipartName: "files"

2、参数payload为JSONArray

import groovy.json.JsonOutput
def restartResponse = httpRequest contentType: 'APPLICATION_JSON',
            httpMode: 'POST',
            consoleLogResponseBody: true,
            url: "http://${ip}/status/reboot",
            customHeaders: [[name: 'Authorization', value: "basic ${token}"]],
            requestBody: JsonOutput.toJson([[a: "${ip}", b: ["${serverEndpoint}"]]])

值得注意的是,requestBody对应的参数,如果是JSONObject对应的JSONString,插件内部会自动进行反序列化,而如果是JSONArray,需要使用JsonOutput进行反序列化,不然会报参数错误。

小结

使用共享脚本库,进一步提高了运维效率,尽量避免重复的劳动,降低了脚本的维护成本。
Jenkins的灵活、易于拓展可以给我们的工作带来很多方便,使用起来也是非常的有意思~

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,099评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,828评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,540评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,848评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,971评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,132评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,193评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,934评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,376评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,687评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,846评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,537评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,175评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,887评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,134评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,674评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,741评论 2 351

推荐阅读更多精彩内容