Add unit tests for summaries with custom JavaDoc tags #565

Author: onewhl

utbot-summary-tests/src/test/kotlin/examples/SummaryTestCaseGeneratorTest.kt

@@ -11,6 +11,7 @@ import org.utbot.framework.UtSettings.checkSolverTimeoutMillis
 import org.utbot.framework.codegen.TestExecution
 import org.utbot.framework.plugin.api.*
 import org.utbot.framework.plugin.api.util.UtContext
+import org.utbot.summary.UtSummarySettings
 import org.utbot.summary.comment.nextSynonyms
 import org.utbot.summary.summarize
 import kotlin.reflect.KClass
@@ -56,6 +57,7 @@ open class SummaryTestCaseGeneratorTest(
             checkSolverTimeoutMillis = 0
             checkNpeInNestedMethods = true
             checkNpeInNestedNotPrivateMethods = true
+            UtSummarySettings.USE_CUSTOM_JAVADOC_TAGS = false
         }
         val utMethod = UtMethod.from(method)
         val testSet = executionsModel(utMethod, mockStrategy)
@@ -67,6 +69,34 @@ open class SummaryTestCaseGeneratorTest(
         testSetWithSummarization.checkClusterInfo(clusterInfo)
     }
 
+    /**
+     * Checks summaries containing custom JavaDoc tags.
+     */
+    inline fun <reified R> checkSummariesWithCustomTags(
+        method: KFunction<R>,
+        mockStrategy: MockStrategyApi,
+        coverageMatcher: CoverageMatcher,
+        summaryKeys: List<String>,
+        methodNames: List<String>,
+        displayNames: List<String>
+    ) {
+        workaround(WorkaroundReason.HACK) {
+            // @todo change to the constructor parameter
+            checkSolverTimeoutMillis = 0
+            checkNpeInNestedMethods = true
+            checkNpeInNestedNotPrivateMethods = true
+            UtSummarySettings.USE_CUSTOM_JAVADOC_TAGS = true
+        }
+        val utMethod = UtMethod.from(method)
+        val testSet = executionsModel(utMethod, mockStrategy)
+        testSet.summarize(searchDirectory)
+        testSet.clustersInfo
+
+        testSet.executions.checkMatchersWithCustomTagsInSummary(summaryKeys)
+        testSet.executions.checkMatchersWithMethodNames(methodNames)
+        testSet.executions.checkMatchersWithDisplayNames(displayNames)
+    }
+
     /**
      * It removes from the String all whitespaces, tabs etc.
      *
@@ -160,6 +190,20 @@ open class SummaryTestCaseGeneratorTest(
         }
     }
 
+    fun List<UtExecution>.checkMatchersWithCustomTagsInSummary(
+        summaryTextKeys: List<String>,
+    ) {
+        if (summaryTextKeys.isEmpty()) {
+            return
+        }
+        val notMatchedExecutions = this.filter { execution ->
+            summaryTextKeys.none { summaryKey ->
+                execution.summary?.toString()?.contains(summaryKey) == true
+            }
+        }
+        Assertions.assertTrue(notMatchedExecutions.isEmpty()) { "Not matched comments ${summaries(notMatchedExecutions)}" }
+    }
+
     fun List<UtExecution>.checkMatchersWithMethodNames(
         methodNames: List<String>,
     ) {

utbot-summary-tests/src/test/kotlin/examples/controlflow/SummaryConditionsTest.kt

@@ -0,0 +1,51 @@
+package examples.controlflow
+
+import examples.SummaryTestCaseGeneratorTest
+import org.junit.jupiter.api.Test
+import org.utbot.examples.DoNotCalculate
+import org.utbot.examples.controlflow.Conditions
+import org.utbot.framework.plugin.api.MockStrategyApi
+
+class SummaryConditionsTest : SummaryTestCaseGeneratorTest(
+    Conditions::class
+) {
+    @Test
+    fun testSimpleCondition() {
+        val summary1 = "@utbot.classUnderTest {@link Conditions}\n" +
+                "@utbot.methodUnderTest {@link org.utbot.examples.controlflow.Conditions#simpleCondition(boolean)}\n" +
+                "@utbot.executesCondition {@code (condition): False}\n" +
+                "@utbot.returnsFrom {@code return 0;}"
+
+        val summary2 = "@utbot.classUnderTest {@link Conditions}\n" +
+                "@utbot.methodUnderTest {@link org.utbot.examples.controlflow.Conditions#simpleCondition(boolean)}\n" +
+                "@utbot.executesCondition {@code (condition): True}\n" +
+                "@utbot.returnsFrom {@code return 1;}"
+
+        val methodName1 = "testSimpleCondition_NotCondition"
+        val methodName2 = "testSimpleCondition_Condition"
+
+        val displayName1 = "condition : False -> return 0"
+        val displayName2 = "condition : True -> return 1"
+
+        val summaryKeys = listOf(
+            summary1,
+            summary2
+        )
+
+        val displayNames = listOf(
+            displayName1,
+            displayName2
+        )
+
+        val methodNames = listOf(
+            methodName1,
+            methodName2
+        )
+
+        val method = Conditions::simpleCondition
+        val mockStrategy = MockStrategyApi.NO_MOCKS
+        val coverage = DoNotCalculate
+
+        checkSummariesWithCustomTags(method, mockStrategy, coverage, summaryKeys, methodNames, displayNames)
+    }
+}

utbot-summary-tests/src/test/kotlin/examples/exceptions/SummaryExceptionClusteringExamplesTest.kt

@@ -0,0 +1,74 @@
+package examples.exceptions
+
+import examples.SummaryTestCaseGeneratorTest
+import org.junit.jupiter.api.Test
+import org.utbot.examples.DoNotCalculate
+import org.utbot.examples.exceptions.ExceptionClusteringExamples
+import org.utbot.framework.plugin.api.MockStrategyApi
+
+class SummaryExceptionClusteringExamplesTest : SummaryTestCaseGeneratorTest(
+    ExceptionClusteringExamples::class
+) {
+    @Test
+    fun testDifferentExceptions() {
+        val summary1 = "@utbot.classUnderTest {@link ExceptionClusteringExamples}\n" +
+                "@utbot.methodUnderTest {@link org.utbot.examples.exceptions.ExceptionClusteringExamples#differentExceptions(int)}\n" +
+                "@utbot.executesCondition {@code (i == 0): True}\n" +
+                "@utbot.throwsException {@link ArithmeticException} in: return 100 / i;"
+
+        val summary2 = "@utbot.classUnderTest {@link ExceptionClusteringExamples}\n" +
+                "@utbot.methodUnderTest {@link org.utbot.examples.exceptions.ExceptionClusteringExamples#differentExceptions(int)}\n" +
+                "@utbot.executesCondition {@code (i == 0): False},\n" +
+                "{@code (i == 1): True}\n" +
+                "@utbot.throwsException {@link MyCheckedException} after condition: {@code i == 1}"
+        val summary3 = "@utbot.classUnderTest {@link ExceptionClusteringExamples}\n" +
+                "@utbot.methodUnderTest {@link org.utbot.examples.exceptions.ExceptionClusteringExamples#differentExceptions(int)}\n" +
+                "@utbot.executesCondition {@code (i == 0): False},\n" +
+                "{@code (i == 1): False},\n" +
+                "{@code (i == 2): True}\n" +
+                "@utbot.throwsException {@link IllegalArgumentException} after condition: {@code i == 2}"
+        val summary4 = "@utbot.classUnderTest {@link ExceptionClusteringExamples}\n" +
+                "@utbot.methodUnderTest {@link org.utbot.examples.exceptions.ExceptionClusteringExamples#differentExceptions(int)}\n" +
+                "@utbot.executesCondition {@code (i == 0): False},\n" +
+                "{@code (i == 1): False},\n" +
+                "{@code (i == 2): False}\n" +
+                "@utbot.returnsFrom {@code return i * 2;}\n"
+
+        val methodName1 = "testDifferentExceptions_IEqualsZero"
+        val methodName2 = "testDifferentExceptions_IEquals1"
+        val methodName3 = "testDifferentExceptions_IEquals2"
+        val methodName4 = "testDifferentExceptions_INotEquals2"
+
+        val displayName1 = "return 100 / i : True -> ThrowArithmeticException"
+        val displayName2 = "i == 1 -> ThrowMyCheckedException"
+        val displayName3 = "i == 2 -> ThrowIllegalArgumentException"
+        val displayName4 = "i == 0 : False -> return i * 2"
+
+        val summaryKeys = listOf(
+            summary1,
+            summary2,
+            summary3,
+            summary4
+        )
+
+        val displayNames = listOf(
+            displayName1,
+            displayName2,
+            displayName3,
+            displayName4
+        )
+
+        val methodNames = listOf(
+            methodName1,
+            methodName2,
+            methodName3,
+            methodName4
+        )
+
+        val method = ExceptionClusteringExamples::differentExceptions
+        val mockStrategy = MockStrategyApi.NO_MOCKS
+        val coverage = DoNotCalculate
+
+        checkSummariesWithCustomTags(method, mockStrategy, coverage, summaryKeys, methodNames, displayNames)
+    }
+}