如何忽略Go测试覆盖范围中生成的文件 [英] How to ignore generated files from Go test coverage

问题描述

我的包中有一个生成的文件，上面有请勿编辑。我正在使用为包运行测试-test -coverprofile = cover.out< package> 。这将创建覆盖率配置文件并显示总覆盖率百分比。但是在计算覆盖率时，它还包括生成的文件。有没有办法在覆盖率计算中忽略生成的文件？

I have a generated file in my package with DO NOT EDIT on top. I am running tests for my package with go test -coverprofile=cover.out <package>. This creates coverage profile and shows total coverage percentage. But it also includes generated files while calculating the coverage. Is there a way to ignore generated files in coverage calculation?

推荐答案

大多数Go工具都对程序包进行操作，因为程序包本身形成了一个 unit 可能完全有用。从软件包中排除文件很容易破坏软件包：被排除的文件可能包含（关键的）软件包初始化代码，甚至可能导致其余的软件包文件无法编译。

Most Go tools operate on packages, because a package itself forms a unit that may be useful in its entirety. Excluding files from a package could easily "break" the package: the excluded file may contain (crucial) package initialization code or may even cause the remaining package files fail to compile.

进行测试也不例外：它也可以在软件包上运行。没有从包中排除文件的第一手支持。

go test is no exception: it also operates on packages. There is no first-hand support to exclude files from a package.

如果可以在不生成文件的情况下编译和测试您的包，则可以选择将文件生成为

If your package may be compiled and tested without the generated file, you may opt to generate the file into a different package, and then it won't be included in your package's (coverage) test naturally.

处理此问题的另一种方法是仍然以相同的方式生成它包/文件夹，并在生成的文件中使用特殊的构建标记，在运行覆盖率测试时可以将其排除在外。您可以在以下位置阅读有关构建标记的更多信息：构建约束，并在此处：< a href = https://stackoverflow.com/questions/35428963/what-is-the-right-approach-to-encapsulate-platform-specific-code-in-go/35429081#35429081>什么是正确的方法在Go中封装平台特定的代码？

Another way to handle this would be to still generate it in the same package / folder, and use special build tags in the generated files, which you may exclude when running the coverage test. You can read more about build tags here: Build Constraints, and here: What is the right approach to encapsulate platform specific code in Go?

如果需要生成的文件来编译/测试程序包，那么您仍然可以选择：使用内部包，用于生成的文件。内部软件包仅可用于以 internal 文件夹为根的软件包树，这意味着您可以导出内部软件包中的任何标识符，编译器确保不会被内部用户使用。 意外各方。您可以在此处阅读有关内部软件包的更多信息：我可以在多个源目录中开发go软件包吗？

If the generated file is needed to compile / test the package, then you still have an option: use an internal package for the generated file. Internal packages are only available to the package tree rooted at the internal folder, which means you may export any identifiers in an internal package, the compiler ensures they won't be used by "unintended" parties. You can read more about internal packages here: Can I develop a go package in multiple source directories?

也可以考虑为生成的代码编写或生成测试的选项，这可能是一个好习惯无论如何，因此您不必使用技巧就可以将它们从覆盖率测试中排除。

Also consider the option to write or generate test for the generated code, which may be good practice anyway, so you wouldn't have to use tricks to exclude them from coverage tests.

这篇关于如何忽略Go测试覆盖范围中生成的文件的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！