kotlin-compile-testing allows you to compile Kotlin and Java code within your tests, mirroring the functionality of Google's Compile Testing. It's designed for testing annotation processors, compiler plugins, and code generation scenarios. By enabling in-process compilation, it provides a controlled environment to verify the behavior of code transformations without deploying to external compilation processes. It benefits from a jigsaw-compatible design and supports JDK-crosscompilation, enabling testing across various JDK versions.
Key features include mixed-source set compilation (Kotlin and Java), support for annotation processing (including generating both Kotlin and Java sources), inheritance of classes from the host application's classpath, and JDK-crosscompilation. It also provides a robust debugging capability by running the compilation process within the same process as your application. Furthermore, the library is compatible with KSP (Kotlin Symbol Processing) for enhanced annotation processor testing.
- Mixed-source sets: Supports compiling both Kotlin and Java source files in a single test run.
- Annotation processing: Enables testing of annotation processors for Kotlin and Java sources, including generating sources and allowing access between them.
- Classpath inheritance: Offers access to classes from the host application's classpath during compilation.
- JDK-crosscompilation: Facilitates testing code against different JDK versions.
- KSP support: Provides dedicated support for Kotlin Symbol Processing (KSP) driven annotation processors.
- Debugging: Allows debugging of annotation processors by running them in the same process as the application.
- Dependency Management : Supports testing plugins and processors by directly providing instances.
The project is actively maintained with recent commits and a consistent release history. It demonstrates good community adoption with numerous projects leveraging its capabilities. Comprehensive documentation, supported by a strong adherence to Kotlin standards, enhances usability and reliability. Recent updates provide support for KSP, highlighting ongoing development and adaptation to newer Kotlin compiler features.
Developers can benefit from kotlin-compile-testing by streamlining the testing of complex code transformations such as annotation processors and compiler plugins. It simplifies the development and validation process for various libraries and frameworks. It eliminates the complexities associated with external compilation setups and enables faster, more reliable testing, particularly benefiting projects using KSP.