如何在沙盒管道脚本中将Jenkins配置为@Grab依赖项

Question

我能够在Jenkins管道脚本中以沙盒和非沙盒模式使用@Grab注释。我的问题是，依赖项在默认情况下是针对maven central repository解决的，但我需要针对我们公司的Artifactory解决它们。要演示此问题，请使用以下简单的管道脚本：

//@Grab(group = 'my.compay', module='my-module-name', version='1.0.0-SNAPSHOT')
//import my.company.MyFancyClass
@Grab('com.google.guava:guava:23.0')
import com.google.common.base.Joiner

pipeline {
    agent any
    stages {
        stage('Grape Test') {
            steps {
                echo "Joiner: ${Joiner.class}"
                // echo "MyFancyClass: ${MyFancyClass.class}"
            }
        }
    }
}

当我按原样运行脚本时，我将在输出中看到类的完全限定名称。然而，当我取消注释与公司artifactory脚本中公开的依赖项一起工作的注释行时，失败如下：

org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
WorkflowScript: 2: unable to resolve class my.company.MyFancyClass
 @ line 1, column 1.
   @Grab(group = 'my.company', module='my-module-name', version='1.0.0-SNAPSHOT')

1 error

经过调查，我发现@Grab使用了Groovy特有的东西，称为Grape，这在这里有描述。所提到的文档描述了如何使用文件~/中的常春藤设置配置Grape以使用您自己的存储库。groovy/grapeConfig。xml。我找到了解决方案，并使其适用于具有以下内容的常规Groovy代码：

<ivysettings>
<settings defaultResolver="downloadGrapes"/>
<credentials host="localhost" realm="Artifactory Realm" username="USERNAME" passwd="PASSWORD"/>
<resolvers>
  <chain name="downloadGrapes" returnFirst="true">
    <filesystem name="cachedGrapes">
      <ivy pattern="${user.home}/.groovy/grapes/[organisation]/[module]/ivy-[revision].xml"/>
      <artifact pattern="${user.home}/.groovy/grapes/[organisation]/[module]/[type]s/[artifact]-[revision](-[classifier]).[ext]"/>
    </filesystem>
    <ibiblio name="localm2" root="file:${user.home}/.m2/repository/" checkmodified="true" changingPattern=".*" changingMatcher="regexp" m2compatible="true"/>

    <ibiblio name="maven-release" m2compatible="true" root="http://artifactory:8081/artifactory/maven-release"/>
    <ibiblio name="maven-snapshot" m2compatible="true" root="http://artifactory:8081/artifactory/maven-snapshot"/>
    <!-- todo add 'endorsed groovy extensions' resolver here -->
    <ibiblio name="jcenter" root="https://jcenter.bintray.com/" m2compatible="true"/>
    <ibiblio name="ibiblio" m2compatible="true"/>
  </chain>
</resolvers>
</ivysettings>

不幸的是，这个常春藤配置文件只部分修复了我的问题，并使Grapes只能从常规Groovy代码中正常工作（从CLI调用graped命令也是如此）。

我不知道Jenkins是如何使用Groovy/Grapes的，但它显然忽略了该文件的默认位置。我阅读了一些常春藤文档，发现可以自定义一些常春藤设置，例如使用属性配置文件位置。这就是为什么我试图说服Jenkins通过使用以下命令从CLI运行配置来有效地使用配置：

java -Divy.settings.file=%USERPROFILE%\.groovy\grapeConfig.xml -jar jenkins.war --httpPort=8888

这确实有效，但令我惊讶的是，它只是部分有效！只有当我关闭管道脚本的沙盒模式时，它才有效。如果我打开它，我再次只能从maven Central@Grab依赖项。

任何想法都非常欢迎...

Answer 1

由于我还没有收到任何答案，我进一步进行了调查，得出了有趣的结论。首先，让我们看看修改后的管道脚本：

@Grab('com.google.guava:guava:23.0')
import com.google.common.base.Joiner

pipeline {
    agent any
    stages {
        stage('Grape Test') {
            steps {
                echo "Joiner: ${Joiner.class}"
                 script {
                    Joiner.class.getClassLoader().getURLs().each { url ->
                        println url.toExternalForm()
                    }
                }
           }
        }
    }
}

我在沙盒模式下运行了这个脚本，maven central似乎满足了对Guava的依赖性。令人惊讶的是，我发现Joiner来自其他地方，如缩短的输出所示：

...

[Pipeline] echo
Joiner: class com.google.common.base.Joiner

...

[Pipeline] echo
file:/C:/Users/mrohac/.jenkins/war/WEB-INF/lib/guava-11.0.1.jar

...

所以，这个测试证明了在导入工作并从类路径加载类时，@Grab处于沙盒模式，被默默忽略。这让我得出结论，如何在管道中使用用Java编写的脚本专有代码的唯一方法是将相关依赖项放在类路径上。

因此，在管道脚本中启用自定义Java代码的结论是将相关的依赖关系放在类路径上。对于作为Jenkins新手的我来说，实现这一点的最佳方法是值得怀疑的。无论如何，我可以确认将依赖关系放在~/. jenkins/war/WEB-INF/lib/可以有效地在管道脚本中使用所需的类。

当然，这可能意味着新的问题，尤其是与Jenkins整体稳定性相关的问题，这可能会因课堂上的冲突而受到损害。无论如何，我希望管道脚本可以使用自定义Java代码进行扩展，并将对Jenkins稳定性的影响降至最低，例如通过引入专用的管道插件来注册和加载此类依赖项。