单元测试

需求

  1. 一个函数，怎么确认它运行结果是正确的。

    解决方法

    传统方法解决

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

  3. 应用案例 ```go package main

import “fmt”

//一个被测试函数 func addUpper(n int) int { res := 0 for i := 1; i <= n; i++ { res += i } return res }

func main() {

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

}

  2. 3. 传统方法的缺点分析 
  3.    - 不方便，我们需要在 main 函数中去调用，这样就需要去修改 main 函数，如果现在项目正在运行，就可能要停止项目。 
  4.    - 不利于管理，因为当我们测试多个函数或者多个模块时，都需要写在 main 函数，不利于我们管理和清晰我们思路。 
  5.    - 引出单元测试 -> testing 测试框架可以很好的解决问题。 
  6. <a name="93b824b5-1"></a>
  7. ## 单元测试
  8. <a name="f72dd4a6"></a>
  9. ### 基本介绍
  11. 1. Go 语言中自带一个轻量级的测试框架 testing 和自带的 go test 命令来实现单元测试和性能测试，testing 框架和其他语言中的测试框架类似，可以给予这个框架写针对相应函数的测试用例，也可以基于该框架写相应的压力测试用例。通过单元测试，可以解决如下问题： 
  12.    - 确保每个函数是可运行，并且运行结果是正确的。 
  13.    - 确保写出来的代码性能是好的 
  14.    - 单元测试能及时的发现程序设计或实现的逻辑错误，使得问题尽早暴露，便与问题的定位解决，而且性能测试的重点在于发现程序设计上的一些问题，让程序能够在高并发的情况下还能保持稳定。 
  15. <a name="e11d9bba"></a>
  16. ### 快速入门
  18. 1. 使用 Go 的单元测试，对 addUpper 和 sub 函数进行测试。
  19. ```go
  20. //testing_case_01/cal.go
  21. package cal
  23. //一个被测试函数
  24. func addUpper(n int) int {
  25.     res := 0
  26.     for i :=0; i <= n; i++{
  27.         res += i
  28.     }
  30.     return res
  31. }
  34. //求两个数的差
  35. func getSub(n1 int, n2 int) int {
  36.     return n1 - n2
  37. }
  1. //testing_case_01/cal_test.go
  2. package cal
  4. import (
  5.     "fmt"
  6.     "testing" //引入 go 的 testing 框架包
  7. )
  10. //编写要给测试用例，去测试 addUpper 是否正确
  11. func TestAddUpper(t *testing.T) {
  12.     //调用
  13.     res := addUpper(10)
  14.     if res != 55 {
  15.         //fmt.Printf("AddUpper(10) 执行错误，期望值=%v 实际值=%v \n", 55, res)
  16.         t.Fatalf("AddUpper(10) 执行错误，期望值 = %v 实际值 = %v \n", 55, res)
  17.     } else {
  18.         //如果正确，输出日志
  19.         t.Logf("AddUpper(10) 执行正确...")
  20.     }
  21. }
  24. func TestHello(t *testing.T) {
  25.     fmt.Println("TestHello被调用")
  27. }
  1. //testing_case_01/sub_test.go
  2. package cal
  4. import (
  5.     "testing" //引入 go 的 testing 框架包
  6. )
  9. //编写要给测试用例，去测试 addUpper 是否正确
  10. func TestGetSub(t *testing.T) {
  11.     //调用
  12.     res := getSub(10, 3)
  13.     if res != 7 {
  14.         t.Fatalf("getSub(10, 3) 执行错误，期望值 = %v 实际值 = %v \n", 7, res)
  15.     } else {
  16.         //如果正确，输出日志
  17.         t.Logf("getSub(10, 3) 执行正确...")
  18.     }
  19. }

  1. 快速入门总结

    • 测试用例文件名必须以 _test.go 结尾。
    • 测试用例函数必须以 Test 开头，一般来说就是 Test + 被测试的函数名。
    • TestAddUpper(t *testing.T)的形参类型必须是 *testing.T
    • 一个测试用例文件中，可以有多个测试用力函数，比如 TestAddUpper、TestSub

    • 运行测试用例指令 

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

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

    • t.Logf 方法可以输出相应的日志
    • 测试用力函数，并没有放在 main 函数中，也执行了，这就是测试用例的方便之处。
    • PASS 表示测试用例运行成功，FAIL 表示测试用例运行失败。

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

      1. go test -v cal_test.go cal.go

    • 测试单个方法 

      1. go test -v -test.run TestAddUpper

      综合案例

  2. 案例一

    • 编写一个 Monster 结构体，字段 Name，Age，Skill
    • 给 Monster 绑定方法 Store，可以将一个 Monster 变量(对象)，序列化后保存到文件中。
    • 给 Monster 绑定方法 Restore，可以将一个序列化的 Monster，从文件中读取，并序列化为 Monster 对象，检查反序列化，名字正确。
    • 编程测试用例文件 store_test.go, 编写测试用例函数 TestStore。 ```go //testing_case_03/monster.go package monster

import ( “encoding/json” “fmt” “io/ioutil” )

type Monster struct { Name string Age int Skill string }

//给 Monster 绑定方法 Store，可以将一个 Monster 变量(对象)，序列化后保存到文件中。 func (monster *Monster) Store() bool {

  1. //先序列化
  2. data, err := json.Marshal(monster)
  3. if err != nil {
  4.     fmt.Println("marshal error: ", err)
  5.     return false
  6. } else {
  7.     //保存到文件
  8.     filePath := "/Users/Gree/Desktop/Linux/text.txt"
  9.     err = ioutil.WriteFile(filePath, data, 0755)
  10.     if err != nil {
  11.         fmt.Println("write file error: ", err)
  12.         return false
  13.     } else {
  14.         return true
  15.     }
  16. }

}

//给 Monster 绑定方法 Restore，可以将一个序列化的 Monster，从文件中读取，并序列化为 Monster 对象，检查反序列化，名字正确。 func (monster *Monster) ReStore() bool {

  1. //1. 先从文件中读取序列化的字符串
  2. filePath := "/Users/Gree/Desktop/Linux/text.txt"
  3. data, err := ioutil.ReadFile(filePath)
  4. if err != nil {
  5.     fmt.Println("read file error: ", err)
  6.     return false
  7. } else {
  8.     //2. 使用读取到data []byte 反序列化
  9.     err = json.Unmarshal(data, monster)
  10.     if err != nil {
  11.         fmt.Println("unmarshal error: ", err)
  12.         return false
  13.     } else {
  14.         return true
  15.     }
  17. }

}

  2. ```go
  3. //testing_case_03/monster_test.go
  4. package monster
  6. import "testing"
  9. //测试用例，测试 Store 方法
  10. func TestStore(t *testing.T) {
  12.     //先创建一个 Monster 实例
  13.     monster := Monster{
  14.         Name: "红孩儿",
  15.         Age: 10,
  16.         Skill: "吐火",
  17.     }
  19.     res := monster.Store()
  20.     if !res {
  21.         t.Fatalf("monster.Store() 错误，希望为 = %v， 实际为 = %v", true, res)
  22.     } else {
  23.         t.Logf("monster.Store() 测试成功")
  24.     }
  26. }
  29. func TestReStore(t *testing.T) {
  31.     //先创建一个 Monster 实例，不需要指定字段的值
  32.     var monster Monster
  34.     res := monster.ReStore()
  35.     if !res {
  36.         t.Fatalf("monster.ReStore() 错误，希望为 = %v， 实际为 = %v", true, res)
  37.     } else {
  38.         //进一步判断
  39.         if monster.Name != "红孩儿" {
  40.             t.Fatalf("monster.ReStore() 错误，希望为 = %v， 实际为 = %v","红孩儿", monster.Name)
  41.         } else {
  42.             t.Logf("monster.ReStore() 测试成功")
  43.         }
  44.     }
  46. }

课程来源