gotesplit

KO | EN

gitlite — search

#javascript #react #python #spring-boot #java #ios #nodejs #golang #swift #kotlin #machine-learning #android

★ 76 Open GitHub ↗

Splits the testing in Go into a subset and run it. It is useful for the CI environment.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

gotesplit
=======

[![Test Status](https://github.com/Songmu/gotesplit/workflows/test/badge.svg?branch=main)][actions]
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]
[![PkgGoDev](https://pkg.go.dev/badge/github.com/Songmu/gotesplit)][PkgGoDev]

[actions]: https://github.com/Songmu/gotesplit/actions?workflow=test
[license]: https://github.com/Songmu/gotesplit/blob/main/LICENSE
[PkgGoDev]: https://pkg.go.dev/github.com/Songmu/gotesplit

gotesplit splits the testng in Go into a subset and run it

## Usage

```console
% gotesplit [options] [pkgs...] [-- go-test-arguments...]
```

### Options

```
-total uint
      total number of test splits (CIRCLE_NODE_TOTAL is used if set) (default 1)
-index uint
      zero-based index number of test splits (CIRCLE_NODE_INDEX is used if set) (default 0)
-junit-dir
       directory to store test result as a JUnit format (optional)
```

### Synopsis

```console
% gotesplit -total=10 -index=0 -- -v -short
go test -v -short -run ^(?:TestAA|TestBB)$
```

### -list-mode

`-list-mode` selects how `gotesplit` enumerates test names:

- `gotest` (default): runs `go test -list .`, which compiles each package and executes `TestMain`.
- `ast`: parses each `_test.go` statically with `go/ast` and `go/doc.Examples`. No compilation, so it tends to be faster on large codebases.

```
gotesplit -list-mode=ast -total=10 -index=0 ./... -- -short
```

The flag also applies to the `regexp` subcommand:

```
gotesplit -list-mode=ast regexp 10 0 ./...
```

## Description

The gotesplit splits the testng in Go into a subset and run it.

It is very useful when you want to run tests in parallel in a CI environment.

## Installation

```console
# Install the latest version. (Install it into ./bin/ by default).
% curl -sfL https://raw.githubusercontent.com/Songmu/gotesplit/main/install.sh | sh -s

# Specify installation directory ($(go env GOPATH)/bin/) and version.
% curl -sfL https://raw.githubusercontent.com/Songmu/gotesplit/main/install.sh | sh -s -- -b $(go env GOPATH)/bin [vX.Y.Z]

# In alpine linux (as it does not come with curl by default)
% wget -O - -q https://raw.githubusercontent.com/Songmu/gotesplit/main/install.sh | sh -s [vX.Y.Z]

# go get
% go get github.com/Songmu/gotesplit/cmd/gotesplit

# aqua https://aquaproj.github.io/
% aqua g -i Songmu/gotesplit
```

## Example

### CircleCI

We don't need to specify the -total and -index flag on CircleCI because gotesplit reads the `CIRCLE_NODE_TOTAL` and `CIRCLE_NODE_INDEX` environment variables automatically.

```yaml
    parallelism: 5
    docker:
      - image: circleci/golang:1.15.3
    steps:
      - checkout
      - run:
          command: |
            curl -sfL https://raw.githubusercontent.com/Songmu/gotesplit/main/install.sh | sh -s
            bin/gotesplit ./... -- -v
```

### GitHub Actions

```yaml
name: CI
on: [push, pull_request]
jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        parallelism: [3]
        index: [0,1,2]
    steps:
      - uses: actions/setup-go@v4
      - uses: actions/checkout@v3
      - name: Run tests parallelly
        run: |
          curl -sfL https://raw.githubusercontent.com/Songmu/gotesplit/main/install.sh | sh -s
          bin/gotesplit -total ${{ matrix.parallelism }} -index ${{ matrix.index }} ./... -- -v
```

## Author

[Songmu](https://github.com/Songmu)

gotesplit

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README