goveralls
Go integration for Coveralls.io continuous code coverage tracking system.
Installation
goveralls requires a working Go installation (Go-1.2 or higher).
$ go get github.com/mattn/goveralls
Usage
First you will need an API token. It is found at the bottom of your repository's page when you are logged in to Coveralls.io. Each repo has its own token.
$ cd $GOPATH/src/github.com/yourusername/yourpackage
$ goveralls -repotoken your_repos_coveralls_token
You can set the environment variable $COVERALLS_TOKEN to your token so you do not have to specify it at each invocation.
You can also run this reporter for multiple passes with the flag -parallel or by setting the environment variable COVERALLS_PARALLEL=true (see coveralls docs for more details).
Continuous Integration
There is no need to run go test separately, as goveralls runs the entire test suite.
Github Actions
shogo82148/actions-goveralls is available on GitHub Marketplace. It provides the shorthand of the GitHub Actions YAML configure.
name: Quality
on: [push, pull_request]
jobs:
test:
name: Test with Coverage
runs-on: ubuntu-latest
steps:
- name: Set up Go
uses: actions/setup-go@v1
with:
go-version: '1.13'
- name: Check out code
uses: actions/checkout@v2
- name: Install dependencies
run: |
go mod download
- name: Run Unit tests
run: |
go test -race -covermode atomic -coverprofile=covprofile ./...
- name: Install goveralls
env:
GO111MODULE: off
run: go get github.com/mattn/goveralls
- name: Send coverage
env:
COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: goveralls -coverprofile=covprofile -service=github
# or use shogo82148/actions-goveralls
# - name: Send coverage
# uses: shogo82148/actions-goveralls@v1
# with:
# path-to-profile: covprofile
Test with Legacy GOPATH mode
If you want to use Go 1.10 or earlier, you have to set GOPATH environment value and the working directory. See https://github.com/golang/go/wiki/GOPATH for more detail.
Here is an example for testing example.com/owner/repo package.
name: Quality
on: [push, pull_request]
jobs:
test:
name: Test with Coverage
runs-on: ubuntu-latest
steps:
- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: '1.10'
# add this step
- name: Set up GOPATH
run: |
echo "GOPATH=${{ github.workspace }}" >> "$GITHUB_ENV"
echo "${{ github.workspace }}/bin" >> "$GITHUB_PATH"
- name: Check out code
uses: actions/checkout@v2
with:
path: src/example.com/owner/repo # add this
- name: Run Unit tests
run: |
go test -race -covermode atomic -coverprofile=covprofile ./...
working-directory: src/example.com/owner/repo # add this
- name: Install goveralls
env:
GO111MODULE: off
run: go get github.com/mattn/goveralls
- name: Send coverage
env:
COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: goveralls -coverprofile=covprofile -service=github
working-directory: src/example.com/owner/repo # add this
Travis CI
GitHub Integration
Enable Travis-CI on your github repository settings.
For a public github repository put bellow's .travis.yml.
language: go
go:
- tip
before_install:
- go get github.com/mattn/goveralls
script:
- $GOPATH/bin/goveralls -service=travis-ci
For a public github repository, it is not necessary to define your repository key (COVERALLS_TOKEN).
For a private github repository put bellow's .travis.yml. If you use travis pro, you need to specify -service=travis-pro instead of -service=travis-ci.
language: go
go:
- tip
before_install:
- go get github.com/mattn/goveralls
script:
- $GOPATH/bin/goveralls -service=travis-pro
Store your Coveralls API token in Environment variables.
COVERALLS_TOKEN = your_token_goes_here
or you can store token using travis encryption keys. Note that this is the token provided in the page for that specific repository on Coveralls. This is not one that was created from the "Personal API Tokens" area under your Coveralls account settings.
$ gem install travis
$ travis encrypt COVERALLS_TOKEN=your_token_goes_here --add env.global
travis will add env block as following example:
env:
global:
secure: xxxxxxxxxxxxx
For others:
$ go get github.com/mattn/goveralls
$ go test -covermode=count -coverprofile=profile.cov
$ goveralls -coverprofile=profile.cov -service=travis-ci
Drone.io
Store your Coveralls API token in Environment Variables:
COVERALLS_TOKEN=your_token_goes_here
Replace the go test line in your Commands with these lines:
$ go get github.com/mattn/goveralls
$ goveralls -service drone.io
goveralls automatically use the environment variable COVERALLS_TOKEN as the default value for -repotoken.
You can use the -v flag to see verbose output from the test suite:
$ goveralls -v -service drone.io
CircleCI
Store your Coveralls API token as an Environment Variable.
In your circle.yml add the following commands under the test section.
test:
pre:
- go get github.com/mattn/goveralls
override:
- go test -v -cover -race -coverprofile=/home/ubuntu/coverage.out
post:
- /home/ubuntu/.go_workspace/bin/goveralls -coverprofile=/home/ubuntu/coverage.out -service=circle-ci -repotoken=$COVERALLS_TOKEN
For more information, See https://coveralls.zendesk.com/hc/en-us/articles/201342809-Go
Semaphore
Store your Coveralls API token in Environment Variables:
COVERALLS_TOKEN=your_token_goes_here
More instructions on how to do this can be found in the Semaphore documentation.
Replace the go test line in your Commands with these lines:
$ go get github.com/mattn/goveralls
$ goveralls -service semaphore
goveralls automatically use the environment variable COVERALLS_TOKEN as the default value for -repotoken.
You can use the -v flag to see verbose output from the test suite:
$ goveralls -v -service semaphore
Jenkins CI
Add your Coveralls API token as a credential in Jenkins (see Jenkins documentation).
Then declare it as the environment variable COVERALLS_TOKEN:
pipeline {
agent any
stages {
stage('Test with coverage') {
steps {
sh 'go test ./... -coverprofile=coverage.txt -covermode=atomic'
}
}
stage('Upload to coveralls.io') {
environment {
COVERALLS_TOKEN = credentials('coveralls-token')
}
steps {
sh 'goveralls -coverprofile=coverage.txt'
}
}
}
}
See also related Jenkins documentation.
It is also possible to let goveralls run the code coverage on its own without providing a coverage profile file.
TeamCity
Store your Coveralls API token in Environment Variables:
COVERALLS_TOKEN=your_token_goes_here
Setup build steps:
$ go get github.com/mattn/goveralls
$ export PULL_REQUEST_NUMBER=%teamcity.build.branch%
$ goveralls -service teamcity -jobid %teamcity.build.id% -jobnumber %build.number%
goveralls will automatically use the environment variable COVERALLS_TOKEN as the default value for -repotoken.
You can use the -v flag to see verbose output.
Gitlab CI
Store your Coveralls API token as an Environment Variable named COVERALLS_TOKEN.
test:
timeout: 30m
stage: test
artifacts:
paths:
- coverage.txt
dependencies:
- build:env
when: always
script:
- go test -covermode atomic -coverprofile=coverage.txt ./...
- go get github.com/mattn/goveralls
- goveralls -service=gitlab -coverprofile=coverage.txt
Coveralls Enterprise
If you are using Coveralls Enterprise and have a self-signed certificate, you need to skip certificate verification:
$ goveralls -insecure
Authors
- Yasuhiro Matsumoto (a.k.a. mattn)
- haya14busa
License
under the MIT License: http://mattn.mit-license.org/2016
