Adds javaAP precondition to KotlinPoet integration

Also adds tests for the changes and marks tests which skip backends it does not target with `AssumptionViolatedException`.
androidx · Mar 10, 2021 · bcf7ef7 · bcf7ef7
1 parent 92977af
commit bcf7ef7
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 6 deletions.
diff --git a/...ng-testing/src/test/java/androidx/room/compiler/processing/util/GeneratedCodeMatchTest.kt b/...ng-testing/src/test/java/androidx/room/compiler/processing/util/GeneratedCodeMatchTest.kt
@@ -24,6 +24,7 @@ import com.squareup.kotlinpoet.BOOLEAN
 import com.squareup.kotlinpoet.FileSpec
 import com.squareup.kotlinpoet.TypeSpec as KTypeSpec
 import org.junit.Test
+import org.junit.AssumptionViolatedException
 import org.junit.runner.RunWith
 import org.junit.runners.Parameterized
 
@@ -118,7 +119,9 @@ class GeneratedCodeMatchTest internal constructor(
     @Test
     fun successfulGeneratedKotlinCodeMatch() {
         // java environment will not generate kotlin files
-        if (runTest.toString() == "java") return
+        if (runTest.toString() == "java") {
+            throw AssumptionViolatedException("javaAP won't generate kotlin code.")
+        }
 
         val file = FileSpec.builder("foo.bar", "Baz")
             .addType(KTypeSpec.classBuilder("Baz").build())
@@ -138,7 +141,9 @@ class GeneratedCodeMatchTest internal constructor(
     @Test
     fun missingGeneratedKotlinCode_mismatch() {
         // java environment will not generate kotlin files
-        if (runTest.toString() == "java") return
+        if (runTest.toString() == "java") {
+            throw AssumptionViolatedException("javaAP won't generate kotlin code.")
+        }
 
         val generated = FileSpec.builder("foo.bar", "Baz")
             .addType(
@@ -180,4 +185,36 @@ class GeneratedCodeMatchTest internal constructor(
         )
         assertThat(result.exceptionOrNull()).hasMessageThat().contains(mismatch.toString())
     }
+
+    @Test
+    fun missingGeneratedKotlinCode_javaAP() {
+        if (runTest.toString() != "java") {
+            throw AssumptionViolatedException("Testing scenario for javaAP only.")
+        }
+
+        val file = FileSpec.builder("foo.bar", "Baz")
+            .addType(KTypeSpec.classBuilder("Baz").build())
+            .build()
+
+        val result = runCatching {
+            runTest { invocation ->
+                if (invocation.processingEnv.findTypeElement("foo.bar.Baz") == null) {
+                    invocation.processingEnv.filer.write(file)
+                }
+                invocation.assertCompilationResult {
+                    generatedSource(
+                        Source.kotlin("foo/bar/Baz.kt", file.toString())
+                    )
+                }
+            }
+        }
+
+        assertThat(result.exceptionOrNull())
+            .hasCauseThat()
+            .hasMessageThat()
+            .contains(
+                "Could not generate kotlin file foo/bar/Baz.kt. The annotation processing " +
+                    "environment is not set to generate Kotlin files."
+            )
+    }
 }
diff --git a/room/compiler-processing/src/main/java/androidx/room/compiler/processing/javac/JavacFiler.kt b/room/compiler-processing/src/main/java/androidx/room/compiler/processing/javac/JavacFiler.kt
@@ -20,13 +20,19 @@ import androidx.room.compiler.processing.XFiler
 import com.squareup.javapoet.JavaFile
 import com.squareup.kotlinpoet.FileSpec
 import javax.annotation.processing.Filer
+import javax.annotation.processing.ProcessingEnvironment
 
-internal class JavacFiler(val filer: Filer) : XFiler {
+internal class JavacFiler(val processingEnv: ProcessingEnvironment) : XFiler {
     override fun write(javaFile: JavaFile) {
-        javaFile.writeTo(filer)
+        javaFile.writeTo(processingEnv.filer)
     }
 
     override fun write(fileSpec: FileSpec) {
-        fileSpec.writeTo(filer)
+        require(processingEnv.options.containsKey("kapt.kotlin.generated")) {
+            val filePath = fileSpec.packageName.replace('.', '/')
+            "Could not generate kotlin file $filePath/${fileSpec.name}.kt. The " +
+                "annotation processing environment is not set to generate Kotlin files."
+        }
+        fileSpec.writeTo(processingEnv.filer)
     }
 }
diff --git a/...er-processing/src/main/java/androidx/room/compiler/processing/javac/JavacProcessingEnv.kt b/...er-processing/src/main/java/androidx/room/compiler/processing/javac/JavacProcessingEnv.kt
@@ -58,7 +58,7 @@ internal class JavacProcessingEnv(
         JavacProcessingEnvMessager(delegate)
     }
 
-    override val filer = JavacFiler(delegate.filer)
+    override val filer = JavacFiler(delegate)
 
     override val options: Map<String, String>
         get() = delegate.options