ktnip-ksp-tests

KSP Processor Test Rules

Test Base

• Extend AbstractKspTest
• Kotest AnnotationSpec with @Test

class ProcessorTest : AbstractKspTest() {
    @Test
    fun defaultHandlers() = runTest("test-data/DefaultHandlers.kt")
}

runTest vs compile

• runTest(path): Load from jvmTest/resources/test-data/<name>.kt, compile with ActivityProcessorProvider, assert exitCode OK, verify generated files (ActivitiesData.kt, KtGramCtxLoader.kt, BotCtx.kt)
• compile(vararg SourceFile): Inline sources, custom processors; returns JvmCompilationResult for custom assertions

Golden Output

Hybrid: If test-data/golden/<TestName>/<FileName>.gold exists, full-file comparison is used. Otherwise, fall back to G-EXPECT.

G-EXPECT optional: When golden files exist, the G-EXPECT block can be omitted — expectations are discovered from golden files.

Update: ./gradlew :ktnip:updateGolden — run when generated output changes intentionally.

G-EXPECT (fallback)

Add /* G-EXPECT ... */ block comments to test data when no golden file exists. One block can contain multiple checks:

/* G-EXPECT
file=ActivitiesData.kt
contains="Activity"

file=KtGramCtxLoader.kt
contains="registerCommand"
contains="registerActivity"

file=BotCtx.kt
contains="userData"
contains="getState"
notContains="TODO"

noError
*/

Directives:

• file=FileName.kt — target generated file (can appear multiple times)
• contains="..." — file must contain substring
• notContains="..." — file must not contain substring
• matches="regex" — file must contain a substring matching the regex
• notMatches="regex" — file must not contain any substring matching the regex
• noError — expect compilation success (default when no error directives)
• error contains="..." — expect compilation error, message contains
• error exact="..." — error message equals
• error count=N — exactly N error lines
• error file=Foo.kt line=12 contains="..." — error at file/line contains