[analysis api, refactoring] move base test cases to base modules, improve service names

2022-03-24 22:14:47 +01:00
parent 443ee4c860
commit 1e5cf80278
32 changed files with 49 additions and 799 deletions
@@ -5,28 +5,28 @@

 package org.jetbrains.kotlin.analysis.api.fir

-import org.jetbrains.kotlin.analysis.api.fir.utils.libraries.binary.LibraryAnalysisApiTestConfiguratorService
-import org.jetbrains.kotlin.analysis.api.fir.utils.libraries.source.LibrarySourceAnalysisApiTestConfiguratorService
+import org.jetbrains.kotlin.analysis.api.fir.utils.libraries.binary.LibraryAnalysisApiTestConfigurator
+import org.jetbrains.kotlin.analysis.api.fir.utils.libraries.source.LibrarySourceAnalysisApiTestConfigurator
 import org.jetbrains.kotlin.analysis.test.framework.*

 object AnalysisApiFirTestConfiguratorFactory : AnalysisApiTestConfiguratorFactory() {
-    override fun createConfigurator(data: AnalysisApiTestConfiguratorFactoryData): AnalysisApiTestConfiguratorService {
+    override fun createConfigurator(data: AnalysisApiTestConfiguratorFactoryData): AnalysisApiTestConfigurator {
        require(supportMode(data))

        return when (data.moduleKind) {
            TestModuleKind.Source -> when (data.analysisSessionMode) {
-                AnalysisSessionMode.Normal -> FirAnalysisApiNormalModeTestConfiguratorService
-                AnalysisSessionMode.Dependent -> FirAnalysisApiDependentModeTestConfiguratorService
+                AnalysisSessionMode.Normal -> AnalysisApiFirTestConfigurator(analyseInDependentSession = false)
+                AnalysisSessionMode.Dependent -> AnalysisApiFirTestConfigurator(analyseInDependentSession = true)
            }

            TestModuleKind.LibraryBinary -> {
                require(data.analysisSessionMode == AnalysisSessionMode.Normal)
-                LibraryAnalysisApiTestConfiguratorService
+                LibraryAnalysisApiTestConfigurator
            }

            TestModuleKind.LibrarySource -> {
                require(data.analysisSessionMode == AnalysisSessionMode.Normal)
-                LibrarySourceAnalysisApiTestConfiguratorService
+                LibrarySourceAnalysisApiTestConfigurator
            }
        }
    }
@@ -1,64 +0,0 @@
-/*
- * Copyright 2010-2021 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.analysis.api.fir
-
-import com.intellij.mock.MockApplication
-import com.intellij.mock.MockProject
-import com.intellij.openapi.Disposable
-import com.intellij.openapi.vfs.impl.jar.CoreJarFileSystem
-import com.intellij.psi.search.GlobalSearchScope
-import org.jetbrains.kotlin.analysis.api.fir.utils.configureOptionalTestCompilerPlugin
-import org.jetbrains.kotlin.analysis.api.impl.base.references.HLApiReferenceProviderService
-import org.jetbrains.kotlin.analysis.low.level.api.fir.test.base.FirLowLevelAnalysisApiTestConfiguratorService
-import org.jetbrains.kotlin.analysis.project.structure.ProjectStructureProvider
-import org.jetbrains.kotlin.analysis.test.framework.AnalysisApiTestConfiguratorService
-import org.jetbrains.kotlin.config.CompilerConfiguration
-import org.jetbrains.kotlin.idea.references.KotlinFirReferenceContributor
-import org.jetbrains.kotlin.idea.references.KotlinReferenceProviderContributor
-import org.jetbrains.kotlin.load.kotlin.PackagePartProvider
-import org.jetbrains.kotlin.psi.KotlinReferenceProvidersService
-import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.test.builders.TestConfigurationBuilder
-
-open class FirAnalysisApiTestConfiguratorService(override val analyseInDependentSession: Boolean) : AnalysisApiTestConfiguratorService {
-    override fun TestConfigurationBuilder.configureTest(disposable: Disposable) {
-        with(FirLowLevelAnalysisApiTestConfiguratorService) { configureTest(disposable) }
-        configureOptionalTestCompilerPlugin()
-    }
-
-    override fun registerProjectServices(
-        project: MockProject,
-        compilerConfig: CompilerConfiguration,
-        files: List<KtFile>,
-        packagePartProvider: (GlobalSearchScope) -> PackagePartProvider,
-        projectStructureProvider: ProjectStructureProvider,
-        jarFileSystem: CoreJarFileSystem,
-    ) {
-        FirLowLevelAnalysisApiTestConfiguratorService.registerProjectServices(
-            project,
-            compilerConfig,
-            files,
-            packagePartProvider,
-            projectStructureProvider,
-            jarFileSystem
-        )
-    }
-
-    override fun registerApplicationServices(application: MockApplication) {
-        FirLowLevelAnalysisApiTestConfiguratorService.registerApplicationServices(application)
-        if (application.getServiceIfCreated(KotlinReferenceProvidersService::class.java) == null) {
-            application.registerService(KotlinReferenceProvidersService::class.java, HLApiReferenceProviderService::class.java)
-            application.registerService(KotlinReferenceProviderContributor::class.java, KotlinFirReferenceContributor::class.java)
-        }
-    }
-
-    override fun doOutOfBlockModification(file: KtFile) {
-        FirLowLevelAnalysisApiTestConfiguratorService.doOutOfBlockModification(file)
-    }
-}
-
-object FirAnalysisApiDependentModeTestConfiguratorService: FirAnalysisApiTestConfiguratorService(analyseInDependentSession = true)
-object FirAnalysisApiNormalModeTestConfiguratorService: FirAnalysisApiTestConfiguratorService(analyseInDependentSession = false)
@@ -1,29 +0,0 @@
-/*
- * Copyright 2010-2021 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.analysis.api.fir.components.importOptimizer
-
-import org.jetbrains.kotlin.analysis.test.framework.base.AbstractAnalysisApiBasedSingleModuleTest
-import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.test.model.TestModule
-import org.jetbrains.kotlin.test.services.TestServices
-import org.jetbrains.kotlin.test.services.assertions
-
-abstract class AbstractHLImportOptimizerTest : AbstractAnalysisApiBasedSingleModuleTest(){
-    override fun doTestByFileStructure(ktFiles: List<KtFile>, module: TestModule, testServices: TestServices) {
-        val mainKtFile = ktFiles.singleOrNull() ?: ktFiles.first { it.name == "main.kt" }
-        val unusedImports = analyseForTest(mainKtFile) { analyseImports(mainKtFile).unusedImports }
-
-        val unusedImportPaths = unusedImports
-            .map { it.importPath ?: error("Import $it should have an import path, instead was ${it.text}") }
-            .sortedBy { it.toString() } // for stable results
-
-        val actualUnusedImports = buildString {
-            unusedImportPaths.forEach(::appendLine)
-        }
-
-        testServices.assertions.assertEqualsToTestDataFileSibling(actualUnusedImports, extension = ".imports")
-    }
-}
@@ -1,31 +0,0 @@
-/*
- * Copyright 2010-2021 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.analysis.api.fir.components.psiTypeProvider
-
-import org.jetbrains.kotlin.analysis.api.analyse
-import org.jetbrains.kotlin.analysis.test.framework.services.expressionMarkerProvider
-import org.jetbrains.kotlin.analysis.test.framework.base.AbstractAnalysisApiSingleFileTest
-import org.jetbrains.kotlin.psi.KtExpression
-import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.test.model.TestModule
-import org.jetbrains.kotlin.test.services.TestServices
-import org.jetbrains.kotlin.test.services.assertions
-
-abstract class AbstractExpressionPsiTypeProviderTest : AbstractAnalysisApiSingleFileTest(){
-    override fun doTestByFileStructure(ktFile: KtFile, module: TestModule, testServices: TestServices) {
-        val declarationAtCaret = testServices.expressionMarkerProvider.getSelectedElement(ktFile) as KtExpression
-        val actual = analyse(ktFile) {
-            val returnType = declarationAtCaret.getKtType()
-                ?: error("Not a typable expression ${declarationAtCaret::class} ${declarationAtCaret.text}")
-            val psiType = returnType.asPsiType(declarationAtCaret)
-            buildString {
-                appendLine("KtType: ${returnType.render()}")
-                appendLine("PsiType: $psiType")
-            }
-        }
-        testServices.assertions.assertEqualsToTestDataFileSibling(actual)
-    }
-}
@@ -1,98 +0,0 @@
-/*
- * Copyright 2010-2021 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.analysis.api.fir.components.psiTypeProvider
-
-import com.intellij.openapi.project.Project
-import com.intellij.psi.PsiClass
-import com.intellij.psi.PsiElement
-import com.intellij.psi.PsiElementVisitor
-import org.jetbrains.kotlin.analysis.api.analyse
-import org.jetbrains.kotlin.analysis.test.framework.services.expressionMarkerProvider
-import org.jetbrains.kotlin.analysis.test.framework.base.AbstractAnalysisApiSingleFileTest
-import org.jetbrains.kotlin.asJava.KotlinAsJavaSupport
-import org.jetbrains.kotlin.asJava.classes.KtLightClass
-import org.jetbrains.kotlin.asJava.elements.KtLightElement
-import org.jetbrains.kotlin.light.classes.symbol.caches.SymbolLightClassFacadeCache
-import org.jetbrains.kotlin.name.Name
-import org.jetbrains.kotlin.psi.KtClassOrObject
-import org.jetbrains.kotlin.psi.KtDeclaration
-import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.psi.psiUtil.parents
-import org.jetbrains.kotlin.test.model.TestModule
-import org.jetbrains.kotlin.test.services.TestServices
-import org.jetbrains.kotlin.test.services.assertions
-import org.jetbrains.kotlin.utils.addToStdlib.firstIsInstanceOrNull
-
-abstract class AbstractPsiTypeProviderTest : AbstractAnalysisApiSingleFileTest(){
-    override fun doTestByFileStructure(ktFile: KtFile, module: TestModule, testServices: TestServices) {
-        val declaration = testServices.expressionMarkerProvider.getElementOfTypAtCaret<KtDeclaration>(ktFile)
-        val containingClass =
-            getContainingKtLightClass(declaration, ktFile)
-        val psiContext = containingClass.findLightDeclarationContext(declaration)
-            ?: error("Can't find psi context for $declaration")
-        val actual = buildString {
-            executeOnPooledThreadInReadAction {
-                analyse(declaration) {
-                    val ktType = declaration.getReturnKtType()
-                    appendLine("KtType: ${ktType.render()}")
-                    appendLine("PsiType: ${ktType.asPsiType(psiContext)}")
-                }
-            }
-        }
-        testServices.assertions.assertEqualsToTestDataFileSibling(actual)
-    }
-
-    private fun getContainingKtLightClass(
-        declaration: KtDeclaration,
-        ktFile: KtFile,
-    ): KtLightClass {
-        val project = ktFile.project
-        return createLightClassByContainingClass(declaration, project)
-            ?: getFacadeLightClass(ktFile, project)
-            ?: error("Can't get or create containing KtLightClass for $declaration")
-
-    }
-
-    private fun getFacadeLightClass(
-        ktFile: KtFile,
-        project: Project,
-    ): KtLightClass? {
-        val mainKtFileFqName = ktFile.packageFqName.child(Name.identifier(ktFile.name))
-        return project.getService(SymbolLightClassFacadeCache::class.java)
-            .getOrCreateSymbolLightFacade(listOf(ktFile), mainKtFileFqName)
-    }
-
-    private fun createLightClassByContainingClass(
-        declaration: KtDeclaration,
-        project: Project
-    ): KtLightClass? {
-        val containingClass = declaration.parents.firstIsInstanceOrNull<KtClassOrObject>() ?: return null
-        return project.getService(KotlinAsJavaSupport::class.java).getLightClass(containingClass)
-    }
-
-    private fun KtLightClass.findLightDeclarationContext(ktDeclaration: KtDeclaration): KtLightElement<*, *>? {
-        val selfOrParents = listOf(ktDeclaration) + ktDeclaration.parents.filterIsInstance<KtDeclaration>()
-        var result: KtLightElement<*, *>? = null
-        val visitor = object : PsiElementVisitor() {
-            override fun visitElement(element: PsiElement) {
-                if (element !is KtLightElement<*, *>) return
-                // NB: intentionally visit members first so that `self` can be found first if matched
-                if (element is PsiClass) {
-                    element.fields.forEach { it.accept(this) }
-                    element.methods.forEach { it.accept(this) }
-                    element.innerClasses.forEach { it.accept(this) }
-                }
-                if (result == null && element.kotlinOrigin in selfOrParents) {
-                    result = element
-                    return
-                }
-            }
-        }
-        accept(visitor)
-        return result
-    }
-
-}
@@ -1,73 +0,0 @@
-/*
- * Copyright 2010-2021 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.analysis.api.fir.utils.libraries.binary
-
-import com.intellij.ide.highlighter.JavaClassFileType
-import com.intellij.mock.MockApplication
-import com.intellij.mock.MockProject
-import com.intellij.openapi.Disposable
-import com.intellij.openapi.extensions.LoadingOrder
-import com.intellij.openapi.vfs.impl.jar.CoreJarFileSystem
-import com.intellij.psi.ClassFileViewProviderFactory
-import com.intellij.psi.FileTypeFileViewProviders
-import com.intellij.psi.compiled.ClassFileDecompilers
-import com.intellij.psi.search.GlobalSearchScope
-import org.jetbrains.kotlin.analysis.api.fir.FirAnalysisApiNormalModeTestConfiguratorService
-import org.jetbrains.kotlin.analysis.test.framework.AnalysisApiTestConfiguratorService
-import org.jetbrains.kotlin.analysis.decompiler.psi.KotlinBuiltInDecompiler
-import org.jetbrains.kotlin.analysis.decompiler.psi.KotlinClassFileDecompiler
-import org.jetbrains.kotlin.analysis.decompiler.stub.file.ClsKotlinBinaryClassCache
-import org.jetbrains.kotlin.analysis.decompiler.stub.file.FileAttributeService
-import org.jetbrains.kotlin.analysis.decompiler.stub.files.DummyFileAttributeService
-import org.jetbrains.kotlin.analysis.low.level.api.fir.compiler.based.registerTestServices
-import org.jetbrains.kotlin.analysis.project.structure.ProjectStructureProvider
-import org.jetbrains.kotlin.analysis.test.framework.services.libraries.LibraryEnvironmentConfigurator
-import org.jetbrains.kotlin.config.CompilerConfiguration
-import org.jetbrains.kotlin.load.kotlin.PackagePartProvider
-import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.test.builders.TestConfigurationBuilder
-
-object LibraryAnalysisApiTestConfiguratorService : AnalysisApiTestConfiguratorService {
-    override val analyseInDependentSession: Boolean get() = false
-
-    override fun TestConfigurationBuilder.configureTest(disposable: Disposable) {
-        useConfigurators(::LibraryEnvironmentConfigurator)
-        usePreAnalysisHandlers(::LibraryModuleRegistrarPreAnalysisHandler)
-    }
-
-    override fun registerProjectServices(
-        project: MockProject,
-        compilerConfig: CompilerConfiguration,
-        files: List<KtFile>,
-        packagePartProvider: (GlobalSearchScope) -> PackagePartProvider,
-        projectStructureProvider: ProjectStructureProvider,
-        jarFileSystem: CoreJarFileSystem,
-    ) {
-        project.registerTestServices(files, packagePartProvider, projectStructureProvider)
-    }
-
-    override fun registerApplicationServices(application: MockApplication) {
-        FirAnalysisApiNormalModeTestConfiguratorService.registerApplicationServices(application)
-        if (application.getServiceIfCreated(ClsKotlinBinaryClassCache::class.java) != null) return
-        application.registerService(ClsKotlinBinaryClassCache::class.java)
-        application.registerService(FileAttributeService::class.java, DummyFileAttributeService)
-
-        FileTypeFileViewProviders.INSTANCE.addExplicitExtension(
-            JavaClassFileType.INSTANCE,
-            ClassFileViewProviderFactory()
-        )
-
-        @Suppress("DEPRECATION")
-        ClassFileDecompilers.getInstance().EP_NAME.point.apply {
-            registerExtension(KotlinClassFileDecompiler(), LoadingOrder.FIRST)
-            registerExtension(KotlinBuiltInDecompiler(), LoadingOrder.FIRST)
-        }
-    }
-
-    override fun doOutOfBlockModification(file: KtFile) {
-        FirAnalysisApiNormalModeTestConfiguratorService.doOutOfBlockModification(file)
-    }
-}
@@ -1,52 +0,0 @@
-/*
- * Copyright 2010-2021 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.analysis.api.fir.utils.libraries.source
-
-import com.intellij.mock.MockApplication
-import com.intellij.mock.MockProject
-import com.intellij.openapi.Disposable
-import com.intellij.openapi.vfs.impl.jar.CoreJarFileSystem
-import com.intellij.psi.search.GlobalSearchScope
-import org.jetbrains.kotlin.analysis.api.fir.FirAnalysisApiNormalModeTestConfiguratorService
-import org.jetbrains.kotlin.analysis.test.framework.AnalysisApiTestConfiguratorService
-import org.jetbrains.kotlin.analysis.low.level.api.fir.compiler.based.registerTestServices
-import org.jetbrains.kotlin.analysis.project.structure.ProjectStructureProvider
-import org.jetbrains.kotlin.analysis.test.framework.services.libraries.CompiledLibraryProvider
-import org.jetbrains.kotlin.analysis.test.framework.services.libraries.LibraryEnvironmentConfigurator
-import org.jetbrains.kotlin.config.CompilerConfiguration
-import org.jetbrains.kotlin.load.kotlin.PackagePartProvider
-import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.test.builders.TestConfigurationBuilder
-import org.jetbrains.kotlin.test.services.ServiceRegistrationData
-
-object LibrarySourceAnalysisApiTestConfiguratorService : AnalysisApiTestConfiguratorService {
-    override val analyseInDependentSession: Boolean get() = false
-
-    override fun TestConfigurationBuilder.configureTest(disposable: Disposable) {
-        useConfigurators(::LibraryEnvironmentConfigurator)
-        usePreAnalysisHandlers(::LibrarySourceModuleRegistrarPreAnalysisHandler)
-        useAdditionalServices(ServiceRegistrationData(CompiledLibraryProvider::class, ::CompiledLibraryProvider))
-    }
-
-    override fun registerProjectServices(
-        project: MockProject,
-        compilerConfig: CompilerConfiguration,
-        files: List<KtFile>,
-        packagePartProvider: (GlobalSearchScope) -> PackagePartProvider,
-        projectStructureProvider: ProjectStructureProvider,
-        jarFileSystem: CoreJarFileSystem,
-    ) {
-        project.registerTestServices(files, packagePartProvider, projectStructureProvider)
-    }
-
-    override fun registerApplicationServices(application: MockApplication) {
-        FirAnalysisApiNormalModeTestConfiguratorService.registerApplicationServices(application)
-    }
-
-    override fun doOutOfBlockModification(file: KtFile) {
-        FirAnalysisApiNormalModeTestConfiguratorService.doOutOfBlockModification(file)
-    }
-}