如何Mock环境变量为Grails应用编写单元测试？

场景说明 #

现有如下SearchController，其中currentEnvironment()方法根据Grails运行环境返回对应标识：

import grails.util.Environment

class SearchController {

    static String currentEnvironment() {
        def curEnvironment
        if (Environment.current == Environment.PRODUCTION){
            curEnvironment = 'prod'
        }
        else {
            curEnvironment = 'alpha'
        }
        return curEnvironment
    }
}

需求是编写单元测试时，不用-Dgrails.env=prod这种全局参数的方式，直接在测试代码中Mock环境变量，验证不同环境下的返回值。

解决方案 #

方法一：使用Groovy元编程Mock静态属性 #

Groovy支持直接修改类的元类来覆盖静态属性，直接控制Environment.current的值：

void testProductionEnvironment() {
    // Mock Environment.current为生产环境
    Environment.metaClass.static.current = Environment.PRODUCTION
    assert controller.currentEnvironment() == 'prod'
    
    // 测试结束后还原元类，避免影响其他测试用例
    Environment.metaClass = null
}

void testNonProductionEnvironment() {
    // Mock为非生产环境（比如开发环境）
    Environment.metaClass.static.current = Environment.DEVELOPMENT
    assert controller.currentEnvironment() == 'alpha'
    
    Environment.metaClass = null
}

方法二：Spock测试框架下的优雅实现 #

如果使用Spock编写测试，可以结合@AfterEach注解统一清理元类，避免重复代码：

import grails.testing.web.controllers.ControllerUnitTest
import grails.util.Environment
import spock.lang.Specification
import spock.lang.AfterEach

class SearchControllerSpec extends Specification implements ControllerUnitTest<SearchController> {

    @AfterEach
    void cleanupEnvironmentMetaClass() {
        // 统一还原Environment元类，防止全局污染
        Environment.metaClass = null
    }

    def "生产环境下返回prod"() {
        given:
        Environment.metaClass.static.current = Environment.PRODUCTION

        expect:
        controller.currentEnvironment() == 'prod'
    }

    def "非生产环境下返回alpha"() {
        given:
        Environment.metaClass.static.current = Environment.TEST

        expect:
        controller.currentEnvironment() == 'alpha'
    }
}

注意事项 #

• 必须还原元类：由于Environment.current是静态属性，修改后会影响全局，所以每个测试用例结束后一定要还原元类，避免干扰其他测试。
• 优先使用枚举值：尽量用Environment.PRODUCTION、Environment.TEST这类枚举常量，而非直接赋值字符串，保证代码规范性。
• 不推荐修改系统属性：System.setProperty("grails.env", "prod")无法直接生效，因为Environment.current是懒加载初始化的，初始化后不会重新读取系统属性，所以元编程是更直接的方案。

内容的提问来源于stack exchange，提问作者Binary Terror