如何使用Spock框架测试无入参的控制台交互Java方法

问题分析 #

你提供的待测试方法核心难点是内部硬编码实例化了依赖System.in的Scanner对象，没有外部注入入口，属于典型的和IO强耦合的无入参方法测试场景，Spock测试需要先解决输入流的模拟问题。
待测试代码：

public InputMessenger getInputForMessengerFromConsole() {
    String templateValue;
    Map<String, String> valuesForTemplate = new HashMap<>();
    try (Scanner scanner = new Scanner(System.in, Constant.CHARSET_NAME_UTF_8)) {
        System.out.println(Constant.MESSAGE_INPUT_TEMPLATE);
        templateValue = scanner.nextLine();

        System.out.println(Constant.MESSAGE_NUMBER_OF_VALUES);
        int numberOfValues = scanner.nextInt();
        scanner.nextLine();

        IntStream.range(0, numberOfValues).forEach(index -> {
            System.out.println(Constant.MESSAGE_KEY + (index + Constant.INT_ONE) + Constant.COLON);
            String key = scanner.nextLine();
            System.out.println(Constant.MESSAGE_VALUE + (index + Constant.INT_ONE) + Constant.COLON);
            String value = scanner.nextLine();
            valuesForTemplate.put(key, value);
        });
    }
    return new InputMessenger(templateValue, valuesForTemplate);
}

测试实现方案 #

方案1（推荐）：重构代码提升可测试性 #

修改方法支持注入Scanner实例，Spock直接Mock Scanner的返回值即可，示例调整后的代码结构：

// 保留原有无参方法兼容原有调用逻辑
public InputMessenger getInputForMessengerFromConsole() {
    return getInputForMessengerFromConsole(new Scanner(System.in, Constant.CHARSET_NAME_UTF_8));
}

// 新增包级私有重载方法用于测试
InputMessenger getInputForMessengerFromConsole(Scanner scanner) {
    String templateValue;
    Map<String, String> valuesForTemplate = new HashMap<>();
    try(scanner) {
        // 保留原有业务逻辑即可，去掉Scanner实例化代码
    }
    return new InputMessenger(templateValue, valuesForTemplate);
}

对应Spock测试用例核心结构：

def "测试从控制台获取输入生成InputMessenger"() {
    given: "模拟Scanner的输入返回"
    def mockScanner = Mock(Scanner)
    mockScanner.nextLine() >> "测试模板" >> "key1" >> "value1"
    mockScanner.nextInt() >> 1

    when: "调用测试方法"
    def result = testObject.getInputForMessengerFromConsole(mockScanner)

    then: "校验返回值符合预期"
    result.templateValue == "测试模板"
    result.valuesForTemplate == [key1: "value1"]
}

方案2：不改原有代码，重定向System.in #

如果无法修改原有业务代码，可以在测试用例中临时替换System.in为自定义的字节输入流，用完后恢复原流即可，Spock用setup和cleanup块处理流的替换和恢复即可。

学习资源推荐 #

书籍 #

• 《Spock实战》：Spock框架专属工具书，覆盖从基础语法到复杂依赖Mock、集成测试的全场景实践，其中硬依赖测试、IO相关测试有对应案例参考
• 《单元测试的艺术》：通用单元测试方法论书籍，核心讲解可测试性代码设计思路、Mock/测试桩的使用原则，能从根源降低写难测代码的概率
• 《Java测试驱动开发》：包含Spock在Java项目中的落地实战章节，覆盖和Spring、控制台交互等常见场景的测试方案

线上学习资源 #

• Spock官方社区的版本更新及最佳实践分享webinar，会同步最新的测试技巧和功能特性
• 国内技术社区的Spock实战专项分享，多为一线工程师的实际踩坑经验总结，适配国内Java项目的常见测试场景

内容的提问来源于stack exchange，提问作者Trak Polisi