Skip to content

Commit b24659f

Browse files
EgorkaKulikovdenis-fokin
EgorkaKulikov
authored and
denis-fokin
committed
Improve exception rendering in parametrized tests №641 (#690)
1 parent 3be063f commit b24659f

File tree

7 files changed

+77
-25
lines changed

7 files changed

+77
-25
lines changed

‎utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/constructor/context/CgContext.kt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,10 @@ internal interface CgContextOwner {
171171
// a variable representing an actual result of the method under test call
172172
var actual: CgVariable
173173

174+
// a variable representing if test method contains reflective call or not
175+
// and should we catch exceptions like InvocationTargetException or not so on
176+
var containsReflectiveCall: Boolean
177+
174178
// map from a set of tests for a method to another map
175179
// which connects code generation error message
176180
// with the number of times it occurred
@@ -420,7 +424,8 @@ internal data class CgContext(
420424
override val runtimeExceptionTestsBehaviour: RuntimeExceptionTestsBehaviour =
421425
RuntimeExceptionTestsBehaviour.defaultItem,
422426
override val hangingTestsTimeout: HangingTestsTimeout = HangingTestsTimeout(),
423-
override val enableTestsTimeout: Boolean = true
427+
override val enableTestsTimeout: Boolean = true,
428+
override var containsReflectiveCall: Boolean = false,
424429
) : CgContextOwner {
425430
override lateinit var statesCache: EnvironmentFieldStateCache
426431
override lateinit var actual: CgVariable

‎utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/constructor/tree/CgCallableAccessManager.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,7 @@ internal class CgCallableAccessManagerImpl(val context: CgContext) : CgCallableA
359359
}
360360

361361
private fun MethodId.callWithReflection(caller: CgExpression?, args: List<CgExpression>): CgMethodCall {
362+
containsReflectiveCall = true
362363
val method = declaredExecutableRefs[this]
363364
?: toExecutableVariable(args).also {
364365
declaredExecutableRefs = declaredExecutableRefs.put(this, it)
@@ -372,6 +373,7 @@ internal class CgCallableAccessManagerImpl(val context: CgContext) : CgCallableA
372373
}
373374

374375
private fun ConstructorId.callWithReflection(args: List<CgExpression>): CgExecutableCall {
376+
containsReflectiveCall = true
375377
val constructor = declaredExecutableRefs[this]
376378
?: this.toExecutableVariable(args).also {
377379
declaredExecutableRefs = declaredExecutableRefs.put(this, it)

‎utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/constructor/tree/CgMethodConstructor.kt

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ import org.utbot.framework.codegen.model.tree.CgExecutableCall
4343
import org.utbot.framework.codegen.model.tree.CgExpression
4444
import org.utbot.framework.codegen.model.tree.CgFieldAccess
4545
import org.utbot.framework.codegen.model.tree.CgGetJavaClass
46+
import org.utbot.framework.codegen.model.tree.CgIsInstance
4647
import org.utbot.framework.codegen.model.tree.CgLiteral
4748
import org.utbot.framework.codegen.model.tree.CgMethod
4849
import org.utbot.framework.codegen.model.tree.CgMethodCall
@@ -1198,20 +1199,6 @@ internal class CgMethodConstructor(val context: CgContext) : CgContextOwner by c
11981199
val testName = nameGenerator.parameterizedTestMethodName(dataProviderMethodName)
11991200
withNameScope {
12001201
val testParameterDeclarations = createParameterDeclarations(testSet, genericExecution)
1201-
val mainBody = {
1202-
substituteStaticFields(statics, isParametrized = true)
1203-
// build this instance
1204-
thisInstance = genericExecution.stateBefore.thisInstance?.let { currentMethodParameters[CgParameterKind.ThisInstance] }
1205-
1206-
// build arguments for method under test and parameterized test
1207-
for (index in genericExecution.stateBefore.parameters.indices) {
1208-
methodArguments += currentMethodParameters[CgParameterKind.Argument(index)]!!
1209-
}
1210-
1211-
//record result and generate result assertions
1212-
recordActualResult()
1213-
generateAssertionsForParameterizedTest()
1214-
}
12151202

12161203
methodType = PARAMETRIZED
12171204
testMethod(
@@ -1222,21 +1209,39 @@ internal class CgMethodConstructor(val context: CgContext) : CgContextOwner by c
12221209
dataProviderMethodName
12231210
) {
12241211
rememberInitialStaticFields(statics)
1212+
substituteStaticFields(statics, isParametrized = true)
1213+
1214+
// build this instance
1215+
thisInstance = genericExecution.stateBefore.thisInstance?.let { currentMethodParameters[CgParameterKind.ThisInstance] }
1216+
1217+
// build arguments for method under test and parameterized test
1218+
for (index in genericExecution.stateBefore.parameters.indices) {
1219+
methodArguments += currentMethodParameters[CgParameterKind.Argument(index)]!!
1220+
}
12251221

12261222
if (containsFailureExecution(testSet) || statics.isNotEmpty()) {
12271223
var currentTryBlock = tryBlock {
1228-
mainBody()
1224+
recordActualResult()
1225+
generateAssertionsForParameterizedTest()
12291226
}
12301227

12311228
if (containsFailureExecution(testSet)) {
1232-
currentTryBlock = currentTryBlock.catch(Throwable::class.java.id) { e ->
1233-
val pseudoExceptionVarName = when (codegenLanguage) {
1234-
CodegenLanguage.JAVA -> "${expectedErrorVarName}.isInstance(${e.name.decapitalize()})"
1235-
CodegenLanguage.KOTLIN -> "${expectedErrorVarName}!!.isInstance(${e.name.decapitalize()})"
1229+
val expectedErrorVariable = currentMethodParameters[CgParameterKind.ExpectedException]
1230+
?: error("Test set $testSet contains failure execution, but test method signature has no error parameter")
1231+
currentTryBlock =
1232+
if (containsReflectiveCall) {
1233+
currentTryBlock.catch(InvocationTargetException::class.java.id) { exception ->
1234+
testFrameworkManager.assertBoolean(
1235+
expectedErrorVariable.isInstance(exception[getTargetException]())
1236+
)
1237+
}
1238+
} else {
1239+
currentTryBlock.catch(Throwable::class.java.id) { throwable ->
1240+
testFrameworkManager.assertBoolean(
1241+
expectedErrorVariable.isInstance(throwable)
1242+
)
1243+
}
12361244
}
1237-
1238-
testFrameworkManager.assertBoolean(CgVariable(pseudoExceptionVarName, booleanClassId))
1239-
}
12401245
}
12411246

12421247
if (statics.isNotEmpty()) {
@@ -1246,7 +1251,8 @@ internal class CgMethodConstructor(val context: CgContext) : CgContextOwner by c
12461251
}
12471252
+currentTryBlock
12481253
} else {
1249-
mainBody()
1254+
recordActualResult()
1255+
generateAssertionsForParameterizedTest()
12501256
}
12511257
}
12521258
}
@@ -1345,7 +1351,7 @@ internal class CgMethodConstructor(val context: CgContext) : CgContextOwner by c
13451351
name = nameGenerator.variableName(expectedErrorVarName)
13461352
),
13471353
// exceptions are always reference type
1348-
isReferenceType = true
1354+
isReferenceType = true,
13491355
)
13501356
this += expectedException
13511357
currentMethodParameters[CgParameterKind.ExpectedException] = expectedException.parameter
@@ -1470,6 +1476,7 @@ internal class CgMethodConstructor(val context: CgContext) : CgContextOwner by c
14701476
thisInstance = null
14711477
methodArguments.clear()
14721478
currentExecution = null
1479+
containsReflectiveCall = false
14731480
mockFrameworkManager.clearExecutionResources()
14741481
currentMethodParameters.clear()
14751482
}

‎utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/constructor/util/CgStatementConstructor.kt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ import org.utbot.framework.plugin.api.util.objectArrayClassId
5858
import org.utbot.framework.plugin.api.util.objectClassId
5959
import fj.data.Either
6060
import org.utbot.framework.codegen.model.tree.CgArrayInitializer
61+
import org.utbot.framework.codegen.model.tree.CgIsInstance
62+
import org.utbot.framework.plugin.api.util.classClassId
6163
import java.lang.reflect.Constructor
6264
import java.lang.reflect.Method
6365
import kotlin.reflect.KFunction
@@ -116,6 +118,8 @@ interface CgStatementConstructor {
116118
fun CgTryCatch.catch(exception: ClassId, init: (CgVariable) -> Unit): CgTryCatch
117119
fun CgTryCatch.finally(init: () -> Unit): CgTryCatch
118120

121+
fun CgExpression.isInstance(value: CgExpression): CgIsInstance
122+
119123
fun innerBlock(init: () -> Unit): CgInnerBlock
120124

121125
// fun CgTryCatchBuilder.statements(init: () -> Unit)
@@ -302,6 +306,15 @@ internal class CgStatementConstructorImpl(context: CgContext) :
302306
return this.copy(finally = finallyBlock)
303307
}
304308

309+
override fun CgExpression.isInstance(value: CgExpression): CgIsInstance {
310+
require(this.type == classClassId) {
311+
"isInstance method can be called on object with type $classClassId only, but actual type is ${this.type}"
312+
}
313+
314+
//TODO: we should better process it as this[isInstanceMethodId](value) as it is a call
315+
return CgIsInstance(this, value)
316+
}
317+
305318
override fun innerBlock(init: () -> Unit): CgInnerBlock =
306319
CgInnerBlock(block(init)).also {
307320
currentBlock += it

‎utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/tree/CgElement.kt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ interface CgElement {
7575
is CgDeclaration -> visit(element)
7676
is CgAssignment -> visit(element)
7777
is CgTypeCast -> visit(element)
78+
is CgIsInstance -> visit(element)
7879
is CgThisInstance -> visit(element)
7980
is CgNotNullAssertion -> visit(element)
8081
is CgVariable -> visit(element)
@@ -537,6 +538,16 @@ class CgTypeCast(
537538
override val type: ClassId = targetType
538539
}
539540

541+
/**
542+
* Represents [java.lang.Class.isInstance] method.
543+
*/
544+
class CgIsInstance(
545+
val classExpression: CgExpression,
546+
val value: CgExpression,
547+
): CgExpression {
548+
override val type: ClassId = booleanClassId
549+
}
550+
540551
// Value
541552

542553
// TODO in general CgLiteral is not CgReferenceExpression because it can hold primitive values

‎utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/visitor/CgAbstractRenderer.kt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import org.utbot.framework.codegen.model.tree.CgGreaterThan
3939
import org.utbot.framework.codegen.model.tree.CgIfStatement
4040
import org.utbot.framework.codegen.model.tree.CgIncrement
4141
import org.utbot.framework.codegen.model.tree.CgInnerBlock
42+
import org.utbot.framework.codegen.model.tree.CgIsInstance
4243
import org.utbot.framework.codegen.model.tree.CgLessThan
4344
import org.utbot.framework.codegen.model.tree.CgLiteral
4445
import org.utbot.framework.codegen.model.tree.CgLogicalAnd
@@ -422,6 +423,15 @@ internal abstract class CgAbstractRenderer(val context: CgContext, val printer:
422423
print("${element.variable.name}--")
423424
}
424425

426+
// isInstance check
427+
428+
override fun visit(element: CgIsInstance) {
429+
element.classExpression.accept(this)
430+
print(".isInstance(")
431+
element.value.accept(this)
432+
print(")")
433+
}
434+
425435
// Try-catch
426436

427437
override fun visit(element: CgTryCatch) {

‎utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/visitor/CgVisitor.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ import org.utbot.framework.codegen.model.tree.CgGreaterThan
4242
import org.utbot.framework.codegen.model.tree.CgIfStatement
4343
import org.utbot.framework.codegen.model.tree.CgIncrement
4444
import org.utbot.framework.codegen.model.tree.CgInnerBlock
45+
import org.utbot.framework.codegen.model.tree.CgIsInstance
4546
import org.utbot.framework.codegen.model.tree.CgLessThan
4647
import org.utbot.framework.codegen.model.tree.CgLiteral
4748
import org.utbot.framework.codegen.model.tree.CgLogicalAnd
@@ -180,6 +181,9 @@ interface CgVisitor<R> {
180181
// Type cast
181182
fun visit(element: CgTypeCast): R
182183

184+
// isInstance check
185+
fun visit(element: CgIsInstance): R
186+
183187
// This instance
184188
fun visit(element: CgThisInstance): R
185189

0 commit comments

Comments
 (0)