Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johejo/go-cover-view
Simple Go coverage report viewer
https://github.com/johejo/go-cover-view
coverage go golang
Last synced: 9 days ago
JSON representation
Simple Go coverage report viewer
- Host: GitHub
- URL: https://github.com/johejo/go-cover-view
- Owner: johejo
- License: mit
- Created: 2020-06-04T16:33:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-22T16:22:58.000Z (16 days ago)
- Last Synced: 2024-12-22T17:24:14.008Z (16 days ago)
- Topics: coverage, go, golang
- Language: Go
- Size: 38.1 KB
- Stars: 3
- Watchers: 2
- Forks: 6
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-cover-view
[](https://github.com/johejo/go-cover-view/actions?query=workflow%3Aci)
[](https://codecov.io/gh/johejo/go-cover-view)
[](https://goreportcard.com/report/github.com/johejo/go-cover-view)
simple go coverage report viewer
## Install
```
go get github.com/johejo/go-cover-view
go install github.com/johejo/go-cover-view
```
## Get Started
Create a new go module.
```sh
mkdir -p example
cd example/
go mod init example.com/example
```
Create a Go file.
example.go
```go
package example
func example() bool {
println("covered")
if false {
println("not covered")
}
return true
}
```
Create a Go test file.
example_test.go
```go
package example
import "testing"
func Test_example(t *testing.T) {
example()
}
```
Run test and generate coverage report.
```sh
go test . -cover -coverprofile coverage.txt
```
view coverage report.
```sh
go-cover-view
```
```
example.com/example/example.go
1: package example
2:
O 3: func example() bool {
O 4: println("covered")
X 5: if false {
X 6: println("not covered")
X 7: }
O 8: return true
9: }
```
json output
```sh
go-cover-view -output json
```
```json
[
{
"fileName": "example.com/example/example.go",
"coveredLines": [3, 4, 8],
"uncoveredLines": [5, 6, 7]
}
]
```
markdown output
```sh
go-cover-view -output markdown
```
```markdown
# Coverage Report
example.com/example/example.go
\```
1: package example
2:
O 3: func example() bool {
O 4: println("covered")
X 5: if false {
X 6: println("not covered")
X 7: }
O 8: return true
9: }
\```
```
## GitHub Actions Integration
Pull Request comment with markdown report
GitHub Actions workflow example
```yaml
name: ci
on:
pull_request:
branches:
- master
jobs:
test:
strategy:
matrix:
os: [ubuntu-latest]
go: ["1.14"]
runs-on: ${{ matrix.os }}
timeout-minutes: 10
steps:
- uses: actions/checkout@v2
- uses: actions/setup-go@v2
with:
go-version: ${{ matrix.go }}
- name: "test"
run: |
go test -cover -coverprofile coverage.txt -race -v ./...
- name: "pull request comment"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git fetch origin master
go get github.com/johejo/go-cover-view
go install github.com/johejo/go-cover-view
go-cover-view -ci github-actions -git-diff-base origin/master
```
## Help
```
Usage of go-cover-view:
-ci string
ci type: available values "", "github-actions"
github-actions:
Comment the markdown report to Pull Request on GitHub.
-covered string
prefix for covered line (default "O")
-git-diff-base string
git diff base (default "origin/master")
-git-diff-only
only files with git diff
-modfile string
go.mod path
-output string
output type: available values "simple", "json", "markdown" (default "simple")
-report string
coverage report path (default "coverage.txt")
-uncovered string
prefix for uncovered line (default "X")
```
## License
MIT
## Author
Mitsuo Heijo (@johejo)