GO语言使用之代码模块单元测试

一、什么是单元测试？

单元测试是一段自动化的代码，这段代码调用被测试的工作单元，之后对这个单元的单个最终结果的某些假设进行检验。单元测试几乎都是用单元测试框架编写的。单元测试容易编写，能快速运行。单元测试可靠、可读、并且可维护。只要产品代码不发生变化，单元测试的结果是稳定的。
单元测试具有以下特征：

自动化、可重复执行；
很容易实现；
运行速度应该很快；
结果应该是稳定的；
能完全控制被测试的单元；
完全隔离（独立于其他测试的运行）；

二、为什么要进行单元测试

从一个案列引入单元测试，在main函数中，调用函数实现1~n的和，看看实际输出的结果是否和预期的结果一致，如果一致，则说明函数正确，否则函数有错误，然后修改错误。

1、案列传统测试方法实现
1）代码如下：

// 被测试函数
func getSum(n int) (sum int) {

    for i := 0; i <= n; i++ {
        sum +=i
    }
    return
} 

func TestGetSum()  {
    //传统的测试方法，就是在main函数中使用看看结果是否正确
    res := getSum(10)

    if res == 55 {
        fmt.Println("测试成功")
    }else{
        fmt.Println("测试失败")
    }
}

2）测试结果：

e:\GoProject\src\go_code\unittest\code\main>go run main.go
测试成功

e:\GoProject\src\go_code\unittest\code\main>

2、传统方法的劣势

1）测试不方便.

将测试代码直接放在main函数中测试，必然会影响项目正常运行，如果现在项目正在运行，就可能去停止项目。

2）不利于管理.

因为当我们测试多个函数或者多个模块时，都需要写在main函数，不利于我们管理和清晰我们思路。同时要测试某个函数时，还要通过注销和启用来调整，显得测试代码会很乱，不好管理。

3、案列测试框架实现

1）代码如下：
calsum.go

package test

func getSum(n int) (sum int) {

    for i := 0; i <= n; i++ {
        sum +=i
    }
    return
}

cal_test.go

package test

import (
    "testing" //引入go 的testing框架包
)
//编写测试用例，测试getSum是否正确
func TestSum(t *testing.T)  {
    res := getSum(10)
    if res == 55 {
        t.Logf("测试成功")
    }else{
        t.Fatalf("测试失败")
    }
}

2）测试结果：

e:\GoProject\src\go_code\unittest\code\test>go test -v
=== RUN   TestSum
--- PASS: TestSum (0.00s)
        cal_test.go:10: 测试成功
PASS
ok      go_code/unittest/code/test      0.284s

e:\GoProject\src\go_code\unittest\code\test>

4、单元测试的优势
1)确保每个函数是可运行，并且运行结果是正确的
2)确保写出来的代码性能是好的.
3)单元测试能及时的发现程序设计或实现的逻辑错误，使问题及早暴露，便于问题的定位解决，而性能测试的重点在于发现程序设计上的一些问题，让程序能够在高并发的情况下还能保持稳定

5、总结，通过比较，可以发现使用代码测试框架更便于我们管理代码。而且更好的检测代码中的问题。推荐使用go的testing测试功能代码。

三、go中单元测试

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

1) 确保每个函数是可运行，并且运行结果是正确的
2) 确保写出来的代码性能是好的，
3) 单元测试能及时的发现程序设计或实现的逻辑错误，使问题及早暴露，便于问题的定位解决，而性能测试的重点在于发现程序设计上的一些问题，让程序能够在高并发的情况下还能保持稳定。

2、案列演示
编写一个Monster结构体, 字段 Name, Age, Skill
给Monster绑定方法Store, 可以将一个Monster变量(对象),序列化后保存到文件中
给Monster绑定方法ReStore, 可以将一个序列化的Monster,从文件中读取，并反序列化为Monster对象,检查反序列化，名字正确
编程测试用例文件 store_test.go , 编写测试用例函数 TestStore 和 TestRestore进行测试。

monster.go

package example

import (
    "io/ioutil"
    "encoding/json"
)

type Monster struct{
    Name string
    Age int
    Skill string
}

func (m *Monster)Store() (err error) {
    data, err := json.Marshal(m)
    if err != nil {
        return
    }
    err = ioutil.WriteFile("d:/monster.dat", data, 0755)
    return


}

func (m *Monster)ReStore() (err error) {
    data, err := ioutil.ReadFile("d:/monster.dat")
    if err != nil {
        return
    }
    err = json.Unmarshal(data, m)
    return

}

monster_test.go

package example

import (
    "testing"
)

func TestStoreMonster(t *testing.T)  {
    m := &Monster{"乱世狂刀",30,"悲龙斩"}
    err := m.Store()
    if err != nil {
        t.Fatalf("保存数据失败, err:%v", err)
    }

    t.Logf("保存数据成功")

}

func TestRestoreMonster(t *testing.T) {

    m := &Monster{}
    err := m.ReStore()
    if err != nil {
        t.Fatalf("读取数据失败, err:%v", err)
    }
    if m.Name != "乱世狂刀" {
        t.Fatalf("读取姓名失败：名字不正确；读取的年龄为%s",m.Name)
    }
    if m.Age != 30 {
        t.Fatalf("读取年龄失败：年龄不正确；读取的年龄为%d",m.Age)
    }
    if m.Skill != "悲龙斩" {
        t.Fatalf("读取技能失败：技能不正确；读取的年龄为%s",m.Skill)
    }
    t.Logf("读取数据成功")
}

测试结果：

e:\GoProject\src\go_code\unittest\code\example>go test -v
=== RUN   TestStoreMonster
--- PASS: TestStoreMonster (0.06s)
        monster_test.go:14: 保存数据成功
=== RUN   TestRestoreMonster
--- PASS: TestRestoreMonster (0.00s)
        monster_test.go:34: 读取数据成功
PASS
ok      go_code/unittest/code/example   0.354s

e:\GoProject\src\go_code\unittest\code\example>

3、单元测试使用细节和注意事项
1) 测试用例文件名必须以 _test.go 结尾。比如 cal_test.go , cal 不是固定的。
2) 测试用例函数必须以Test开头，一般来说就是Test+被测试的函数名，比如 TestSum
3) TestSum(t *tesing.T) 的形参类型必须是 *testing.T 【源码如下：】
这里写图片描述

4) 一个测试用例文件中，可以有多个测试用例函数，比如 TestSum、TestSub
5) 运行测试用例指令

cmd>go test [如果运行正确，无日志，错误时，会输出日志]
cmd>go test -v [运行正确或是错误，都输出日志]

6)当出现错误时，可以使用t.Fatalf 来格式化输出错误信息，并退出程序
7) t.Logf 方法可以输出相应的日志
8) 测试用例函数，并没有放在main函数中，也可以执行，使用比较方便，
可能有人会问为什么没有main方法？因为testing底层封装了mian方法
下图是测试的原理图
这里写图片描述
9) PASS表示测试用例运行成功，FAIL 表示测试用例运行失败
10) 测试单个文件，一定要带上被测试的原文件

go test -v monster_test.go monster.go

11)测试单个方法

go test -v -test.run TestStore