[Analysis API] AbstractAnalysisApiBasedTest: introduce entry point for tests with main file

Pulled up the implementation from AbstractCompilerFacilityTest

^KT-64805

analysis/analysis-api-impl-base/tests/org/jetbrains/kotlin/analysis/api/impl/base/test/cases/components/compilerFacility/AbstractCompilerFacilityTest.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Copyright 2010-2024 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.
  */
 
@@ -14,7 +14,6 @@ import org.jetbrains.kotlin.analysis.api.components.KtCompilerTarget
 import org.jetbrains.kotlin.analysis.api.diagnostics.KtDiagnostic
 import org.jetbrains.kotlin.analysis.api.diagnostics.KtDiagnosticWithPsi
 import org.jetbrains.kotlin.analysis.test.framework.base.AbstractAnalysisApiBasedTest
-import org.jetbrains.kotlin.analysis.test.framework.project.structure.ktModuleProvider
 import org.jetbrains.kotlin.analysis.test.framework.services.expressionMarkerProvider
 import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension
 import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext
@@ -37,7 +36,6 @@ import org.jetbrains.kotlin.test.directives.JvmEnvironmentConfigurationDirective
 import org.jetbrains.kotlin.test.directives.model.SimpleDirectivesContainer
 import org.jetbrains.kotlin.test.model.TestModule
 import org.jetbrains.kotlin.test.services.EnvironmentConfigurator
-import org.jetbrains.kotlin.test.services.TestModuleStructure
 import org.jetbrains.kotlin.test.services.TestServices
 import org.jetbrains.kotlin.test.services.assertions
 import org.jetbrains.org.objectweb.asm.ClassReader
@@ -68,16 +66,14 @@ abstract class AbstractCompilerFacilityTest : AbstractAnalysisApiBasedTest() {
         ).map { it.name }
     }
 
