从同一存储库加载 Jenkins Pipeline 共享库

Question

TL;DR 有没有办法将代码导入到Jenkinsfile 从本地 存储库（load 步骤除外）？

为什么？

我已经体验到，对于复杂的构建，Jenkinsfile 会变得有点笨重且不太易于维护。
既然构建工作是代码，那么拥有与其他代码相同的方法会很棒。 也就是说，我想把它分成更小（更易于维护）的单元并单元测试它们。

我尝试了什么

• shared libraries：允许将我们的 Jenkins 流水线逻辑划分为单独模块中的较小文件，甚至对其进行单元测试。
  但是，它们需要位于不同的存储库中，并且（如果不在 GitHub 上）必须配置到 Jenkins 中。
• load Step：允许从存储库加载 groovy 脚本。
  但是，这些文件必须是脚本而不是“完整”的 groovy 类，因此很难拥有多个相互依赖的文件或类。例如继承是不可能的。
  此外，这些文件在 Jenkins 作业上执行 replay 时不会显示，这使得它们难以开发和调试。

我的问题

• 有没有办法（或解决方法）在与Jenkinsfile 相同的存储库中创建共享库并将此库导入Jenkinsfile？
• 或者还有其他我还没有尝试过的方法吗？

示例目录结构

类似于为shared libs 描述的目录结构我希望在单个存储库中拥有以下内容。

(root)
+- someModule
|   +- ...
+- jenkins           # Classes/Scripts used by Jenkins in a separate module
|   +- src                       # Groovy source files
|      +- org
|          +- foo
|              +- Bar.groovy     # for org.foo.Bar class
|   +- test                      # Groovy test files
|      +- org
|          +- foo
|              +- BarTest.groovy # Test for org.foo.Bar class
|   +- pom.xml or build.groovy   # Build for local library
+- Jenkinsfile     # Build "someModule", uses classes from "jenkins" module

Answer 1

解决方法：

library identifier: 'shared-library@version', retriever: legacySCM(scm)

目前在PR 37 中采用的方法无法与构建代理一起正常工作，而且无论如何只能用于使用library 步骤的脚本，而不是@Library 注释。

顺便说一下，从load 步骤加载的文件做会出现在重播中。但是您的脚本确实不能静态引用此类文件中定义的类型。换句话说，您可以模拟库 vars/*.groovy 但不能模拟 src/**/*.groovy — 与当前 PR 37 的限制相同。

Answer 2

我想正确的方法是实现自定义SCMRetriever。

但是，您可以使用以下 hack：

假设您的本地仓库中的 jenkins/vars/log.groovy 包含：

def info(message) {
    echo "INFO: ${message}"
}

您的Jenkinsfile 可以使用library 步骤从jenkins/ 目录加载该共享库：

node('node1') { // load library
    checkout scm
    // create new git repo inside jenkins subdirectory
    sh('cd jenkins && git init && git add --all . && git commit -m init &> /dev/null') 
    def repoPath = sh(returnStdout: true, script: 'pwd').trim() + "/jenkins"
    library identifier: 'local-lib@master', retriever: modernSCM([$class: 'GitSCMSource', remote: repoPath])
}

node('node2') {
    stage('Build') {
        log.info("called shared lib") // use the loaded library
    }
}

Answer 3

你可以看看我写的插件，它可以使用你的管道作为共享库的 repo 的子目录：https://github.com/karolgil/SharedLibrary

构建和安装后，您可以简单地将以下内容放入管道中：

@SharedLibrary('dir/in/repo') _

开始使用 dir/in/repo 作为管道的共享库。

Answer 4

想要做同样的事情并最终创建了这个：

https://github.com/jenkinsci/workflow-cps-global-lib-plugin/pull/37

这是我的使用方法：

https://github.com/syndesisio/syndesis-pipeline-library/blob/master/Jenkinsfile#L3

在我的例子中，我想创建一个 Jenkinsfile，它实际上是 tests 存储库包含的管道库。

让我知道您的想法，并随时将您的 cmets 添加到 PR 上。

Answer 5

如果您从 SCM 检查管道（未嵌入在 Je​​nkins 作业 UI 配置中），我发现 Pawel 的版本存在问题。这是我针对这些情况的版本：

node {
    def scriptFolder = sh(script: "echo \$(pwd | sed 's,\\(.*\\)\\(@[0-9]*\$\\),\\1,')@script/\$(sed -n '2,\$p' ../config.xml | xmllint --xpath '(//scriptPath/text())' - | xargs dirname)", returnStdout: true).trim()
    sh("cd ${scriptFolder} && ls -l vars/ && if [ -d .git ]; then rm -rf .git; fi; git init && git add --all . && git commit -m init &> /dev/null")
    library identifier: 'local-lib@master', retriever: modernSCM([$class: 'GitSCMSource', remote: scriptFolder])

    stage('Build') {
        log.info("called shared lib") // use the loaded library
    }
}

对于这些情况，管道本身在与管道本身定义的不同的工作空间（相同的目录名称但名称中包含 @script）中签出。

Answer 6

我已经成功测试了一个简单的解决方法，用于具有两种协议的 GIT 存储库 - HTTPS 和 SSH（我正在使用 BitBucket） - 只需按如下方式配置 Jenkins 作业（指向同一个存储库但强制使用不同的获取方法）：

• 在分支源中添加“通过 SSH 结帐”选项

• 在管道库 -> 源代码管理 -> 项目存储库中使用 HTTPS 协议 - 例如像 https://...

Answer 7

有没有办法将代码从本地存储库导入到 Jenkinsfile 中（加载步骤除外）？

有没有办法（或解决方法）在与 Jenkinsfile 相同的存储库中创建共享库并将此库导入 Jenkinsfile？

是的。如果按照规范遵守“共享库存储库的目录结构”，则绝对可行，无需任何变通方法即可使其正常工作。基本上，您的目录结构需要按照以下几行进行调整：

+- 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
+- someModule
|   +- ...
|
|
+- Jenkinsfile

此答案并非基于猜想。虽然没有记录，但我已经在多个项目和培训中应用了这种模式，并且它有效。无论如何，您都不需要像往常一样修改您的工作配置。