Support for excluding private methods in utbot-gradle (#482)

Author: mmvpm

utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/GenerateTestsAndSarifReportFacade.kt

@@ -71,7 +71,7 @@ class GenerateTestsAndSarifReportFacade(
 
     private fun generateTestCases(targetClass: TargetClassWrapper, workingDirectory: Path): List<UtTestCase> =
         UtBotTestCaseGenerator.generateForSeveralMethods(
-            targetClass.targetMethods(),
+            targetClass.targetMethods,
             sarifProperties.mockStrategy,
             sarifProperties.classesToMockAlways,
             sarifProperties.generationTimeout

utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/SarifExtensionProvider.kt

@@ -39,6 +39,11 @@ interface SarifExtensionProvider {
      */
     val markGeneratedTestsDirectoryAsTestSourcesRoot: Boolean
 
+    /**
+     * Generate tests for private methods or not.
+     */
+    val testPrivateMethods: Boolean
+
     val testFramework: TestFramework
 
     val mockFramework: MockFramework

utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/TargetClassWrapper.kt

@@ -4,6 +4,7 @@ import org.utbot.framework.plugin.api.UtMethod
 import java.io.File
 import kotlin.reflect.KCallable
 import kotlin.reflect.KClass
+import kotlin.reflect.KVisibility
 import kotlin.reflect.jvm.kotlinFunction
 
 /**
@@ -14,13 +15,22 @@ data class TargetClassWrapper(
     val classUnderTest: KClass<*>,
     val sourceCodeFile: File,
     val testsCodeFile: File,
-    val sarifReportFile: File
+    val sarifReportFile: File,
+    val testPrivateMethods: Boolean = false
 ) {
     /**
      * Returns the methods of the class [classUnderTest] declared by the user.
      */
-    fun targetMethods() =
-        classUnderTest.java.declaredMethods.map {
+    val targetMethods: List<UtMethod<*>> = run {
+        val declaredMethods = classUnderTest.java.declaredMethods.map {
             UtMethod(it.kotlinFunction as KCallable<*>, classUnderTest)
         }
+        if (testPrivateMethods) {
+            declaredMethods
+        } else {
+            declaredMethods.filter {
+                it.callable.visibility != KVisibility.PRIVATE
+            }
+        }
+    }
 }

utbot-gradle/docs/utbot-gradle.md

@@ -40,6 +40,7 @@ __Groovy:__
       generatedTestsRelativeRoot = 'build/generated/test'
       sarifReportsRelativeRoot = 'build/generated/sarif'
       markGeneratedTestsDirectoryAsTestSourcesRoot = true
+      testPrivateMethods = false
       testFramework = 'junit5'
       mockFramework = 'mockito'
       generationTimeout = 60000L
@@ -58,6 +59,7 @@ __Kotlin DSL:__
       generatedTestsRelativeRoot.set("build/generated/test")
       sarifReportsRelativeRoot.set("build/generated/sarif")
       markGeneratedTestsDirectoryAsTestSourcesRoot.set(true)
+      testPrivateMethods.set(false)
       testFramework.set("junit5")
       mockFramework.set("mockito")
       generationTimeout.set(60000L)
@@ -78,6 +80,7 @@ generateTestsAndSarifReport
     -PprojectRoot='C:/.../SomeDirectory'
     -PgeneratedTestsRelativeRoot='build/generated/test'
     -PsarifReportsRelativeRoot='build/generated/sarif'
+    -PtestPrivateMethods='false'
     -PtestFramework=junit5
     -PmockFramework=mockito
     -PgenerationTimeout=60000
@@ -112,6 +115,10 @@ generateTestsAndSarifReport
   - Mark the directory with generated tests as `test sources root` or not.
   - By default, `true` is used.
 
+- `testPrivateMethods`–
+  - Generate tests for private methods or not.
+  - By default, `false` is used.
+
 - `testFramework` –
   - The name of the test framework to be used.
   - Can be one of:

utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtension.kt

@@ -43,6 +43,12 @@ abstract class SarifGradleExtension {
     @get:Input
     abstract val markGeneratedTestsDirectoryAsTestSourcesRoot: Property<Boolean>
 
+    /**
+     * Generate tests for private methods or not.
+     */
+    @get:Input
+    abstract val testPrivateMethods: Property<Boolean>
+
     /**
      * Can be one of: 'junit4', 'junit5', 'testng'.
      */

utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtensionProvider.kt

@@ -52,6 +52,11 @@ class SarifGradleExtensionProvider(
         get() = extension.markGeneratedTestsDirectoryAsTestSourcesRoot.orNull
             ?: true
 
+    override val testPrivateMethods: Boolean
+        get() = taskParameters["testPrivateMethods"]?.let { it == "true"}
+            ?: extension.testPrivateMethods.orNull
+            ?: false
+
     override val testFramework: TestFramework
         get() = (taskParameters["testFramework"] ?: extension.testFramework.orNull)
             ?.let(::testFrameworkParse)

utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/wrappers/SourceSetWrapper.kt

@@ -90,7 +90,8 @@ class SourceSetWrapper(
             classUnderTest,
             sourceCodeFile,
             createTestsCodeFile(classFqn),
-            createSarifReportFile(classFqn)
+            createSarifReportFile(classFqn),
+            parentProject.sarifProperties.testPrivateMethods
         )
     }
 

utbot-gradle/src/test/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtensionProviderTest.kt

@@ -211,6 +211,43 @@ class SarifGradleExtensionProviderTest {
         }
     }
 
+    @Nested
+    @DisplayName("testPrivateMethods")
+    inner class TestPrivateMethodsTest {
+        @Test
+        fun `should be false by default`() {
+            setTestPrivateMethodsInExtension(null)
+            assertEquals(false, extensionProvider.testPrivateMethods)
+        }
+
+        @Test
+        fun `should be provided from the extension`() {
+            setTestPrivateMethodsInExtension(true)
+            assertEquals(true, extensionProvider.testPrivateMethods)
+        }
+
+        @Test
+        fun `should be provided from the task parameters`() {
+            setTestPrivateMethodsInTaskParameters(true)
+            assertEquals(true, extensionProvider.testPrivateMethods)
+        }
+
+        @Test
+        fun `should be provided from the task parameters, not from the extension`() {
+            setTestPrivateMethodsInTaskParameters(false)
+            setTestPrivateMethodsInExtension(true)
+            assertEquals(false, extensionProvider.testPrivateMethods)
+        }
+
+        private fun setTestPrivateMethodsInExtension(value: Boolean?) {
+            Mockito.`when`(extensionMock.testPrivateMethods).thenReturn(createBooleanProperty(value))
+        }
+
+        private fun setTestPrivateMethodsInTaskParameters(value: Boolean) {
+            extensionProvider.taskParameters = mapOf("testPrivateMethods" to "$value")
+        }
+    }
+
     @Nested
     @DisplayName("testFramework")
     inner class TestFrameworkTest {

utbot-maven/docs/utbot-maven.md

@@ -40,6 +40,7 @@ For example, the following configuration may be used:
     <generatedTestsRelativeRoot>target/generated/test</generatedTestsRelativeRoot>
     <sarifReportsRelativeRoot>target/generated/sarif</sarifReportsRelativeRoot>
     <markGeneratedTestsDirectoryAsTestSourcesRoot>true</markGeneratedTestsDirectoryAsTestSourcesRoot>
+    <testPrivateMethods>false</testPrivateMethods>
     <testFramework>junit5</testFramework>
     <mockFramework>mockito</mockFramework>
     <generationTimeout>60000L</generationTimeout>
@@ -79,6 +80,10 @@ For example, the following configuration may be used:
     - Mark the directory with generated tests as `test sources root` or not.
     - By default, `true` is used.
 
+- `testPrivateMethods`&ndash;
+    - Generate tests for private methods or not.
+    - By default, `false` is used.
+
 - `testFramework` &ndash;
     - The name of the test framework to be used.
     - Can be one of:

utbot-maven/src/main/kotlin/org/utbot/maven/plugin/GenerateTestsAndSarifReportMojo.kt

@@ -71,6 +71,12 @@ class GenerateTestsAndSarifReportMojo : AbstractMojo() {
     @Parameter(defaultValue = "true")
     internal var markGeneratedTestsDirectoryAsTestSourcesRoot: Boolean = true
 
+    /**
+     * Generate tests for private methods or not.
+     */
+    @Parameter(defaultValue = "false")
+    internal var testPrivateMethods: Boolean = false
+
     /**
      * Can be one of: 'junit4', 'junit5', 'testng'.
      */

utbot-maven/src/main/kotlin/org/utbot/maven/plugin/extension/SarifMavenConfigurationProvider.kt

@@ -33,6 +33,9 @@ class SarifMavenConfigurationProvider(
     override val markGeneratedTestsDirectoryAsTestSourcesRoot: Boolean
         get() = generateTestsAndSarifReportMojo.markGeneratedTestsDirectoryAsTestSourcesRoot
 
+    override val testPrivateMethods: Boolean
+        get() = generateTestsAndSarifReportMojo.testPrivateMethods
+
     override val testFramework: TestFramework
         get() = testFrameworkParse(generateTestsAndSarifReportMojo.testFramework)
 

utbot-maven/src/main/kotlin/org/utbot/maven/plugin/wrappers/MavenProjectWrapper.kt

@@ -125,7 +125,8 @@ class MavenProjectWrapper(
             classUnderTest,
             sourceCodeFile,
             createTestsCodeFile(classFqn),
-            createSarifReportFile(classFqn)
+            createSarifReportFile(classFqn),
+            sarifProperties.testPrivateMethods
         )
     }
 

utbot-maven/src/test/kotlin/org/utbot/maven/plugin/extension/SarifMavenConfigurationProviderTest.kt

@@ -52,18 +52,21 @@ class SarifMavenConfigurationProviderTest : AbstractMojoTestCase() {
         Assertions.assertEquals(true, configurationProvider.markGeneratedTestsDirectoryAsTestSourcesRoot)
     }
 
+    @Test
+    fun `testPrivateMethods should be provided from the configuration`() {
+        Assertions.assertEquals(true, configurationProvider.testPrivateMethods)
+    }
+
     @Test
     fun `testFramework should be provided from the configuration`() {
         Assertions.assertEquals(Junit5, configurationProvider.testFramework)
     }
 
-
     @Test
     fun `mockFramework should be provided from the configuration`() {
         Assertions.assertEquals(MockFramework.MOCKITO, configurationProvider.mockFramework)
     }
 
-
     @Test
     fun `generationTimeout should be provided from the configuration`() {
         Assertions.assertEquals(10000, configurationProvider.generationTimeout)

utbot-maven/src/test/resources/project-to-test/pom.xml

@@ -30,6 +30,7 @@
                     <generatedTestsRelativeRoot>target/generated/test</generatedTestsRelativeRoot>
                     <sarifReportsRelativeRoot>target/generated/sarif</sarifReportsRelativeRoot>
                     <markGeneratedTestsDirectoryAsTestSourcesRoot>true</markGeneratedTestsDirectoryAsTestSourcesRoot>
+                    <testPrivateMethods>true</testPrivateMethods>
                     <testFramework>junit5</testFramework>
                     <mockFramework>mockito</mockFramework>
                     <generationTimeout>10000</generationTimeout>