Jenkins Shared Libraries教程(二): 使用第三方库编写自己的库
2019-03-14
前面我们使用gradle初始化了Jenkins Shared Libraries的开发框架，本篇将介绍在src目录下使用第三方库开发我们自己的库。 在src目录下开发自己的库的需求是肯定存在的，我们在var目录中编写自定义Step时会用到Jenkins及其众多插件目前提供的各式各样的Pipeline Step，但有些需求是这些Step无法提供的。例如，在进行构建容器镜像之前我们可能需要访问Harbor(一个Docker镜像仓库)的API获取一些额外的信息，或者访问其他配置纹理系统的Restful API获取信息，这就需要我们的Shared Libraries中提供HTTP Client的功能，显然这个功能可以放到src目录下，而我们不会白手起家，在src目录下编写这个HTTP Client功能的时候，就会用到第三方库了。
Jenkins Shared Libraries 编写库和自定义Step #
前面我们使用gradle初始化了Jenkins Shared Libraries的开发框架，目录结果如下：
1(root)
2+- src # Groovy source files
3| +- org
4| +- foo
5| +- Bar.groovy # for org.foo.Bar class
6+- vars
7| +- foo.groovy # for global 'foo' variable
8| +- foo.txt # help for 'foo' variable
9+- resources # resource files (external libraries only)
10| +- org
11| +- foo
12| +- bar.json # static helper data for org.foo.Bar
13+- test
14| +- fooTest.groovy # test for 'foo' variable
在这个开发框架下，我们可以再src目录下使用grovvy编写我们自己的库文件，在vars目录下编写结构化的DSL即我们自定义的Jenkins Pipeline Step。vars目录下自定义的Step可以使用src中自定义库的类。下面是关于官方文档Extending with Shared Libraries 中关于在src下编写库和在var下编写自定义Step的例子：
1// src/org/foo/Point.groovy
2package org.foo;
3
4// point in 3D space
5class Point {
6 float x,y,z;
7}
1// vars/buildPlugin.groovy
2def call(Map config) {
3 node {
4 git url: "https://github.com/jenkinsci/${config.name}-plugin.git"
5 sh 'mvn install'
6 mail to: '...', subject: "${config.name} plugin build", body: '...'
7 }
8}
var中自定义的Step，可以再test目录中使用[JenkinsPipelineUnit](https://github.com/jenkinsci/JenkinsPipelineUnit)编写单元测试。
使用第三方库开发我们自己的库 #
官方文档Extending with Shared Libraries 中给出了一个使用第三方库的例子：
1@Grab('org.apache.commons:commons-math3:3.4.1')
2import org.apache.commons.math3.primes.Primes
3void parallelize(int count) {
4 if (!Primes.isPrime(count)) {
5 error "${count} was not prime"
6 }
7 // …
8}
注意上面的代码中使用@Grab注释来引入第三库，在默认情况下，第三方库会被缓存到Jenkins主机的~/.groovy/grapes目录下。
Grape使用一个内嵌在Groovy中的jar依赖管理器，通过@Grap注解在以在类路径下快速添加maven风格的依赖，方便我们编写Groovy脚本。
更多关于Grape的内容可以查看它的文档Dependency management with Grape，在这里你只需要理解使用@Grap注解引入的第三方库依赖是在运行时运行groovy脚本时需要使用的，而如果使用gradle开发和测试shared libraries项目的话，在开发和测试阶段也要在build.gradle中添加对应的第三方库依赖，这是在开发和测试阶段使用的。