Ginkgo

To use Captain with Ginkgo, you need to configure your test suite to output test results to a file and then tell Captain where to find those test results.

Getting started

Ginkgo can output test results to a file using the --json-report flag. Configure Captain by creating a .captain/config.yaml file in the root directory of your repository:

test-suites:
  your-project-ginkgo:
    command: ginkgo run --keep-going --json-report ./tmp/ginkgo.json ./...
    results:
      path: tmp/ginkgo.json

You can change your-project-ginkgo to any name you like, but we typically recommend using the name of your project followed by a dash followed by ginkgo. The command is the command you already use to run your test suite. Captain will invoke this command to run your tests. The example above shows what you might use if you use ginkgo run and want to store test results in tmp/ginkgo.json. Make sure to include the --json-report flag!

Once Captain is configured, you can run captain run your-project-ginkgo --print-summary. If you see your typical test output following by a captain block like this:

--------------------------------------------------------------------------------
----------------------------------- Captain ------------------------------------
--------------------------------------------------------------------------------

then you've configured everything correctly! You can now supercharge your test framework's capabilities. See below for configuring each of Captain's features.

Quarantining Tests

Traditionally, you might mark a test as pending or skipped to triage flaky or failing tests. With Captain, you can quarantine them instead. When only quarantined tests fail, Captain will still report your build as successful and exit with a 0 exit code. Unlike skipped tests, quarantined tests will continue to run, so you can still view their failure messages and see how frequently they are failing.

You can quarantine tests in OSS mode with captain add quarantine like so:

captain add quarantine your-project-ginkgo \
  --file internal/pkg1/foo_test.go  \
  --description "Foo passes"

See the identifying tests section of this page for more information on finding the file and description, and see the OSS quarantining guide for more information on managing quarantined tests in OSS mode.

Retrying Tests

You can configure Captain to automatically retry failed tests to help you determine if failing tests are flaky or are genuinely failing. To configure retries, update your .captain/config.yaml file like so:

test-suites:
  your-project-ginkgo:
    command: ginkgo run --keep-going --json-report ./tmp/ginkgo.json ./...
    results:
      path: tmp/ginkgo.json
    output:
      print-summary: true
    retries:
      attempts: 2
      command: ginkgo run {{ tests }} --keep-going --json-report ./tmp/ginkgo.json ./...

Once configured, Captain will invoke your original test command, check for any failures, and retry your tests however many times you've specified (in this example, two additional times) by templating the failures into the command specified by retries.command. The output.print-summary option is not required, but we've added it for convenience in understanding the overall results after the retries have been factored in.

Partitioning

Unfortunately, partitioning is not currently supported in Ginkgo. If you're interested in this feature, please let us know so we can better prioritize support.

Identifying Tests

Captain uses framework specific "identity recipes" to identify the tests in your suite. These recipes are order dependent components extracted from native test framework output.

We use this identity to track the executions of a test over the course of their lifetime in your suite. This enables us to do things like flake detection, quarantining, and retries.

For Ginkgo, Captain constructs the identity by parsing out the file and description attributes.