validate tests, build, remote paths in wizard and settings

vol0n · vol0n · commit e8f7abb19bbd · 2022-09-20T19:38:17.000+03:00
diff --git a/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/settings/UTBotConfigurable.kt b/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/settings/UTBotConfigurable.kt
@@ -5,12 +5,14 @@ package org.utbot.cpp.clion.plugin.settings
 import com.intellij.openapi.components.service
 import com.intellij.openapi.diagnostic.Logger
 import com.intellij.openapi.options.BoundConfigurable
+import com.intellij.openapi.options.ConfigurationException
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.DialogPanel
 import com.intellij.ui.JBIntSpinner
 import com.intellij.ui.components.JBTextField
 import com.intellij.ui.dsl.builder.BottomGap
 import com.intellij.ui.dsl.builder.COLUMNS_LARGE
+import com.intellij.ui.dsl.builder.Cell
 import com.intellij.ui.dsl.builder.LabelPosition
 import com.intellij.ui.dsl.builder.Panel
 import com.intellij.ui.dsl.builder.bindIntValue
@@ -22,7 +24,12 @@ import kotlin.reflect.KMutableProperty0
 import org.utbot.cpp.clion.plugin.UTBot
 import org.utbot.cpp.clion.plugin.listeners.UTBotSettingsChangedListener
 import org.utbot.cpp.clion.plugin.ui.sourceFoldersView.UTBotProjectViewPaneForSettings
+import org.utbot.cpp.clion.plugin.utils.ComponentValidationInfo
+import org.utbot.cpp.clion.plugin.utils.ValidationCondition
+import org.utbot.cpp.clion.plugin.utils.addValidation
 import org.utbot.cpp.clion.plugin.utils.commandLineEditor
+import org.utbot.cpp.clion.plugin.utils.isLookLikeUnixPath
+import org.utbot.cpp.clion.plugin.utils.isValidHostName
 import org.utbot.cpp.clion.plugin.utils.projectLifetimeDisposable
 import java.awt.Dimension
 
@@ -33,6 +40,7 @@ class UTBotConfigurable(private val myProject: Project) : BoundConfigurable(
     private val panel by lazy { createMainPanel() }
 
     private val settings: UTBotProjectStoredSettings = myProject.service()
+    private val validationInfos: MutableList<ComponentValidationInfo> = mutableListOf()
     private lateinit var portComponent: JBIntSpinner
     private lateinit var serverNameTextField: JBTextField
 
@@ -44,6 +52,13 @@ class UTBotConfigurable(private val myProject: Project) : BoundConfigurable(
             })
     }
 
