如何忽略Go测试覆盖中生成的文件

Question

我的包中有一个生成的文件DO NOT EDIT.我正在为我的包运行测试go test -coverprofile=cover.out <package>.这将创建覆盖率配置文件并显示总覆盖百分比 但它还包括在计算覆盖范围时生成的文件.有没有办法忽略覆盖率计算中生成的文件？

Answer 1

您可以从封面配置文件中删除生成的代码:

go test . -coverprofile cover.out.tmp
cat cover.out.tmp | grep -v "_generated.go" > cover.out
tool cover -func cover.out

根据使用的工具,这可以在管道/制造中轻松实现.

Answer 2

按照我可以解决这个需求的方法。

通过排除目录/包

由于要运行测试并生成封面，您将指定 go test 命令应该从该 pkg 中查找文件的 pkgs 将被自动忽略。下面是一个例子

project
|_______/pkg/web/app 
|_______/pkg/web/mock -> It will be ignored.

# Command:   
$go test -failfast -tags=integration -coverprofile=coverage.out -covermode=count github.com/aerogear/mobile-security-service/pkg/web/apps

但是，它不能适用于所有情况。例如，在文件是接口的模拟例程的情况下，它可能无法很好地工作，因为服务、测试和模拟所需的导入可能会处于循环中，而在这种情况下是不允许的。

通过在名称定义中使用“_test”

如果您想忽略测试中使用的文件，那么_test在名称末尾使用是有意义的。例如，my_service_mock_test.go。_test默认情况下，名称末尾带有的文件将被忽略。

通过从封面文件中删除如下

go test . -coverprofile cover.out.tmp
cat cover.out.tmp | grep -v "_generated.go" > cover.out
tool cover -func cover.out

PS.：我找不到可以排除它们的评论或标签。

Answer 3

您可以从测试中提取出这些目录。

所以，而不是：

go test ./...

你做这个：

go test `go list ./... | grep -v ./excluded/autogen/directory/here`

另外，请确保不要添加尾随/. 它不能完美地工作。

Answer 4

大多数Go工具都在包上运行,因为包本身形成了一个整体可能有用的单元.从包中排除文件可能很容易"破坏"包:排除的文件可能包含(关键)包初始化代码,甚至可能导致其余的包文件无法编译.

go test也不例外:它也适用于包装.没有第一手支持从包中排除文件.

如果您的软件包可能在没有生成文件的情况下进行编译和测试,您可以选择将文件生成到另一个软件包中,然后它将不会自然地包含在软件包的(coverage)测试中.

处理此问题的另一种方法是仍然在同一个包/文件夹中生成它,并在生成的文件中使用特殊的构建标记,您可以在运行coverage测试时将其排除.您可以在此处阅读有关构建标记的更多信息:构建约束,此处:在Go中封装特定于平台的代码的正确方法是什么？

如果编译/测试包需要生成的文件,那么您仍然有一个选项:对生成的文件使用内部包.内部包仅适用于以该internal文件夹为根的包树,这意味着您可以在内部包中导出任何标识符,编译器确保它们不会被"非预期"方使用.您可以在此处阅读有关内部包的更多信息:我可以在多个源目录中开发一个go包吗？

还要考虑为生成的代码编写或生成测试的选项,这可能是一种好的做法,因此您不必使用技巧将它们从覆盖测试中排除.