How Can I Exclude Generated Files from Go Test Coverage Calculations?

Ignoring Generated Files in Go Test Coverage

When testing Go packages that include generated files with "DO NOT EDIT" remarks, it is undesirable to have these files influence the test coverage calculation. Here's how to remedy this:

Using the standard go test command with the -coverprofile flag, the test coverage is typically calculated across all files in the package, including generated ones. To exclude generated files from the coverage report:

1. Generate coverage profile: Run go test . -coverprofile cover.out.tmp. This generates a temporary coverage profile file cover.out.tmp.
2. Filter generated files: Use a command like cat cover.out.tmp | grep -v "_generated.go" > cover.out to create a new profile cover.out that excludes files ending with "_generated.go."
3. Analyze coverage: Execute tool cover -func cover.out to generate a coverage report that excludes the generated files.
4. (Optional) Automate process: Implement this process within your pipeline or makefile for seamless integration.

By following these steps, you can efficiently calculate coverage for your Go packages, excluding generated files as desired.

The above is the detailed content of How Can I Exclude Generated Files from Go Test Coverage Calculations?. For more information, please follow other related articles on the PHP Chinese website!