golang终端测试覆盖率可视化工具插件go-carpet的使用

go-carpet - 显示Go源文件的测试覆盖率

go-carpet是一个在终端显示Go代码测试覆盖率的工具。

主要特性

• 直接在终端查看测试覆盖率
• 可以在GOPATH目录外工作
• 支持递归处理多个包
• 使用-256colors选项时，会用不同深浅的绿色表示覆盖率等级
• 默认跳过vendor目录(Godeps,vendor)，也可使用-include-vendor选项包含
• 使用-mincov选项可以设置显示文件的覆盖率阈值

使用方法

usage: go-carpet [options] [paths]
  -256colors
    	use more colors on 256-color terminal (indicate the level of coverage)
  -args string
    	pass additional arguments for go test
  -file string
    	comma-separated list of files to test (default: all)
  -func string
    	comma-separated functions list (default: all functions)
  -include-vendor
    	include vendor directories for show coverage (Godeps, vendor)
  -mincov float
    	coverage threshold of the file to be displayed (in percent) (default 100)
  -summary
    	only show summary for each file
  -version
    	get version

要在less中查看覆盖率，使用-R选项：

go-carpet | less -R

安装方法

从源码安装：

go install github.com/msoap/go-carpet@latest

从Homebrew安装(OS X)：

brew tap msoap/tools
brew install go-carpet
# 更新：
brew upgrade go-carpet

示例截图

完整示例

下面是一个完整的示例，展示如何使用go-carpet查看测试覆盖率：

1. 首先创建一个简单的Go项目：

// main.go
package main

import "fmt"

func main() {
    fmt.Println(greet("World"))
}

func greet(name string) string {
    return "Hello, " + name
}

1. 创建测试文件：

// main_test.go
package main

import "testing"

func TestGreet(t *testing.T) {
    tests := []struct {
        name string
        want string
    }{
        {"World", "Hello, World"},
        {"Gopher", "Hello, Gopher"},
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            if got := greet(tt.name); got != tt.want {
                t.Errorf("greet() = %v, want %v", got, tt.want)
            }
        })
    }
}

1. 运行go-carpet查看覆盖率：

go-carpet -256colors .

输出会显示代码的测试覆盖率情况，不同深浅的绿色表示不同的覆盖率等级。

1. 如果只想查看覆盖率低于100%的文件：

go-carpet -mincov 99 .

1. 如果只想查看特定文件的覆盖率：

go-carpet -file main.go

1. 如果只想查看特定函数的覆盖率：

go-carpet -func greet