VSCode配置Golang单元测试实例

目录

• 前言
• 正文
• 单元测试规范
   一、导入testing工具包
   二、单元测试文件命名规范
   三、单元测试方法命名规范
   四、执行单元测试
• 结尾

前言

说到代码的健壮性，单元测试是少不了的，基本上所有语言都有自己的单元测试方案。工作这么多年，单元测试也没少写，像 Java、C++、Golang 都有过恶补单元测试的经历，为的就是应付各种 KPI，但是也不能说单元测试没有用，只是原始动力不是为了单元测试而单元测试，而是为了应付检查而单元测试。今天呢，就来说一说 Golang 语言的单元测试（这次真的是我自己主动要加的^_^)。

正文

Golang 单元测试的工具包有很多，在 VSCode 插件超市里可以找到很多。今天我们主要介绍 Golang 内置的单元测试工具包—— testing。说实在的，用熟了之后，发现还是挺好用的。

单元测试规范

一、导入testing工具包

testing 是 Golang 内置的单元测试工具包，导入的时候非常方便，不需要引用 github 仓库地址的包。

实例代码：

package utils

import "testing"

二、单元测试文件命名规范

一般我们编写单元测试时，都会和原文件组合出现，以_test.go结尾。比如，原文件是xxx.go，那么它对应的单元测试文件就是 xxx_test.go。这是一种约定，所以我们在定义文件名时，不要轻易使用_test.go后缀。

结构示例图如下：

三、单元测试方法命名规范

单元测试一般都是针对单个方法进行单元测试的，所以，一般单元测试方法的命名也有一定的规则。如果我们测试的方法的名字是 aaa()，那么，单元测试方法的名字就是 Testaaa(t *Testing.T)。当然，单元测试方法可以自己手动写，也可以右键 VSCode 自动生成。

比如，我想测试一个压缩方法，单元测试方法实例代码：

func TestZipFiles(t *testing.T) {
	type args struct {
		filename string
		files    []string
		oldForm  string
		newForm  string
	}

	good := args{
		filename: "../example/resources/test.zip",
		files:    []string{"../example/resources/test.txt"},
		oldForm:  "",
		newForm:  "",
	}
	bad := args{
		filename: "../example/resources/test.zip",
		files:    []string{"../example/resources/test.pdf"},
		oldForm:  "",
		newForm:  "",
	}

	tests := []struct {
		name    string
		args    args
		wantErr bool
	}{
		{
			name:    "good",
			args:    good,
			wantErr: false,
		},
		{
			name:    "bad",
			args:    bad,
			wantErr: true,
		},
	}
	t.Errorf("------------>begin")
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			if err := ZipFiles(tt.args.filename, tt.args.files, tt.args.oldForm, tt.args.newForm); (err != nil) != tt.wantErr {
				t.Errorf("ZipFiles() error = %v, wantErr %v", err, tt.wantErr)
			}
		})
	}
	t.Errorf("end<--------------")
}

在单元测试方法中，我们可以列出多个 case ，上面的例子中就包括一个可执行测试用例和一个不可执行测试用例。

四、执行单元测试

单元测试方法写完之后，怎么运行呢？也非常简单。

命令：

go test -v

结果实例：

结尾

好了，今天关于在 VSCode 中进行 Golang 单元测试的方法就介绍完了，感兴趣的小伙伴自己搞起来！晚安啦！我是 liuzhen007，欢迎关注，分享更多 Golang 知识。