【go语言开发】编写单元测试

以你之姓@ 2024-05-24 02:07 82阅读 0赞

> 本文主要介绍使用go语言编写单元测试用例，首先介绍如何编写单元测试，然后介绍基本命令的使用，最后给出demo示例

#### 文章目录 ####

*  前言
 *  命令
 *  示例

## 前言 ##

在go语言中编写单元测试时，使用说明

1.  **测试文件命名**：在 Go 语言中，测试文件的命名应与被测试的源代码文件相同，但以 “\_test” 结尾。例如，如果你的源代码文件名为 example.go，则测试文件名应为 example\_test.go。
2.  **导入 testing 包**：在测试文件的开头，导入 testing 包，这是 Go 语言内置的用于编写单元测试的包。
3.  **编写测试函数**：测试函数的命名应以 “Test” 开头，后面跟着被测试的函数名，并接收一个参数 t \*testing.T。例如，如果要测试名为 Add 的函数，测试函数名应为 TestAdd(t \*testing.T)。
4.  **使用 t.Error 或 t.Errorf 进行断言**：在测试函数中，你可以使用 t.Error 或 t.Errorf 方法来判断测试是否通过。如果断言条件为假，则测试失败。例如，t.Error(“错误信息”) 表示测试失败并输出错误信息，而 t.Errorf(“格式化错误信息”, 参数列表…) 允许你使用类似 fmt.Printf 的格式化字符串。
5.  **运行测试命令**：在项目的根目录下，使用 go test 命令来执行单元测试。Go 语言会自动找到并运行所有的测试文件。你还可以使用 -v 参数来获取更详细的输出。
6.  **测试覆盖率报告**：你可以使用 -cover 参数来生成测试覆盖率报告。例如，go test -cover 将显示每个被测试的函数的覆盖率百分比。
7.  **子测试**：你可以在单个测试函数中定义多个子测试，以便更好地组织和管理测试代码。使用 t.Run 方法来运行子测试。

## 命令 ##

测试用例文件使用go test指令来执行，**不需要 main() 作为函数入口**

Go 语言的测试工具提供了许多命令和选项来帮助你编写和运行测试。以下是一些常见的 go test 命令和选项：

*  **go test:** 在项目的根目录下，使用此命令来运行所有的测试文件并输出测试结果。
 *  **go test :** 运行特定包中的所有测试文件，并输出测试结果。例如，go test calc 将运行 calc 包中的所有测试文件。
 *  **go test -v:** 输出更详细的测试结果信息，包括测试名称、测试运行时间、测试覆盖率等。
 *  **go test -run :** 仅运行名称匹配给定模式的测试函数。例如，go test -run TestAdd 将仅运行名称为 TestAdd 的测试函数。
 *  **go test -cover:** 生成测试覆盖率报告，显示每个被测试的函数的覆盖率百分比。
 *  **go test -coverprofile :** 生成覆盖率文件，并将其写入指定文件。例如，go test -coverprofile cover.out 将生成一个名为 cover.out 的文件，其中包含测试覆盖率数据。
 *  **go tool cover -html :** 使用 HTML 格式显示覆盖率报告。例如，go tool cover -html=cover.out 将使用浏览器显示 cover.out 文件的测试覆盖率报告。

## 示例 ##

package test
    
    import "testing"
    
    func Add(a, b int) int {
        
    	return a + b
    }
    
    func TestAdd(t *testing.T) {
        
    	result := Add(4, 5)
    	if result != 9 {
        
    		t.Errorf("Add(4,5)=%d fail\n", result)
    	}
    }

点击红圈地方，可以直接运行单元测试用例  
![在这里插入图片描述][42bff80f24984bfb9b486d80ba64dc49.png]  
控制台输出结果：  
![在这里插入图片描述][ee547766877e4abf8fd87ba98baa8987.png]

命令行运行：

*  go test  
    ![在这里插入图片描述][000d80f998ca42babc34dd7ccc6b7878.png]  
    go test -v  
    ![在这里插入图片描述][334811279d0546a3a33f3d7612e872ac.png]

[42bff80f24984bfb9b486d80ba64dc49.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/2681d6e84f5a491cbd2ac2c1c8280cc7.png
[ee547766877e4abf8fd87ba98baa8987.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/f7c501be56a744ff88eac66365c60e05.png
[000d80f998ca42babc34dd7ccc6b7878.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/6eae98f0a6c943b4887c219d5fe005c8.png
[334811279d0546a3a33f3d7612e872ac.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/24/1dd0a6ec927c4b83a1a1c92474015229.png