Documentation
Tools

Tools

TableTest provides a suite of tools to enhance your data-driven testing workflow. Each tool serves a specific purpose and can be used independently or together.

Core Library

The foundation — a JUnit extension that enables table-driven testing with the @TableTest annotation.

  • Java and Kotlin — works with both languages out of the box
  • Behaviour-focused — tables document expected behaviour as readable examples
  • Standard JUnit — runs alongside regular @Test methods with no special setup
  • Extensible — custom type converters, external table files, and value sets for advanced scenarios

Available on: Maven Central | Source: GitHub

IntelliJ Plugin

IDE support for working with TableTest tables inside IntelliJ IDEA. The plugin provides syntax highlighting, automatic column alignment, comment toggling, and row reordering — all with familiar keyboard shortcuts.

  • Auto-formatting — press Cmd+Option+L (macOS) or Ctrl+Alt+L to align columns
  • Syntax highlighting — distinct colours for headers, delimiters, values, and comments
  • Language injection — automatic TableTest language support in @TableTest annotations

Available on: JetBrains Marketplace | Source: GitHub

Formatter

A formatting tool for consistent table layout across your codebase. Formats tables in Java files, Kotlin files, and standalone .table files.

  • Spotless plugin for Gradle — automatic formatting in your build
  • CLI tool for standalone formatting or CI integration
  • Maven integration via exec-maven-plugin
  • EditorConfig support — reads indent style and size from .editorconfig

The formatter is safe by default: it returns input unchanged on parse errors, so it never breaks your build.

Available on: Maven Central | Source: GitHub

Reporter

Generates documentation from your TableTest tests. Run your tests, then run the reporter to turn test tables into readable AsciiDoc or Markdown documentation that you can publish alongside your project docs.

  • Gradle plugin and Maven plugin — integrates into your build
  • Custom templates — extend or replace built-in templates using Pebble
  • Pass/fail indicators — rows are marked with test results in the generated output
  • Custom output formats — define HTML, XML, or any format via templates

Available on: Maven Central | Source: GitHub

Compatibility

All tools support:

  • Java: 21 or above
  • Build Tools: Maven and Gradle
  • Frameworks: Spring Boot 3.4.0+, Quarkus 3.21.2+

Source Code

All tools are open source under Apache Licence 2.0: