Separate CgClassFile and TestsGenerationReport (#1345)

EgorkaKulikov · web-flow · commit d554c3ce63ca · 2022-11-15T12:20:27.000+03:00
Refactor CgClassFile, remove report from it
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/CodeGenerator.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/CodeGenerator.kt
@@ -81,11 +81,13 @@ open class CodeGenerator(
     ): CodeGeneratorResult = withCustomContext(testClassCustomName) {
         context.withTestClassFileScope {
             val testClassModel = TestClassModel.fromTestSets(classUnderTest, cgTestSets)
-            val testClassFile = CgTestClassConstructor(context).construct(testClassModel)
+            val cgClassConstructor = CgTestClassConstructor(context)
+            val testClassFile = cgClassConstructor.construct(testClassModel)
+
             CodeGeneratorResult(
                 generatedCode = renderClassFile(testClassFile),
                 utilClassKind = UtilClassKind.fromCgContextOrNull(context),
-                testsGenerationReport = testClassFile.testsGenerationReport
+                testsGenerationReport = cgClassConstructor.testsGenerationReport
             )
         }
     }
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/constructor/tree/CgTestClassConstructor.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/constructor/tree/CgTestClassConstructor.kt
@@ -21,16 +21,16 @@ import org.utbot.framework.codegen.model.tree.CgRegion
 import org.utbot.framework.codegen.model.tree.CgSimpleRegion
 import org.utbot.framework.codegen.model.tree.CgStaticsRegion
 import org.utbot.framework.codegen.model.tree.CgClass
+import org.utbot.framework.codegen.model.tree.CgClassFile
 import org.utbot.framework.codegen.model.tree.CgRealNestedClassesRegion
-import org.utbot.framework.codegen.model.tree.CgTestClassFile
 import org.utbot.framework.codegen.model.tree.CgTestMethod
 import org.utbot.framework.codegen.model.tree.CgTestMethodCluster
 import org.utbot.framework.codegen.model.tree.CgTripleSlashMultilineComment
 import org.utbot.framework.codegen.model.tree.CgUtilEntity
 import org.utbot.framework.codegen.model.tree.CgUtilMethod
 import org.utbot.framework.codegen.model.tree.buildClass
 import org.utbot.framework.codegen.model.tree.buildClassBody
-import org.utbot.framework.codegen.model.tree.buildTestClassFile
+import org.utbot.framework.codegen.model.tree.buildClassFile
 import org.utbot.framework.codegen.model.visitor.importUtilMethodDependencies
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.MethodId
@@ -53,16 +53,15 @@ open class CgTestClassConstructor(val context: CgContext) :
     private val nameGenerator = getNameGeneratorBy(context)
     private val testFrameworkManager = getTestFrameworkManagerBy(context)
 
-    protected val testsGenerationReport: TestsGenerationReport = TestsGenerationReport()
+    val testsGenerationReport = TestsGenerationReport()
 
     /**
      * Given a testClass model  constructs CgTestClass
      */
-    open fun construct(testClassModel: TestClassModel): CgTestClassFile {
-        return buildTestClassFile {
+    open fun construct(testClassModel: TestClassModel): CgClassFile {
+        return buildClassFile {
             this.declaredClass = withTestClassScope { constructTestClass(testClassModel) }
             imports += context.collectedImports
-            testsGenerationReport = this@CgTestClassConstructor.testsGenerationReport
         }
     }
 
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/tree/Builders.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/tree/Builders.kt
@@ -21,16 +21,6 @@ class CgClassFileBuilder : CgBuilder<CgClassFile> {
 
 fun buildClassFile(init: CgClassFileBuilder.() -> Unit) = CgClassFileBuilder().apply(init).build()
 
-class CgTestClassFileBuilder : CgBuilder<CgTestClassFile> {
-    val imports: MutableList<Import> = mutableListOf()
-    lateinit var declaredClass: CgClass
-    lateinit var testsGenerationReport: TestsGenerationReport
-
-    override fun build() = CgTestClassFile(imports, declaredClass, testsGenerationReport)
-}
-
-fun buildTestClassFile(init: CgTestClassFileBuilder.() -> Unit) = CgTestClassFileBuilder().apply(init).build()
-
 class CgClassBuilder : CgBuilder<CgClass> {
     lateinit var id: ClassId
     val annotations: MutableList<CgAnnotation> = mutableListOf()
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/tree/CgElement.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/tree/CgElement.kt
@@ -36,7 +36,6 @@ interface CgElement {
     // TODO: order of cases is important here due to inheritance between some of the element types
     fun <R> accept(visitor: CgVisitor<R>): R = visitor.run {
         when (val element = this@CgElement) {
-            is CgTestClassFile -> visit(element)
             is CgClassFile -> visit(element)
             is CgClass -> visit(element)
             is CgClassBody -> visit(element)
@@ -125,12 +124,6 @@ open class CgClassFile(
     open val declaredClass: CgClass,
 ): CgElement
 
-data class CgTestClassFile(
-    override val imports: List<Import>,
-    override val declaredClass: CgClass,
-    val testsGenerationReport: TestsGenerationReport
-) : CgClassFile(imports, declaredClass)
-
 class CgClass(
     val id: ClassId,
     val annotations: List<CgAnnotation>,
diff --git a/utbot-js/src/main/kotlin/codegen/JsCodeGenerator.kt b/utbot-js/src/main/kotlin/codegen/JsCodeGenerator.kt
@@ -14,7 +14,6 @@ import org.utbot.framework.codegen.model.constructor.CgMethodTestSet
 import org.utbot.framework.codegen.model.constructor.TestClassModel
 import org.utbot.framework.codegen.model.constructor.context.CgContext
 import org.utbot.framework.codegen.model.constructor.tree.CgTestClassConstructor
-import org.utbot.framework.codegen.model.tree.CgTestClassFile
 import org.utbot.framework.codegen.model.visitor.CgAbstractRenderer
 import org.utbot.framework.plugin.api.CodegenLanguage
 import org.utbot.framework.plugin.api.ExecutableId
@@ -78,7 +77,7 @@ class JsCodeGenerator(
         }
     }
 
-    private fun renderClassFile(file: CgTestClassFile): String {
+    private fun renderClassFile(file: CgClassFile): String {
         val renderer = CgAbstractRenderer.makeRenderer(context)
         file.accept(renderer)
         return renderer.toString()
diff --git a/utbot-python/src/main/kotlin/org/utbot/python/framework/codegen/model/PythonCodeGenerator.kt b/utbot-python/src/main/kotlin/org/utbot/python/framework/codegen/model/PythonCodeGenerator.kt
@@ -66,8 +66,10 @@ class PythonCodeGenerator(
         context.withTestClassFileScope {
             val testClassModel = TestClassModel(classUnderTest, cgTestSets)
             context.collectedImports.addAll(importModules)
-            val testClassFile = PythonCgTestClassConstructor(context).construct(testClassModel)
-            CodeGeneratorResult(renderClassFile(testClassFile), testClassFile.testsGenerationReport)
+            val cgTestClassConstructor = PythonCgTestClassConstructor(context)
+
+            val testClassFile = cgTestClassConstructor.construct(testClassModel)
+            CodeGeneratorResult(renderClassFile(testClassFile), cgTestClassConstructor.testsGenerationReport)
         }
     }
 }
diff --git a/utbot-python/src/main/kotlin/org/utbot/python/framework/codegen/model/constructor/tree/PythonCgTestClassConstructor.kt b/utbot-python/src/main/kotlin/org/utbot/python/framework/codegen/model/constructor/tree/PythonCgTestClassConstructor.kt
@@ -3,18 +3,17 @@ package org.utbot.python.framework.codegen.model.constructor.tree
 import org.utbot.framework.codegen.model.constructor.TestClassModel
 import org.utbot.framework.codegen.model.constructor.context.CgContext
 import org.utbot.framework.codegen.model.constructor.tree.CgTestClassConstructor
-import org.utbot.framework.codegen.model.tree.CgTestClassFile
-import org.utbot.framework.codegen.model.tree.buildTestClassFile
+import org.utbot.framework.codegen.model.tree.CgClassFile
+import org.utbot.framework.codegen.model.tree.buildClassFile
 
 internal class PythonCgTestClassConstructor(context: CgContext) : CgTestClassConstructor(context) {
-    override fun construct(testClassModel: TestClassModel): CgTestClassFile {
-        return buildTestClassFile {
+    override fun construct(testClassModel: TestClassModel): CgClassFile {
+        return buildClassFile {
             this.declaredClass = withTestClassScope {
                 with(currentTestClassContext) { testClassSuperclass = testFramework.testSuperClass }
                 constructTestClass(testClassModel)
             }
             imports.addAll(context.collectedImports)
-            testsGenerationReport = this@PythonCgTestClassConstructor.testsGenerationReport
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -81,11 +81,13 @@ open class CodeGenerator(`
`81`	`81`	`): CodeGeneratorResult = withCustomContext(testClassCustomName) {`
`82`	`82`	`context.withTestClassFileScope {`
`83`	`83`	`val testClassModel = TestClassModel.fromTestSets(classUnderTest, cgTestSets)`
`84`		`- val testClassFile = CgTestClassConstructor(context).construct(testClassModel)`
	`84`	`+ val cgClassConstructor = CgTestClassConstructor(context)`
	`85`	`+ val testClassFile = cgClassConstructor.construct(testClassModel)`
	`86`	`+`
`85`	`87`	`CodeGeneratorResult(`
`86`	`88`	`generatedCode = renderClassFile(testClassFile),`
`87`	`89`	`utilClassKind = UtilClassKind.fromCgContextOrNull(context),`
`88`		`- testsGenerationReport = testClassFile.testsGenerationReport`
	`90`	`+ testsGenerationReport = cgClassConstructor.testsGenerationReport`
`89`	`91`	`)`
`90`	`92`	`}`
`91`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,8 +66,10 @@ class PythonCodeGenerator(`
`66`	`66`	`context.withTestClassFileScope {`
`67`	`67`	`val testClassModel = TestClassModel(classUnderTest, cgTestSets)`
`68`	`68`	`context.collectedImports.addAll(importModules)`
`69`		`- val testClassFile = PythonCgTestClassConstructor(context).construct(testClassModel)`
`70`		`- CodeGeneratorResult(renderClassFile(testClassFile), testClassFile.testsGenerationReport)`
	`69`	`+ val cgTestClassConstructor = PythonCgTestClassConstructor(context)`
	`70`	`+`
	`71`	`+ val testClassFile = cgTestClassConstructor.construct(testClassModel)`
	`72`	`+ CodeGeneratorResult(renderClassFile(testClassFile), cgTestClassConstructor.testsGenerationReport)`
`71`	`73`	`}`
`72`	`74`	`}`
`73`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,18 +3,17 @@ package org.utbot.python.framework.codegen.model.constructor.tree`
`3`	`3`	`import org.utbot.framework.codegen.model.constructor.TestClassModel`
`4`	`4`	`import org.utbot.framework.codegen.model.constructor.context.CgContext`
`5`	`5`	`import org.utbot.framework.codegen.model.constructor.tree.CgTestClassConstructor`
`6`		`-import org.utbot.framework.codegen.model.tree.CgTestClassFile`
`7`		`-import org.utbot.framework.codegen.model.tree.buildTestClassFile`
	`6`	`+import org.utbot.framework.codegen.model.tree.CgClassFile`
	`7`	`+import org.utbot.framework.codegen.model.tree.buildClassFile`
`8`	`8`
`9`	`9`	`internal class PythonCgTestClassConstructor(context: CgContext) : CgTestClassConstructor(context) {`
`10`		`- override fun construct(testClassModel: TestClassModel): CgTestClassFile {`
`11`		`- return buildTestClassFile {`
	`10`	`+ override fun construct(testClassModel: TestClassModel): CgClassFile {`
	`11`	`+ return buildClassFile {`
`12`	`12`	`this.declaredClass = withTestClassScope {`
`13`	`13`	`with(currentTestClassContext) { testClassSuperclass = testFramework.testSuperClass }`
`14`	`14`	`constructTestClass(testClassModel)`
`15`	`15`	`}`
`16`	`16`	`imports.addAll(context.collectedImports)`
`17`		`- testsGenerationReport = this@PythonCgTestClassConstructor.testsGenerationReport`
`18`	`17`	`}`
`19`	`18`	`}`
`20`	`19`	`}`