Refactor everything related to codegen

Author: EgorkaKulikov

HowToUseLoggers.md

@@ -18,7 +18,7 @@ The file is usually in the resource folder.
 
 The easiest way is:
 
-- Go in the code that you are going to debug. Let’s assume it is a method in org.utbot.framework.plugin.api.UtBotTestCaseGenerator.
+- Go in the code that you are going to debug. Let’s assume it is a method in org.utbot.framework.plugin.api.TestCaseGenerator.
 - Find out if there is a KotlinLogging object that is used to create a **logger**
 - If such a logger exists, use the fully qualified class name as the logger name in the next steps
 <br/>
@@ -28,7 +28,7 @@ The easiest way is:
 Open log4j2.xml and add the logger in the loggers section like this
 
 ```
-<Logger name=" org.utbot.framework.plugin.api.UtBotTestCaseGenerator " level="info">
+<Logger name=" org.utbot.framework.plugin.api.TestCaseGenerator " level="info">
     <AppenderRef ref="Console"/>
 </Logger>
 ```

utbot-analytics/src/test/kotlin/org/utbot/features/FeatureProcessorWithRepetitionTest.kt

@@ -5,13 +5,13 @@ import org.junit.jupiter.api.Assertions
 import org.junit.jupiter.api.BeforeAll
 import org.junit.jupiter.api.Test
 import org.utbot.analytics.EngineAnalyticsContext
-import org.utbot.examples.AbstractTestCaseGeneratorTest
+import org.utbot.examples.UtTestCaseChecker
 import org.utbot.examples.eq
 import org.utbot.examples.withFeaturePath
 import java.io.File
 import java.io.FileInputStream
 
