0

0

使用 STRETCHR/TESTIFY 和 MOCKERY 进行 GOL 测试

花韻仙語

花韻仙語

发布时间:2024-10-17 13:12:30

|

565人浏览过

|

来源于dev.to

转载

使用 stretchr/testify 和 mockery 进行 gol 测试

让我们看一个全面的示例,其中涵盖了stretchr/testify库的常见功能以及golang中的mockery。此示例将包括使用断言进行测试、使用 require 包进行严格断言、测试 http 处理程序以及使用 mockery 模拟依赖项。

设想

假设我们有一个从外部 api 获取用户信息的服务。我们想要测试:

  • 服务的功能。
  • 它与外部客户端的集成。
  • 嘲笑外部客户端。

项目结构

/project
│
├── main.go
├── service.go
├── service_test.go
├── user_client.go
├── mocks/
│   └── userclient.go (generated by mockery)
└── go.mod

代码概述

  1. user_client.go

    该文件定义了与外部用户 api 交互的接口。

    package project
    
    type user struct {
        id   int
        name string
    }
    
    type userclient interface {
        getuserbyid(id int) (*user, error)
    }
    
  2. service.go

    该文件包含一个使用 userclient 获取用户详细信息的服务。

    package project
    
    import "fmt"
    
    type userservice struct {
        client userclient
    }
    
    func newuserservice(client userclient) *userservice {
        return &userservice{client: client}
    }
    
    func (s *userservice) getuserdetails(id int) (string, error) {
        user, err := s.client.getuserbyid(id)
        if err != nil {
            return "", fmt.errorf("failed to get user: %w", err)
        }
    
        return fmt.sprintf("user: %s (id: %d)", user.name, user.id), nil
    }
    
  3. 使用嘲讽生成模拟

    您可以使用 mockery 为 userclient 生成模拟:

    mockery --name=userclient --output=./mocks
    

    这将在mocks/userclient.go 中生成一个模拟。

    家电小商城网站源码1.0
    家电小商城网站源码1.0

    家电公司网站源码是一个以米拓为核心进行开发的家电商城网站模板,程序采用metinfo5.3.9 UTF8进行编码,软件包含完整栏目与数据。安装方法:解压上传到空间,访问域名进行安装,安装好后,到后台-安全与效率-数据备份还原,恢复好数据后到设置-基本信息和外观-电脑把网站名称什么的改为自己的即可。默认后台账号:admin 密码:132456注意:如本地测试中127.0.0.1无法正常使用,请换成l

    下载
  4. service_test.go

    现在,让我们使用 testify 断言和模拟生成的模拟为 userservice 编写一个测试。

        package project_test
    
        import (
            "errors"
            "testing"
    
            "github.com/stretchr/testify/assert"
            "github.com/stretchr/testify/require"
            "github.com/stretchr/testify/mock"
            "project"
            "project/mocks"
        )
    
        func TestUserService_GetUserDetails_Success(t *testing.T) {
            // Create a new mock client
            mockClient := new(mocks.UserClient)
    
            // Define what the mock should return when `GetUserByID` is called
            mockClient.On("GetUserByID", 1).Return(&project.User{
                ID:   1,
                Name: "John Doe",
            }, nil)
    
            // Create the UserService with the mock client
            service := project.NewUserService(mockClient)
    
            // Test the GetUserDetails method
            result, err := service.GetUserDetails(1)
    
            // Use `require` for error checks
            require.NoError(t, err)
            require.NotEmpty(t, result)
    
            // Use `assert` for value checks
            assert.Equal(t, "User: John Doe (ID: 1)", result)
    
            // Ensure that the `GetUserByID` method was called exactly once
            mockClient.AssertExpectations(t)
        }
    
        func TestUserService_GetUserDetails_Error(t *testing.T) {
            // Create a new mock client
            mockClient := new(mocks.UserClient)
    
            // Define what the mock should return when `GetUserByID` is called with an error
            mockClient.On("GetUserByID", 2).Return(nil, errors.New("user not found"))
    
            // Create the UserService with the mock client
            service := project.NewUserService(mockClient)
    
            // Test the GetUserDetails method
            result, err := service.GetUserDetails(2)
    
            // Use `require` for error checks
            require.Error(t, err)
            assert.Contains(t, err.Error(), "user not found")
    
            // Ensure that the result is empty
            assert.Empty(t, result)
    
            // Ensure that the `GetUserByID` method was called exactly once
            mockClient.AssertExpectations(t)
        }
    
    

本例的要点

  1. 带有的断言证明:
    • assert 和 require 包用于不同类型的检查。
    • require 用于检查如果失败则应立即使测试失败(例如,检查 nil 错误)。
    • 断言用于即使失败也可以继续的检查(例如,比较值)。
  2. 嘲笑来嘲笑:
    • mockery 生成 userclient 接口的模拟。
    • 在测试中,模拟配置为使用 .on() 来指定预期输入,并使用 .return() 来指定输出。
    • assertexpectations 验证是否使用预期输入调用了模拟方法。
  3. 测试错误处理
    • 一个测试检查成功场景,而另一个测试则测试服务如何处理来自 userclient 的错误。

此设置涵盖了stretcher/testify 的断言和模拟的基本功能,为 golang 中的单元测试提供了结构化且可维护的方法。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

173

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

224

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

335

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

206

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

388

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

193

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

184

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

191

2025.06.17

ip地址修改教程大全
ip地址修改教程大全

本专题整合了ip地址修改教程大全,阅读下面的文章自行寻找合适的解决教程。

121

2025.12.26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 2.3万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号