本篇博客介绍了在 Jenkins Pipeline 中 groovy 脚本发送 HTTP 请求的用法。
在使用 Jenkins Pipeline 时，有时需要和外部系统以 HTTP 方式交互或集成，此时就需要发送 HTTP 请求给外部系统，并接收响应，继续进行处理，而 curl 等命令不太好处理接收到的响应，此时可以使用 groovy 脚本来处理。
1、使用 Jenkins 第一件事情，安装插件，groovy 脚本发送 HTTP 请求需要安装 HTTP Request 插件，插件 ID 为：
2、在 pipeline 中编写代码如下：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
stage('Deploy') {
steps {
container('golang-build-container') {
script {
ws(projectPath) {
def payload = """
{ "app": "xdhuxc-app" }
"""
def authorization = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTExNzkzNTYsInVzZXIiOiJ3YW5naHVhbnxbMTcgMyA0IDUgNiA3IDggOSAxMCAxMSAxMiAxMyAxNiAxOSAyMCAyMSAyMiAyMyAyNCAyNSAyNl18YWRtaW4ifQ.WR7GaFdm0y2SE3WHGYfE_VbTiXZovmm5hBojvhLn5NI"
def app = "xdhuxc-app"
def response = httpRequest acceptType: 'APPLICATION_JSON', contentType: 'APPLICATION_JSON', httpMode: 'PUT', requestBody: payload, url: "http://127.0.0.1:80/xdhuxc/apps?app=${app}&authorization=${authorization}", validResponseCodes: "100:511"
if (response.status == 200) {
println("Http request to ${url} is successfully, the body is ${body}")
} else {
throw new Exception("the request failed, the http response status is ${response.status}, content is ${response.content}")
}
}
}
}
}
}
|
注意，需要加 validResponseCodes: "100:511"，默认的 validResponseCodes 为 100:399，这意味着响应状态码为 400~511 的请求会直接抛错，拿不到响应。
此外，还可以添加自定义请求头：
1
|
def response = httpRequest customHeaders: [[name: 'cid', value: '110']]
|
默认情况下，会输出整个请求的信息，包括：URL、请求头、返回码等。如果请求中含有不希望显示的 token，可以修改 quiet: true 参数，不显示请求详情。
有时，我们可能会在提交的数据中加入变量，这时可通过如下方式提交数据：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
import groovy.json.JsonOutput
stage('Deploy') {
steps {
container('golang-build-container') {
script {
ws(env.WORKSPACE) {
def url = 'http://127.0.0.1:8000/xdhuxc/apps?app=xdhuxc-cicd'
def body = JsonOutput.toJson(["xdhuxc-cicd": env.image])
def headers = [[name: 'authorization', value: 'Bearer zZXIiOiJzZ3QtamVua2lucy11cGRhdGUtaW1hZ2V8WzE3IDEwIDExIDEyIDEzIDE2IDE5IDIwIDIxIDIyIDIzIDI0IDMgNCA1IDYgNyA4IDldfG9wZW5hcGktc2d0LWplbmtpbnMtdXBkYXRlLWltYWdlIn0']]
def response = httpRequest acceptType: 'APPLICATION_JSON', contentType: 'APPLICATION_JSON', customHeaders: headers, httpMode: 'PUT', requestBody: body, url: url, validResponseCodes: "100:511", quiet: true
if (response.status == 200) {
println("Http request to ${url} is successfully, the body is ${body}")
} else {
throw new Exception("Deploy to kubernetes failed, the http response status is ${response.status}, content is ${response.content}")
}
}
}
}
}
}
|
https://www.jenkins.io/doc/pipeline/steps/http_request/#httprequest-perform-an-http-request-and-return-a-response-object
http request 插件参数：https://www.jenkins.io/doc/pipeline/steps/http_request/#http-request-plugin
https://github.com/jenkinsci/http-request-plugin