Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LawrenceWoodman/roveralls
A Go recursive coverage testing tool
https://github.com/LawrenceWoodman/roveralls
Last synced: about 2 months ago
JSON representation
A Go recursive coverage testing tool
- Host: GitHub
- URL: https://github.com/LawrenceWoodman/roveralls
- Owner: lawrencewoodman
- License: mit
- Created: 2016-06-26T07:45:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-19T19:39:13.000Z (almost 7 years ago)
- Last Synced: 2024-06-20T19:21:42.663Z (3 months ago)
- Language: Go
- Size: 22.5 KB
- Stars: 20
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-go - roveralls - Recursive coverage testing tool. (Continuous Integration / Standard CLI)
- awesome-go - roveralls - Recursive coverage testing tool. (Continuous Integration / Standard CLI)
- awesome-go - roveralls - A Go recursive coverage testing tool - ★ 10 (Continuous Integration)
README
roveralls
=========
A Go recursive coverage testing tool.
[](https://godoc.org/github.com/lawrencewoodman/roveralls)
[](https://travis-ci.org/lawrencewoodman/roveralls)
[](https://ci.appveyor.com/project/lawrencewoodman/roveralls)
[](https://coveralls.io/r/lawrencewoodman/roveralls?branch=master)
[](https://goreportcard.com/report/github.com/lawrencewoodman/roveralls)
roveralls runs coverage tests on a package and all its sub-packages. The coverage profile is output as a single file called 'roveralls.coverprofile' for use by tools such as goveralls.
This tool was inspired by [github.com/go-playground/overalls](https://github.com/go-playground/overalls) written by Dean Karn, but I found it difficult to test and brittle so I decided to rewrite it from scratch. Thanks for the inspiration Dean.
Usage
-----
At its simplest, to test the current package and sub-packages and create a `roveralls.coverprofile` file in the directory that you run the command:
$ roveralls
To see the help for the command:
$ roveralls -help
roveralls runs coverage tests on a package and all its sub-packages. The
coverage profile is output as a single file called 'roveralls.coverprofile'
for use by tools such as goveralls.
Usage of roveralls:
-covermode count,set,atomic
Mode to run when testing files: count,set,atomic (default "count")
-help
Display this help
-ignore dir1,dir2,...
Comma separated list of directory names to ignore: dir1,dir2,... (default ".git,vendor")
-short
Tell long-running tests to shorten their run time
-v Verbose output
View Output in a Web Browser
----------------------------
To view the code coverage for you packge in a browser:
$ go tool cover -html=roveralls.coverprofile
Use with goveralls
------------------
The output of `roveralls` is the same as the the standard `go test -coverprofile=profile.coverprofile` but with multiple files tested in the output file. This can therefore be used with tools such as `goveralls`.
If you wanted to call it from a `.travis.yml` script you could use:
- $HOME/gopath/bin/roveralls
- $HOME/gopath/bin/goveralls -coverprofile=roveralls.coverprofile -service=travis-ci
Contributing
------------
If you want to improve this program make a pull request to the [repo](https://github.com/lawrencewoodman/roveralls) on github. Please put any pull requests in a separate branch to ease integration and add a test to prove that it works. If you find a bug, please report it at the project's [issues tracker](https://github.com/lawrencewoodman/roveralls/issues) also on github.
Licence
-------
Copyright (C) 2016, Lawrence Woodman
This software is licensed under an MIT Licence. Please see the file, LICENCE.md, for details.