Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 2.58 KB

README.md

File metadata and controls

74 lines (55 loc) · 2.58 KB
Raw

kompile-testing Build Status

A library for testing kotlinc compilation with kotlin annotation processors(kapt) which is strongly inspired by google/compile-testing.

kompile-testing gives you an easy way to assert not only annotation processors can handle incorrect inputs and prints the correct errors but also the generated Kotlin file is correctly formed.

NOTE: Current library's status is still in development especially due to performance issue. Use at your own risk:D

Installation

latestVersion is Download 

dependencies {
    testImplementation "org.permissionsdispatcher:kompile-testing:{latestVersion}"
}

Usage

A simple example that tests compiling a source file succeeded and make assertions about generated file is:

kotlinc()
    .withProcessors(YourProcessor())
    .addKotlin("input.kt", """
        import kompile.testing.TestAnnotation

        @TestAnnotation
        class TestClass
        """.trimIndent())
        .compile()
        .succeededWithoutWarnings()
        .generatedFile("generatedKtFile.kt")
        .hasSourceEquivalentTo("""
            class GeneratedKtFile
        """.trimIndent())

You can also test that errors or warnings were reported.

The following tests compiling a source file with an annotation processor reported an error:

kotlinc()
    .withProcessors(YourProcessor())
    .addKotlin("input.kt", """
        import kompile.testing.TestAnnotation

        @TestAnnotation
        class TestClass
        """.trimIndent())
        .compile()
        .failed()
        .withErrorContaining("Expected error message here.")

License

Copyright (C) 2019 permissions-dispatcher contributors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.