vscode: 配置golang单元测试

554 阅读3分钟

参考网址

developer.aliyun.com/article/868…

简介

说到代码的健壮性,单元测试是少不了的,基本上所有语言都有自己的单元测试方案。
工作这么多年,单元测试也没少写,像 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`后缀。

结构示例图如下:

图片.png

三、单元测试方法(函数)命名规范

单元测试一般都是针对单个方法(函数)进行单元测试的,而不是针对整个文件。
所以,一般单元测试方法(函数)的命名也有一定的规则。
如果我们测试的方法(函数)的名字是 `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,
        },
    }
    
    // 上面准备了2个测试用例
    // 下面通过for循环的方式来进行单元测试
    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<--------------")
}

四、执行单元测试

单元测试方法写完之后,怎么运行呢?也非常简单。
命令:
  > go test -v

结果如下所示

图片.png

vscode为开发者,提供了4种单元测试的方法:
<1>run package tests
  运行整个包中的测试,
  等价于执行go test -cover,请谨慎使用

<2>run file tests
   运行某个具体的文件的测试方法,
   等价于执行go test *_test.go,请谨慎使用

<3>run test
   只运行单个测试方法(函数),
   等价于执行go test -v main_test.go --test.run 测试方法名称

<4>debug test
   只调试单个测试方法(函数),
   这个博主还真没找到等价命令,主要是只调试这个方法,然后就可以终止,不知道是什么奇技淫巧,到底是dlv还是dlv-dap的功劳,还是微软注入了新的能力,有知道的同学可以留言。

五、结尾

好了,今天关于在 VSCode 中进行 Golang 单元测试的方法就介绍完了,感兴趣的小伙伴自己搞起来!
晚安啦!