15. golang之单元测试

1. 先看一个需求

在我们的工作中，会遇到这样的情况，就是去确认一个函数，或者一个模块的结果是否正确。

如：

2. 传统的方法

1）传统的方法来进行测试

在main函数中，调用addUpper函数，看看实际输出的结果是否和预期的结果一致，如果一致，则说明函数正确，否则函数有错误，然后修改错误

 代码实现：

package main
import (
	"fmt"
)

func addUpper(n int) int {
	res := 0
	for i := 1; i <= n; i++ {
		res += i
	}
	return res
}

func main() {
	// 传统的测试方法，就是在main函数中使用看看结果是否正确
	res := addUpper(10) // 1. + 10 = 55
	if res != 55 {
		fmt.Println("addUpper错误 返回值=%v 期望值=%v\n",res,55)
	} else {
		fmt.Printf("addUpper正确 返回值=%v 期望值=%v\n",res,55)
	}
}

2）传统方法的缺点分析

        <1> 不方便，我们需要在main函数中去调用，这样就需要去修改main函数，如果现在项目正在运行，就可能去停止项目。

        <2>不利于管理，因为当我们测试多个函数或者多个模块时，都需要写在main函数，不利于我们管理和清晰我们的思路

        <3>引出单元测试。 -> testing  测试框架，可以很好的解决问题

3. 单元测试——基本介绍

Go语言中自带有一个轻量级的测试框架testing和自带的go test命令来实现单元测试和性能测试，testing框架和其它语言中的测试框架类似，可以基于这个框架写针对相应函数的测试用例，也可以基于该框架写相应的压力测试用例。通过单元测试，可以解决如下问题：

1）确保每个函数是可运行的，并且运行结果是正确的

2）确保写出来的代码性能是好的

3）单元测试能及时的发现程序设计或实现的逻辑错误，使问题及早暴露，便于问题的定位解决，而性能测试的重点在于发现程序设计上的一些问题，让程序能够在高并发的情况下还能保持稳定

4. 单元测试——快速入门

使用Go的单元测试，对addUpper和sub函数进行测试

特别说明：测试时，可能需要暂时退出360。（因为360可能会认为生成的测试用例程序是木马）

演示如何进行单元测试：

cal.go

package cal

func addUpper(n int) int {
	res := 0
	for i := 1; i <= n; i++ {
		res += i
	}
	return res
}
func getSub(n1 int,n2 int) int {
	return n1 - n2
}

cal_test.go

package cal
import (
	"fmt"
	"testing" // 引入go 的testing框架包
)

// 编写要给测试用例，去测试addUpper是否正确
func TestAddUpper(t *testing.T) {
	//调用
	res := addUpper(10)
	if res != 55 {
		t.Fatalf("AddUpper(10) 执行错误，期望值=%v 实际值=%v\n",55,res)
	}
	// 如果正确，输出日志
	t.Logf("AddUpper(10)  执行正确...")
}
func TestHello(t *testing.T) {
	fmt.Println("TestHello被调用..")
}

sub_test.go

package cal
import (
	_ "fmt"
	"testing" //引入go 的testing框架包
)

//编写要给测试用例，去测试addUpper是否正确
func TestGetSub(t *testing.T) {
	//调用
	res := getSub(10, 3)
	if res != 7 {
		//fmt.Printf("AddUpper(10) 执行错误，期望值=%v 实际值=%v\n", 55, res)
		t.Fatalf("getSub(10, 3) 执行错误，期望值=%v 实际值=%v\n", 7, res)
	}
	//如果正确，输出日志
	t.Logf("getSub(10, 3) 执行正确!!!!...")
}

在相应文件夹下执行：go test -v

单元测试的运行原理示意图：

 5. 单元测试快速入门总结

1）测试用例文件名必须以_test.go结尾。比如： cal_test.go，cal不是固定的

2）测试用例函数必须以Test开头，一般来说就是Test+被测试的函数名，比如：TestAddUpper，Test后跟的第一个字符不能是a-z。

3）TestAddUpper(t *testing.T) 的形参类型必须是 *testing.T【看手册】

4）一个测试用例的而文件中，可以有多个测试用例函数，比如TestAddUpper、TestSub

5）运行测试用例指令

（1）cmd > go test  【如果运行正确，无日志，错误时，会输出日志】

（2）cmd > go test -v 【运行正确或错误，都输出日志】

6）当出现错误时，可以使用t.Fatalf来格式化输出错误信息，并退出程序

7）t.Logf方法可以输出相应的日志

8）测试用例函数，并没有放在main函数中，也执行了，这就是测试用例的方便之处【原理图】

9）PASS表示测试用例运行成功，FAIL表示测试用例运行失败

10）测试单个文件，一定要带上被测试的原文件

        go test -v cal_test.go cal.go

11）测试单个方法

        go test -v -test.run TestAddUpper

6. 单元测试——综合案例

monster.go

package monster
import (
	"fmt"
	"io/ioutil"
	"encoding/json"
)

type Monster struct {
	Name string
	Age int
	Skill string
}
//给 Monster 绑定方法 Store, 可以将一个 Monster 变量(对象),序列化后保存到文件中
func (monster *Monster) Store(filePath string) bool {
	data, err := json.Marshal(monster)
	if err != nil {
		fmt.Println("marshal err=", err)
		return false
	}
	// 保存到文件中
	err = ioutil.WriteFile(filePath,data,0666)
	if err != nil {
		fmt.Println("write file err=", err)
		return false
	}
	return true
}
//给 Monster 绑定方法 ReStore, 可以将一个序列化的 Monster,从文件中读取， //并反序列化为 Monster 对象,检查反序列化，名字正确
func (monster *Monster) ReStore(filePath string) bool {
	// 1. 先从文件中，读取序列化的字符串
	data, err := ioutil.ReadFile(filePath)
	if err != nil {
		fmt.Println("readFile failed err=",err)
		return false
	}
	// 2. 使用读取到data[]byte，对反序列化
	err = json.Unmarshal(data,monster)
	if err != nil {
		fmt.Println("unMarshal err=",err)
		return false
	}
	return true
}

monster_test.go

package monster
import (
	"testing"
)
// 测试用例，测试Store方法
func TestStore(t *testing.T) {
	// 先创建一个Monster实例
	monster := Monster{
		Name: "孙悟空",
		Age: 500,
		Skill: "吃桃子",
	}
	res := monster.Store("K:\\go_file\\monster.txt")
	if !res {
		t.Fatalf("monster.Store()错误，希望为=%v,实际为=%v",true,res)
	}
	t.Logf("monster.Store() 测试成功...")
}

func TestReStore(t *testing.T) {
	// 测试数据很多，测试很多次，才确定函数、模块...
	// 先创建一个 Monster实例，不需要指定字段的值
	var monster Monster = Monster{}
	res := monster.ReStore("K:\\go_file\\monster.txt")
	if !res {
		t.Fatalf("monster.ReStore() 错误，希望为=%v  实际为=%v",true,res)
	}
	// 进一步判断
	if monster.Name != "二郎神" {
		t.Fatalf("monster.ReStore() 错误， 希望为=%v, 实际为=%v","二郎神",monster.Name)
	}
	t.Logf("monster.ReStore() 测试成功...")
}