Jenkins流水线共享库插件交互依赖及导入问题咨询

我之前也碰到过一模一样的问题——纯Groovy/Java逻辑的共享库测试跑起来顺风顺水，但一涉及Jenkins核心对象、插件交互就各种报错，核心原因就是测试环境里缺少Jenkins核心和对应插件的依赖，同时没正确模拟Jenkins运行时的上下文。下面分场景给你拆解解决方案：

一、处理Jenkins核心对象（currentBuild、环境变量等）的依赖 #

currentBuild这类内置对象是Jenkins Pipeline运行时注入的，测试时没法直接引用，得先在pom里加核心依赖，再模拟上下文：

1. 添加pom依赖 #

<dependencies>
    <!-- 匹配你生产环境的Jenkins核心版本 -->
    <dependency>
        <groupId>org.jenkins-ci.main</groupId>
        <artifactId>jenkins-core</artifactId>
        <version>2.426.3</version>
        <scope>test</scope>
    </dependency>
    <!-- Jenkins测试工具包，用于模拟Jenkins实例 -->
    <dependency>
        <groupId>org.jenkins-ci.main</groupId>
        <artifactId>jenkins-test-harness</artifactId>
        <version>2.46</version>
        <scope>test</scope>
    </dependency>
    <!-- Groovy依赖，保证共享库代码能被编译测试 -->
    <dependency>
        <groupId>org.codehaus.groovy</groupId>
        <artifactId>groovy-all</artifactId>
        <version>3.0.17</version>
        <scope>test</scope>
    </dependency>
</dependencies>

2. 测试代码里模拟currentBuild #

用JenkinsRule创建模拟的Pipeline运行对象，替代真实的currentBuild：

import org.jenkinsci.plugins.workflow.job.WorkflowJob
import org.jenkinsci.plugins.workflow.job.WorkflowRun
import org.junit.Rule
import org.jvnet.hudson.test.JenkinsRule
import spock.lang.Specification

class YourHelperTest extends Specification {
    @Rule
    JenkinsRule jenkinsRule = new JenkinsRule()

    def "test BUILD_NUMBER retrieval"() {
        given:
        // 创建模拟的Pipeline任务和构建
        WorkflowJob job = jenkinsRule.createProject(WorkflowJob)
        WorkflowRun mockBuild = job.scheduleBuild2(0).get()
        // 手动设置环境变量
        mockBuild.environment.addEnvVar("BUILD_NUMBER", "456")

        when:
        // 把mockBuild传入你的Helper方法，替代currentBuild
        def buildNumber = new YourHelper().fetchBuildNumber(mockBuild)

        then:
        buildNumber == "456"
    }
}

二、GitHelper的依赖与测试 #

如果你的GitHelper用到了Jenkins Git插件的API（比如GitClient、GitSCM），得添加插件依赖并模拟Git客户端：

1. 添加pom依赖 #

<dependency>
    <groupId>org.jenkins-ci.plugins</groupId>
    <artifactId>git</artifactId>
    <version>5.11.0</version>
    <scope>test</scope>
</dependency>

2. 用Mockito模拟Git客户端 #

单元测试没必要连真实Git仓库，直接mock插件对象：

import org.jenkinsci.plugins.gitclient.GitClient
import org.mockito.Mockito
import spock.lang.Specification

class GitHelperTest extends Specification {
    def "test git branch retrieval"() {
        given:
        // Mock GitClient对象
        GitClient mockGitClient = Mockito.mock(GitClient.class)
        Mockito.when(mockGitClient.getBranchNames()).thenReturn(["main", "feature/test"])
        
        // 把mock对象注入你的GitHelper
        GitHelper gitHelper = new GitHelper(gitClient: mockGitClient)

        when:
        def branches = gitHelper.getCurrentBranches()

        then:
        branches == ["main", "feature/test"]
    }
}

三、ArtifactoryHelper的依赖与测试 #

和Git插件同理，先加Artifactory插件依赖，再mock客户端：

1. 添加pom依赖 #

<dependency>
    <groupId>org.jfrog.hudson</groupId>
    <artifactId>artifactory-plugin</artifactId>
    <version>3.2.4</version>
    <scope>test</scope>
</dependency>

2. 模拟Artifactory交互 #

同样用Mockito模拟Artifactory的客户端或构建信息对象，避免依赖真实的Artifactory实例：

import org.jfrog.hudson.ArtifactoryServer
import org.mockito.Mockito
import spock.lang.Specification

class ArtifactoryHelperTest extends Specification {
    def "test artifact upload check"() {
        given:
        ArtifactoryServer mockServer = Mockito.mock(ArtifactoryServer.class)
        Mockito.when(mockServer.exists("libs-release-local/com/your/artifact/1.0.0")).thenReturn(true)
        
        ArtifactoryHelper helper = new ArtifactoryHelper(server: mockServer)

        when:
        def exists = helper.checkArtifactExists("com.your:artifact:1.0.0")

        then:
        exists == true
    }
}

额外小贴士 #

• 版本对齐：所有依赖的版本（Jenkins核心、插件）必须和你生产环境的Jenkins版本匹配，不然会出现奇怪的兼容性问题。
• 测试分层：单元测试用mock隔离外部依赖，集成测试用JenkinsRule启动嵌入式Jenkins做真实场景验证。
• Maven构建配置：如果用Maven管理测试，记得加Groovy编译插件，确保共享库的Groovy代码能被正确编译：

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.gmavenplus</groupId>
            <artifactId>gmavenplus-plugin</artifactId>
            <version>1.13.1</version>
            <executions>
                <execution>
                    <goals>
                        <goal>compile</goal>
                        <goal>testCompile</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M7</version>
            <configuration>
                <useSystemClassLoader>false</useSystemClassLoader>
            </configuration>
        </plugin>
    </plugins>
</build>

内容的提问来源于stack exchange，提问作者Daniel Rogatchevsky