Installation

Learn

Getting Started

Installation

TableTest is available on Maven Central. Add it to your project as a test-scoped dependency alongside JUnit.

Requirements

Before installing TableTest, ensure your project meets these requirements:

Kotlin or Java 8 or above (Java 15+ recommended for text block syntax)
JUnit 5.11 or above

Setup

pom.xml

<dependencies>
    <!-- TableTest -->
    <dependency>
        <groupId>org.tabletest</groupId>
        <artifactId>tabletest-junit</artifactId>
        <version>1.2.0</version>
        <scope>test</scope>
    </dependency>

    <!-- JUnit -->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter</artifactId>
        <version>6.0.3</version>
        <scope>test</scope>
    </dependency>
</dependencies>

build.gradle

dependencies {
    testImplementation 'org.tabletest:tabletest-junit:1.2.0'
    testImplementation 'org.junit.jupiter:junit-jupiter:6.0.3'
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

test {
    useJUnitPlatform()
}

build.gradle.kts

dependencies {
    testImplementation("org.tabletest:tabletest-junit:1.2.0")
    testImplementation("org.junit.jupiter:junit-jupiter:6.0.3")
    testImplementation(kotlin("test"))
    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
}

tasks.test {
    useJUnitPlatform()
}

Framework Compatibility

TableTest works with popular Java frameworks:

Spring Boot 3.4.0 and above
Quarkus 3.21.2 and above

Verification

Create a simple test to verify TableTest is working:

public class InstallationTest {
    @TableTest("""
        Input | Expected
        1     | 1
        2     | 2
        3     | 3
        """)
    public void verifyTableTestWorks(int input, int expected) {
        assertEquals(expected, input);
    }
}

class InstallationKtTest {
    @TableTest(
        """
        Input | Expected
        1     | 1
        2     | 2
        3     | 3
        """
    )
    fun verifyTableTestWorks(input: Int, expected: Int) {
        assertEquals(expected, input)
    }
}

Run your tests. If you see three passing test executions, TableTest is correctly configured!

IDE Support

For an enhanced development experience, consider installing the IDE plugin for your editor:

IntelliJ IDEA — TableTest IntelliJ Plugin
VS Code — TableTest VS Code Extension

Both provide automatic table formatting and syntax highlighting. The IntelliJ plugin additionally offers visual feedback for invalid syntax.

Next Steps

With TableTest installed, you’re ready to write your first test →

What is TableTest?Your First TableTest