weilbith / neotest-gradle

Neotest adapter for Kotlin and Java projects with Gradle

Neotest Gradle

Neotest adapter for Kotlin and Java projects using Gradle test with reports in JUnit XML format.

Warning

This is primarily an export from my personal NeoVim configuration. Please don't expect any support! It might not work for any Gradle/project setup. Please feel free to open PRs when you managed to make the adapter more versatile.

Setup

Install with your favorite plugin management toolchain and register it as adatper to Neotest.

Adapter Registration

require('neotest').setup({
    adapters = {
        require('neotest-gradle'),
        -- more adapters ...
    },
    -- more configuration ...
})

Supported Features

Noteworthy:

• diagnostics for failed tests
• test description annotations
• nested test classes

Planned:

• debugging strategy support using for example the kotlin-debug-adapter (still unreliable and highly experimental on local setup)

Contribution

I tried to produce somewhat "clean code" including documentation to help anyone getting into the adapter internals himself. Here are some notes of the higher level ideas to understand the adapter by how I tried to match the Neotest concepts with the Gradle test ones. Please be aware that I'm no expert for Gradle in general and the adapter might not work for all cases in every project. Please feel free to contribute such improvements. It mainly works for the projects I'm working on right now. Though I might no more work on them by now.

• (nested) test classes are interpreted as Neotest namespace positions
• test methods are interpreted as Neotest test positions
• running test files just runs all namespaces within this file
• Neotest position identifiers are set to the fully qualified Java pattern with package path, classes and method name as provided to gradle test --tests <pattern>
• no globs are used for test filtering, rather multiple filters are set
• the report directory is determined by asking for the testResultsDir property of the project
• test reports are expected to be XML files in JUnit format
• there is some "prettifying" of test cases for UI purposes