Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vladopajic/go-test-coverage
go-test-coverage is tool and github action which reports issues when test coverage is below set threshold
https://github.com/vladopajic/go-test-coverage
ci cicd code-coverage coverage github-actions go golang test-coverage testing
Last synced: 8 days ago
JSON representation
go-test-coverage is tool and github action which reports issues when test coverage is below set threshold
- Host: GitHub
- URL: https://github.com/vladopajic/go-test-coverage
- Owner: vladopajic
- License: gpl-3.0
- Created: 2023-03-25T18:48:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-07T09:26:28.000Z (about 1 month ago)
- Last Synced: 2024-10-15T19:09:52.760Z (23 days ago)
- Topics: ci, cicd, code-coverage, coverage, github-actions, go, golang, test-coverage, testing
- Language: Go
- Homepage:
- Size: 316 KB
- Stars: 84
- Watchers: 2
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - go-test-coverage - Tool and GitHub action which reports issues when test coverage is below set threshold. (Continuous Integration / Standard CLI)
- fucking-awesome-go - go-test-coverage - Tool and GitHub action which reports issues when test coverage is below set threshold. (Continuous Integration / Standard CLI)
- awesome-go - go-test-coverage - Tool and GitHub action which reports issues when test coverage is below set threshold. (Continuous Integration / Standard CLI)
- awesome-go-with-stars - go-test-coverage - Tool and GitHub action which reports issues when test coverage is below set threshold. (Continuous Integration / Standard CLI)
- awesome-go-plus - go-test-coverage - Tool and GitHub action which reports issues when test coverage is below set threshold. (Continuous Integration / Standard CLI)
README
# go-test-coverage
[](https://github.com/vladopajic/go-test-coverage/actions/workflows/test.yml)
[](https://github.com/vladopajic/go-test-coverage/actions/workflows/action-test.yml)
[](https://github.com/vladopajic/go-test-coverage/actions/workflows/lint.yml)
[](/.github/.testcoverage.yml)
[](https://goreportcard.com/report/github.com/vladopajic/go-test-coverage)
[](https://github.com/vladopajic/go-test-coverage/releases/latest)
`go-test-coverage` is a tool designed to report issues when test coverage falls below a specified threshold, ensuring higher code quality and preventing regressions in test coverage over time.
## Why Use go-test-coverage?
Here are the key features and benefits:
- **Quick Setup**: Install and configure in just 5 minutes.
- **Serverless Operation**: No need for external servers, registration, or permissions.
- Eliminates connectivity or server-related failures.
- **Data Privacy**: All coverage checks are done locally, so no sensitive information leaks to third parties.
- Learn more about [information leakage risks](https://gist.github.com/vladopajic/0b835b28bcfe4a5a22bb0ae20e365266).
- **Performance**: Lightning-fast execution (e.g., ~1 second on [this repo](https://github.com/vladopajic/go-test-coverage/actions/runs/8401578681/job/23010110385)).
- **Versatility**: Can be used both locally and in CI pipelines.
- **Customizable**: Extensive configuration options to fit any project's needs.
- **Stylish Badges**: Generate beautiful coverage badges for your repository.
- **Open Source**: Free to use and contribute to!
## Usage
You can use `go-test-coverage` in two ways:
- Locally as part of your development process.
- As a step in your GitHub Workflow.
It’s recommended to utilize both options for Go projects.
### Local Usage
Here’s an example `Makefile` with a `check-coverage` command that runs `go-test-coverage` locally:
```makefile
GOBIN ?= $$(go env GOPATH)/bin
.PHONY: install-go-test-coverage
install-go-test-coverage:
go install github.com/vladopajic/go-test-coverage/v2@latest
.PHONY: check-coverage
check-coverage: install-go-test-coverage
go test ./... -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
${GOBIN}/go-test-coverage --config=./.testcoverage.yml
```
### GitHub Workflow
Here’s an example of how to integrate `go-test-coverage` into a GitHub Actions workflow:
```yml
name: Go test coverage check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v3
- name: generate test coverage
run: go test ./... -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
- name: check test coverage
uses: vladopajic/go-test-coverage@v2
with:
# Configure action using config file (option 1)
config: ./.testcoverage.yml
# Configure action by specifying input parameters individually (option 2).
# If you are using config file (option 1) you shouldn't use these parameters, however
# specifing these action parameters will override appropriate config values.
profile: cover.out
local-prefix: github.com/org/project
threshold-file: 80
threshold-package: 80
threshold-total: 95
```
### Configuration
Here’s an example [.testcoverage.yml](./.testcoverage.example.yml) configuration file:
```yml
# (mandatory)
# Path to coverprofile file (output of `go test -coverprofile` command).
#
# For cases where there are many coverage profiles, such as when running
# unit tests and integration tests separately, you can combine all those
# profiles into one. In this case, the profile should have a comma-separated list
# of profile files, e.g., 'cover_unit.out,cover_integration.out'.
profile: cover.out
# (optional; but recommended to set)
# When specified reported file paths will not contain local prefix in the output
local-prefix: "github.com/org/project"
# Holds coverage thresholds percentages, values should be in range [0-100]
threshold:
# (optional; default 0)
# The minimum coverage that each file should have
file: 70
# (optional; default 0)
# The minimum coverage that each package should have
package: 80
# (optional; default 0)
# The minimum total coverage project should have
total: 95
# Holds regexp rules which will override thresholds for matched files or packages
# using their paths.
#
# First rule from this list that matches file or package is going to apply
# new threshold to it. If project has multiple rules that match same path,
# override rules should be listed in order from specific to more general rules.
override:
# Increase coverage threshold to 100% for `foo` package
# (default is 80, as configured above in this example)
- threshold: 100
path: ^pkg/lib/foo$
# Holds regexp rules which will exclude matched files or packages
# from coverage statistics
exclude:
# Exclude files or packages matching their paths
paths:
- \.pb\.go$ # excludes all protobuf generated files
- ^pkg/bar # exclude package `pkg/bar`
# NOTES:
# - symbol `/` in all path regexps will be replaced by current OS file path separator
# to properly work on Windows
```
### Exclude Code from Coverage
For cases where there is a code block that does not need to be tested, it can be ignored from coverage statistics by adding the comment `// coverage-ignore` at the start line of the statement body (right after `{`).
```go
...
result, err := foo()
if err != nil { // coverage-ignore
return err
}
...
```
Similarly, the entire function can be excluded from coverage statistics when a comment is found at the start line of the function body (right after `{`).
```go
func bar() { // coverage-ignore
...
}
```
## Generate Coverage Badge
You can easily generate a stylish coverage badge for your repository and embed it in your markdown files. Here’s an example badge: (eg. ).
Instructions for badge creation are available [here](./docs/badge.md).
## Visualise Coverage
Go includes a built-in tool for visualizing coverage profiles, allowing you to see which parts of the code are not covered by tests. To generate a visual report:
Following command will generate `cover.html` page with visualized coverage profile:
```console
go tool cover -html=cover.out -o=cover.html
```
## Support the Project
`go-test-coverage` is freely available for all users. If your organization benefits from this tool, especially if you’ve transitioned from a paid coverage service, consider [sponsoring the project](https://github.com/sponsors/vladopajic).
Your sponsorship will help sustain development, introduce new features, and maintain high-quality support. Every contribution directly impacts the future growth and stability of this project.
## Contribution
We welcome all contributions—whether it's fixing a typo, adding new features, or pointing out an issue. Feel free to open a pull request or issue to contribute!