|
|
|
|
公众号矩阵

玩转触发器之Jenkins Generic Webhook使用技巧

学习HTTP基础知识,掌握如何使用Postman和Curl调用接口的方法。HTTP超文本传输协议,是确保服务器(Server)和客户端(Client)之间的正确通信。

作者:Lizeyang来源:DevOps云学堂|2021-09-14 07:12

1. 预备知识

目标:学习HTTP基础知识,掌握如何使用Postman和Curl调用接口的方法。

1.1 Web HTTP基础知识

HTTP请求是什么?

HTTP超文本传输协议,是确保服务器(Server)和客户端(Client)之间的正确通信。

一个请求和响应的过程:

Request用户通过浏览器向服务端发起请求。Response服务端将客户端请求的资源数据进行响应。

HTTP常见的错误码

1xx : 服务已收到请求,请求者继续执行操作。

2xx:请求成功,常见(201)

3xx:请求成功,页面发生重定向(301)

4xx:客户端发生了错误

  • 常见的是资源找不到了(404)
  • 资源请求需要认证认证失败(401)
  • 认证成功但是权限不够(403)

5xx:服务端发生了错误

  • 网关超时(504)
  • 内部错误(500)
  • 网关错误(502)
  • 服务不可用(503)

2. Jenkins Generic Webhook实践

目的:为Jenkins作业添加触发器,便于其他系统调用。

安装配置Generic WebHook

插件名称:Generic Webhook Trigger

重启后,进入一个Pipeline项目设置,已经可以选择这个触发器了....

插件文档:https://plugins.jenkins.io/generic-webhook-trigger/


Jenkins作业配置触发器

启动Generic Webhook触发器后, 相当于给Jenkins加了一个新的接口(http://JENKINS_URL/generic-webhook-trigger/invoke)。

调用的时候:这里要把 JENKINS_URL 换成自己真实的Jenkins 服务器地址,有端口就加上端口,是域名就写域名。下面是一个参考的URL:

  1. http://192.168.1.200:8080/generic-webhook-trigger/invoke 

Post content parameters:获取调用接口传进来的数据

JsonPath语法文档:https://github.com/json-path/JsonPath

Header parameters:获取Header中的参数

Request parameters:获取URL中的请求参数

  1. curl http://192.168.1.200:8080/generic-webhook-trigger/invoke?runopts=gitlab 

Token: 给URL添加一个触发的认证

  1. curl http://192.168.1.200:8080/generic-webhook-trigger/invoke?token=devops-service 

打印调试信息到日志中

触发条件过滤:仅满足条件才能触发此作业

实践:demo

解析GET/POST请求数据

传参注意,第一个参数使用?号连接, 后面的参数使用&符号连接。

  1. ?token=demo-pipeline-service&user=jenkins&a=1&b=2 

演示将postman中的请求转换curl方式。

  1. [root@zeyang-nuc-service ~]# curl --location --request GET 'http://192.168.1.200:8080/generic-webhook-trigger/invoke?token=demo-pipeline-service' 
  2. {"jobs":{"demo-pipeline-service":{"regexpFilterExpression":"","triggered":true,"resolvedVariables":{},"regexpFilterText":"","id":209,"url":"queue/item/209/"}},"message":"Triggered jobs."}[root@zeyang-nuc-service ~]# 

解析GET数据

客户端发送Get请求, 带有两个参数 version 和 username 。

  1. http://192.168.1.200:8080/generic-webhook-trigger/invoke?token=demo-pipeline-service&version=1.1.1&username=jenkins 

Jenkins 配置Generic hook,获取请求参数version 和 username (参数名称要一致)

验证测试(Jenkins日志中能够打印出获取的值,则正常)

通过jenkinsfile读取传递的参数

  1. println("${username}"
  2. println("${version}"

解析HEADER参数数据

客户端发送请求(什么请求都可以,这里的header与请求类型无关), 带有两个参数 header_name 和 header_id 。

  1. curl --location --request GET 'http://192.168.1.200:8080/generic-webhook-trigger/invoke?token=demo-pipeline-service' \ 
  2. --header 'header_name: jenkins' \ 
  3. --header 'header_id: 100' 

Jenkins 配置Generic hook,获取请求参数header_name 和 header_id 。

通过jenkinsfile读取传递的参数

  1. println("${header_id}"
  2. println("${header_name}"
  3. println(header_id) 
  4. println(header_name) 
  5.  
  6. String headerName = "${header_id}" 
  7. println(headerName) 
  8.  
  9.  
  10. //pipeline {   
  11. //} 

解析POST数据

客户端发送POST请求, 参数存储在body体中(参考POSTMAN中的样例)

  1. curl --location --request POST 'http://192.168.1.200:8080/generic-webhook-trigger/invoke?token=demo-pipeline-service' \ 
  2. --header 'Content-Type: application/json' \ 
  3. --data-raw '{ 
  4.     "name""zhangsan"
  5.     "id""123"
  6.     "group1": { 
  7.         "name""jenkins"
  8.         "id" : "001"
  9.         "age""40" 
  10.     } 
  11. }' 

Jenkins 配置触发器来获取Post参数。

获取所有数据

获取username字段

获取group1Name字段

Jenkinsfile中使用参数

  1. println("所有body数据 --> ${allData}"
  2. println('最外层name ---> $.name' + "${userName}"
  3. println('第二层name ---> $.group1.name' + "${group1Name}"

扩展流水线解析JSON数据

安装插件:Pipeline Utility Steps

readJSON:处理json数据

  1. println("所有body数据 --> ${allData}"
  2.  
  3. def webHookData = readJSON  text: "${allData}" 
  4.  
  5. String userName = webHookData["name"
  6. String userName2 = webHookData.name 
  7.  
  8. String group1Name = webHookData["group1"]["name"
  9. String group1Name2 = webHookData.group1.name 
  10.  
  11. println('最外层name ---> $.name' + "${userName}"
  12. println('最外层name ---> $.name' + "${userName2}"
  13.  
  14. println('第二层name ---> $.group1.name' + "${group1Name}"
  15. println('第二层name ---> $.group1.name' + "${group1Name2}"

Rebuilder 插件使用

可以直接携带原触发参数进行触发,不用重复触发(不用在重复的提交代码了)。

进入某一次构建后,可以点击rebuild。

【编辑推荐】

  1. 鸿蒙官方战略合作共建——HarmonyOS技术社区
  2. 苹果推送iOS 15 正式版更新内容通知
  3. 庖丁解牛-图解MySQL 8.0优化器查询解析篇
  4. 缓解SQL注入威胁的三种方法
  5. iPhone 13都快来了 iOS这些硬伤还要忍多久?
  6. 为什么现在的手机价格越来越贵了?
【责任编辑:姜华 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

订阅专栏+更多

带你轻松入门 RabbitMQ

带你轻松入门 RabbitMQ

轻松入门RabbitMQ
共4章 | loong576

44人订阅学习

数据湖与数据仓库的分析实践攻略

数据湖与数据仓库的分析实践攻略

助力现代化数据管理:数据湖与数据仓库的分析实践攻略
共3章 | 创世达人

14人订阅学习

云原生架构实践

云原生架构实践

新技术引领移动互联网进入急速赛道
共3章 | KaliArch

42人订阅学习

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊

51CTO服务号

51CTO官微