Gone框架介绍19 -如何进行单元测试？

Golang依赖注入框架Goner的单元测试与mock实践

原创已于 2024-05-24 06:41:13 修改 · 603 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#单元测试 #gone #mock测试 #go #gomock #mockgen

于 2024-05-15 20:14:56 首次发布

Gone框架介绍专栏收录该内容

66 篇文章

订阅专栏

gone是可以高效开发Web服务的Golang依赖注入框架
github地址：https://github.com/gone-io/gone
文档地址：https://goner.fun/zh/

文章目录

单元测试

单元测试

在一个依赖注入框架中如何进行单元测试，将依赖项先注入后再测试；如果测试内容和注入内容强相关，可以考虑对相关内容做mock；一种方式是手动将mock后的Goner埋葬到系统，另外一种方式时将已经埋葬的Goner，使用cemetery.ReplaceBury做替换性埋葬。

假设我们编写的Goner如下

文件名：goner.go

package test

import (
	"github.com/gone-io/gone"
	"github.com/gone-io/gone/goner/config"
)

const pointNameA = "example-test-point-a"
const pointNameB = "example-test-point-b"

func NewPointA() (gone.Goner, gone.GonerId) {
	return &Point{}, pointNameA
}

func NewPointB() (gone.Goner, gone.GonerId) {
	return &Point{X: -1, Y: -1}, pointNameB
}

type Point struct {
	gone.Flag
	X int `gone:"config,example.test.point.a-x"`
	Y int `gone:"config,example.test.point.a-y,default=200"`
}

type Line struct {
	gone.Flag
	A *Point `gone:"example-test-point-a"`
	B *Point `gone:"example-test-point-b"`
}

func (*Line) Say() string {
	return ""
}

func NewLine() *Line {
	return &Line{}
}

func Priest(cemetery gone.Cemetery) error {
	cemetery.Bury(NewPointA())
	cemetery.Bury(NewPointB())
	cemetery.Bury(NewLine())
	return config.Priest(cemetery)
}

我们可以编写测试文件如下：

文件名：goner_test.go

package test

import (
	"github.com/gone-io/gone"
	"github.com/gone-io/gone/goner/config"
	"github.com/stretchr/testify/assert"
	"testing"
)

func Test_Line(t *testing.T) {
	t.Run("config default", func(t *testing.T) {
		gone.TestAt(pointNameA, func(point *Point) {
			assert.Equal(t, point.X, 1000)
			assert.Equal(t, point.Y, 200)
		}, config.Priest, Priest)
	})

	t.Run("config default", func(t *testing.T) {
		gone.Test(func(line *Line) {
			assert.Equal(t, line.A.Y, 200)
		}, Priest)
	})

	t.Run("ReplaceBury", func(t *testing.T) {
		gone.Test(func(line *Line) {
			assert.Equal(t, line.A.X, 20)
		}, Priest, func(cemetery gone.Cemetery) error {
			Mock := func() gone.Goner {
				return &Point{X: 20}
			}
			return cemetery.ReplaceBury(Mock(), pointNameA)
		})
	})
}

使用gomock做mock测试

为了解耦，我们推荐使用接口进行注入；实际上推荐接口注入的另一个原因是，go语言提供了基于接口的mock方案，我们可以将依赖的内容都mock起来。然而使用mockgen生成的mock实现，不是Goner，无法被埋葬，所以也无法注入；为此，我们在辅助工具中提供了解决方案。

gone mock  -f ${fromGoFile} -o ${outGoFile}

gone mock 命令可以在一个mockgen生成的mock对象中增加gone.Flag，让其变成一个Goner，可以进入Cemetery。

一般的使用方法是，在需要mock的接口上加//go:generate注释，让生成过程在go generate ./...命令时自动完成，下面是一个例子：

文件名：i_point.go

package test

//go:generate sh -c "mockgen -package=mock -source=$GOFILE|gone mock -o mock/$GOFILE"
type IPoint interface {
	GetX() int
	GetY() int
}

上面//go:generate sh -c "mockgen -package=mock -source=$GOFILE|gone mock -o mock/$GOFILE"的作用是，先用mock为该接口生成一个mock对象，然后通过管道传递给gone mock添加gone.Flag标记。

注意mockgen工具和gomock包的版本需要保持一致；
运行下面代码，安装最新版本：
go get github.com/golang/mock/gomock
go get github.com/golang/mock/mockgen
需要安装gone辅助工具；安装参考 gone辅助工具。

好让，我们来试试吧，创建一个空目录并在进入后，将上文件i_test.go创建出来，让后在当前目录运行命令：

go generate ./...

可以看到，命令运行完后，将生成文件mock/i_point.go。

下面我们创建一个 origin_point.go文件，内容如下：

package test

import "github.com/gone-io/gone"

type originPoint struct {
	gone.Flag
}

//go:gone
func NewOriginPoint() gone.Goner {
	return &originPoint{}
}

func (o *originPoint) GetX() int {
	return 100
}
func (o *originPoint) GetY() int {
	return 200
}

在创建一个名为distance_calculator.go的文件，内容如下：

package test

import (
	"github.com/gone-io/gone"
	"math"
)

//go:gone
func NewDistanceCalculator() gone.Goner {
	return &distanceCalculator{}
}

type distanceCalculator struct {
	gone.Flag

	originPoint IPoint `gone:"*"`
}

func (d *distanceCalculator) CalculateDistanceFromOrigin(x, y int) float64 {
	originX, originY := d.originPoint.GetX(), d.originPoint.GetY()
	return math.Sqrt(math.Pow(float64(x-originX), 2) + math.Pow(float64(y-originY), 2))
}

distanceCalculator 的业务是计算(x,y int)到originPoint点的距离，originPoint是依赖注入的；现在我们来编写CalculateDistanceFromOrigin的测试函数如下：

package test

import (
	"example/test/mock"
	"github.com/golang/mock/gomock"
	"github.com/gone-io/gone"
	"github.com/stretchr/testify/assert"
	"testing"
)

func Test_distanceCalculator_CalculateDistanceFromOrigin(t *testing.T) {

	//创建mock控制器
	controller := gomock.NewController(t)
	defer controller.Finish()

	gone.Test(func(d *distanceCalculator) {
		distance := d.CalculateDistanceFromOrigin(3, 4)

		assert.Equal(t, float64(5), distance)

	}, func(cemetery gone.Cemetery) error {

		//创建mock对象
		point := mock.NewMockIPoint(controller)
		point.EXPECT().GetX().Return(0)
		point.EXPECT().GetY().Return(0)

		//将mock对象埋葬到Cemetery
		cemetery.Bury(point)

		//被测试的对象也需要埋葬到Cemetery
		cemetery.Bury(NewDistanceCalculator())
		return nil
	})
}