在Golang的单元测试体系中,错误分支逻辑测试是验证程序健壮性的重要环节,它用于确认当函数返回错误时,上层调用方能够正确处理错误,避免出现 panic 或者逻辑异常的情况。通常错误分支的测试需要和正常逻辑测试分开编写,确保每一种可能的错误场景都被覆盖到。
Golang错误分支测试的基础准备
Golang的标准库提供了 testing 包用于编写单元测试,测试错误分支时我们主要依赖该包提供的断言能力,同时结合 error 接口的特性来验证错误是否符合预期。首先我们需要有一个包含错误返回的函数作为测试对象,比如下面这个模拟用户查询的函数:
package service
import (
"errors"
"fmt"
)
// 模拟用户数据结构
type User struct {
ID int
Name string
}
// 模拟用户存储
var userDB = map[int]User{
1: {ID: 1, Name: "张三"},
2: {ID: 2, Name: "李四"},
}
// QueryUserByID 根据ID查询用户,用户不存在时返回错误
func QueryUserByID(id int) (User, error) {
user, exists := userDB[id]
if !exists {
return User{}, errors.New(fmt.Sprintf("用户ID %d 不存在", id))
}
// 模拟查询过程中可能出现的内部错误
if id == 999 {
return User{}, errors.New("查询用户时发生内部错误")
}
return user, nil
}
基础错误分支测试方法
最基础的测试方式是调用目标函数后,判断返回的错误是否为空,同时验证错误信息是否符合预期。我们可以在测试文件中编写如下测试函数:
package service
import (
"errors"
"testing"
)
// TestQueryUserByID_NotExist 测试用户不存在的错误分支
func TestQueryUserByID_NotExist(t *testing.T) {
// 调用查询函数,传入不存在的用户ID
_, err := QueryUserByID(100)
// 断言错误不为空
if err == nil {
t.Errorf("期望返回错误,但是未返回错误")
}
// 验证错误信息是否正确
expectedErrMsg := "用户ID 100 不存在"
if err.Error() != expectedErrMsg {
t.Errorf("期望错误信息为 %s,实际错误信息为 %s", expectedErrMsg, err.Error())
}
}
验证特定错误类型
如果我们在代码中定义了自定义的错误类型,测试时还需要验证返回的错误是否属于预期的类型。比如我们先定义一个自定义错误类型:
package service
import "fmt"
// NotFoundError 自定义用户不存在错误类型
type NotFoundError struct {
ID int
}
// Error 实现error接口
func (e *NotFoundError) Error() string {
return fmt.Sprintf("用户ID %d 不存在", e.ID)
}
// 修改QueryUserByID函数,用户不存在时返回自定义错误
func QueryUserByIDV2(id int) (User, error) {
user, exists := userDB[id]
if !exists {
return User{}, &NotFoundError{ID: id}
}
if id == 999 {
return User{}, errors.New("查询用户时发生内部错误")
}
return user, nil
}
针对自定义错误类型的测试可以这样编写:
package service
import (
"testing"
)
// TestQueryUserByIDV2_NotFoundError 测试自定义错误类型的返回
func TestQueryUserByIDV2_NotFoundError(t *testing.T) {
_, err := QueryUserByIDV2(100)
if err == nil {
t.Errorf("期望返回错误,但是未返回错误")
}
// 使用类型断言判断错误是否为NotFoundError类型
notFoundErr, ok := err.(*NotFoundError)
if !ok {
t.Errorf("期望返回NotFoundError类型错误,实际错误类型为 %T", err)
}
if notFoundErr.ID != 100 {
t.Errorf("期望错误中的用户ID为100,实际为 %d", notFoundErr.ID)
}
}
模拟依赖错误返回
当被测试的函数依赖其他模块返回错误时,我们可以使用接口加模拟的方式来控制依赖的返回结果,从而测试当前函数的错误分支。比如我们有一个依赖数据访问层的用户服务:
package service
// UserRepository 用户数据访问接口
type UserRepository interface {
GetByID(id int) (User, error)
}
// UserService 用户服务
type UserService struct {
repo UserRepository
}
// NewUserService 创建用户服务实例
func NewUserService(repo UserRepository) *UserService {
return &UserService{repo: repo}
}
// GetUser 获取用户,依赖repo返回结果
func (s *UserService) GetUser(id int) (User, error) {
return s.repo.GetByID(id)
}
编写测试时我们可以实现一个模拟的 UserRepository,让它返回指定的错误:
package service
import (
"errors"
"testing"
)
// MockUserRepository 模拟用户数据访问层
type MockUserRepository struct{}
// GetByID 模拟返回错误
func (m *MockUserRepository) GetByID(id int) (User, error) {
return User{}, errors.New("模拟数据访问错误")
}
// TestUserService_GetUser_RepoError 测试依赖返回错误时的分支
func TestUserService_GetUser_RepoError(t *testing.T) {
// 创建模拟的repo
mockRepo := &MockUserRepository{}
// 创建用户服务,注入模拟repo
userService := NewUserService(mockRepo)
// 调用服务方法
_, err := userService.GetUser(1)
if err == nil {
t.Errorf("期望返回错误,但是未返回错误")
}
expectedErrMsg := "模拟数据访问错误"
if err.Error() != expectedErrMsg {
t.Errorf("期望错误信息为 %s,实际错误信息为 %s", expectedErrMsg, err.Error())
}
}
错误分支测试的注意事项
- 每个错误场景单独编写一个测试函数,避免一个测试函数覆盖多个错误分支,导致错误定位困难
- 错误信息如果包含动态内容,比如用户ID、时间戳等,测试时要么匹配固定的动态部分,要么使用错误类型而非错误信息做断言
- 不要忽略函数返回的错误,即使你认为该场景不会返回错误,也应该在测试中验证错误为 nil,避免遗漏潜在问题
- 对于会触发 panic 的错误场景,可以使用
defer加recover来验证 panic 是否被正确触发
常见错误分支测试场景总结
以下是Golang中常见的错误分支测试场景和对应的测试方法:
| 场景 | 测试方法 |
|---|---|
| 函数返回普通错误 | 判断错误不为 nil,验证错误信息 |
| 函数返回自定义错误类型 | 使用类型断言验证错误类型,检查错误字段 |
| 依赖模块返回错误 | 使用模拟依赖返回指定错误,验证当前函数的处理逻辑 |
| 函数触发 panic | 使用 defer 和 recover 验证 panic 被触发 |
通过上述方法,我们可以完整地覆盖Golang代码中的各类错误分支,确保程序在异常场景下的行为符合预期,提升整体代码质量。