Go语言测试库stretchr/testify

于 2023-06-20 19:34:54 发布
阅读量1.2k 收藏 2
点赞数 1
分类专栏： golang 文章标签： golang
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_30614345/article/details/131314038
版权

Go语言测试库stretchr/testify

在其他语言中处理测试时，你可能熟悉使用断言和期望。但是，在Go中，我找不到类似的东西，直到我发现了

testify包，Testify的 assert 包为我们的测试提供了各种有用的工具。

Github地址：https://github.com/stretchr/testify

官方文档：https://pkg.go.dev/github.com/stretchr/testify

1、安装

go get github.com/stretchr/testify

2、assert package

package go_testify

import (
	"github.com/stretchr/testify/assert"
	"testing"
)

type Object struct {
	Value string
}

func TestSomething(t *testing.T) {
	var object =  Object{Value: "Something"}
	// assert equality
	assert.Equal(t, 123, 123, "they should be equal")
	// assert inequality
	assert.NotEqual(t, 123, 456, "they should not be equal")
	// assert for nil (good for errors)
	assert.Nil(t, nil)
	// assert for not nil (good when you expect something)
	if assert.NotNil(t, object) {
		// now we know that object isn't nil, we are safe to make
		// further assertions without causing any errors
		assert.Equal(t, "Something", object.Value)
	}
}

$ go test -v 001_test.go
=== RUN   TestSomething
--- PASS: TestSomething (0.00s)
PASS
ok      command-line-arguments  0.290s

如果多次断言，请使用以下命令：

package go_testify

import (
	"github.com/stretchr/testify/assert"
	"testing"
)

type Object struct {
	Value string
}

func TestSomething(t *testing.T) {
	var object = Object{Value: "Something"}
	assert := assert.New(t)
	// assert equality
	assert.Equal(123, 123, "they should be equal")
	// assert inequality
	assert.NotEqual(123, 456, "they should not be equal")
	// assert for nil (good for errors)
	assert.Nil(nil)
	// assert for not nil (good when you expect something)
	if assert.NotNil(object) {
		// now we know that object isn't nil, we are safe to make
		// further assertions without causing any errors
		assert.Equal("Something", object.Value)
	}
}

$ go test -v 002_test.go
=== RUN   TestSomething
--- PASS: TestSomething (0.00s)
PASS
ok      command-line-arguments  0.033s

3、require package

require包提供了与assert包相同的全局函数，但它们并没有返回布尔结果，而是终止了当前测试。

package go_testify

import (
	"github.com/stretchr/testify/require"
	"testing"
)

type Object struct {
	Value string
}

func TestSomething(t *testing.T) {
	var object = Object{Value: "Something"}
	require.Equal(t, 123, 123, "they should be equal")
	require.NotEqual(t, 123, 456, "they should not be equal")
	require.Nil(t, nil)
	require.NotNil(t, object)
}

$ go test -v 003_test.go
=== RUN   TestSomething
--- PASS: TestSomething (0.00s)
PASS
ok      command-line-arguments  0.261s

package go_testify

import (
	"github.com/stretchr/testify/require"
	"testing"
)

type Object struct {
	Value string
}

func TestSomething(t *testing.T) {
	var object = Object{Value: "Something"}
	require := require.New(t)
	require.Equal(123, 123, "they should be equal")
	require.NotEqual(123, 456, "they should not be equal")
	require.Nil(nil)
	require.NotNil(t, object)
}

$ go test -v 004_test.go
=== RUN   TestSomething
--- PASS: TestSomething (0.00s)
PASS
ok      command-line-arguments  0.250s

4、mock package

mock包提供了一种用于轻松编写mock对象的机制，在编写测试代码时可以使用该机制来代替真实对象。

package go_testify

import (
	"fmt"
	"github.com/stretchr/testify/mock"
	"testing"
)

// Test objects
// MyMockedObject是一个模拟对象,它实现了一个接口,该接口描述了我正在测试的代码所依赖的对象
type MyMockedObject struct {
	mock.Mock
}

// DoSomething是MyMockedObject上的一个方法,它实现了一些接口,只记录活动,并返回Mock对象告诉的内容
// 在真实的对象中,这个方法会做一些有用的事情,但由于这是一个模拟对象,我们只需要将其截断
func (m *MyMockedObject) DoSomething(number int) (bool, error) {
	args := m.Called(number)
	return args.Bool(0), args.Error(1)
}

