Jenkins共享库单元测试：依赖缺失与单例值断言问题

1. 依赖缺失错误（如antlr/ANTLRException）解决及Gradle自动补全配置 #

直接在项目根目录的build.gradle中配置以下内容，Gradle会自动从指定仓库拉取所需依赖：

plugins {
    id 'groovy'
}

repositories {
    mavenCentral()
    // 必须添加Jenkins官方仓库，部分Pipeline相关依赖仅在此发布
    maven { url 'https://repo.jenkins-ci.org/public/' }
}

dependencies {
    // 匹配项目Groovy版本的核心依赖
    implementation 'org.codehaus.groovy:groovy-all:3.0.17'
    // Jenkins Pipeline Unit核心测试依赖
    testImplementation 'com.lesfurets:jenkins-pipeline-unit:1.14'
    // 手动补充antlr依赖（部分场景下自动引入的版本不足或缺失）
    testImplementation 'org.antlr:antlr4-runtime:4.13.1'
}

test {
    useJUnitPlatform()
}

配置说明：

• 确保仓库包含Jenkins官方公共仓库，否则无法拉取Pipeline相关依赖包
• 若仍出现依赖缺失，可执行./gradlew dependencies查看依赖树，定位缺失项后手动添加到testImplementation中
• Gradle会自动处理依赖传递，无需手动下载jar包

2. 测试编写要点：单例验证与包结构规范 #

测试类包结构 #

测试类建议放在与被测类相同的包下（即test/org/company），这样可直接访问被测类的包级私有成员，无需为测试修改类的访问权限，同时符合常规测试代码组织规范。

单例JobData的内容验证 #

单例的核心问题是测试隔离——不同测试用例会共享单例实例，导致测试结果互相干扰。解决方法是在每次测试前后重置单例状态：

步骤1：给JobData添加测试专用重置方法

在src/org/company/JobData.groovy中添加仅用于测试的重置逻辑（可通过编译条件或注解限制生产环境生效）：

package org.company

class JobData {
    private static JobData instance
    Map<String, Object> data = [:]

    private JobData() {}

    static JobData getInstance() {
        if (!instance) {
            instance = new JobData()
        }
        instance
    }

    // 仅用于测试环境的重置方法
    static void resetForTest() {
        instance = null
    }
}

步骤2：编写测试用例验证单例内容

测试类继承BasePipelineTest以获得Jenkins Pipeline模拟环境，在@Before和@After方法中调用重置方法，确保每次测试使用干净的实例：

package org.company

import com.lesfurets.jenkins.unit.BasePipelineTest
import org.junit.After
import org.junit.Before
import org.junit.Test

class JobDataTest extends BasePipelineTest {

    @Before
    void setUp() {
        super.setUp()
        // 每次测试前重置单例，隔离测试环境
        JobData.resetForTest()
    }

    @After
    void tearDown() {
        JobData.resetForTest()
    }

    // 验证单例本身的正确性
    @Test
    void testSingletonInstanceAndData() {
        def firstInstance = JobData.instance
        firstInstance.data['buildNumber'] = 100

        def secondInstance = JobData.instance
        assert firstInstance.is(secondInstance)
        assert secondInstance.data['buildNumber'] == 100
    }

    // 验证automationTest脚本对JobData的修改
    @Test
    void testAutomationTestUpdatesJobData() {
        // 加载vars下的automationTest脚本
        scriptLoader.loadScript('vars/automationTest.groovy')
        // 模拟调用脚本，传入参数
        helper.call('automationTest', [env: 'test', version: '1.0'])

        // 验证JobData中的数据是否符合预期
        def jobData = JobData.instance
        assert jobData.data['env'] == 'test'
        assert jobData.data['version'] == '1.0'
    }
}

测试编写注意事项 #

• 测试vars下的脚本时，必须用scriptLoader.loadScript加载脚本文件，再通过helper.call模拟调用
• 若被测代码使用了Jenkins Pipeline步骤（如sh、echo），需在setUp方法中用helper.registerAllowedMethod模拟这些步骤的行为
• 避免在测试中依赖外部环境，所有Jenkins相关操作都应通过Pipeline Unit提供的模拟API完成

内容的提问来源于stack exchange，提问作者Barel Elbaz