ginkgo1

Usage

Overview

Ginkgo is a BDD-style Golang testing framework built to help you efficiently write expressive and comprehensive tests.

This page documents the ginkgo CLI, which offers a number of conveniences beyond what go test provides out of the box and its usage is recommended, but not necessary.

Options

ginkgo or ginkgo run flags packages -- pass-throughs

Run the tests in packages (or the package in the current directory).

Any arguments after -- will be passed to the test. Run ginkgo help run for a description of all valid flags.

ginkgo watch flags packages -- pass-throughs

Watches the files in packages and re-runs tests when changes occur.

ginkgo bootstrap flags

Bootstrap a test suite for the current package

ginkgo generate filenames

Generate a test file named filename_test.go

If the optional filenames argument is omitted, a file named after the package in the current directory will be created.

ginkgo labels flags packages

List labels detected in the passed-in packages (or the package in the current directory).

ginkgo outline filename

Create an outline of Ginkgo symbols for a file.

ginkgo unfocus

Recursively unfocuses any focused tests under the current directory