func targetFuncThatDoesSomethingWithObj1(myMockedObject *MyMockedObject) (bool, error) {
	b, err := myMockedObject.DoSomething(123)
	if err != nil {
		return false, fmt.Errorf("failed, error details: %w", err)
	}
	return b, nil
}

// 实际测试功能
// TestSomething是一个如何使用我们的测试对象来断言我们正在测试的一些目标代码的示例
func TestSomething(t *testing.T) {
	testObj := new(MyMockedObject)
	testObj.On("DoSomething", 123).Return(true, nil)
	targetFuncThatDoesSomethingWithObj1(testObj)
	testObj.AssertExpectations(t)
}

// TestSomethingWithPlaceholder是关于如何使用我们的测试对象来断言我们正在测试的一些目标代码的第二个例子
// 这次使用占位符,当传入的数据通常是动态生成的,并且无法预先预测时可能会使用占位符
func TestSomethingWithPlaceholder(t *testing.T) {
	testObj := new(MyMockedObject)
	testObj.On("DoSomething", mock.Anything).Return(true, nil)
	targetFuncThatDoesSomethingWithObj2(testObj)
	testObj.AssertExpectations(t)
}

func targetFuncThatDoesSomethingWithObj2(myMockedObject *MyMockedObject) (bool, error) {
	b, err := myMockedObject.DoSomething(123)
	if err != nil {
		return false, fmt.Errorf("failed, error details: %w", err)
	}
	return b, nil
}

// 展示了如何使用Unset方法清理处理程序，然后添加新的处理程序
func TestSomethingElse2(t *testing.T) {
	testObj := new(MyMockedObject)
	mockCall := testObj.On("DoSomething", mock.Anything).Return(true, nil)
	targetFuncThatDoesSomethingWithObj3(testObj)
	testObj.AssertExpectations(t)
	mockCall.Unset()
	testObj.On("DoSomething", mock.Anything).Return(false, nil)
	testObj.AssertExpectations(t)
}

func targetFuncThatDoesSomethingWithObj3(myMockedObject *MyMockedObject) (bool, error) {
	b, err := myMockedObject.DoSomething(123)
	if err != nil {
		return false, fmt.Errorf("failed, error details: %w", err)
	}
	return b, nil
}

$ go test -v 005_test.go
=== RUN   TestSomething
    005_test.go:36: PASS:       DoSomething(int)
--- PASS: TestSomething (0.00s)
=== RUN   TestSomethingWithPlaceholder
    005_test.go:45: PASS:       DoSomething(string)
--- PASS: TestSomethingWithPlaceholder (0.00s)
=== RUN   TestSomethingElse2
    005_test.go:61: PASS:       DoSomething(string)
    005_test.go:64: PASS:       DoSomething(string)
--- PASS: TestSomethingElse2 (0.00s)
PASS
ok      command-line-arguments  0.262s

5、suite package

suite 包您可以使用结构体构建测试套件，在结构体上定义设置/拆卸和测试方法，并像平常一样使用 go test 运行

它们。

package go_testify

import (
	"testing"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/suite"
)

type ExampleTestSuite struct {
	suite.Suite
	VariableThatShouldStartAtFive int
}

// before each test
func (suite *ExampleTestSuite) SetupTest() {
	suite.VariableThatShouldStartAtFive = 5
}

func (suite *ExampleTestSuite) TestExample() {
	assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive)
}

func TestExampleTestSuite(t *testing.T) {
	suite.Run(t, new(ExampleTestSuite))
}

$ go test -v 006_test.go
=== RUN   TestExampleTestSuite
=== RUN   TestExampleTestSuite/TestExample
--- PASS: TestExampleTestSuite (0.00s)
    --- PASS: TestExampleTestSuite/TestExample (0.00s)
PASS
ok      command-line-arguments  0.371s

要获得一个更完整的示例，使用 suite 包提供的所有功能，请查看我们的示例测试suite ：

package go_testify

import (
	"testing"
	"github.com/stretchr/testify/suite"
)

type ExampleTestSuite struct {
	suite.Suite
	VariableThatShouldStartAtFive int
}

// before each test
func (suite *ExampleTestSuite) SetupTest() {
	suite.VariableThatShouldStartAtFive = 5
}

func (suite *ExampleTestSuite) TestExample() {
	suite.Equal(suite.VariableThatShouldStartAtFive, 5)
}

func TestExampleTestSuite(t *testing.T) {
	suite.Run(t, new(ExampleTestSuite))
}

