Rename createSarifReport Gradle and Maven task (#203)

* #196 Rename createSarifReport Gradle and Maven task

Author: mmvpm

…/plugin/sarif/CreateSarifReportFacade.kt …rif/GenerateTestsAndSarifReportFacade.ktutbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/CreateSarifReportFacade.kt renamed to utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/GenerateTestsAndSarifReportFacade.kt utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/CreateSarifReportFacade.kt renamed to utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/GenerateTestsAndSarifReportFacade.kt

@@ -13,10 +13,10 @@ import java.net.URLClassLoader
 import java.nio.file.Path
 
 /**
- * Facade for `createSarifReport` task/mojo.
+ * Facade for `generateTestsAndSarifReport` task/mojo.
  * Stores common logic between gradle and maven plugins.
  */
-class CreateSarifReportFacade(
+class GenerateTestsAndSarifReportFacade(
     val sarifProperties: SarifExtensionProvider,
     val sourceFindingStrategy: SourceFindingStrategy
 ) {

utbot-gradle/docs/utbot-gradle.md

@@ -2,7 +2,7 @@
 
 Utbot Gradle Plugin is a gradle plugin for generating tests and creating SARIF-reports.
 
-The `createSarifReport` gradle task generates tests and SARIF-reports for all classes in your project (or only for classes specified in the configuration).
+The `generateTestsAndSarifReport` gradle task generates tests and SARIF-reports for all classes in your project (or only for classes specified in the configuration).
 In addition, it creates one big SARIF-report containing the results from all the processed files.   
 
 
@@ -26,7 +26,7 @@ _TODO: The plugin has not been published yet._
   </pre>
   </details>
 
-- Run gradle task `utbot/createSarifReport` to create a report.
+- Run gradle task `utbot/generateTestsAndSarifReport` to create a report.
 
 
 ### How to configure
@@ -242,9 +242,9 @@ There are two ways to do it.
 
 ### How to configure the log level
 
-To change the log level run the `createSarifReport` task with the appropriate flag.
+To change the log level run the `generateTestsAndSarifReport` task with the appropriate flag.
 
-For example, `createSarifReport --debug`
+For example, `generateTestsAndSarifReport --debug`
 
 Note that the internal gradle log information will also be shown.
 

…t/gradle/plugin/CreateSarifReportTask.kt …lugin/GenerateTestsAndSarifReportTask.ktutbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/CreateSarifReportTask.kt renamed to utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/GenerateTestsAndSarifReportTask.kt utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/CreateSarifReportTask.kt renamed to utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/GenerateTestsAndSarifReportTask.kt

@@ -7,7 +7,7 @@ import org.utbot.common.bracket
 import org.utbot.common.debug
 import org.utbot.framework.plugin.api.util.UtContext
 import org.utbot.framework.plugin.api.util.withUtContext
-import org.utbot.framework.plugin.sarif.CreateSarifReportFacade
+import org.utbot.framework.plugin.sarif.GenerateTestsAndSarifReportFacade
 import org.utbot.gradle.plugin.extension.SarifGradleExtensionProvider
 import org.utbot.gradle.plugin.wrappers.GradleProjectWrapper
 import org.utbot.gradle.plugin.wrappers.SourceFindingStrategyGradle
@@ -16,11 +16,11 @@ import org.utbot.framework.plugin.sarif.TargetClassWrapper
 import javax.inject.Inject
 
 /**
- * The main class containing the entry point [createSarifReport].
+ * The main class containing the entry point [generateTestsAndSarifReport].
  *
  * [Documentation](https://docs.gradle.org/current/userguide/custom_tasks.html)
  */
-open class CreateSarifReportTask @Inject constructor(
+open class GenerateTestsAndSarifReportTask @Inject constructor(
     private val sarifProperties: SarifGradleExtensionProvider
 ) : DefaultTask() {
 
@@ -33,7 +33,7 @@ open class CreateSarifReportTask @Inject constructor(
      * Entry point: called when the user starts this gradle task.
      */
     @TaskAction
-    fun createSarifReport() {
+    fun generateTestsAndSarifReport() {
         val rootGradleProject = try {
             GradleProjectWrapper(project, sarifProperties)
         } catch (t: Throwable) {
@@ -42,7 +42,7 @@ open class CreateSarifReportTask @Inject constructor(
         }
         try {
             generateForProjectRecursively(rootGradleProject)
-            CreateSarifReportFacade.mergeReports(
+            GenerateTestsAndSarifReportFacade.mergeReports(
                 sarifReports = rootGradleProject.collectReportsRecursively(),
                 mergedSarifReportFile = rootGradleProject.sarifReportFile
             )
@@ -89,9 +89,9 @@ open class CreateSarifReportTask @Inject constructor(
         logger.debug().bracket("Generating tests for the $targetClass") {
             val sourceFindingStrategy =
                 SourceFindingStrategyGradle(sourceSet, targetClass.testsCodeFile.path)
-            val createSarifReportFacade =
-                CreateSarifReportFacade(sarifProperties, sourceFindingStrategy)
-            createSarifReportFacade.generateForClass(
+            val generateTestsAndSarifReportFacade =
+                GenerateTestsAndSarifReportFacade(sarifProperties, sourceFindingStrategy)
+            generateTestsAndSarifReportFacade.generateForClass(
                 targetClass, sourceSet.workingDirectory, sourceSet.runtimeClasspath
             )
         }

utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/SarifGradlePlugin.kt

@@ -28,9 +28,9 @@ class SarifGradlePlugin : Plugin<Project> {
 
     /**
      * The name of the gradle task.
-     * @see [CreateSarifReportTask]
+     * @see [GenerateTestsAndSarifReportTask]
      */
-    internal val createSarifReportTaskName = "createSarifReport"
+    internal val generateTestsAndSarifReportTaskName = "generateTestsAndSarifReport"
 
     /**
      * Entry point: called when the plugin is applied.
@@ -45,12 +45,12 @@ class SarifGradlePlugin : Plugin<Project> {
             sarifGradleExtension
         )
 
-        val createSarifReportTask = project.tasks.register(
-            createSarifReportTaskName,
-            CreateSarifReportTask::class.java,
+        val generateTestsAndSarifReportTask = project.tasks.register(
+            generateTestsAndSarifReportTaskName,
+            GenerateTestsAndSarifReportTask::class.java,
             sarifGradleExtensionProvider
         )
-        createSarifReportTask.addDependencyOnClassesTasksRecursively(project)
+        generateTestsAndSarifReportTask.addDependencyOnClassesTasksRecursively(project)
 
         markGeneratedTestsDirectoryIfNeededRecursively(project, sarifGradleExtensionProvider)
     }
@@ -60,7 +60,7 @@ class SarifGradlePlugin : Plugin<Project> {
     /**
      * Applies [addDependencyOnClassesTasks] to the [project] and to all its child projects.
      */
-    private fun TaskProvider<CreateSarifReportTask>.addDependencyOnClassesTasksRecursively(project: Project) {
+    private fun TaskProvider<GenerateTestsAndSarifReportTask>.addDependencyOnClassesTasksRecursively(project: Project) {
         project.afterEvaluate {
             addDependencyOnClassesTasks(project)
         }
@@ -70,13 +70,13 @@ class SarifGradlePlugin : Plugin<Project> {
     }
 
     /**
-     * Makes [CreateSarifReportTask] dependent on `classes` task
+     * Makes [GenerateTestsAndSarifReportTask] dependent on `classes` task
      * of each source set from the [project], except `test` source set.
      *
      * The [project] should be evaluated because we need its `java` plugin.
      * Therefore, it is recommended to call this function in the `project.afterEvaluate` block.
      */
-    private fun TaskProvider<CreateSarifReportTask>.addDependencyOnClassesTasks(project: Project) {
+    private fun TaskProvider<GenerateTestsAndSarifReportTask>.addDependencyOnClassesTasks(project: Project) {
         val javaPlugin = project.convention.findPlugin(JavaPluginConvention::class.java)
         if (javaPlugin == null) {
             logger.warn {
@@ -88,11 +88,11 @@ class SarifGradlePlugin : Plugin<Project> {
             sourceSet.name != SourceSet.TEST_SOURCE_SET_NAME
         }
         logger.debug { "Found source sets in the '${project.name}': ${sourceSetsExceptTest.map { it.name }}" }
-        configure { createSarifReportTask ->
+        configure { generateTestsAndSarifReportTask ->
             sourceSetsExceptTest.map { sourceSet ->
                 val classesTask = project.tasks.getByName(sourceSet.classesTaskName)
-                createSarifReportTask.dependsOn(classesTask)
-                logger.debug { "'createSarifReport' task now depends on the task '${classesTask.name}'" }
+                generateTestsAndSarifReportTask.dependsOn(classesTask)
+                logger.debug { "'generateTestsAndSarifReport' task now depends on the task '${classesTask.name}'" }
             }
         }
     }

utbot-gradle/src/test/kotlin/org/utbot/gradle/plugin/SarifGradlePluginTest.kt

@@ -13,11 +13,11 @@ class SarifGradlePluginTest {
     }
 
     @Test
-    fun `plugin should register createSarifReport task`() {
+    fun `plugin should register generateTestsAndSarifReport task`() {
         val project = buildProject()
         val sarifGradlePlugin = project.sarifGradlePlugin
-        val createSarifReportTask = project.tasks.getByName(sarifGradlePlugin.createSarifReportTaskName)
-        assertNotNull(createSarifReportTask)
+        val generateTestsAndSarifReportTask = project.tasks.getByName(sarifGradlePlugin.generateTestsAndSarifReportTaskName)
+        assertNotNull(generateTestsAndSarifReportTask)
     }
 
     @Test

utbot-maven/docs/utbot-maven.md

@@ -2,7 +2,7 @@
 
 Utbot Maven Plugin is a maven plugin for generating tests and creating SARIF-reports.
 
-The `createSarifReport` maven task generates tests and SARIF-reports for all classes in your project (or only for classes specified in the configuration).
+The `generateTestsAndSarifReport` maven task generates tests and SARIF-reports for all classes in your project (or only for classes specified in the configuration).
 In addition, it creates one big SARIF-report containing the results from all the processed files.
 
 
@@ -23,7 +23,7 @@ _TODO: The plugin has not been published yet._
   </build>
   ```
 
-- Run maven task `utbot:createSarifReport` to create a report.
+- Run maven task `utbot:generateTestsAndSarifReport` to create a report.
 
 
 ### How to configure
@@ -136,8 +136,8 @@ you need to do the following:
 
 ### How to configure the log level
 
-To change the log level run the `createSarifReport` task with the appropriate flag.
+To change the log level run the `generateTestsAndSarifReport` task with the appropriate flag.
 
-For example, `mvn utbot:createSarifReport --debug`
+For example, `mvn utbot:generateTestsAndSarifReport --debug`
 
 Note that the internal maven log information will also be shown.

…ot/maven/plugin/CreateSarifReportMojo.kt …lugin/GenerateTestsAndSarifReportMojo.ktutbot-maven/src/main/kotlin/org/utbot/maven/plugin/CreateSarifReportMojo.kt renamed to utbot-maven/src/main/kotlin/org/utbot/maven/plugin/GenerateTestsAndSarifReportMojo.kt utbot-maven/src/main/kotlin/org/utbot/maven/plugin/CreateSarifReportMojo.kt renamed to utbot-maven/src/main/kotlin/org/utbot/maven/plugin/GenerateTestsAndSarifReportMojo.kt

@@ -11,28 +11,28 @@ import org.utbot.common.bracket
 import org.utbot.common.debug
 import org.utbot.framework.plugin.api.util.UtContext
 import org.utbot.framework.plugin.api.util.withUtContext
-import org.utbot.framework.plugin.sarif.CreateSarifReportFacade
+import org.utbot.framework.plugin.sarif.GenerateTestsAndSarifReportFacade
 import org.utbot.framework.plugin.sarif.TargetClassWrapper
 import org.utbot.maven.plugin.extension.SarifMavenConfigurationProvider
 import org.utbot.maven.plugin.wrappers.MavenProjectWrapper
 import org.utbot.maven.plugin.wrappers.SourceFindingStrategyMaven
 import java.io.File
 
-private val logger = KotlinLogging.logger {}
+internal val logger = KotlinLogging.logger {}
 
 /**
  * The main class containing the entry point [execute].
  *
  * [Documentation](https://maven.apache.org/guides/plugin/guide-java-plugin-development.html)
  */
 @Mojo(
-    name = "createSarifReport",
+    name = "generateTestsAndSarifReport",
     defaultPhase = LifecyclePhase.GENERATE_TEST_SOURCES
 )
 @Execute(
     phase = LifecyclePhase.GENERATE_TEST_SOURCES
 )
-class CreateSarifReportMojo : AbstractMojo() {
+class GenerateTestsAndSarifReportMojo : AbstractMojo() {
 
     @Parameter(defaultValue = "\${project}", readonly = true)
     private lateinit var mavenProject: MavenProject
@@ -128,7 +128,7 @@ class CreateSarifReportMojo : AbstractMojo() {
         }
         try {
             generateForProjectRecursively(rootMavenProjectWrapper)
-            CreateSarifReportFacade.mergeReports(
+            GenerateTestsAndSarifReportFacade.mergeReports(
                 sarifReports = rootMavenProjectWrapper.collectReportsRecursively(),
                 mergedSarifReportFile = rootMavenProjectWrapper.sarifReportFile
             )
@@ -166,9 +166,9 @@ class CreateSarifReportMojo : AbstractMojo() {
         logger.debug().bracket("Generating tests for the $targetClass") {
             val sourceFindingStrategy =
                 SourceFindingStrategyMaven(mavenProjectWrapper, targetClass.testsCodeFile.path)
-            val createSarifReportFacade =
-                CreateSarifReportFacade(sarifProperties, sourceFindingStrategy)
-            createSarifReportFacade.generateForClass(
+            val generateTestsAndSarifReportFacade =
+                GenerateTestsAndSarifReportFacade(sarifProperties, sourceFindingStrategy)
+            generateTestsAndSarifReportFacade.generateForClass(
                 targetClass, mavenProjectWrapper.workingDirectory, mavenProjectWrapper.runtimeClasspath
             )
         }

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

@@ -8,52 +8,52 @@ 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.sarif.SarifExtensionProvider
-import org.utbot.maven.plugin.CreateSarifReportMojo
+import org.utbot.maven.plugin.GenerateTestsAndSarifReportMojo
 import java.io.File
 
 /**
  * Provides fields needed to create a SARIF report in a convenient form.
  */
 class SarifMavenConfigurationProvider(
-    private val createSarifReportMojo: CreateSarifReportMojo
+    private val generateTestsAndSarifReportMojo: GenerateTestsAndSarifReportMojo
 ) : SarifExtensionProvider {
 
     override val targetClasses: List<String>
-        get() = createSarifReportMojo.targetClasses
+        get() = generateTestsAndSarifReportMojo.targetClasses
 
     override val projectRoot: File
-        get() = createSarifReportMojo.projectRoot
+        get() = generateTestsAndSarifReportMojo.projectRoot
 
     override val generatedTestsRelativeRoot: String
-        get() = createSarifReportMojo.generatedTestsRelativeRoot
+        get() = generateTestsAndSarifReportMojo.generatedTestsRelativeRoot
 
     override val sarifReportsRelativeRoot: String
-        get() = createSarifReportMojo.sarifReportsRelativeRoot
+        get() = generateTestsAndSarifReportMojo.sarifReportsRelativeRoot
 
     override val markGeneratedTestsDirectoryAsTestSourcesRoot: Boolean
-        get() = createSarifReportMojo.markGeneratedTestsDirectoryAsTestSourcesRoot
+        get() = generateTestsAndSarifReportMojo.markGeneratedTestsDirectoryAsTestSourcesRoot
 
     override val testFramework: TestFramework
-        get() = testFrameworkParse(createSarifReportMojo.testFramework)
+        get() = testFrameworkParse(generateTestsAndSarifReportMojo.testFramework)
 
     override val mockFramework: MockFramework
-        get() = mockFrameworkParse(createSarifReportMojo.mockFramework)
+        get() = mockFrameworkParse(generateTestsAndSarifReportMojo.mockFramework)
 
     override val generationTimeout: Long
-        get() = generationTimeoutParse(createSarifReportMojo.generationTimeout)
+        get() = generationTimeoutParse(generateTestsAndSarifReportMojo.generationTimeout)
 
     override val codegenLanguage: CodegenLanguage
-        get() = codegenLanguageParse(createSarifReportMojo.codegenLanguage)
+        get() = codegenLanguageParse(generateTestsAndSarifReportMojo.codegenLanguage)
 
     override val mockStrategy: MockStrategyApi
-        get() = mockStrategyParse(createSarifReportMojo.mockStrategy)
+        get() = mockStrategyParse(generateTestsAndSarifReportMojo.mockStrategy)
 
     override val staticsMocking: StaticsMocking
-        get() = staticsMockingParse(createSarifReportMojo.staticsMocking)
+        get() = staticsMockingParse(generateTestsAndSarifReportMojo.staticsMocking)
 
     override val forceStaticMocking: ForceStaticMocking
-        get() = forceStaticMockingParse(createSarifReportMojo.forceStaticMocking)
+        get() = forceStaticMockingParse(generateTestsAndSarifReportMojo.forceStaticMocking)
 
     override val classesToMockAlways: Set<ClassId>
-        get() = classesToMockAlwaysParse(createSarifReportMojo.classesToMockAlways)
+        get() = classesToMockAlwaysParse(generateTestsAndSarifReportMojo.classesToMockAlways)
 }