Tests for AnalysisHandlerExtension

Add two common use cases of AnalysisHandlerExtension: 1. repeated analysis with new source roots. 2. frontend only mode
2021-03-20 22:33:54 -07:00
parent dba127a4d8
commit 0dee48781c
1 changed files with 115 additions and 0 deletions
@@ -0,0 +1,115 @@
+/*
+ * Copyright 2010-2018 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlin.cli
+
+import com.intellij.mock.MockProject
+import com.intellij.openapi.project.Project
+import org.jetbrains.kotlin.analyzer.AnalysisResult
+import org.jetbrains.kotlin.cli.common.CLITool
+import org.jetbrains.kotlin.cli.js.K2JSCompiler
+import org.jetbrains.kotlin.cli.jvm.K2JVMCompiler
+import org.jetbrains.kotlin.cli.metadata.K2MetadataCompiler
+import org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar
+import org.jetbrains.kotlin.config.CompilerConfiguration
+import org.jetbrains.kotlin.container.ComponentProvider
+import org.jetbrains.kotlin.context.ProjectContext
+import org.jetbrains.kotlin.descriptors.ModuleDescriptor
+import org.jetbrains.kotlin.psi.KtFile
+import org.jetbrains.kotlin.resolve.BindingContext
+import org.jetbrains.kotlin.resolve.BindingTrace
+import org.jetbrains.kotlin.resolve.extensions.AnalysisHandlerExtension
+import org.jetbrains.kotlin.test.CompilerTestUtil
+import org.jetbrains.kotlin.test.TestCaseWithTmpdir
+import java.io.File
+import java.util.zip.ZipEntry
+import java.util.zip.ZipOutputStream
+
+private data class TestKtFile(
+    val name: String,
+    val content: String
+)
+
+private val classNotFound = TestKtFile("C.kt", "class C : ClassNotFound")
+private val repeatedAnalysis = TestKtFile("D.kt", "class D : Generated")
+
+class AnalysisHandlerExtensionTest : TestCaseWithTmpdir() {
+
+    // Writes the service file only; CustomComponentRegistrar is already in classpath.
+    private fun writePlugin(): String {
+        val jarFile = tmpdir.resolve("plugin.jar")
+        ZipOutputStream(jarFile.outputStream()).use {
+            val entry = ZipEntry("META-INF/services/org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar")
+            it.putNextEntry(entry)
+            it.write(CustomComponentRegistrar::class.java.name.toByteArray())
+        }
+        return jarFile.absolutePath
+    }
+
+    private fun runTest(compiler: CLITool<*>, src: TestKtFile, extras: List<String> = emptyList()) {
+        val mainKt = tmpdir.resolve(src.name).apply {
+            writeText(src.content)
+        }
+        val plugin = writePlugin()
+        val args = listOf("-Xplugin=$plugin", mainKt.absolutePath)
+        CompilerTestUtil.executeCompilerAssertSuccessful(compiler, args + extras)
+    }
+
+    fun testShouldNotGenerateCodeJVM() {
+        runTest(K2JVMCompiler(), classNotFound)
+    }
+
+    fun testShouldNotGenerateCodeJS() {
+        runTest(K2JSCompiler(), classNotFound, listOf("-output", tmpdir.resolve("out.js").absolutePath))
+    }
+
+    fun testShouldNotGenerateCodeMetadata() {
+        runTest(K2MetadataCompiler(), classNotFound, listOf("-d", tmpdir.resolve("out").absolutePath))
+    }
+
+    fun testRepeatedAnalysisJVM() {
+        runTest(K2JVMCompiler(), repeatedAnalysis)
+    }
+
+    fun testRepeatedAnalysisJS() {
+        runTest(K2JSCompiler(), repeatedAnalysis, listOf("-output", tmpdir.resolve("out.js").absolutePath))
+    }
+
+    fun testRepeatedAnalysisMetadata() {
+        runTest(K2MetadataCompiler(), repeatedAnalysis, listOf("-d", tmpdir.resolve("out").absolutePath))
+    }
+}
+
+class CustomComponentRegistrar : ComponentRegistrar {
+    override fun registerProjectComponents(project: MockProject, configuration: CompilerConfiguration) {
+        AnalysisHandlerExtension.registerExtension(project, CustomAnalysisHandler())
+    }
+}
+
+// Assume that the directory of input files is writeable!
+private class CustomAnalysisHandler : AnalysisHandlerExtension {
+    override fun doAnalysis(
+        project: Project,
+        module: ModuleDescriptor,
+        projectContext: ProjectContext,
+        files: Collection<KtFile>,
+        bindingTrace: BindingTrace,
+        componentProvider: ComponentProvider
+    ): AnalysisResult? {
+        val filenames = files.map { it.name }
+        if (repeatedAnalysis.name in filenames) {
+            if ("Generated.kt" in filenames) {
+                return null
+            } else {
+                val outDir = File(files.single { it.name == repeatedAnalysis.name }.virtualFilePath).parentFile
+                outDir.resolve("Generated.kt").apply {
+                    writeText("interface Generated")
+                }
+                return AnalysisResult.RetryWithAdditionalRoots(BindingContext.EMPTY, module, emptyList(), listOf(outDir))
+            }
+        }
+        return AnalysisResult.success(BindingContext.EMPTY, module, false)
+    }
+}