ginkgo

Documentation

Overview

The Ginkgo CLI

The Ginkgo CLI is fully documented [here](http://onsi.github.io/ginkgo/#the_ginkgo_cli)

To install:

go install github.com/onsi/ginkgo/ginkgo

To run tests:

ginkgo

To run tests in all subdirectories:

ginkgo -r

To run tests in particular packages:

ginkgo <flags> /path/to/package /path/to/another/package

To monitor packages and rerun tests when changes occur:

ginkgo -watch <-r> </path/to/package>

passing `ginkgo -watch` the `-r` flag will recursively detect all test suites under the current directory and monitor them. `-watch` does not detect *new* packages. Moreover, changes in package X only rerun the tests for package X, tests for packages that depend on X are not rerun.

To run tests in parallel

ginkgo -nodes=N

where N is the number of nodes. By default the Ginkgo CLI will spin up a server that the individual test processes stream test output to. The CLI then aggregates these streams into one coherent stream of output. An alternative is to have the parallel nodes run and then present the resulting, final, output in one monolithic chunk - you can opt into this if streaming is giving you trouble:

ginkgo -nodes=N -stream=false

On windows, the default value for stream is false.

To bootstrap a test suite:

ginkgo bootstrap

To generate a test file:

ginkgo generate <test_file_name>

To unfocus tests:

ginkgo unfocus

To print out Ginkgo's version:

ginkgo version

To get more help:

ginkgo help