Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eun/go-test-buckets
Split your go tests into buckets.
https://github.com/eun/go-test-buckets
go golang golang-testing testing
Last synced: 1 day ago
JSON representation
Split your go tests into buckets.
- Host: GitHub
- URL: https://github.com/eun/go-test-buckets
- Owner: Eun
- License: mit
- Created: 2020-01-06T15:35:58.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-08T04:33:35.000Z (8 months ago)
- Last Synced: 2024-10-27T08:24:30.044Z (about 2 months ago)
- Topics: go, golang, golang-testing, testing
- Language: Go
- Size: 56.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# go-test-buckets
[](https://github.com/Eun/go-test-buckets/actions)
[](https://coveralls.io/github/Eun/go-test-buckets?branch=master)
[](https://pkg.go.dev/github.com/Eun/go-test-buckets)
[](https://goreportcard.com/report/github.com/Eun/go-test-buckets)
---
Split your go tests into buckets, or exclude some packages/directories.
## Buckets
```golang
package main_test
import (
"testing"
"os"
"github.com/Eun/go-test-buckets"
)
func TestMain(m *testing.M) {
buckets.Buckets(m)
os.Exit(m.Run())
}
// run with BUCKET=0 TOTAL_BUCKETS=2 go test -count=1 -v ./...
// will run TestA and TestB
// run with BUCKET=1 TOTAL_BUCKETS=2 go test -count=1 -v ./...
// will run TestC
func TestA(t *testing.T) {
}
func TestB(t *testing.T) {
}
func TestC(t *testing.T) {
}
```
## Excluding Packages/Directories
1. Add to your package
```go
func TestMain(m *testing.M) {
buckets.Buckets(m)
os.Exit(m.Run())
}
```
2. Run `EXCLUDE_PACKAGES=package/path/to/exclude,package/path/to/exclude-2 go test -count=1 -v ./...`
3. Or `EXCLUDE_DIRECTORIES=/full/path/to/exclude go test -count=1 -v ./...`
> Because of `go test` package separation, you have to call `buckets.Buckets(m)` in every package you want to ignore.
## Why?
Speed up ci pipelines by parallelizing go tests without thinking about [t.Parallel](https://golang.org/pkg/testing/#T.Parallel).
And getting rid of weird piping `go test $(go list ./... | grep -v /ignore/)`
## Extra Github Actions
You can use following github action when using test buckets:
```yaml
on:
push:
name: "push"
jobs:
test:
strategy:
matrix:
platform: [ubuntu-latest]
bucket: [0, 1, 2, 3]
env:
TOTAL_BUCKETS: 4
runs-on: ${{ matrix.platform }}
steps:
-
name: Checkout code
uses: actions/[email protected]
-
name: Get go.mod details
uses: Eun/[email protected]
id: go-mod-details
-
name: Install Go
uses: actions/setup-go@v4
with:
go-version: ${{ steps.go-mod-details.outputs.go_version }}
-
name: Test
run: go test -v -count=1 ./...
env:
BUCKET: ${{ matrix.bucket }}
```