How to set up Kaocha with Clojure CLI tools.deps?

Add Kaocha as a dependency under an alias in deps.edn and create a binstub script. The README provides step-by-step instructions, including alternative exec-fn approaches for different preferences.

Kaocha vs Leiningen test runner: which is better for my project?

Kaocha offers advanced features like watch mode and filtering, making it superior for complex workflows. However, if you only need basic test execution, Leiningen's built-in runner is simpler and requires less setup.

How do I run only specific tests using metadata in Kaocha?

Use the --focus option with test names or configure metadata-based filtering in tests.edn. The documentation covers focusing and skipping based on metadata tags for granular control.

Does Kaocha work with Babashka for scripting?

Yes, Kaocha is compatible with Babashka. You can set up a bb.edn file and create a binstub to run tests, as outlined in the Babashka section of the README.

How to generate JUnit XML reports for CI/CD pipelines with Kaocha?

Use the kaocha-junit-xml plugin. Add it as a dependency and configure the reporter in your tests.edn file to output standard XML reports for integration with CI systems.

What are some essential Kaocha plugins for everyday use?

Common plugins include kaocha-junit-xml for CI reports, kaocha-notifier for desktop notifications, and kaocha-profiling for identifying slow tests. Choose based on your team's workflow needs.

Open-Awesome

kaocha

EPL-1.0Clojurev1.91.1392

A full-featured next-generation test runner for Clojure with watch mode, filtering, and extensible plugins.

Visit Website GitHub

860 stars81 forks0 contributors

What is kaocha?

Kaocha is a next-generation test runner for Clojure that provides a comprehensive suite of features for running and managing tests. It solves the problem of fragmented testing workflows by offering a unified, extensible tool that works across multiple build systems and test frameworks.

Target Audience

Clojure developers and teams looking for a modern, feature-rich test runner that integrates seamlessly with their existing toolchain, whether using Clojure CLI, Leiningen, Boot, or Babashka.

Value Proposition

Developers choose Kaocha for its extensibility, watch mode, and tool-agnostic design, which together provide a smoother and more productive testing experience compared to basic built-in test runners.

Overview

Full featured next gen Clojure test runner

Use Cases

Best For

Running Clojure and ClojureScript tests with a single tool
Implementing test-driven development (TDD) with automatic re-runs on file changes
Filtering and focusing on specific tests or namespaces during development
Integrating tests into CI/CD pipelines with JUnit XML output
Profiling test suites to identify performance bottlenecks
Extending test functionality with custom plugins and reporters

Not Ideal For

Projects stuck on Clojure versions earlier than 1.9, as Kaocha has a minimum version requirement.
Teams relying exclusively on IDE-integrated test runners without command-line tooling needs.
Simple applications with basic test suites where advanced features like plugins and watch mode add unnecessary complexity.

Pros & Cons

Pros

Advanced Test Filtering

Supports filtering by test names or metadata, enabling precise test runs with CLI options like --focus, as shown in the quick start examples.

Real-time Watch Mode

Automatically re-runs tests on file changes, providing rapid feedback for test-driven development workflows, highlighted as a core feature.

Tool Agnostic Design

Works with Clojure CLI, Leiningen, Boot, and Babashka, offering consistent testing across different build systems without lock-in.

Extensible Plugin Ecosystem

Allows custom test types and plugins, with a rich set of third-party extensions like kaocha-junit-xml for CI integration, documented in the projects table.

Cons

Configuration Overhead

Requires setting up a tests.edn file for non-standard projects, and the README warns that default assumptions often need adjustment, adding initial complexity.

Verbose Initial Setup

Involves creating binstubs and tool-specific aliases for each build system, which can be cumbersome compared to simpler, out-of-the-box runners.

Plugin Dependency Fragmentation

Core features like JUnit XML output require separate plugins, increasing dependency management and potential version compatibility issues.

Frequently Asked Questions

Related Projects

Midje

Midje provides a migration path from clojure.test to a more flexible, readable, abstract, and gracious style of testing

Stars1,697

Forks128

Last commit2 years ago

Expectations

A minimalist's unit testing framework ("classic" version)

Stars398

Forks25

Last commit3 years ago

StateFlow

Integration testing framework using a state monad in the backend for building and composing flows

Stars390

Forks14

Last commit3 months ago

test-doubles

A small spying and stubbing library for Clojure and ClojureScript

Stars36

Forks4

Last commit4 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub