Merge branch 'vol0n/clion_plugin' into fix_bugs_after_refactoring

Author: Arseniy Volynets

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

@@ -3,7 +3,6 @@ package org.utbot.cpp.clion.plugin.settings
 import com.intellij.openapi.components.Service
 import com.intellij.openapi.components.service
 import com.intellij.openapi.project.Project
-import com.intellij.openapi.project.guessProjectDir
 import com.jetbrains.cidr.cpp.execution.CMakeAppRunConfiguration
 import org.utbot.cpp.clion.plugin.listeners.UTBotSettingsChangedListener
 import org.utbot.cpp.clion.plugin.ui.targetsToolWindow.UTBotTarget
@@ -19,14 +18,10 @@ class UTBotAllProjectSettings(val project: Project) {
     val storedSettings: UTBotProjectStoredSettings.State
         get() = project.service<UTBotProjectStoredSettings>().state
 
+    // todo: maybe remove this property and access directly
     var projectPath: String
         get() {
-            // if true then there is nothing persisted in xml files and plugin was launched for the first time
-            if (storedSettings.projectPath == null)
-                // so we should guess the project path
-                storedSettings.projectPath = project.guessProjectDir()?.path
             return storedSettings.projectPath
-            ?: error("Could not guess project path! Should be specified in settings")
         }
         set(value) {
             storedSettings.projectPath = value
@@ -67,12 +62,13 @@ class UTBotAllProjectSettings(val project: Project) {
     fun predictPaths() {
         fun getSourceFoldersFromSources(sources: Collection<File>) = sources.map { it.parent }.toMutableSet()
 
-        storedSettings.remotePath = projectPath
-        storedSettings.buildDirRelativePath = "build-utbot"
+        storedSettings.remotePath = UTBotProjectStoredSettings.REMOTE_PATH_VALUE_FOR_LOCAL_SCENARIO
+        storedSettings.buildDirRelativePath = UTBotProjectStoredSettings.DEFAULT_RELATIVE_PATH_TO_BUILD_DIR
         storedSettings.targetPath = UTBotTarget.autoTarget.path
 
         try {
-            storedSettings.testDirPath = Paths.get(projectPath, "tests").toString()
+            storedSettings.testDirPath =
+                Paths.get(projectPath, UTBotProjectStoredSettings.DEFAULT_RELATIVE_PATH_TO_TEST_DIR).toString()
         } catch (e: IllegalStateException) {
             notifyWarning("Guessing settings failed: could not guess project path! Please specify it in settings!")
         }

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

@@ -9,6 +9,7 @@ import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.DialogPanel
 import com.intellij.ui.dsl.builder.BottomGap
 import com.intellij.ui.dsl.builder.COLUMNS_LARGE
+import com.intellij.ui.dsl.builder.LabelPosition
 import com.intellij.ui.dsl.builder.Panel
 import com.intellij.ui.dsl.builder.Row
 import com.intellij.ui.dsl.builder.bindIntText
@@ -95,17 +96,18 @@ class UTBotConfigurable(private val myProject: Project) : BoundConfigurable(
                     UTBot.message("settings.project.testsDir.browse.title")
                 ).rowComment(UTBot.message("paths.testsDirectory.description"))
 
-                row(UTBot.message("settings.project.sourcePaths")) {
+                row {
                     val pane = UTBotProjectViewPaneForSettings(myProject)
                     cell(pane.createComponent()).onApply {
                         pane.apply()
                     }.onReset {
                         pane.reset()
                     }.onIsModified {
                         pane.isModified()
-                    }
+                    }.label(UTBot.message("settings.project.sourcePaths"), LabelPosition.TOP)
                 }.bottomGap(BottomGap.SMALL).rowComment(UTBot.message("paths.sourceDirectories.description"))
 
+
                 row {
                     label("Try to get paths from CMake model: ")
                     button("Detect Paths") {

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

@@ -5,7 +5,9 @@ import com.intellij.openapi.components.Service
 import com.intellij.openapi.components.State
 import com.intellij.openapi.components.Storage
 import com.intellij.openapi.project.Project
+import com.intellij.openapi.project.guessProjectDir
 import org.utbot.cpp.clion.plugin.ui.targetsToolWindow.UTBotTarget
+import java.nio.file.Paths
 
 /**
  * Settings that are specific to each project
@@ -20,11 +22,11 @@ class UTBotProjectStoredSettings(val project: Project) : PersistentStateComponen
 
     // serialized by the ide
     data class State(
-        var projectPath: String? = null,
-        var buildDirRelativePath: String = "build-utbot",
+        var projectPath: String = "",
+        var buildDirRelativePath: String = DEFAULT_RELATIVE_PATH_TO_BUILD_DIR,
         var testDirPath: String = "",
         var targetPath: String = UTBotTarget.autoTarget.path,
-        var remotePath: String = "",
+        var remotePath: String = REMOTE_PATH_VALUE_FOR_LOCAL_SCENARIO,
         var sourceDirs: Set<String> = setOf(),
         var cmakeOptions: String = DEFAULT_CMAKE_OPTIONS.joinToString(" "),
         var generateForStaticFunctions: Boolean = true,
@@ -55,7 +57,21 @@ class UTBotProjectStoredSettings(val project: Project) : PersistentStateComponen
         myState = state
     }
 
+    // called when during component initialization if there is no persisted state.
+    // See java docs for PersistingStateComponent
+    override fun noStateLoaded() {
+        myState.projectPath =
+            project.guessProjectDir()?.path ?: error("Could not guess project path! Should be specified in settings")
+        myState.testDirPath = Paths.get(myState.projectPath).resolve(DEFAULT_RELATIVE_PATH_TO_TEST_DIR).toString()
+        myState.remotePath = REMOTE_PATH_VALUE_FOR_LOCAL_SCENARIO
+    }
+
+
     companion object {
         val DEFAULT_CMAKE_OPTIONS = listOf("-DCMAKE_EXPORT_COMPILE_COMMANDS=ON", "-DCMAKE_EXPORT_LINK_COMMANDS=ON")
+        // local means no conversion of paths is needed. This is the case for when server runs locally on Linux
+        const val REMOTE_PATH_VALUE_FOR_LOCAL_SCENARIO = ""
+        const val DEFAULT_RELATIVE_PATH_TO_TEST_DIR = "utbot-tests"
+        const val DEFAULT_RELATIVE_PATH_TO_BUILD_DIR = "utbot-build"
     }
 }

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/steps/ConnectionStep.kt

@@ -34,6 +34,8 @@ import org.utbot.cpp.clion.plugin.utils.validateInput
 import javax.swing.JComponent
 import javax.swing.event.DocumentEvent
 import kotlin.properties.Delegates
+import org.utbot.cpp.clion.plugin.settings.UTBotProjectStoredSettings
+import org.utbot.cpp.clion.plugin.utils.isWindows
 
 enum class ConnectionStatus {
     Connected,
@@ -61,7 +63,8 @@ class ConnectionStep(
             if (newValue) {
                 portTextField.text = UTBotAllProjectSettings.DEFAULT_PORT.toString()
                 hostTextField.text = UTBotAllProjectSettings.DEFAULT_HOST
-                remotePathTextField.text = project.settings.projectPath.toWslFormat()
+                remotePathTextField.text = if (isWindows) project.settings.projectPath.toWslFormat()
+                    else UTBotProjectStoredSettings.REMOTE_PATH_VALUE_FOR_LOCAL_SCENARIO
             }
         }
     }
@@ -167,9 +170,10 @@ class ConnectionStep(
         addHtml("media/remote_path.html")
         panel {
             row {
-                textField().bindText(settingsModel.projectSettings::remotePath).columns(COLUMNS_LARGE).applyToComponent {
-                    remotePathTextField = this
-                }.enabledIf(object : ComponentPredicate() {
+                textField().bindText(settingsModel.projectSettings::remotePath).columns(COLUMNS_LARGE)
+                    .applyToComponent {
+                        remotePathTextField = this
+                    }.enabledIf(object : ComponentPredicate() {
                     override fun invoke() = !useConnectionDefaults.value
                     override fun addListener(listener: (Boolean) -> Unit) {
                         useConnectionDefaults.addOnChangeListener { newValue -> listener(!newValue) }

clion-plugin/src/main/resources/messages/UTBot.properties

@@ -6,8 +6,8 @@ projectConfigure.reconfigure=Reset cache and configure project
 wizard.show=Quickstart wizard
 settings.project.projectPath=Path to project:
 settings.project.projectPath.title=Choose project directory
-settings.project.projectPath.info=Path to project:
-settings.project.sourcePaths=Source paths:
+settings.project.projectPath.info=Path to project (local). Generally it is guessed automatically. But in rare cases should be set manually
+settings.project.sourcePaths=Source paths
 settings.project.buildDir=Build directory:
 settings.project.target=target path:
 settings.project.testsDir=Tests directory:
@@ -34,12 +34,12 @@ requests.buildDir.description.progress=Creating build directory...
 uri.wiki=https://github.com/UnitTestBot/UTBotCpp/wiki
 deployment.utbotHost.description=UTBot Server host address. <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#deployment>Learn more</a>
 deployment.utbotPort.description=UTBot Server port. <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#utbot-port>Learn more</a>
-deployment.remotePath.description=Remote path configuration specifies the path to the project on a remote host. <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#remote-path>Learn more</a>
+deployment.remotePath.description=Remote path configuration specifies the path to the project on a remote host. Empty value specifies local scenario (for Linux). <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#remote-path>Learn more</a>
 paths.buildDirectory.description=Relative path to build directory with compile_commands.json and/or coverage.json. <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#build-directory>Learn more</a>
 paths.target.description=Path to target which is passed to UTBot
 paths.cmakeOptions.description=Options passed to CMake command. <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#cmake-options>Learn more</a>
 paths.testsDirectory.description=Relative path to directory in which tests will be generated. <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#tests-directory>Learn more</a>
-paths.sourceDirectories.description=Paths to directories, that are marked as source directories. <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#source-directories>Learn more</a>
+paths.sourceDirectories.description=Mark/unmark directory as source by double-clicking or using actions from context menu. You can also unmark or mark directories in UTBot project view pane. <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#source-directories>Learn more</a>
 testsGeneration.verboseFormatting.description=If set to true, tests will be formatted in more detailed form. <a href=https://github.com/UnitTestBot/UTBotCpp/wiki/vscode-extension-settings#verbose-formatting>Learn more</a>
 testsGeneration.verboseFormatting.title=Use verbose mode
 testsGeneration.generateForStaticFunctions.title=Generate for static functions