add monitoring settings

Author: Rustam Sadykov

.github/workflows/night-statistics-monitoring.yml

@@ -5,8 +5,7 @@ on:
      - cron: '0 0 * * *'
 
 env:
-  run_tries: 3
-  run_timeout_minutes: 20
+  monitoring_properties: monitoring/monitoring.properties
   output_stats: stats.json
   history_file: monitoring/history.json
   coverage_graph_file: monitoring/coverage_graph.png
@@ -38,8 +37,10 @@ jobs:
       - name: Build and run monitoring UTBot Java
         run: |
           gradle :utbot-junit-contest:monitoringJar
-          java -jar utbot-junit-contest/build/libs/monitoring.jar \
-            $output_stats $run_tries $run_timeout_minutes
+          java -jar \
+            -Dutbot.monitoring.settings.path=$monitoring_properties \
+            utbot-junit-contest/build/libs/monitoring.jar \
+            $output_stats
 
       - name: Update history and render graphs
         run: |

docs/NightStatisticsMonitoring.md

@@ -14,12 +14,15 @@ Thus, we will do it every night when no one makes changes.
 ### Collecting statistics
 Collecting statistics StatisticsMonitoring.kt based on ContestEstimator.kt 
 that runs testcase generation on projects, then compile generated tests.
-We run it several times. Input arguments: `<output json> <run tries> <run timeout min>`.
+We run it several times. Input arguments: `<output json>`.
+
 More about statistic: Statistics.kt.
 
