https://github.com/andreacrotti/kaocha-retry

Retry plugin for Kaocha
https://github.com/andreacrotti/kaocha-retry

Last synced: 9 months ago
JSON representation

Retry plugin for Kaocha

• Host: GitHub
• URL: https://github.com/andreacrotti/kaocha-retry
• Owner: AndreaCrotti
• License: mit
• Created: 2020-12-02T09:08:14.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T09:47:07.000Z (almost 3 years ago)
• Last Synced: 2025-03-28T04:34:47.879Z (10 months ago)
• Language: Clojure
• Size: 38.1 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![CircleCI](https://circleci.com/gh/AndreaCrotti/kaocha-retry/tree/main.svg?style=svg)](https://circleci.com/gh/AndreaCrotti/kaocha-retry/tree/main)

# Retry plugin for kaocha

Flakey tests are an issue that affect many people, and they should be

handled properly to avoid the flakeyness.

However in some cases you might still want to retry flakey tests, in case

the failures depend on external transient factors that are hard to control.

This [Kaocha](https://github.com/lambdaisland/kaocha) plugin will

re run tests automatically in a transparent way, but making sure that the

retried tests get reported at the end.

## How to use it

Add the dependency to your project.clj/deps.edn file with:

[![Clojars Project](https://img.shields.io/clojars/v/kaocha-retry.svg)](https://clojars.org/kaocha-retry)

You can enable this plugin globally for all test suites adding `:kaocha-retry.plugin/retry` to your list of Kaocha plugins.

If you enable it globally you can still disable it by passing:

    --no-retry

Otherwise you can just enable it for your own test run with enabling it with:

    --with-plugin :kaocha-retry.plugin/retry

You can also configure the number of retries and the wait interval between runs with:

    --max-retries $NUMBER_OF_RETRIES

and:

    --retry-interval $RETRY_INTERVAL_IN_MILLISECONDS

If you want to narrow down the list of tests that should be actually retried, you can add this configuration in your `tests.edn`:

    :kaocha-retry.plugin/retrying-tests-regexes ["ns/test-*"]

Which is a list of regular expressions that will match both the namespace and the actual test name.

### Sample report

After all the tests run you will get a report of the tests that were retried, for example:

    4 tests, 5 assertions, 1 errors, 1 failures.

    * Tests failed even after 3 retries

    - :simple-test/not-working-test

    * Tests succeeded after retrying `n` times

    - :simple-test/not-working-test-2: 2

## Contributing

If you want to try this plugin out just run [the kaocha script](./simple-testing/kaocha)

in that simple project.

It will uses kaocha-retry from your local checkout so you can develop with it easily.

## Release

Check the [deps-library documentation](https://github.com/applied-science/deps-library) to understand how to release new versions to clojars, and use the [release.sh script](./release.sh).