Running Golang tests with Jest
Jan 10 2018
/ 3 min read /
0 Likes •
0 Replies •
A few weeks ago, I got the privilege to hear about “Jest as a test platform” from one of the top contributor of the Jest project Rogelio Guzman , and especially about jest runners and what they can achieve. For those who want a great introduction to what Jest is and what kind of problem it solves, I highly recommend you to check out his talk from React Conf 2017.
The story behind jest runners inspired me and several days later, I wrote jest-runner-go, a jest runner that enables anyone to execute Golang tests using the Jest platform and its features.
In a nutshell, Jest is composed of multiple packages that are each one responsible for a specific step in your test run lifecycle. Runners are the packages that focus on “running” tests. Jest provides an interface to plug your own runner on both the interface package, which is in charge of finding files, providing the UX and filtering, and the result reporting package, which basically manages the output of your tests.
The ability to add custom runners is interesting in case you want to run other types of tests than the default ones supported by Jest. In the case of jest-runner-go, the runner will simply run
go test against all Go tests files found by the Jest interface and parse the output in a way the Jest result reporting package can understand it and present the results in a more human readable way.
Using Jest to test both the Golang backend and the React frontend of an app has brought me a certain peace of mind, especially when running the tests during CI: the output is consistent and clear across my stack when running my tests. Additionally I get features that are not available with
go tests like a native watch mode or running tests with a specific pattern which makes the experience of running tests in Go better.
To integrate jest-runner-go in your project, first run
yarn add jest jest-runner-go then simply add the following to whichever Jest config you’re using, either
jest.config.js or a specific config that will be passed with the
--config flag when running Jest, or even the
package.json of the project:
Jest config file
1"moduleFileExtensions": \[2"go"3\],4"runner": "jest-runner-go",5"testMatch": \[6"\*\*/?(\*\_)test.go"7\]
jest --config my-go-test-config will find all the files matching
go test against each of these files and finally parse the output produced by
go test so Jest will get the required data to output.
As mentioned before, most of my use cases for jest-runner-go along with the classic jest-runner include whenever one of my projects uses both Go and React. It’s possible to run the tests of both sides of the project in a single test run by using the
--projects flag and pass multiple Jest configs. In the example below, I added the previous config to a config file called
gojest.config.js and then used the following command in a small project generated with
create-react-app that also includes some Go code with unit tests:
Running Jest with multiple Jest configs
1jest --projects jest.config.js gojest.config.js
which gives us the following output:
Other Jest runners have been written these last few months, the most notable ones that I’ve found or been introduced to so far are:
This case is a tricky one as many Go projects owners don’t want to have a dependency on Node to run their tests, as well as everything that comes with it: a
node_modules folder, a
package.json and a Jest config.
That’s why I started working on Gojest: a standalone binary to run Go tests using the Jest platform and jest-runner-go. The project is compiled for Linux, macOS and Windows using pkg and is available here. This is purely experimental and is obviously not intended to be used in production given how new and not widely used the project and jest-runner-go currently are.
If you want to get the latest version of Gojest you can either download the binaries from the release page of the project or install them using Docker by running the following:
Install command for gojest on macOS
1docker pull maximeheckel/gojest:latest &&2id=$(docker create maximeheckel/gojest:latest) &&3docker cp $id:/gojest-macos /usr/local/bin/gojest && (docker rm \$id >/dev/null)
Install command for gojest on Linux
1docker pull maximeheckel/gojest:latest &&2id=$(docker create maximeheckel/gojest:latest) &&3docker cp $id:/gojest-linux /usr/local/bin/gojest && (docker rm \$id >/dev/null)
Install command for gojest on Windows
1docker pull maximeheckel/gojest:latest &&2id=$(docker create maximeheckel/gojest:latest) &&3docker cp $id:/gojest-win.exe gojest.exe && (docker rm \$id >/dev/null)
Here’s an example of using Gojest to run unit tests in a Go project:
I really hope to make jest-runner-go and Gojest stable enough to be used by the Go community in a decent timeframe. If you want to contribute or give feedback, both projects are available on Github at
Pull requests are more than welcome.
Do you have any questions, comments or simply wish to contact me privately? Don’t hesitate to shoot me a DM on Twitter.
Have a wonderful day.
How to use the Jest platform to run Golang test