-class FeatureProcessorWithRepetitionTest : AbstractTestCaseGeneratorTest(OnePath::class, false) {
+class FeatureProcessorWithRepetitionTest : UtTestCaseChecker(OnePath::class, false) {
     companion object {
         const val featureDir = "src/test/resources/features"
         fun reward(coverage: Double, time: Double) = RewardEstimator.reward(coverage, time)

utbot-cli/src/main/kotlin/org/utbot/cli/GenerateTestsAbstractCommand.kt

@@ -8,6 +8,7 @@ import com.github.ajalt.clikt.parameters.options.option
 import com.github.ajalt.clikt.parameters.options.unique
 import com.github.ajalt.clikt.parameters.types.choice
 import com.github.ajalt.clikt.parameters.types.long
+import mu.KotlinLogging
 import org.utbot.common.PathUtil.classFqnToPath
 import org.utbot.common.PathUtil.replaceSeparator
 import org.utbot.common.PathUtil.toPath
@@ -19,14 +20,13 @@ import org.utbot.framework.codegen.ForceStaticMocking
 import org.utbot.framework.codegen.MockitoStaticMocking
 import org.utbot.framework.codegen.NoStaticMocking
 import org.utbot.framework.codegen.StaticsMocking
-import org.utbot.framework.codegen.model.ModelBasedTestCodeGenerator
+import org.utbot.framework.codegen.model.CodeGenerator
 import org.utbot.framework.codegen.testFrameworkByName
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.CodegenLanguage
-import org.utbot.framework.plugin.api.MockFramework
 import org.utbot.framework.plugin.api.MockStrategyApi
 import org.utbot.framework.plugin.api.TreatOverflowAsError
-import org.utbot.framework.plugin.api.UtBotTestCaseGenerator
+import org.utbot.framework.plugin.api.TestCaseGenerator
 import org.utbot.framework.plugin.api.UtMethod
 import org.utbot.framework.plugin.api.UtTestCase
 import org.utbot.summary.summarize
@@ -41,7 +41,6 @@ import java.time.temporal.ChronoUnit
 import kotlin.reflect.KCallable
 import kotlin.reflect.KClass
 import kotlin.reflect.jvm.kotlinFunction
-import mu.KotlinLogging
 
 private const val LONG_GENERATION_TIMEOUT = 1_200_000L
 
@@ -160,7 +159,7 @@ abstract class GenerateTestsAbstractCommand(name: String, help: String) :
         searchDirectory: Path,
         chosenClassesToMockAlways: Set<ClassId>
     ): List<UtTestCase> =
-        UtBotTestCaseGenerator.generateForSeveralMethods(
+        TestCaseGenerator.generateTestCases(
             targetMethods,
             mockStrategy,
             chosenClassesToMockAlways,
@@ -199,21 +198,20 @@ abstract class GenerateTestsAbstractCommand(name: String, help: String) :
         // Set UtSettings parameters.
         UtSettings.treatOverflowAsError = treatOverflowAsError == TreatOverflowAsError.AS_ERROR
 
-        UtBotTestCaseGenerator.init(workingDirectory, classPathNormalized, System.getProperty("java.class.path")) { false }
+        TestCaseGenerator.init(workingDirectory, classPathNormalized, System.getProperty("java.class.path"))
     }
 
-    private fun initializeCodeGenerator(testFramework: String, classUnderTest: KClass<*>): ModelBasedTestCodeGenerator {
+    private fun initializeCodeGenerator(testFramework: String, classUnderTest: KClass<*>): CodeGenerator {
         val generateWarningsForStaticMocking =
             forceStaticMocking == ForceStaticMocking.FORCE && staticsMocking is NoStaticMocking
-        return ModelBasedTestCodeGenerator().apply {
+        return CodeGenerator().apply {
             init(
                 testFramework = testFrameworkByName(testFramework),
                 classUnderTest = classUnderTest.java,
-                mockFramework = MockFramework.MOCKITO, // TODO: rewrite default mock framework system
                 codegenLanguage = codegenLanguage,
                 staticsMocking = staticsMocking,
                 forceStaticMocking = forceStaticMocking,
-                generateWarningsForStaticMocking = generateWarningsForStaticMocking
+                generateWarningsForStaticMocking = generateWarningsForStaticMocking,
             )
         }
     }

utbot-framework-api/src/main/kotlin/org/utbot/framework/plugin/api/Api.kt

@@ -33,16 +33,6 @@ import org.utbot.framework.plugin.api.util.primitiveTypeJvmNameOrNull
 import org.utbot.framework.plugin.api.util.shortClassId
 import org.utbot.framework.plugin.api.util.toReferenceTypeBytecodeSignature
 import org.utbot.framework.plugin.api.util.voidClassId
-import java.io.File
-import java.lang.reflect.Modifier
-import java.nio.file.Path
-import kotlin.jvm.internal.CallableReference
-import kotlin.reflect.KCallable
-import kotlin.reflect.KClass
-import kotlin.reflect.KFunction
-import kotlin.reflect.full.instanceParameter
-import kotlin.reflect.jvm.javaConstructor
-import kotlin.reflect.jvm.javaType
 import soot.ArrayType
 import soot.BooleanType
 import soot.ByteType
@@ -58,6 +48,15 @@ import soot.Type
 import soot.VoidType
 import soot.jimple.JimpleBody
 import soot.jimple.Stmt
+import java.io.File
+import java.lang.reflect.Modifier
+import kotlin.jvm.internal.CallableReference
+import kotlin.reflect.KCallable
+import kotlin.reflect.KClass
+import kotlin.reflect.KFunction
+import kotlin.reflect.full.instanceParameter
+import kotlin.reflect.jvm.javaConstructor
+import kotlin.reflect.jvm.javaType
 
 data class UtMethod<R>(
     val callable: KCallable<R>,
@@ -1024,17 +1023,6 @@ open class TypeParameters(val parameters: List<ClassId> = emptyList())
 
 class WildcardTypeParameter: TypeParameters(emptyList())
 
-interface TestCaseGenerator {
-    fun init(
-        buildDir: Path,
-        classpath: String? = null,
-        dependencyPaths: String,
-        isCanceled: () -> Boolean = { false }
-    )
-
-    fun generate(method: UtMethod<*>, mockStrategy: MockStrategyApi): UtTestCase
-}
-
 interface CodeGenerationSettingItem {
     val displayName: String
     val description: String
@@ -1193,13 +1181,6 @@ fun isolateCommandLineArgumentsToArgumentFile(arguments: List<String>): String {
     return argumentFile.absolutePath.let { "@$it" }
 }
 
-interface UtService<T> {
-    val displayName: String
-    val serviceProvider: T
-}
-
-interface TestGeneratorService : UtService<TestCaseGenerator>
-
 private fun StringBuilder.appendOptional(name: String, value: Collection<*>) {
     if (value.isNotEmpty()) {
         append(", $name=$value")

utbot-framework/src/main/kotlin/org/utbot/engine/CollectionWrappers.kt

@@ -10,7 +10,6 @@ import org.utbot.engine.overrides.collections.UtHashSet
 import org.utbot.engine.overrides.collections.UtLinkedList
 import org.utbot.engine.pc.UtAddrExpression
 import org.utbot.engine.pc.UtExpression
-import org.utbot.engine.pc.UtFalse
 import org.utbot.engine.pc.select
 import org.utbot.engine.symbolic.asHardConstraint
 import org.utbot.engine.z3.intValue
@@ -26,7 +25,7 @@ import org.utbot.framework.plugin.api.UtNullModel
 import org.utbot.framework.plugin.api.UtReferenceModel
 import org.utbot.framework.plugin.api.UtStatementModel
 import org.utbot.framework.plugin.api.classId
-import org.utbot.framework.plugin.api.graph
+import org.utbot.framework.util.graph
 import org.utbot.framework.plugin.api.id
 import org.utbot.framework.plugin.api.util.booleanClassId
 import org.utbot.framework.plugin.api.util.constructorId

utbot-framework/src/main/kotlin/org/utbot/engine/Traverser.kt

@@ -89,13 +89,13 @@ import org.utbot.framework.plugin.api.FieldId
 import org.utbot.framework.plugin.api.MethodId
 import org.utbot.framework.plugin.api.UtMethod
 import org.utbot.framework.plugin.api.classId
-import org.utbot.framework.plugin.api.graph
 import org.utbot.framework.plugin.api.id
 import org.utbot.framework.plugin.api.util.id
 import org.utbot.framework.plugin.api.util.jClass
 import org.utbot.framework.plugin.api.util.signature
 import org.utbot.framework.plugin.api.util.utContext
 import org.utbot.framework.util.executableId
+import org.utbot.framework.util.graph
 import java.lang.reflect.ParameterizedType
 import kotlin.collections.plus
 import kotlin.collections.plusAssign

utbot-framework/src/main/kotlin/org/utbot/engine/UtBotSymbolicEngine.kt

@@ -72,13 +72,13 @@ import org.utbot.framework.plugin.api.UtMethod
 import org.utbot.framework.plugin.api.UtNullModel
 import org.utbot.framework.plugin.api.UtOverflowFailure
 import org.utbot.framework.plugin.api.UtResult
-import org.utbot.framework.plugin.api.graph
-import org.utbot.framework.plugin.api.jimpleBody
+import org.utbot.framework.util.graph
 import org.utbot.framework.plugin.api.onSuccess
 import org.utbot.framework.plugin.api.util.executableId
 import org.utbot.framework.plugin.api.util.id
 import org.utbot.framework.plugin.api.util.utContext
 import org.utbot.framework.plugin.api.util.description
+import org.utbot.framework.util.jimpleBody
 import org.utbot.fuzzer.FallbackModelProvider
 import org.utbot.fuzzer.FuzzedMethodDescription
 import org.utbot.fuzzer.FuzzedValue

utbot-framework/src/main/kotlin/org/utbot/external/api/UtBotJavaApi.kt

@@ -8,15 +8,15 @@ import org.utbot.framework.codegen.Junit5
 import org.utbot.framework.codegen.NoStaticMocking
 import org.utbot.framework.codegen.StaticsMocking
 import org.utbot.framework.codegen.TestFramework
-import org.utbot.framework.codegen.model.ModelBasedCodeGeneratorService
+import org.utbot.framework.codegen.model.CodeGenerator
 import org.utbot.framework.concrete.UtConcreteExecutionData
 import org.utbot.framework.concrete.UtConcreteExecutionResult
 import org.utbot.framework.concrete.UtExecutionInstrumentation
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.CodegenLanguage
 import org.utbot.framework.plugin.api.MockFramework
 import org.utbot.framework.plugin.api.MockStrategyApi
-import org.utbot.framework.plugin.api.UtBotTestCaseGenerator
+import org.utbot.framework.plugin.api.TestCaseGenerator
 import org.utbot.framework.plugin.api.UtExecution
 import org.utbot.framework.plugin.api.UtMethod
 import org.utbot.framework.plugin.api.UtPrimitiveModel
@@ -81,10 +81,9 @@ object UtBotJavaApi {
         }
 
         return withUtContext(utContext) {
-            val testGenerator = ModelBasedCodeGeneratorService().serviceProvider.apply {
+            val testGenerator = CodeGenerator().apply {
                 init(
                     classUnderTest = classUnderTest,
-                    params = mutableMapOf(),
                     testFramework = testFramework,
                     mockFramework = mockFramework,
                     codegenLanguage = codegenLanguage,
@@ -122,13 +121,13 @@ object UtBotJavaApi {
         val testCases: MutableList<UtTestCase> = mutableListOf()
 
         testCases.addAll(withUtContext(utContext) {
-            UtBotTestCaseGenerator
+            TestCaseGenerator
                 .apply {
                     init(
                         FileUtil.isolateClassFiles(classUnderTest.kotlin).toPath(), classpath, dependencyClassPath
                     )
                 }
-                .generateForSeveralMethods(
+                .generateTestCases(
                     methodsForAutomaticGeneration.map {
                         toUtMethod(
                             it.methodToBeTestedFromUserInput,
@@ -187,12 +186,12 @@ object UtBotJavaApi {
         }
 
         return withUtContext(UtContext(classUnderTest.classLoader)) {
-            UtBotTestCaseGenerator
+            TestCaseGenerator
                 .apply {
                     init(
                         FileUtil.isolateClassFiles(classUnderTest.kotlin).toPath(), classpath, dependencyClassPath
                     )
-                }.generateForSeveralMethods(
+                }.generateTestCases(
                     methodsForAutomaticGeneration.map {
                         toUtMethod(
                             it.methodToBeTestedFromUserInput,

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/CodeGeneratorService.kt

@@ -1,15 +1,15 @@
 package org.utbot.framework.codegen.model
 
+import org.utbot.common.packageName
 import org.utbot.framework.codegen.ForceStaticMocking
 import org.utbot.framework.codegen.HangingTestsTimeout
 import org.utbot.framework.codegen.ParametrizedTestSource
 import org.utbot.framework.codegen.RuntimeExceptionTestsBehaviour
 import org.utbot.framework.codegen.StaticsMocking
-import org.utbot.framework.codegen.TestCodeGenerator
 import org.utbot.framework.codegen.TestFramework
-import org.utbot.framework.codegen.TestsCodeWithTestReport
 import org.utbot.framework.codegen.model.constructor.context.CgContext
 import org.utbot.framework.codegen.model.constructor.tree.CgTestClassConstructor
+import org.utbot.framework.codegen.model.constructor.tree.TestsGenerationReport
 import org.utbot.framework.codegen.model.tree.CgTestClassFile
 import org.utbot.framework.codegen.model.visitor.CgAbstractRenderer
 import org.utbot.framework.plugin.api.CodegenLanguage
@@ -18,23 +18,23 @@ import org.utbot.framework.plugin.api.UtMethod
 import org.utbot.framework.plugin.api.UtTestCase
 import org.utbot.framework.plugin.api.util.id
 
-class ModelBasedTestCodeGenerator : TestCodeGenerator {
+class CodeGenerator {
     private lateinit var context: CgContext
 
-    override fun init(
+    fun init(
         classUnderTest: Class<*>,
-        params: MutableMap<UtMethod<*>, List<String>>,
-        testFramework: TestFramework,
-        mockFramework: MockFramework?,
-        staticsMocking: StaticsMocking,
-        forceStaticMocking: ForceStaticMocking,
-        generateWarningsForStaticMocking: Boolean,
-        codegenLanguage: CodegenLanguage,
-        parameterizedTestSource: ParametrizedTestSource,
-        runtimeExceptionTestsBehaviour: RuntimeExceptionTestsBehaviour,
-        hangingTestsTimeout: HangingTestsTimeout,
-        enableTestsTimeout: Boolean,
-        testClassPackageName: String
+        params: MutableMap<UtMethod<*>, List<String>> = mutableMapOf(),
+        testFramework: TestFramework = TestFramework.defaultItem,
+        mockFramework: MockFramework? = MockFramework.defaultItem,
+        staticsMocking: StaticsMocking = StaticsMocking.defaultItem,
+        forceStaticMocking: ForceStaticMocking = ForceStaticMocking.defaultItem,
+        generateWarningsForStaticMocking: Boolean = true,
+        codegenLanguage: CodegenLanguage = CodegenLanguage.defaultItem,
+        parameterizedTestSource: ParametrizedTestSource = ParametrizedTestSource.defaultItem,
+        runtimeExceptionTestsBehaviour: RuntimeExceptionTestsBehaviour = RuntimeExceptionTestsBehaviour.defaultItem,
+        hangingTestsTimeout: HangingTestsTimeout = HangingTestsTimeout(),
+        enableTestsTimeout: Boolean = true,
+        testClassPackageName: String = classUnderTest.packageName,
     ) {
         context = CgContext(
             classUnderTest = classUnderTest.id,
@@ -56,13 +56,13 @@ class ModelBasedTestCodeGenerator : TestCodeGenerator {
     }
 
     //TODO: we support custom test class name only in utbot-online, probably support them in plugin as well
-    override fun generateAsString(testCases: Collection<UtTestCase>, testClassCustomName: String?): String =
+    fun generateAsString(testCases: Collection<UtTestCase>, testClassCustomName: String? = null): String =
         generateAsStringWithTestReport(testCases, testClassCustomName).generatedCode
 
     //TODO: we support custom test class name only in utbot-online, probably support them in plugin as well
-    override fun generateAsStringWithTestReport(
+    fun generateAsStringWithTestReport(
         testCases: Collection<UtTestCase>,
-        testClassCustomName: String?
+        testClassCustomName: String? = null,
     ): TestsCodeWithTestReport =
             withCustomContext(testClassCustomName) {
                 context.withClassScope {
@@ -95,3 +95,6 @@ class ModelBasedTestCodeGenerator : TestCodeGenerator {
         return renderer.toString()
     }
 }
+
+data class TestsCodeWithTestReport(val generatedCode: String, val testsGenerationReport: TestsGenerationReport)
+