+More about monitoring settings: MonitoringSettings.kt
+
 Example input:
 ```
-stats.json 3 20
+stats.json
 ```
 Example output:
 ```json

monitoring/monitoring.properties

@@ -0,0 +1,3 @@
+timeLimitPerClass=20
+runTries=3
+runTimeoutMinutes=20

utbot-core/src/main/kotlin/org/utbot/common/AbstractSettings.kt

@@ -0,0 +1,80 @@
+package org.utbot.common
+
+import java.io.FileInputStream
+import java.io.IOException
+import java.util.*
+import mu.KLogger
+import org.utbot.common.PathUtil.toPath
+import kotlin.properties.PropertyDelegateProvider
+import kotlin.reflect.KProperty
+
+abstract class AbstractSettings(
+    private val logger: KLogger,
+    defaultKeyForSettingsPath: String,
+    defaultSettingsPath: String? = null
+) {
+    protected val properties = Properties().also { props ->
+        val settingsPath = System.getProperty(defaultKeyForSettingsPath) ?: defaultSettingsPath
+        val settingsPathFile = settingsPath?.toPath()?.toFile()
+        if (settingsPathFile?.exists() == true) {
+            try {
+                FileInputStream(settingsPathFile).use { reader ->
+                    props.load(reader)
+                }
+            } catch (e: IOException) {
+                logger.info(e) { e.message }
+            }
+        }
+    }
+
+    protected val settingsValues: MutableMap<KProperty<*>, Any?> = mutableMapOf()
+
+    inner class SettingDelegate<T>(val property: KProperty<*>, val initializer: () -> T) {
+        private var value = initializer()
+
+        init {
+            updateSettingValue()
+        }
+
+        operator fun getValue(thisRef: Any?, property: KProperty<*>): T = value
+
+        operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T) {
+            this.value = value
+            updateSettingValue()
+        }
+
+        private fun updateSettingValue() {
+            settingsValues[property] = value
+        }
+    }
+
+    protected fun <T> getProperty(
+        defaultValue: T,
+        converter: (String) -> T
+    ): PropertyDelegateProvider<Any?, SettingDelegate<T>> {
+        return PropertyDelegateProvider { _, property ->
+            SettingDelegate(property) {
+                try {
+                    properties.getProperty(property.name)?.let(converter) ?: defaultValue
+                } catch (e: Throwable) {
+                    logger.info(e) { e.message }
+                    defaultValue
+                }
+            }
+        }
+    }
+
+    protected fun getBooleanProperty(defaultValue: Boolean) = getProperty(defaultValue, String::toBoolean)
+    protected fun getIntProperty(defaultValue: Int) = getProperty(defaultValue, String::toInt)
+    protected fun getLongProperty(defaultValue: Long) = getProperty(defaultValue, String::toLong)
+    protected fun getStringProperty(defaultValue: String) = getProperty(defaultValue) { it }
+    protected inline fun <reified T : Enum<T>> getEnumProperty(defaultValue: T) =
+        getProperty(defaultValue) { enumValueOf(it) }
+
+    override fun toString(): String =
+        settingsValues
+            .mapKeys { it.key.name }
+            .entries
+            .sortedBy { it.key }
+            .joinToString(separator = System.lineSeparator()) { "\t${it.key}=${it.value}" }
+}

utbot-framework-api/src/main/kotlin/org/utbot/framework/UtSettings.kt

@@ -1,11 +1,7 @@
 package org.utbot.framework
 
 import mu.KotlinLogging
-import org.utbot.common.PathUtil.toPath
-import java.io.FileInputStream
-import java.io.IOException
-import java.util.Properties
-import kotlin.properties.PropertyDelegateProvider
+import org.utbot.common.AbstractSettings
 import kotlin.reflect.KProperty
 
 private val logger = KotlinLogging.logger {}
@@ -50,43 +46,9 @@ internal class SettingDelegate<T>(val property: KProperty<*>, val initializer: (
  */
 const val DEFAULT_CONCRETE_EXECUTION_TIMEOUT_IN_CHILD_PROCESS_MS = 1000L
 
-object UtSettings {
-    private val properties = Properties().also { props ->
-        val settingsPath = System.getProperty(defaultKeyForSettingsPath) ?: defaultSettingsPath
-        val settingsPathFile = settingsPath.toPath().toFile()
-        if (settingsPathFile.exists()) {
-            try {
-                FileInputStream(settingsPathFile).use { reader ->
-                    props.load(reader)
-                }
-            } catch (e: IOException) {
-                logger.info(e) { e.message }
-            }
-        }
-    }
-
-    private fun <T> getProperty(
-        defaultValue: T,
-        converter: (String) -> T
-    ): PropertyDelegateProvider<UtSettings, SettingDelegate<T>> {
-        return PropertyDelegateProvider { _, property ->
-            SettingDelegate(property) {
-                try {
-                    properties.getProperty(property.name)?.let(converter) ?: defaultValue
-                } catch (e: Throwable) {
-                    logger.info(e) { e.message }
-                    defaultValue
-                }
-            }
-        }
-    }
-
-    private fun getBooleanProperty(defaultValue: Boolean) = getProperty(defaultValue, String::toBoolean)
-    private fun getIntProperty(defaultValue: Int) = getProperty(defaultValue, String::toInt)
-    private fun getLongProperty(defaultValue: Long) = getProperty(defaultValue, String::toLong)
-    private fun getStringProperty(defaultValue: String) = getProperty(defaultValue) { it }
-    private inline fun <reified T : Enum<T>> getEnumProperty(defaultValue: T) =
-        getProperty(defaultValue) { enumValueOf(it) }
+object UtSettings : AbstractSettings(
+    logger, defaultKeyForSettingsPath, defaultSettingsPath
+) {
 
     /**
      * Setting to disable coroutines debug explicitly.
@@ -388,13 +350,6 @@ object UtSettings {
      * Flag that indicates whether tests for synthetic methods (values, valueOf in enums) should be generated, or not
      */
     var skipTestGenerationForSyntheticMethods by getBooleanProperty(true)
-
-    override fun toString(): String =
-        settingsValues
-            .mapKeys { it.key.name }
-            .entries
-            .sortedBy { it.key }
-            .joinToString(separator = System.lineSeparator()) { "\t${it.key}=${it.value}" }
 }
 
 /**

utbot-junit-contest/src/main/kotlin/org/utbot/monitoring/MonitoringSettings.kt

@@ -0,0 +1,33 @@
+package org.utbot.monitoring
+
+import mu.KotlinLogging
+import org.utbot.common.AbstractSettings
+
+
+private val logger = KotlinLogging.logger {}
+
+private const val defaultKeyForSettingsPath = "utbot.monitoring.settings.path"
+
+object MonitoringSettings : AbstractSettings(
+    logger, defaultKeyForSettingsPath
+) {
+    /**
+     * Test generation for one class timeout.
+     */
+    val timeLimitPerClass by getIntProperty(20)
+
+    /**
+     * Bound of classes for generation.
+     */
+    val processedClassesThreshold by getIntProperty(9999)
+
+    /**
+     * Number of running test generation.
+     */
+    val runTries by getIntProperty(1)
+
+    /**
+     * One running generation for all projects timeout in minutes.
+     */
+    val runTimeoutMinutes by getIntProperty(180)
+}

utbot-junit-contest/src/main/kotlin/org/utbot/monitoring/StatisticsMonitoring.kt

@@ -11,7 +11,6 @@ import org.utbot.contest.GlobalStats
 import org.utbot.contest.Paths
 import org.utbot.contest.Tool
 import org.utbot.contest.runEstimator
-import org.utbot.contest.toText
 import org.utbot.framework.JdkPathService
 import org.utbot.instrumentation.ConcreteExecutor
 import kotlin.system.exitProcess
@@ -20,22 +19,20 @@ private val javaHome = System.getenv("JAVA_HOME")
 private val logger = KotlinLogging.logger {}
 
 fun main(args: Array<String>) {
+    logger.info { "Monitoring Settings:\n$MonitoringSettings" }
+
     val methodFilter: String?
     val projectFilter: List<String>?
-    val processedClassesThreshold = 9999
+    val processedClassesThreshold = MonitoringSettings.processedClassesThreshold
     val tools: List<Tool> = listOf(Tool.UtBot)
-    val timeLimit = 20
-
-    require(args.size == 3) {
-        "Wrong arguments: <output json> <run tries> <run timeout min> expected, but got: ${args.toText()}"
-    }
+    val timeLimit = MonitoringSettings.timeLimitPerClass
 
     projectFilter = listOf("guava")
     methodFilter = null
 
-    val outputFile = File(args[0])
-    val runTries = args[1].toInt()
-    val runTimeout = TimeUnit.MINUTES.toMillis(args[2].toLong())
+    val outputFile = args.getOrNull(0)?.let { File(it) }
+    val runTries = MonitoringSettings.runTries
+    val runTimeout = TimeUnit.MINUTES.toMillis(MonitoringSettings.runTimeoutMinutes.toLong())
 
     val estimatorArgs: Array<String> = arrayOf(
         Paths.classesLists,
@@ -51,7 +48,7 @@ fun main(args: Array<String>) {
     val executor = ThreadBasedExecutor()
 
     repeat(runTries) { idx ->
-        logger.info().bracket("Run UTBot try number $idx") {
+        logger.info().bracket("Run UTBot try number ${idx + 1}") {
 
             executor.invokeWithTimeout(runTimeout) {
                 runEstimator(estimatorArgs, methodFilter, projectFilter, processedClassesThreshold, tools)
@@ -69,7 +66,7 @@ fun main(args: Array<String>) {
     if (statistics.isEmpty())
         exitProcess(1)
 
-    outputFile.writeText(statistics.jsonString())
+    outputFile?.writeText(statistics.jsonString())
 }
 
 private fun StringBuilder.tab(tabs: Int) {