jenkins 实现参数联动构建

Posted 2023-05-03

参考技术A 日常编写pipeline的时候，有时候会遇到针对参数作出处理（联动，校验值格式等）。一开始想到的是能不能针对build按钮作出改变，比如我在提交的时候校验下参数是否填写，是否符合要求。但是那样就需要修改jenkins源码，针对build按钮作逻辑判断。考虑到这不是简单的功能，而且有可能会破坏原有的设计，并且没有大量的测试覆盖的话，出现幺蛾子的概率很大。所以最终还是放弃了。还有位同学提出job开始做出判断，但是这种不好的地方在于用户在触发job后，必须到log中才能看到失败的原因，而且这种做法比较被动，易产生大量的error记录，不友好。

思考再三，加上看到jenkins官网上有个属性是

决定尝试一下。这个属性的作用是可以根据依赖控件选择的值，返还本控件用户期望的值。比如下图的功能：branch有两个选择：master和pr，当用户选择master的时候，默认编译artfact。当用户选择branch 为pr的时候，需要用户提供pr的artifact version，并且把build artifact的按钮灰掉，不让用户触发。限制用户行为，避免流程出错。

有两种做法：

以pr_artifact_version 配置为例。

1.通过jenkins页面配置。

referenced parameters一定要写，表明根据那个参数变化而变化。

2.pipeline 脚本的方式。

以在pipeline properties--parameters属性中加上下面的参数声明，jenkinsUtil是我自己抽出来的util类，其中的生成动态依赖方法如下图：

需要传入的参数有本身控件的name，依赖的控件的name（reference），本身控件的type，次此处我用的是"ET_FORMATTED_html",因为我需要在页面上画出文本框，然后是本身控件的描述，最后是执行的groovy 脚本：如果branch为pr，那么返回一个不能改变的选择框，提示用户不需要关心（也可以把它隐藏，type选"ET_FORMATTED_HIDDEN_HTML"）,如果是master，则就返回checkbox，默认勾选，让用户自己选择是build，还是不需要build。

综上，通过这种方式能达到原先得需求，但是本身使用起来还是有点瑕疵的，比如它的提示和容错能力还是存在问题的（需要将不同flow的参数都要列举在页面，容易迷惑用户）。好的做法应该是把用户不关心的东西隐藏，易错的地方（甚至错误发生了）有足够的提示，并提示用户进一步的修正。

Jenkins定时构建并传递构建参数

Jenkins定时构建不能传递参数，所以我们使用crontab+Jenkins远程构建的方式来实现

生成API Token

进入Jenkins的用户设置页面，生成一个API Token

调用Jenkins远程API

使用curl命令调用接口，并在Jenkins上确认参数传递成功

Simple example - sending "String Parameters":

curl JENKINS_URL/job/JOB_NAME/buildWithParameters \\
  --user USER:TOKEN \\
  --data id=123 --data verbosity=high

Another example - sending a "File Parameter":

curl JENKINS_URL/job/JOB_NAME/buildWithParameters \\
  --user USER:PASSWORD \\
  --form FILE_LOCATION_AS_SET_IN_JENKINS=@PATH_TO_FILE

配置crontab

比如周一至周五22:00构建

[root@jenkins jobs]# crontab -l
0 22 * * 1-5 curl http://172.19.201.222:8080/job/testjob/buildWithParameters --user wemux:115432405374b224f2338aa90db2c4f67e --data branch=1.0.1 --data version=1.0.1