-    override fun doTestByModuleStructure(moduleStructure: TestModuleStructure, testServices: TestServices) {
-        val (mainModule, ktFile) = findTargetFile(moduleStructure, testServices)
-
+    override fun doTestByMainModule(mainFile: KtFile, mainModule: TestModule, testServices: TestServices) {
         val irCollector = CollectingIrGenerationExtension()
 
-        val project = ktFile.project
+        val project = mainFile.project
         project.extensionArea.getExtensionPoint(IrGenerationExtension.extensionPointName)
             .registerExtension(irCollector, LoadingOrder.LAST, project)
 
-        val ktCodeFragment = createCodeFragment(ktFile, mainModule, testServices)
+        val ktCodeFragment = createCodeFragment(mainFile, mainModule, testServices)
         if (ktCodeFragment != null) {
             for (importNameString in mainModule.directives[Directives.CODE_FRAGMENT_IMPORT]) {
                 ktCodeFragment.addImport("import $importNameString")
@@ -96,7 +92,7 @@ abstract class AbstractCompilerFacilityTest : AbstractAnalysisApiBasedTest() {
                 ?.let { put(KtCompilerFacility.CODE_FRAGMENT_METHOD_NAME, it) }
         }
 
-        val ktTargetFile = ktCodeFragment ?: ktFile
+        val ktTargetFile = ktCodeFragment ?: mainFile
 
         analyze(ktTargetFile) {
             val target = KtCompilerTarget.Jvm(ClassBuilderFactories.TEST)
@@ -117,28 +113,6 @@ abstract class AbstractCompilerFacilityTest : AbstractAnalysisApiBasedTest() {
         }
     }
 
-    private fun findTargetFile(moduleStructure: TestModuleStructure, testServices: TestServices): Pair<TestModule, KtFile> {
-        if (moduleStructure.modules.size == 1) {
-            val testModule = moduleStructure.modules.single()
-            val psiFiles = testServices.ktModuleProvider.getModuleFiles(testModule)
-            val ktFiles = psiFiles.filterIsInstance<KtFile>()
-            if (ktFiles.size == 1) {
-                // In simpler whole-file compilation tests, do not require the '<caret>'
-                return testModule to ktFiles.single()
-            }
-        }
-
-        for (testModule in moduleStructure.modules) {
-            for (psiFile in testServices.ktModuleProvider.getModuleFiles(testModule)) {
-                if (psiFile is KtFile && testServices.expressionMarkerProvider.getCaretPositionOrNull(psiFile) != null) {
-                    return testModule to psiFile
-                }
-            }
-        }
-
-        error("Cannot find the main test file")
-    }
-
     override fun configureTest(builder: TestConfigurationBuilder) {
         super.configureTest(builder)
         with(builder) {

analysis/analysis-test-framework/tests/org/jetbrains/kotlin/analysis/test/framework/base/AbstractAnalysisApiBasedTest.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2022 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Copyright 2010-2024 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.
  */
 
@@ -35,6 +35,7 @@ import org.jetbrains.kotlin.test.directives.JvmEnvironmentConfigurationDirective
 import org.jetbrains.kotlin.test.model.DependencyKind
 import org.jetbrains.kotlin.test.model.FrontendKinds
 import org.jetbrains.kotlin.test.model.ResultingArtifact
+import org.jetbrains.kotlin.test.model.TestModule
 import org.jetbrains.kotlin.test.runners.AbstractKotlinCompilerTest
 import org.jetbrains.kotlin.test.services.*
 import org.jetbrains.kotlin.test.services.impl.TemporaryDirectoryManagerImpl
@@ -47,6 +48,9 @@ import java.nio.file.Paths
 import kotlin.io.path.exists
 import kotlin.io.path.nameWithoutExtension
 
+/**
+ * [doTestByMainModule] or [doTestByModuleStructure] should be overridden
+ */
 abstract class AbstractAnalysisApiBasedTest : TestWithDisposable() {
     abstract val configurator: AnalysisApiTestConfigurator
 
@@ -67,7 +71,38 @@ abstract class AbstractAnalysisApiBasedTest : TestWithDisposable() {
         configurator.configureTest(builder, disposable)
     }
 
-    protected abstract fun doTestByModuleStructure(moduleStructure: TestModuleStructure, testServices: TestServices)
+    protected open fun doTestByModuleStructure(moduleStructure: TestModuleStructure, testServices: TestServices) {
+        val (mainFile, mainModule) = findMainFile(moduleStructure, testServices)
+        doTestByMainModule(mainFile, mainModule, testServices)
+    }
+
+    protected open fun doTestByMainModule(mainFile: KtFile, mainModule: TestModule, testServices: TestServices) {
+        throw UnsupportedOperationException("The test case is not fully implemented. '${::doTestByMainModule.name}' or '${::doTestByModuleStructure.name}' should be overridden")
+    }
+
+    private fun findMainFile(moduleStructure: TestModuleStructure, testServices: TestServices): Pair<KtFile, TestModule> {
+        val moduleProvider = testServices.ktModuleProvider
+        if (moduleStructure.modules.size == 1) {
+            val testModule = moduleStructure.modules.single()
+            val psiFiles = moduleProvider.getModuleFiles(testModule)
+            val ktFiles = psiFiles.filterIsInstance<KtFile>()
+            if (ktFiles.size == 1) {
+                // In simpler whole-file compilation tests, do not require the '<caret>'
+                return ktFiles.single() to testModule
+            }
+        }
+
+        val expressionMarkerProvider = testServices.expressionMarkerProvider
+        for (testModule in moduleStructure.modules) {
+            for (psiFile in moduleProvider.getModuleFiles(testModule)) {
+                if (psiFile is KtFile && expressionMarkerProvider.getCaretPositionOrNull(psiFile) != null) {
+                    return psiFile to testModule
+                }
+            }
+        }
+
+        error("Cannot find the main test file")
+    }
 
     protected fun AssertionsService.assertEqualsToTestDataFileSibling(
         actual: String,