Go测试覆盖率问题：setupConfig()未覆盖Viper错误处理代码

原因 #

你的测试用例仅覆盖了Viper操作成功的分支，没有构造任何会让Viper返回错误的测试场景（比如配置文件不存在、格式非法、读取键值失败等）。Go的覆盖率统计只计算实际被执行过的代码行，未触发的错误处理分支自然不会被计入覆盖范围。

解决方法 #

1. 封装Viper接口+自定义Mock实现 #

通过抽象接口隔离Viper依赖，测试时用Mock对象模拟错误返回：

// 定义Viper操作的抽象接口
type ConfigLoader interface {
    ReadInConfig() error
    GetString(key string) string
    // 按需添加其他用到的Viper方法
}

// 生产环境用的真实Viper实现
type ViperLoader struct{}

func (v *ViperLoader) ReadInConfig() error {
    return viper.ReadInConfig()
}

func (v *ViperLoader) GetString(key string) string {
    return viper.GetString(key)
}

// 修改setupConfig函数，接收ConfigLoader参数
func setupConfig(loader ConfigLoader) error {
    if err := loader.ReadInConfig(); err != nil {
        // 未覆盖的错误处理代码
        log.Printf("Config read failed: %v", err)
        return err
    }
    // 其他配置逻辑...
    return nil
}

测试时编写Mock返回错误：

// Mock实现，用于模拟错误场景
type MockConfigLoader struct {
    readErr error
}

func (m *MockConfigLoader) ReadInConfig() error {
    return m.readErr
}

func (m *MockConfigLoader) GetString(key string) string {
    return ""
}

func Test_setupConfig_ReadError(t *testing.T) {
    mockLoader := &MockConfigLoader{readErr: fmt.Errorf("missing config file")}
    err := setupConfig(mockLoader)
    if err == nil {
        t.Fatal("expected error, got nil")
    }
    // 可额外验证日志输出或其他错误处理行为
}

2. 构造真实错误场景 #

如果不想修改原有代码结构，可以在测试中临时修改Viper配置，触发真实错误：

func Test_setupConfig_ConfigFileNotFound(t *testing.T) {
    // 保存原有配置路径，测试后恢复
    originalFile := viper.ConfigFileUsed()
    defer viper.SetConfigFile(originalFile)

    // 设置不存在的配置文件路径
    viper.SetConfigFile("/tmp/nonexistent_config.yaml")
    err := setupConfig()
    if err == nil {
        t.Fatal("expected error when config file not exists, got nil")
    }
}

3. 使用第三方Mock库简化实现 #

借助testify/mock这类库可以快速生成Mock对象：

import "github.com/stretchr/testify/mock"

type MockViper struct {
    mock.Mock
}

func (m *MockViper) ReadInConfig() error {
    args := m.Called()
    return args.Error(0)
}

func (m *MockViper) GetString(key string) string {
    args := m.Called(key)
    return args.String(0)
}

func Test_setupConfig_WithTestifyMock(t *testing.T) {
    mockViper := new(MockViper)
    // 模拟ReadInConfig返回错误
    mockViper.On("ReadInConfig").Return(fmt.Errorf("mock config error"))

    err := setupConfig(mockViper)
    assert.Error(t, err)
    // 验证Mock方法是否被正确调用
    mockViper.AssertExpectations(t)
}

内容的提问来源于stack exchange，提问作者Dan Sherwin