$ go test -v 007_test.go
=== RUN   TestExampleTestSuite
=== RUN   TestExampleTestSuite/TestExample
--- PASS: TestExampleTestSuite (0.00s)
    --- PASS: TestExampleTestSuite/TestExample (0.00s)
PASS
ok      command-line-arguments  0.036s

6、常用的stretchr/testify框架函数

func Equal(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
func NotEqual(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool

func Nil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool

func Empty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
func NotEmpty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool

func NoError(t TestingT, err error, msgAndArgs ...interface{}) bool
func Error(t TestingT, err error, msgAndArgs ...interface{}) bool

func Zero(t TestingT, i interface{}, msgAndArgs ...interface{}) bool
func NotZero(t TestingT, i interface{}, msgAndArgs ...interface{}) bool

func True(t TestingT, value bool, msgAndArgs ...interface{}) bool
func False(t TestingT, value bool, msgAndArgs ...interface{}) bool

func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{}) bool

func NotContains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool
func NotContains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool
func Subset(t TestingT, list, subset interface{}, msgAndArgs ...interface{}) (ok bool)
func NotSubset(t TestingT, list, subset interface{}, msgAndArgs ...interface{}) (ok bool)

func FileExists(t TestingT, path string, msgAndArgs ...interface{}) bool
func DirExists(t TestingT, path string, msgAndArgs ...interface{}) bool
242030
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Go-Testify-标准go测试包一个的神圣扩展
08-13
Testify - 标准go测试包一个的神圣扩展
github.com/stretchr/testify/suite
y果子
08-10 1843
import "github.com/stretchr/testify/suite" 软件包套件包含用于创建测试套件结构并将这些结构上的方法作为测试运行的逻辑. 该软件包最有用的部分是，您可以在测试套件上创建安装/拆卸方法，该方法将在整个套件或单个测试之前/之后运行（取决于您实现的接口）. 通常，通过首先从suite.Suite中扩展内置套件功能来构建测试套件. 另外，您也可以根据需要自行重现该逻辑（您只需要从suite / interfaces.go中实现TestingSuite接口即可）. 之后，您可
【golang】go mock单元测试stretchr/testify
zhonglinzhang
04-03 4316
assertpackage Theassertpackage provides some helpful methods that allow you to write better test code in Go. Prints friendly, easy to read failure descriptions Allows for very readable code Op...
stretchr/testify-源码解读
song21song的专栏
09-23 407
src/github.com/stretchr/testify/require/requirements_test.go:48/requirements_test.go:48 ``` func TestIsType(t *testing.T) { IsType(t, new(AssertionTesterConformingObject), new(AssertionTesterCo...
go语言单元测试报错：missing go.sum entry for module providing package github.com/stretchr/testify/assert
supergirlll的博客
03-26 5529
报错：missing go.sum entry for module providing package github.com/stretchr/testify/assert (imported by GinCasbin/test); 解决方法： ❯ go mod edit -require github.com/gin-gonic/gin@latest ❯ go mod tidy 再执行go test成功：
使用go语言测试grpc工程源码
05-19
在本文中，我们将深入探讨如何使用Go语言进行gRPC工程的测试，特别是在处理源码级别的测试。gRPC是一个高性能、开源和通用的RPC框架，它基于HTTP/2协议和Protocol Buffers（protobuf）来定义服务接口。Go语言，作为...
go_test:go语言测试学习项目
03-19
在本文中，我们将深入探讨Go语言的测试框架和实践，主要基于提供的"go_test:go语言测试学习项目"。Go语言（通常称为Golang）是由Google开发的一种静态类型的、编译型的、并发型的、垃圾回收的编程语言。Go语言内置了...
Go-测试框架断言-基础的断言Go库
08-13
在Go语言中，进行单元测试时，我们常常需要使用断言库来判断代码执行的结果是否符合预期。"Go-测试框架断言-基础的断言Go库"这个标题提到的库，很可能是一个辅助进行断言操作的第三方工具，类似于`assert`包。描述中...
Go-Golang单元测试快速入门
08-14
Go语言的单元测试基于其标准库中的`testing`包，该包提供了编写、组织和执行测试的基本框架。下面我们将深入探讨`testing`包的使用方法，以及如何编写高效的单元测试。 1. **创建测试文件** - Go的测试文件通常与...
learn-go-with-tests:该存储库用于培训Golang进行测试
03-12
在本文中，我们将深入探讨如何使用Go语言进行测试，基于提供的资源"learn-go-with-tests"。这个存储库是一个专门为了教育目的而创建的，目的是帮助开发者掌握在Golang环境中编写和执行测试用例的技巧。Golang，也被...
Go-一个通用的golang对象池
08-14
go-commons-pool - 一个通用的golang对象池
go语言单元测试之二：gin框架用httptest做单元测试
刘老师的技术森林
01-26 3486
一，安装用到的库 1,testify的代码地址: https://github.com/stretchr/testify 2,从命令行安装: liuhongdi@ku:~$ go get -u github.com/stretchr/testify 我们可以用testify的assert模块简化代码 说明：刘宏缔的go森林是一个专注golang的博客， 地址：https://blog.csdn.net/weixin_43881017 说明：作者:刘宏缔 邮箱: 37...
Go 中 assert 使用
热门推荐
qq_43267773的博客
11-03 1万+
文章目录Go 中 assert 使用前言asset 包的获取新旧测试文件对比 Go 中 assert 使用 前言 在本周的服务计算作业中，我发现老师写的测试文件使用了 assert 函数代替了之前的 Errorf，这是我第一次看到这个函数，并且发现该函数用于测试文件十分方便，于是在此记录。 asset 包的获取 使用以下命令就可以获取 asset 程序包 go get github.com/stretchr/testify/assert 使用完此命令后可以在本地的 GOPATH/src 路径下发现多了三个文
2、Go自动化测试入门-testify
Mumu的博客
01-26 1497
先获取testify包：go get GitHub.com/stretchr/testify 一个简单的示例 让我们先看看传统上如何在 Go 中编写测试。这将让我们对提高可读性的 testify 有所了解。 我先来写一个简单的 Go 程序，它有一个输出函数， Calculate() 。 package main import ( "fmt" ) // 计算并返回 x + 2. func Calculate(x int) (result int) { result = x + 2
Go 每日一库之 testify
darjun的博客
08-12 1316
简介testify可以说是最流行的（从 GitHub star 数来看）Go 语言测试库了。testify提供了很多方便的函数帮助我们做assert和错误信息输出。使用标准库testing...
推荐几个 Go 测试工具和技巧让你在虎年如虎添翼
kevin_tech的博客，微信搜「网管叨bi叨」
01-24 1333
今天带来一篇让你在虎年如虎添翼的Go测试工具和技巧的文章分享。大体内容翻译于 Go (Golang): Testing tools & tips to step up your g...
Go报错：package X is not a main package
qq_32439305的博客
12-07 8472
有时候会遇到package github.com/pkg/profile is not a main package问题。 这是因为我使用的是go install , 换成 go get之后就好了 不知道为啥，记录一下。X
盘点Golang测试相关库
伤心的辣条
11-04 1253
golang的生态还是丰富的，几乎各种需求都能找到对应库。但有不少库的质量堪忧，因为不少项目的维护停留在几个月，甚至好几年前，有种我错过Golang的黄金年代，但其实Golang正在变得越来越多人使用。我不会用Golang写自动化测试，看一看 selenium/playwright 的代码，err 的处理真的会让人崩溃，不可否认，Golang在其他方面很棒~！我目前正有在使用Golang写web服务。如果你发现Golang还有哪些测试人员会用到的宝藏项目，欢迎在留言~！
编译go程序时出错问题解决方法
stars的博客
05-01 1271
在使用go进行编译脚本时，提示如下错误 go: downloading github.com/stretchr/testify v1.4.0 go: downloading github.com/bitly/go-simplejson v0.5.0 testClient.go:7:2: unknown import path "github.com/bitly/go-simplejson": Get https://goproxy.io/github.com/bitly/go-simplejson/@v
修改 /opt/chaincode/ 目录下的 go.mod, 指定版本，添加如下内容： require ( github.com/golang/protobuf v1.3.2 github.com/hyperledger/fabric-chaincode-go v0.0.0-20200424173110-d7076418f212 github.com/hyperledger/fabric-contract-api-go v1.1.0 github.com/hyperledger/fabric-protos-go v0.0.0-20200424173316-dd554ba3746e github.com/stretchr/testify v1.5.1 golang.org/x/tools v0.1.0 // indirect )
最新发布
05-17
这个操作是修改指定目录下的 go.mod 文件，... github.com/stretchr/testify v1.5.1 golang.org/x/tools v0.1.0 // indirect ) ``` 4. 保存并关闭文件。 5. 现在，您可以运行您的链码并确保依赖库的版本已被锁定。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值