Refactor UI and Utils related logic (#357)

Author: EgorkaKulikov

clion-plugin/README.md

@@ -43,7 +43,7 @@ all configuration options.
 1. Open plugin settings in settings - Tools - UTBot Settings
 2. Click `detect paths`. It will try to get source paths, build dir paths from CLion 
 CMake model.
-3. Specify absolute path to build folder, it should be different from build folder that CLion uses, 
+3. Specify absolute path to build directory, it should be different from build directory that CLion uses, 
 because there can be conflicts between UTBotCpp and CLion. For example, if CLion uses `project_path/cmake-build-debug`, 
 then you can specify `project_path/utbot_build`.
 4. For target path specify `/utbot/auto/target/path`

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/UTBotStartupActivity.kt

@@ -9,19 +9,24 @@ import org.utbot.cpp.clion.plugin.client.ClientManager
 import org.utbot.cpp.clion.plugin.settings.pluginSettings
 import org.utbot.cpp.clion.plugin.settings.settings
 import org.utbot.cpp.clion.plugin.ui.wizard.UTBotWizard
-import org.utbot.cpp.clion.plugin.utils.getCurrentClient
 import org.utbot.cpp.clion.plugin.utils.invokeOnEdt
 
 class UTBotStartupActivity : StartupActivity {
     override fun runActivity(project: Project) {
-        // we initialize Client here, so that initialization will not happen when user issues first
-        // generation request which would cause a UI freeze
+        // We initialize Client here, so that initialization will not happen
+        // when user issues first generation request which would cause a UI freeze.
         initializeClient(project)
-        guessPathsOnFirstProjectOpen(project)
-        showWizardOnFirstProjectOpen(project)
+        guessPathsOnFirstOpen(project)
+        showWizardOnFirstOpen(project)
     }
 
-    private fun showWizardOnFirstProjectOpen(project: Project) {
+    // Here we address the service ClientManager for the first time so that it
+    // will be initialized by the ide and Client will be created.
+    // Client in turn will create a grpc channel and start heart-beating the server.
+    private fun initializeClient(project: Project) = project.service<ClientManager>()
+
+
+    private fun showWizardOnFirstOpen(project: Project) {
         if (pluginSettings.isFirstLaunch && !Client.IS_TEST_MODE) {
             pluginSettings.isFirstLaunch = false
             invokeOnEdt {
@@ -30,14 +35,7 @@ class UTBotStartupActivity : StartupActivity {
         }
     }
 
-    private fun initializeClient(project: Project) {
-        // Here we address the service ClientManager for the first time so that it
-        // will be initialized by the ide and Client will be created.
-        // Client in turn will create a grpc channel and start heartbeating the server
-        project.service<ClientManager>()
-    }
-
-    private fun guessPathsOnFirstProjectOpen(project: Project) {
+    private fun guessPathsOnFirstOpen(project: Project) {
         RunOnceUtil.runOnceForProject(project, "Guess UTBot paths in settings") {
             project.settings.predictPaths()
         }

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/actions/generate/RunWithCoverageAction.kt

@@ -14,7 +14,7 @@ class RunWithCoverageAction(val element: PsiElement) : BaseGenerateTestsAction()
     override fun actionPerformed(e: AnActionEvent) {
         logger.debug("Action RunWithCoverageAction was called")
 
-        val testArgs = TestNameAndTestSuite.getFromPsiElement(element)
+        val testArgs = TestNameAndTestSuite.create(element)
         val suiteName = testArgs.suite
         val testedMethodName = testArgs.name
         val filePath = e.getRequiredData(CommonDataKeys.VIRTUAL_FILE).path

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/Client.kt

@@ -12,6 +12,7 @@ import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.isActive
+import kotlinx.coroutines.job
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withTimeout
@@ -21,7 +22,6 @@ import org.utbot.cpp.clion.plugin.grpc.getProjectConfigGrpcRequest
 import org.utbot.cpp.clion.plugin.listeners.ConnectionStatus
 import org.utbot.cpp.clion.plugin.listeners.UTBotEventsListener
 import org.utbot.cpp.clion.plugin.settings.projectIndependentSettings
-import org.utbot.cpp.clion.plugin.utils.hasChildren
 import org.utbot.cpp.clion.plugin.utils.logger
 import testsgen.Testgen
 
@@ -52,15 +52,15 @@ class Client(
         exception.printStackTrace()
     }
 
-    val dispatcher = Dispatchers.IO
+    private val dispatcher = Dispatchers.IO
 
     // coroutine scope for requests that don't have a lifetime of a plugin, e.g. generation requests
     // this division is needed for testing: when in test we send a generate request to server, we need to wait
     // until it completes, the indicator that all such requests have completed is that this scope has no children
-    val requestsCS: CoroutineScope = CoroutineScope(dispatcher + excHandler + SupervisorJob())
+    private val requestsCS: CoroutineScope = CoroutineScope(dispatcher + excHandler + SupervisorJob())
 
     // coroutine scope for suspending functions that can live entire plugin lifetime, e.g. server logs, gtest logs, heartbeat
-    val servicesCS: CoroutineScope = CoroutineScope(dispatcher + excHandler + SupervisorJob())
+    private val servicesCS: CoroutineScope = CoroutineScope(dispatcher + excHandler + SupervisorJob())
 
     init {
         logger.info { "Connecting to server on host: ${projectIndependentSettings.serverName} , port: ${projectIndependentSettings.port}" }
@@ -192,7 +192,7 @@ class Client(
     fun waitForServerRequestsToFinish(timeout: Long = SERVER_TIMEOUT) {
         runBlocking {
             withTimeout(timeout) {
-                while (requestsCS.hasChildren()) {
+                while (requestsCS.coroutineContext.job.children.any()) {
                     delay(DELAY_TIME)
                 }
             }

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/LoggingChannels.kt

@@ -7,7 +7,7 @@ import kotlinx.coroutines.flow.catch
 import kotlinx.coroutines.flow.collect
 import org.utbot.cpp.clion.plugin.grpc.getDummyGrpcRequest
 import org.utbot.cpp.clion.plugin.grpc.getLogChannelGrpcRequest
-import org.utbot.cpp.clion.plugin.ui.userLog.OutputProvider
+import org.utbot.cpp.clion.plugin.ui.services.OutputProvider
 import org.utbot.cpp.clion.plugin.ui.userLog.UTBotConsole
 import org.utbot.cpp.clion.plugin.utils.invokeOnEdt
 import org.utbot.cpp.clion.plugin.utils.logger

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/handlers/ProjectConfigurationHandler.kt

@@ -15,7 +15,7 @@ import org.utbot.cpp.clion.plugin.utils.notifyError
 import org.utbot.cpp.clion.plugin.utils.notifyInfo
 import org.utbot.cpp.clion.plugin.utils.notifyUnknownResponse
 import org.utbot.cpp.clion.plugin.utils.notifyWarning
-import org.utbot.cpp.clion.plugin.utils.refreshAndFindIOFile
+import org.utbot.cpp.clion.plugin.utils.refreshAndFindNioFile
 import testsgen.Testgen
 
 abstract class ProjectConfigResponseHandler(
@@ -58,8 +58,9 @@ class CheckProjectConfigurationHandler(
                 val missingFileName =
                     if (response.type == Testgen.ProjectConfigStatus.LINK_COMMANDS_JSON_NOT_FOUND) "link_commands.json" else "compile_commands.json"
                 notifyError(
-                    "Project is not configured properly: $missingFileName is missing in the build folder.",
-                    project, AskServerToGenerateJsonForProjectConfiguration()
+                    "Project is not configured properly: file $missingFileName is missed in the build directory",
+                    project,
+                    AskServerToGenerateJsonForProjectConfiguration(),
                 )
             }
             Testgen.ProjectConfigStatus.BUILD_DIR_SAME_AS_PROJECT -> {
@@ -97,7 +98,7 @@ class CreateBuildDirHandler(
             }
             else -> notifyUnknownResponse(response, project)
         }
-        refreshAndFindIOFile(project.settings.buildDirPath.toString())
+        refreshAndFindNioFile(project.settings.buildDirPath)
     }
 }
 
@@ -116,6 +117,6 @@ class GenerateJsonHandler(
             )
             else -> notifyUnknownResponse(response, project)
         }
-        refreshAndFindIOFile(project.settings.buildDirPath.toString())
+        refreshAndFindNioFile(project.settings.buildDirPath)
     }
 }

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/handlers/StreamHandlerWithProgress.kt

@@ -27,7 +27,7 @@ abstract class StreamHandlerWithProgress<T>(
     override fun onFinish() {
         super.onFinish()
         invokeOnEdt {
-            indicator.complete()
+            indicator.finish()
         }
     }
 

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/handlers/TestsStreamHandler.kt

@@ -4,9 +4,9 @@ import com.intellij.openapi.project.Project
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.flow.Flow
 import org.utbot.cpp.clion.plugin.utils.convertFromRemotePathIfNeeded
-import org.utbot.cpp.clion.plugin.utils.createFileAndMakeDirs
+import org.utbot.cpp.clion.plugin.utils.createFileWithText
 import org.utbot.cpp.clion.plugin.utils.logger
-import org.utbot.cpp.clion.plugin.utils.refreshAndFindIOFile
+import org.utbot.cpp.clion.plugin.utils.refreshAndFindNioFile
 import testsgen.Testgen
 import testsgen.Util
 import java.nio.file.Path
@@ -42,7 +42,7 @@ class TestsStreamHandler(
 
             if (sourceCode.code.isNotEmpty()) {
                 project.logger.trace { "Creating generated test file: $filePath." }
-                createFileAndMakeDirs(
+                createFileWithText(
                     filePath,
                     sourceCode.code
                 )
@@ -54,7 +54,7 @@ class TestsStreamHandler(
                         " and ${sourceCode.errorMethodsNumber} tests in error suite"
             project.logger.info { "$infoMessage: $filePath" }
 
-            refreshAndFindIOFile(filePath)
+            refreshAndFindNioFile(filePath)
         }
     }
 

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/logger/ClientLogger.kt

@@ -1,114 +1,36 @@
 package org.utbot.cpp.clion.plugin.client.logger
 
-import com.intellij.execution.ui.ConsoleViewContentType
 import com.intellij.openapi.components.Service
-import com.intellij.openapi.components.service
 import com.intellij.openapi.project.Project
-import org.utbot.cpp.clion.plugin.ui.userLog.OutputProvider
-import org.utbot.cpp.clion.plugin.utils.invokeOnEdt
-import java.time.LocalDateTime
-import java.time.format.DateTimeFormatter
-
-enum class Level(val text: String) {
-    TRACE("TRACE"), DEBUG("DEBUG"), INFO("INFO"), WARN("WARN"), ERROR("ERROR"), OFF("OFF")
-}
-
-interface Writer {
-    fun write(message: LogMessage)
-}
-
-interface Formatter {
-    fun format(message: LogMessage): String
-}
-
-class SimpleFormatter : Formatter {
-    override fun format(message: LogMessage): String {
-        val dateTime = DateTimeFormatter.ofPattern("HH:mm:ss.SSSS").format(message.dateTime)
-        return "$dateTime | ${message.fileName}:${message.line} [${message.threadName}] " +
-                "|${message.level.text}| ${message.messageSupplier()} \n"
-    }
-}
-
-data class LogMessage(
-    val messageSupplier: () -> (String),
-    val line: Int,
-    val fileName: String,
-    val threadName: String,
-    val methodName: String,
-    val level: Level,
-    val dateTime: LocalDateTime = LocalDateTime.now(),
-) {
-    constructor(message: () -> String, level: Level, frame: StackTraceElement) :
-            this(
-                message,
-                frame.lineNumber,
-                frame.fileName ?: "Unknown file",
-                Thread.currentThread().name,
-                frame.methodName,
-                level
-            )
-}
-
-class ConsoleWriter(project: Project) : Writer {
-    private val console = project.service<OutputProvider>().clientOutputChannel.outputConsole
-    private val formatter = SimpleFormatter()
-    override fun write(message: LogMessage) {
-        val type = when (message.level) {
-            Level.INFO -> ConsoleViewContentType.NORMAL_OUTPUT
-            Level.WARN -> ConsoleViewContentType.LOG_WARNING_OUTPUT
-            Level.ERROR -> ConsoleViewContentType.LOG_ERROR_OUTPUT
-            Level.DEBUG -> ConsoleViewContentType.LOG_DEBUG_OUTPUT
-            else -> ConsoleViewContentType.NORMAL_OUTPUT
-        }
-        invokeOnEdt {
-            console.print(formatter.format(message), type)
-        }
-    }
-}
-
-class SystemWriter : Writer {
-    private val formatter = SimpleFormatter()
-    override fun write(message: LogMessage) {
-        println(formatter.format(message))
-    }
-}
 
 @Service
-class ClientLogger(private val project: Project) {
-    var level = Level.TRACE
+class ClientLogger(project: Project) {
+    var level = LogLevel.TRACE
         set(value) {
             info { "Setting new log level: ${value.text}" }
             field = value
         }
 
-    val writers: MutableList<Writer> = mutableListOf(ConsoleWriter(project))
+    val logWriters: MutableList<LogWriter> = mutableListOf(ConsoleWriter(project))
 
-    fun info(message: () -> String) {
-        log(message, Level.INFO)
-    }
+    fun info(message: () -> String) = log(message, LogLevel.INFO)
 
-    fun warn(message: () -> String) {
-        log(message, Level.WARN)
-    }
+    fun warn(message: () -> String) = log(message, LogLevel.WARN)
 
-    fun error(message: () -> String) {
-        log(message, Level.ERROR)
-    }
+    fun error(message: () -> String) = log(message, LogLevel.ERROR)
 
-    fun debug(message: () -> String) {
-        log(message, Level.DEBUG)
-    }
+    fun debug(message: () -> String) = log(message, LogLevel.DEBUG)
 
-    fun trace(message: () -> String) {
-        log(message, Level.TRACE)
-    }
+    fun trace(message: () -> String) = log(message, LogLevel.TRACE)
 
-    fun log(messageSupplier: () -> (String), level: Level, depth: Int = 3) {
-        if (level.ordinal < this.level.ordinal)
+    private fun log(messageSupplier: () -> (String), level: LogLevel, depth: Int = 3) {
+        if (level.ordinal < this.level.ordinal){
             return
-        val logMessage: LogMessage = LogMessage(messageSupplier, level, Thread.currentThread().stackTrace[depth + 1])
-        writers.forEach {
-            it.write(logMessage)
+        }
+
+        val logMessage = LogMessage(messageSupplier, level, Thread.currentThread().stackTrace[depth + 1])
+        for (writer in logWriters) {
+            writer.write(logMessage)
         }
     }
 }

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/logger/LogFormatter.kt

@@ -0,0 +1,13 @@
+package org.utbot.cpp.clion.plugin.client.logger
+
+import java.time.format.DateTimeFormatter
+
+object LogFormatter {
+    fun format(message: LogMessage): String {
+        val dateTime = DateTimeFormatter.ofPattern("HH:mm:ss.SSSS").format(message.dateTime)
+        return "$dateTime | ${message.fileName}:${message.line} [${message.threadName}] " +
+                "|${message.level.text}| ${message.messageSupplier()} \n"
+    }
+}
+
+

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/logger/LogLevel.kt

@@ -0,0 +1,10 @@
+package org.utbot.cpp.clion.plugin.client.logger
+
+enum class LogLevel(val text: String) {
+    TRACE("TRACE"),
+    DEBUG("DEBUG"),
+    INFO("INFO"),
+    WARN("WARN"),
+    ERROR("ERROR"),
+    OFF("OFF"),
+}

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/logger/LogMessage.kt

@@ -0,0 +1,23 @@
+package org.utbot.cpp.clion.plugin.client.logger
+
+import java.time.LocalDateTime
+
+data class LogMessage(
+    val messageSupplier: () -> (String),
+    val line: Int,
+    val fileName: String,
+    val threadName: String,
+    val methodName: String,
+    val level: LogLevel,
+    val dateTime: LocalDateTime = LocalDateTime.now(),
+) {
+    constructor(message: () -> String, level: LogLevel, frame: StackTraceElement) :
+            this(
+                message,
+                frame.lineNumber,
+                frame.fileName ?: "Unknown file",
+                Thread.currentThread().name,
+                frame.methodName,
+                level
+            )
+}