Jenkins流水线即代码之扩展共享库初体验

简介

Jenkin的多分支流水线，允许Jenkinsfile与需要 Jenkins 构建的应用程序代码放在一起，然后 Jenkins 从源代码管理系统中检出 Jenkinsfile 文件作为流水线项目构建过程的一部分并接着执行你的流水线。

Jenkins这种构建方式正是“谁构建，谁运行”DevOps理念的一种体现。

由于流水线代码（特别是脚本式流水线）是使用类似 Groovy 的语法编写的，因此我们要想学习需要了解Groovy的语法。

目录结构

共享库的目录结构如下:

(root)
+- src                     # Groovy source files
|   +- org
|       +- foo
|           +- Bar.groovy  # for org.foo.Bar class
+- vars
|   +- foo.groovy          # for global 'foo' variable
|   +- foo.txt             # help for 'foo' variable
+- resources               # resource files (external libraries only)
|   +- org
|       +- foo
|           +- bar.json    # static helper data for org.foo.Bar

1. src 目录应该看起来像标准的 Java 源目录结构。当执行流水线时，该目录被添加到类路径下。
2. vars 目录定义可从流水线访问的全局变量的脚本。 每个 *.groovy 文件的基名应该是一个 Groovy (~ Java) 标识符, 通常是 camelCased。 匹配 *.txt, 如果存在, 可以包含文档, 通过系统的配置标记格式化从处理 (所以可能是 HTML, Markdown 等，虽然 txt 扩展是必需的)。
3. resources 目录允许从外部库中使用 libraryResource 步骤来加载有关的非 Groovy 文件。 目前，内部库不支持该特性。

注意：初次使用src、resources目录可以为空，我们可以在vars中定义脚本，使用call方法实现功能。

全局共享库

Manage Jenkins » Configure System » Global Pipeline Libraries 可以配置许多全局共享库。

系统中的任何流水线都可以使用这些库中实现的功能。

使用类库

标记为 Load implicitly 的共享库允许流水线立即使用任何此库定义的类或全局变量。为了访问其他共享库， Jenkinsfile 需要使用 @Library 注解。
在此我们将共享库托管在git上，在jenkins中设置如下：

• 使用“shared-library”命名
• 默认使用master分支调用

Jenkinsfile 需要使用 @Library 注解， 指定库的名字：

#调用共享库的默认master分支
@Library('my-shared-library') _
#使用test分直的共享库，也可使用tag等区分
@Library('my-shared-library@test') _

部署使用

1.定义pipeline共享库

└── pipeline-shared-library
    ├── README.en.md
    ├── README.md
    ├── resources
    ├── src
    └── vars
        └── helloworld.groovy

由于初步使用，resources和src我们都只保留项目结构，但设置为空；只在vars中设置脚本即可，并定义call方法，通过允许访问全局变量实现相关功能。

#遵循groovy语法
cat vars/helloworld.groovy 
def call(String s = "groovy") {
    echo "Hello, $s."
}

2.流水线调用

在项目中定义Jenkinsfile文件，通过声明式流水线调用共享库。

其中需要使用“@Library(‘shared-library’) _”来引入共享库。

#cat Jenkinsfile
@Library('shared-library') _

pipeline {
    options {
        ansiColor('xterm')
        timestamps()
    }
    agent {
        label 'docker-slave-java'
    }

    stages {
        stage('测试环境部署') {
            when { branch 'master'}
            steps {
              
                script {
                    println "import shared-library"
                    result = helloworld 'test'
                    println result
                }
            }
        }
    post {
        unstable {
            emailext (
                body: """项目名称：${JOB_NAME}\n构建编号：${BUILD_NUMBER}\n构建日志：${BUILD_URL}console""",
                subject: '【Jenkins构建通知】:$JOB_NAME - Build # $BUILD_NUMBER - Unstable!',
                to: 'test@aa.cn',
                from: 'jenkins@aa.cn'
            )   
        }   
        success {
            emailext (
                body: """项目名称：${JOB_NAME}\n构建编号：${BUILD_NUMBER}\n构建日志：${BUILD_URL}console""",
                subject: '【Jenkins构建通知】:$JOB_NAME - Build # $BUILD_NUMBER - Successful!',
                to: 'test@aa.cn',
                from: 'jenkins@aa.cn'
            )   
        }   
        failure {
            emailext (
                body: """项目名称：${JOB_NAME}\n构建编号：${BUILD_NUMBER}\n构建日志：${BUILD_URL}console""",
                subject: '【Jenkins构建通知】:$JOB_NAME - Build # $BUILD_NUMBER - Failure!',
                to: 'test@aa.cn',
                from: 'jenkins@aa.cn'
            )   
        }   
    }
  }

应用项目在jenkins上使用多分支流水线，通过when当test分支更新时，“测试环境部署”步骤才执行，最后将构建结果以邮件的形式通知。

注意：声明式流水线不允许在script指令之外使用全局变量。

3.执行过程

通过多分支流水线，可以将项目的多个分支在同一个jenkins任务中管理，避免了一个分支对应一个任务。如下图所示：docker-test-java3项目，分master/test/develop分支分别管理。
如下图所示，在流水线中“测试环境部署”中的操作已经调用共享库方法，打印出对应消息。

注意：在流水线构建任务中，BlueOcean 可以引导用户通过直观的、可视化的过程来创建Pipeline，从而使Pipeline的创建更加简单。而且Blue Ocean 与普通界面相比，屏蔽了部分输出，只展示 Pipeline中需要关注的地方， 简化异常处理。

总结

Jenkins扩展共享库是真正意义上的流水线即代码，通过共享库可以实现多个项目之间共享流水线，有助于减少冗余并保持代码干净整洁。

在CI/CD过程中，引入扩展共享库使管理过程更加灵活，重新定义了运维和开发之前的协作方式。但是groovy对于运维人员上手操作需要一定时间，而对于java开发人员却是天作之合。也正是这个原因，我也是对扩展共享库做了简单的介绍，更高级的使用需深入研究。