+    private fun <T : JBTextField> Cell<T>.validateInput(vararg conditions: ValidationCondition): Cell<T> {
+        return this.apply {
+            validationInfos.add(this.addValidation(*conditions))
+        }
+    }
+
+
     override fun createPanel() = panel
 
     private fun createMainPanel(): DialogPanel {
@@ -69,17 +84,28 @@ class UTBotConfigurable(private val myProject: Project) : BoundConfigurable(
         row(UTBot.message("settings.project.serverName")) {
             textField().bindText(projectIndependentSettings::serverName).applyToComponent {
                 serverNameTextField = this
-            }
+            }.validateInput(
+                ValidationCondition(
+                    UTBot.message("validation.invalid.host")
+                ) { it.text.isValidHostName() }
+            )
         }.rowComment(UTBot.message("deployment.utbotHost.description"))
 
         row(UTBot.message("settings.project.remotePath")) {
-            textField().bindText(settings::remotePath).columns(COLUMNS_LARGE)
+            textField().bindText(settings::remotePath).columns(COLUMNS_LARGE).validateInput(
+                ValidationCondition(UTBot.message("validation.not.empty")) { it.text.isNotEmpty() },
+                ValidationCondition(UTBot.message("validation.not.unix.path")) { it.text.isLookLikeUnixPath() }
+            )
         }.rowComment(UTBot.message("deployment.remotePath.description"))
     }
 
     private fun Panel.createPathsSettings() {
         row(UTBot.message("settings.project.buildDir")) {
+            val validator: (JBTextField) -> Boolean = {
+                it.text.isNotEmpty()
+            }
             textField().bindText(settings::buildDirRelativePath).columns(COLUMNS_LARGE)
+                .validateInput(ValidationCondition(UTBot.message("validation.not.empty")) { it.text.isNotEmpty() })
         }.rowComment(UTBot.message("paths.buildDirectory.description"))
 
         row(UTBot.message("settings.project.target")) {
@@ -93,6 +119,7 @@ class UTBotConfigurable(private val myProject: Project) : BoundConfigurable(
 
         row(UTBot.message("settings.project.testsDir")) {
             textField().bindText(settings::testDirRelativePath).columns(COLUMNS_LARGE)
+                .validateInput(ValidationCondition(UTBot.message("validation.not.empty")) { it.text.isNotEmpty() })
         }.rowComment(UTBot.message("paths.testsDir.description"))
 
         row {
@@ -179,6 +206,12 @@ class UTBotConfigurable(private val myProject: Project) : BoundConfigurable(
     }
 
     override fun apply() {
+        val invalidComponentValidationInfo = validationInfos.find { !it.isValid() }
+        if (invalidComponentValidationInfo != null) {
+            panel.scrollRectToVisible(invalidComponentValidationInfo.component.visibleRect)
+            invalidComponentValidationInfo.component.requestFocus()
+            throw ConfigurationException("Some fields have invalid values")
+        }
         val wereConnectionSettingsModified =
             portComponent.number != projectIndependentSettings.port || serverNameTextField.text != projectIndependentSettings.serverName
         panel.apply()
@@ -194,4 +227,4 @@ class UTBotConfigurable(private val myProject: Project) : BoundConfigurable(
     companion object {
         val TEXT_FIELD_MAX_SIZE = Dimension(370, 100)
     }
-}
+}
diff --git a/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/UTBotBaseWizardStep.kt b/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/UTBotBaseWizardStep.kt
@@ -1,24 +1,30 @@
 package org.utbot.cpp.clion.plugin.ui.wizard
 
 import com.intellij.ide.wizard.Step
+import com.intellij.openapi.Disposable
 import com.intellij.openapi.ui.DialogPanel
+import com.intellij.ui.components.JBTextField
+import com.intellij.ui.dsl.builder.Cell
 import com.intellij.util.ui.HtmlPanel
 import com.intellij.util.ui.UIUtil
 import javax.swing.Box
 import javax.swing.BoxLayout
 import javax.swing.Icon
 import javax.swing.JComponent
 import javax.swing.JPanel
+import org.utbot.cpp.clion.plugin.utils.ComponentValidationInfo
+import org.utbot.cpp.clion.plugin.utils.ValidationCondition
+import org.utbot.cpp.clion.plugin.utils.validateInput
 import java.awt.Component
 import java.awt.Dimension
 import java.awt.Font
 
-abstract class UTBotBaseWizardStep : Step {
+abstract class UTBotBaseWizardStep(private val parentDisposable: Disposable) : Step {
     private val panel by lazy { JPanel() }
     private var isInitialized = false
-
+    private val validators = mutableListOf<ComponentValidationInfo>()
     private val onApplyCallbacks = mutableListOf<() -> Unit>()
-
+    class Validator(val component: JComponent, val isValid: ()->Boolean)
     abstract fun createUI()
 
     override fun _init() {
@@ -39,6 +45,12 @@ abstract class UTBotBaseWizardStep : Step {
         addComponentToStep(this)
     }
 
+    protected fun <T : JBTextField> Cell<T>.validateWith(vararg conditions: ValidationCondition): Cell<T> {
+        return this.applyToComponent {
+            validators.add(this.validateInput(parentDisposable, *conditions))
+        }
+    }
+
     override fun _commit(finishChosen: Boolean) = onApplyCallbacks.forEach { it.invoke() }
 
     //TODO: find a good icon and use here
@@ -60,7 +72,15 @@ abstract class UTBotBaseWizardStep : Step {
         panel.add(component)
     }
 
-    open fun canProceedToNextStep(): Boolean = true
+    protected fun validate(): JComponent? {
+        return validators.find { !it.isValid() }?.component
+    }
+
+    open fun canProceedToNextStep(): Boolean {
+        val validationResult = validate()
+        validationResult?.requestFocus()
+        return validationResult == null
+    }
 
     private fun createHtmlComponent(html: String): JComponent = object : HtmlPanel() {
         init {
diff --git a/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/UTBotWizard.kt b/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/UTBotWizard.kt
@@ -3,7 +3,6 @@ package org.utbot.cpp.clion.plugin.ui.wizard
 import com.intellij.ide.BrowserUtil
 import com.intellij.ide.wizard.AbstractWizard
 import com.intellij.openapi.project.Project
-import javax.swing.JButton
 import org.utbot.cpp.clion.plugin.UTBot
 import org.utbot.cpp.clion.plugin.settings.UTBotSettingsModel
 import org.utbot.cpp.clion.plugin.settings.projectIndependentSettings
@@ -17,13 +16,14 @@ import java.awt.event.KeyEvent
 
 class UTBotWizard(private val project: Project) : AbstractWizard<UTBotBaseWizardStep>("UTBot: Quickstart", project) {
     // copy of settings to make changes during wizard steps
-    private val mySettingsModel = UTBotSettingsModel(project.settings.storedSettings.copy(), projectIndependentSettings.copy())
+    private val mySettingsModel =
+        UTBotSettingsModel(project.settings.storedSettings.copy(), projectIndependentSettings.copy())
 
     init {
-        addStep(IntroStep())
-        addStep(ConnectionStep(project, mySettingsModel))
-        addStep(BuildOptionsStep(mySettingsModel))
-        addStep(FinalStep())
+        addStep(IntroStep(disposable))
+        addStep(ConnectionStep(disposable, project, mySettingsModel))
+        addStep(BuildOptionsStep(disposable, mySettingsModel))
+        addStep(FinalStep(disposable))
         super.init()
         isResizable = true
         setSize(400, 400)
@@ -56,6 +56,7 @@ class UTBotWizard(private val project: Project) : AbstractWizard<UTBotBaseWizard
         }
     }
 
+
     override fun proceedToNextStep() {
         if (currentStepObject?.canProceedToNextStep() != false) {
             super.proceedToNextStep()
diff --git a/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/steps/BuildOptionsStep.kt b/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/steps/BuildOptionsStep.kt
@@ -2,21 +2,26 @@
 
 package org.utbot.cpp.clion.plugin.ui.wizard.steps
 
+import com.intellij.openapi.Disposable
 import com.intellij.ui.dsl.builder.COLUMNS_LARGE
 import com.intellij.ui.dsl.builder.bindText
 import com.intellij.ui.dsl.builder.columns
 import com.intellij.ui.dsl.builder.panel
+import org.utbot.cpp.clion.plugin.UTBot
 import org.utbot.cpp.clion.plugin.settings.UTBotSettingsModel
 import org.utbot.cpp.clion.plugin.ui.wizard.UTBotBaseWizardStep
+import org.utbot.cpp.clion.plugin.utils.ValidationCondition
 import org.utbot.cpp.clion.plugin.utils.commandLineEditor
 
-class BuildOptionsStep(private val settingsModel: UTBotSettingsModel) : UTBotBaseWizardStep() {
+class BuildOptionsStep(parentDisposable: Disposable, private val settingsModel: UTBotSettingsModel) : UTBotBaseWizardStep(parentDisposable) {
     override fun createUI() {
         addHtml("media/options_wizard_text.html")
         panel {
             row("Relative path to Build directory") {
                 textField().bindText(settingsModel.projectSettings::buildDirRelativePath).columns(COLUMNS_LARGE)
+                    .validateWith(ValidationCondition(UTBot.message("validation.not.empty")) { it.text.isNotEmpty() })
             }
+
         }.addToUI()
         addHtml("media/cmake_options.html")
         panel {
diff --git a/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/steps/ConnectionStep.kt b/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/steps/ConnectionStep.kt
@@ -2,6 +2,7 @@
 
 package org.utbot.cpp.clion.plugin.ui.wizard.steps
 
+import com.intellij.openapi.Disposable
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.DialogWrapper
 import com.intellij.ui.AnimatedIcon
@@ -30,8 +31,13 @@ import org.utbot.cpp.clion.plugin.ui.wizard.UTBotBaseWizardStep
 import org.utbot.cpp.clion.plugin.utils.toWslFormatIfNeeded
 import javax.swing.JComponent
 import javax.swing.event.DocumentEvent
+import kotlinx.coroutines.CoroutineExceptionHandler
+import org.utbot.cpp.clion.plugin.UTBot
 import org.utbot.cpp.clion.plugin.settings.UTBotProjectStoredSettings
 import org.utbot.cpp.clion.plugin.ui.ObservableValue
+import org.utbot.cpp.clion.plugin.utils.ValidationCondition
+import org.utbot.cpp.clion.plugin.utils.isLookLikeUnixPath
+import org.utbot.cpp.clion.plugin.utils.isValidHostName
 import org.utbot.cpp.clion.plugin.utils.isWindows
 import org.utbot.cpp.clion.plugin.utils.ourPluginVersion
 import org.utbot.cpp.clion.plugin.utils.path
@@ -44,9 +50,10 @@ enum class ConnectionStatus {
 }
 
 class ConnectionStep(
+    parentDisposable: Disposable,
     private val project: Project,
     private val settingsModel: UTBotSettingsModel,
-) : UTBotBaseWizardStep() {
+) : UTBotBaseWizardStep(parentDisposable) {
     private lateinit var hostTextField: JBTextField
     private lateinit var portComponent: JBIntSpinner
     private lateinit var remotePathTextField: JBTextField
@@ -57,7 +64,8 @@ class ConnectionStep(
     private val useConnectionDefaults = ObservableValue(false)
 
     inner class ConnectionInfo(val port: Int, val host: String, val remotePath: String) {
-        constructor(): this(portComponent.number, hostTextField.text, remotePathTextField.text)
+        constructor() : this(portComponent.number, hostTextField.text, remotePathTextField.text)
+
         fun apply() {
             portComponent.number = port
             hostTextField.text = host
@@ -69,7 +77,7 @@ class ConnectionStep(
         UTBotAllProjectSettings.DEFAULT_PORT,
         UTBotAllProjectSettings.DEFAULT_HOST,
         if (isWindows) project.path.toWslFormatIfNeeded()
-                else UTBotProjectStoredSettings.REMOTE_PATH_VALUE_FOR_LOCAL_SCENARIO
+        else UTBotProjectStoredSettings.REMOTE_PATH_VALUE_FOR_LOCAL_SCENARIO
     )
 
     private var beforeCheckingBoxConnectionInfo: ConnectionInfo? = null
@@ -91,10 +99,16 @@ class ConnectionStep(
     }
 
     override fun canProceedToNextStep(): Boolean {
-        if (connectionStatus.value != ConnectionStatus.Failed) {
+        val validationResult = validate()
+        if (connectionStatus.value != ConnectionStatus.Failed && validationResult == null) {
             return true
         }
 
+        if (validationResult != null) {
+            validationResult.requestFocus()
+            return false
+        }
+
         return NotConnectedWarningDialog(project).showAndGet()
     }
 
@@ -119,7 +133,11 @@ class ConnectionStep(
                     override fun addListener(listener: (Boolean) -> Unit) {
                         useConnectionDefaults.addOnChangeListener { newValue -> listener(!newValue) }
                     }
-                })
+                }).validateWith(
+                    ValidationCondition(
+                        UTBot.message("validation.invalid.host")
+                    ) { it.text.isValidHostName() }
+                )
             }
 
             row("Port") {
@@ -194,7 +212,10 @@ class ConnectionStep(
                         override fun addListener(listener: (Boolean) -> Unit) {
                             useConnectionDefaults.addOnChangeListener { newValue -> listener(!newValue) }
                         }
-                    })
+                    }).validateWith(
+                        ValidationCondition(UTBot.message("validation.not.empty")) { it.text.isNotEmpty() },
+                        ValidationCondition(UTBot.message("validation.not.unix.path")) { it.text.isLookLikeUnixPath() }
+                    )
             }
         }.addToUI()
     }
@@ -221,15 +242,19 @@ class ConnectionStep(
     }
 
     private fun pingServer() {
-        CoroutineScope(Dispatchers.IO + SupervisorJob()).launch {
+        val handler = CoroutineExceptionHandler { _, e ->
+            e.printStackTrace()
+        }
+        CoroutineScope(Dispatchers.IO + SupervisorJob() + handler).launch {
             connectionStatus.value = pingServer(portComponent.number, hostTextField.text)
         }
     }
 
     private fun setupPingOnPortOrHostChange() {
         hostTextField.document.addDocumentListener(object : DocumentAdapter() {
             override fun textChanged(e: DocumentEvent) {
-                pingServer()
+                if (hostTextField.text.isValidHostName())
+                    pingServer()
             }
         })
         portComponent.addChangeListener {
diff --git a/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/steps/FinalStep.kt b/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/steps/FinalStep.kt
@@ -1,7 +1,8 @@
 package org.utbot.cpp.clion.plugin.ui.wizard.steps
 
+import com.intellij.openapi.Disposable
 import org.utbot.cpp.clion.plugin.ui.wizard.UTBotBaseWizardStep
 
-class FinalStep : UTBotBaseWizardStep() {
+class FinalStep(parentDisposable: Disposable) : UTBotBaseWizardStep(parentDisposable) {
     override fun createUI() = addHtml("media/final_wizard_text.html")
 }
diff --git a/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/steps/IntroStep.kt b/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/ui/wizard/steps/IntroStep.kt
@@ -1,7 +1,8 @@
 package org.utbot.cpp.clion.plugin.ui.wizard.steps
 
+import com.intellij.openapi.Disposable
 import org.utbot.cpp.clion.plugin.ui.wizard.UTBotBaseWizardStep
 
-class IntroStep : UTBotBaseWizardStep() {
+class IntroStep(parentDisposable: Disposable) : UTBotBaseWizardStep(parentDisposable) {
     override fun createUI() = addHtml("media/intro_wizard_text.html")
 }
diff --git a/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/utils/PathUtils.kt b/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/utils/PathUtils.kt
diff --git a/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/utils/UiUtils.kt b/clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/utils/UiUtils.kt
diff --git a/clion-plugin/src/main/resources/messages/UTBot.properties b/clion-plugin/src/main/resources/messages/UTBot.properties

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
`1`	`1`	`package org.utbot.cpp.clion.plugin.ui.wizard.steps`
`2`	`2`
	`3`	`+import com.intellij.openapi.Disposable`
`3`	`4`	`import org.utbot.cpp.clion.plugin.ui.wizard.UTBotBaseWizardStep`
`4`	`5`
`5`		`-class FinalStep : UTBotBaseWizardStep() {`
	`6`	`+class FinalStep(parentDisposable: Disposable) : UTBotBaseWizardStep(parentDisposable) {`
`6`	`7`	`override fun createUI() = addHtml("media/final_wizard_text.html")`
`7`	`8`	`}`