How to Run Go Tests with Coverage Percentage

Jun 1, 2017 · 146 words · 1 minute read

#coverage #percentage #profile #test #testing #usage

Go has a brilliant built in testing package, which although it is quite raw, it is very powerful. It also has the ability to show the test coverage as a percentage of the code base. Which is very useful to get perspective of a project and to know perhaps which areas need improvement.

You can see the test coverage by using the -coverprofile parameter on the test command.

1
2
3
4
5


go test -coverprofile cp.out

# PASS
# coverage: 60.2% of statements
# ok      yourpackage  1.372s

This is great, but even better is being able to visualise the test coverage. You can see which code is run during testing and which code is not by loading the cover profile in a browser. To do this, use this command:

1

go tool cover -html=cp.out

Which will produce something like this (although I’ve cropped it down):

Code Example

Related Posts

Mock S3 Uploads in Go Tests – Feb 22, 2020
A common scenario a back-end web developer might encounter is writing code which uploads a file to an external storage platform, like S3 or Azure. This is simple enough, but writing tests for this code which are isolated from the dependencies isn’t quite as straight forward. We can achieve this in Go through the use of interfaces and creating a “mock” uploader when our tests run. Below we’ve build an example to show this, first showing the test and then the code it’s testing.
How to Run a Single Test – Sep 24, 2019
Go has a simple command line for running its tests, with go test. However, often when writing tests you don’t care about the rest of the test suite - you just want to run your new test. This post shows you the command you need to run just your test, as well as a full example below.
Disable Log Output During Tests – Jan 14, 2019
It’s quite common to use the log package within your code to keep track of things which the end user might not need to see, like deprecated notices and warnings. These are great when they are in production and you are monitoring the logs - but they will show up during your tests. Below is an example test for our example application (even further below) which just asserts that the result of the function is 5.

Image of Author Edd Turtle

Follow @EddTurtle Follow @golangcode

Author: Edd Turtle

Edd is the Lead Developer at Hoowla, a prop-tech startup, where he spends much of his time working on production-ready Go and PHP code. He loves coding, but also enjoys cycling and camping in his spare time.

See something which isn't right? You can contribute to this page on GitHub or just let us know in the comments below - Thanks for reading!