Merge pull request #60 from stack-spot/bug/sc-390954/ide-intellij-ajuste-project-wizard-link-documentação

adroaldonetozup · web-flow · commit a60bbcaae559 · 2022-10-27T15:12:36.000-03:00
Bug Fix: Documentation link in project wizard was not visible
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/BackgroundCommandRunner.kt b/src/main/kotlin/com/stackspot/intellij/commands/BackgroundCommandRunner.kt
@@ -23,7 +23,7 @@ import com.stackspot.intellij.commons.singleThreadAsCoroutine
 import kotlinx.coroutines.Deferred
 import java.nio.charset.Charset
 
-class BackgroundCommandRunner(private var workingDir: String? = null) : CommandRunner {
+class BackgroundCommandRunner : CommandRunner {
 
     var stdout: String = ""
         get() {
@@ -34,11 +34,11 @@ class BackgroundCommandRunner(private var workingDir: String? = null) : CommandR
     var timeout: Boolean = false
     var cancelled: Boolean = false
 
-    override fun run(commandLine: List<String>, listener: CommandRunner.CommandEndedListener?) {
+    override fun run(commandLine: List<String>, listener: CommandRunner.CommandEndedListener?, workingDir: String?) {
         val generalCommandLine = GeneralCommandLine(commandLine)
             .withCharset(Charset.forName("UTF-8"))
             .withWorkDirectory(workingDir)
-            .withEnvironment(CommandRunner.STK_CHANNEL_ENVIRONMENT_VARIABLE, CommandRunner.STK_CHANNLE_INTELLIJ)
+            .withEnvironment(CommandRunner.STK_CHANNEL_ENVIRONMENT_VARIABLE, CommandRunner.STK_CHANNEL_INTELLIJ)
         val processOutput = execAndGetOutput(generalCommandLine)
         stdout = processOutput.stdout
         stderr = processOutput.stderr
@@ -51,14 +51,14 @@ class BackgroundCommandRunner(private var workingDir: String? = null) : CommandR
     private fun replaceStdout(stdout: String) =
         stdout.replace("\\n".toRegex(), "")
 
-    override fun runSync(commandLine: List<String>): BackgroundCommandRunner {
+    override fun runSync(commandLine: List<String>, workingDir: String?): BackgroundCommandRunner {
         return singleThread {
             var done = false
             run(commandLine, object : CommandRunner.CommandEndedListener {
                 override fun notifyEnded() {
                     done = true
                 }
-            })
+            }, workingDir)
 
             while (!done) {
                 Thread.sleep(1L)
@@ -67,16 +67,14 @@ class BackgroundCommandRunner(private var workingDir: String? = null) : CommandR
         }
     }
 
-    override suspend fun runAsync(
-        commandLine: List<String>
-    ): Deferred<BackgroundCommandRunner> {
+    override suspend fun runAsync(commandLine: List<String>,workingDir: String?): Deferred<BackgroundCommandRunner> {
         var done = false
         return singleThreadAsCoroutine {
             this.run(commandLine, object : CommandRunner.CommandEndedListener {
                 override fun notifyEnded() {
                     done = true
                 }
-            })
+            }, workingDir)
             this
         }
     }
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/BaseCommand.kt b/src/main/kotlin/com/stackspot/intellij/commands/BaseCommand.kt
@@ -20,7 +20,10 @@ import kotlinx.coroutines.Deferred
 
 abstract class BaseCommand(val runner: CommandRunner) : Command {
     abstract fun commandLine(): List<String>
-    override fun run(listener: CommandRunner.CommandEndedListener?) = runner.run(commandLine(), listener)
-    override fun runSync(): BackgroundCommandRunner = runner.runSync(commandLine())
-    override suspend fun runAsync(): Deferred<BackgroundCommandRunner> = runner.runAsync(commandLine())
+    override fun run(listener: CommandRunner.CommandEndedListener?, workingDir: String?) =
+        runner.run(commandLine(), listener, workingDir)
+
+    override fun runSync(workingDir: String?): BackgroundCommandRunner = runner.runSync(commandLine(), workingDir)
+    override suspend fun runAsync(workingDir: String?): Deferred<BackgroundCommandRunner> =
+        runner.runAsync(commandLine(), workingDir)
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/Command.kt b/src/main/kotlin/com/stackspot/intellij/commands/Command.kt
@@ -16,13 +16,14 @@
 
 package com.stackspot.intellij.commands
 
+import com.stackspot.constants.Constants
 import kotlinx.coroutines.Deferred
 
 interface Command {
-    fun run(listener: CommandRunner.CommandEndedListener? = null)
+    fun run(listener: CommandRunner.CommandEndedListener? = null, workingDir: String? = Constants.Paths.STK_HOME.toString())
 
-    fun runSync(): BackgroundCommandRunner
+    fun runSync(workingDir: String? = Constants.Paths.STK_HOME.toString()): BackgroundCommandRunner
 
-    suspend fun runAsync(): Deferred<BackgroundCommandRunner>
+    suspend fun runAsync(workingDir: String? = Constants.Paths.STK_HOME.toString()): Deferred<BackgroundCommandRunner>
 
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/CommandRunner.kt b/src/main/kotlin/com/stackspot/intellij/commands/CommandRunner.kt
@@ -16,22 +16,33 @@
 
 package com.stackspot.intellij.commands
 
+import com.stackspot.constants.Constants
 import kotlinx.coroutines.Deferred
 
-
 interface CommandRunner {
 
     companion object {
-        val STK_CHANNEL_ENVIRONMENT_VARIABLE = "STK_CHANNEL"
-        val STK_CHANNLE_INTELLIJ = "intellij"
+        const val STK_CHANNEL_ENVIRONMENT_VARIABLE = "STK_CHANNEL"
+        const val STK_CHANNEL_INTELLIJ = "intellij"
     }
 
     interface CommandEndedListener {
         fun notifyEnded()
     }
 
-    fun run(commandLine: List<String>, listener: CommandEndedListener? = null)
-
-    fun runSync(commandLine: List<String>): BackgroundCommandRunner
-    suspend fun runAsync(commandLine: List<String>): Deferred<BackgroundCommandRunner>
+    fun run(
+        commandLine: List<String>,
+        listener: CommandEndedListener? = null,
+        workingDir: String? = Constants.Paths.STK_HOME.toString()
+    )
+
+    fun runSync(
+        commandLine: List<String>,
+        workingDir: String? = Constants.Paths.STK_HOME.toString()
+    ): BackgroundCommandRunner
+
+    suspend fun runAsync(
+        commandLine: List<String>,
+        workingDir: String? = Constants.Paths.STK_HOME.toString()
+    ): Deferred<BackgroundCommandRunner>
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/git/GitBranch.kt b/src/main/kotlin/com/stackspot/intellij/commands/git/GitBranch.kt
@@ -19,8 +19,7 @@ package com.stackspot.intellij.commands.git
 import com.stackspot.intellij.commands.BackgroundCommandRunner
 import com.stackspot.intellij.commands.BaseCommand
 
-class GitBranch(var workingDir: String, private val flags: Array<String>) :
-    BaseCommand(BackgroundCommandRunner(workingDir)) {
+class GitBranch(private val flags: Array<String>) : BaseCommand(BackgroundCommandRunner()) {
 
     override fun commandLine(): List<String> {
         return listOf("git", "branch", *flags)
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/git/GitConfig.kt b/src/main/kotlin/com/stackspot/intellij/commands/git/GitConfig.kt
@@ -19,8 +19,7 @@ package com.stackspot.intellij.commands.git
 import com.stackspot.intellij.commands.BackgroundCommandRunner
 import com.stackspot.intellij.commands.BaseCommand
 
-class GitConfig(var workingDirectory: String) :
-    BaseCommand(BackgroundCommandRunner(workingDirectory)) {
+class GitConfig : BaseCommand(BackgroundCommandRunner()) {
 
     var flags: Array<String> = arrayOf()
 
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/stk/CommandInfoList.kt b/src/main/kotlin/com/stackspot/intellij/commands/stk/CommandInfoList.kt
@@ -20,12 +20,10 @@ import com.stackspot.intellij.commands.BackgroundCommandRunner
 import com.stackspot.intellij.commands.BaseCommand
 import org.apache.commons.lang3.StringUtils
 
-class CommandInfoList(
-    workingDir: String? = null
-): BaseCommand(BackgroundCommandRunner(workingDir)) {
+class CommandInfoList: BaseCommand(BackgroundCommandRunner()) {
 
     var command: String = StringUtils.EMPTY
-    var flags: Array<String> = arrayOf()
+    private var flags: Array<String> = arrayOf()
 
     override fun commandLine() =  listOf("stk", "list", command, "--json", *flags)
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/stk/CreateProjectByStackfile.kt b/src/main/kotlin/com/stackspot/intellij/commands/stk/CreateProjectByStackfile.kt
@@ -21,13 +21,12 @@ import com.stackspot.intellij.commands.BaseCommand
 import com.stackspot.intellij.ui.StackSpotTerminalRunner
 import com.stackspot.model.Stack
 import com.stackspot.model.Stackfile
-import kotlin.io.path.Path
 
 class CreateProjectByStackfile(
     private val project: Project,
     private val stack: Stack,
     private val stackfile: Stackfile
-) : BaseCommand(StackSpotTerminalRunner(project, Path(project.basePath!!).parent.toString())) {
+) : BaseCommand(StackSpotTerminalRunner(project)) {
 
     override fun commandLine(): List<String> {
         return listOf(
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/stk/DeleteStack.kt b/src/main/kotlin/com/stackspot/intellij/commands/stk/DeleteStack.kt
@@ -23,5 +23,5 @@ import com.stackspot.model.Stack
 
 class DeleteStack(private val stack: Stack, private val project: Project) :
     BaseCommand(StackSpotTerminalRunner(project)) {
-    override fun commandLine() = listOf("stk", "delete", "stack", "${stack.name}")
+    override fun commandLine() = listOf("stk", "delete", "stack", stack.name)
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/stk/UpdateAllStacks.kt b/src/main/kotlin/com/stackspot/intellij/commands/stk/UpdateAllStacks.kt
@@ -20,7 +20,6 @@ import com.intellij.openapi.project.Project
 import com.stackspot.intellij.commands.BaseCommand
 import com.stackspot.intellij.ui.StackSpotTerminalRunner
 
-class UpdateAllStacks(private val project: Project) :
-    BaseCommand(StackSpotTerminalRunner(project)) {
+class UpdateAllStacks(project: Project) : BaseCommand(StackSpotTerminalRunner(project)) {
     override fun commandLine() = listOf("stk", "update", "stack")
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/commands/stk/UpdateStack.kt b/src/main/kotlin/com/stackspot/intellij/commands/stk/UpdateStack.kt
@@ -21,7 +21,6 @@ import com.stackspot.intellij.commands.BaseCommand
 import com.stackspot.intellij.ui.StackSpotTerminalRunner
 import com.stackspot.model.Stack
 
-class UpdateStack(private val stack: Stack, private val project: Project) :
-    BaseCommand(StackSpotTerminalRunner(project)) {
-    override fun commandLine() = listOf("stk", "update", "stack", "${stack.name}")
+class UpdateStack(private val stack: Stack, project: Project) : BaseCommand(StackSpotTerminalRunner(project)) {
+    override fun commandLine() = listOf("stk", "update", "stack", stack.name)
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/commons/ThreadExecutor.kt b/src/main/kotlin/com/stackspot/intellij/commons/ThreadExecutor.kt
@@ -23,7 +23,6 @@ import kotlinx.coroutines.withContext
 import java.util.concurrent.Executors
 import java.util.concurrent.TimeUnit
 
-
 fun <R : Any> singleThread(
     timeout: Long = 500L,
     unit: TimeUnit = TimeUnit.MILLISECONDS,
diff --git a/src/main/kotlin/com/stackspot/intellij/listeners/TerminalToolWindowRegisteredListener.kt b/src/main/kotlin/com/stackspot/intellij/listeners/TerminalToolWindowRegisteredListener.kt
@@ -73,7 +73,10 @@ class TerminalToolWindowRegisteredListener : ToolWindowManagerListener {
                 LinkGradleProjectsToProjectListener(project),
                 LinkMavenProjectsToProjectListener(project)
             )
-            command.run(CompositeCommandEndedListener(listeners))
+            command.run(
+                CompositeCommandEndedListener(listeners),
+                workingDir = Path(project.basePath!!).parent.toString()
+            )
         }
     }
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/services/CreateProjectService.kt b/src/main/kotlin/com/stackspot/intellij/services/CreateProjectService.kt
@@ -17,7 +17,6 @@
 package com.stackspot.intellij.services
 
 import com.intellij.openapi.components.Service
-import com.stackspot.constants.Constants
 import com.stackspot.intellij.commands.BackgroundCommandRunner
 import com.stackspot.intellij.commands.git.GitConfig
 import com.stackspot.intellij.commands.stk.Version
@@ -49,11 +48,11 @@ class CreateProjectService() {
         }
 
     private var version = Version()
-    private var gitConfigCmd = GitConfig(Constants.Paths.STK_HOME.toString())
+    private var gitConfigCmd = GitConfig()
 
     constructor(
         version: Version = Version(),
-        gitConfigCmd: GitConfig = GitConfig(Constants.Paths.STK_HOME.toString())
+        gitConfigCmd: GitConfig = GitConfig()
     ) : this() {
         this.version = version
         this.gitConfigCmd = gitConfigCmd
@@ -63,6 +62,7 @@ class CreateProjectService() {
         val stdout = version.runSync().stdout
         return stdout.contains(STK_VERSION_MESSAGE)
     }
+
     fun isStackfileSelected(): Boolean = stack != null && stackfile != null
 
     fun clearInfo() {
diff --git a/src/main/kotlin/com/stackspot/intellij/services/GetDocumentationService.kt b/src/main/kotlin/com/stackspot/intellij/services/GetDocumentationService.kt
@@ -18,7 +18,6 @@ package com.stackspot.intellij.services
 
 import com.intellij.openapi.components.Service
 import com.intellij.util.containers.isNullOrEmpty
-import com.stackspot.constants.Constants
 import com.stackspot.intellij.commands.BackgroundCommandRunner
 import com.stackspot.intellij.commands.git.GitBranch
 import com.stackspot.intellij.commands.git.GitConfig
@@ -30,12 +29,12 @@ import java.util.logging.Logger
 @Service
 class GetDocumentationService() {
 
-    private var gitConfigCmd = GitConfig(Constants.Paths.STK_HOME.toString())
-    private var gitBranchCmd = GitBranch(Constants.Paths.STK_HOME.toString(), arrayOf("--show-current"))
+    private var gitConfigCmd = GitConfig()
+    private var gitBranchCmd = GitBranch(arrayOf("--show-current"))
 
     constructor(
-        gitConfigCmd: GitConfig = GitConfig(Constants.Paths.STK_HOME.toString()),
-        gitBranchCmd: GitBranch = GitBranch(Constants.Paths.STK_HOME.toString(), arrayOf("--show-current"))
+        gitConfigCmd: GitConfig = GitConfig(),
+        gitBranchCmd: GitBranch = GitBranch(arrayOf("--show-current"))
     ) : this() {
         this.gitConfigCmd = gitConfigCmd
         this.gitBranchCmd = gitBranchCmd
@@ -83,15 +82,15 @@ class GetDocumentationService() {
     }
 
     private fun getRemoteUrl(stack: Stack): String {
-        gitConfigCmd.workingDirectory = stack.location.toPath().parent.toString()
+        val workingDir = stack.location.toPath().parent.toString()
         gitConfigCmd.flags = arrayOf("--get", "remote.origin.url")
-        gitConfigCmd.run()
+        gitConfigCmd.run(workingDir = workingDir)
         return (gitConfigCmd.runner as BackgroundCommandRunner).stdout
     }
 
     private fun getCurrentBranchName(stack: Stack): String {
-        gitBranchCmd.workingDir = stack.location.toPath().toString()
-        gitBranchCmd.run()
+        val workingDir = stack.location.toPath().parent.toString()
+        gitBranchCmd.run(workingDir = workingDir)
         return (gitBranchCmd.runner as BackgroundCommandRunner).stdout
     }
 
diff --git a/src/main/kotlin/com/stackspot/intellij/ui/StackSpotTerminalRunner.kt b/src/main/kotlin/com/stackspot/intellij/ui/StackSpotTerminalRunner.kt
@@ -70,48 +70,45 @@ class StackSpotTerminalCommandMonitoringTask(
 
 private const val OPERATION_IS_NOT_SUPPORTED = "Operation is not supported"
 
-class StackSpotTerminalRunner(private val project: Project, private val workingDir: String? = null) : CommandRunner {
+class StackSpotTerminalRunner(private val project: Project) : CommandRunner {
 
     companion object {
         const val CMD_SEPARATOR = " "
         var commandSequence = 0
     }
 
-    override fun run(commandLine: List<String>, listener: CommandRunner.CommandEndedListener?) {
+    override fun run(commandLine: List<String>, listener: CommandRunner.CommandEndedListener?, workingDir: String?) {
         val toolWindowManager = ToolWindowManager.getInstance(project)
         val window = toolWindowManager.getToolWindow(TerminalToolWindowFactory.TOOL_WINDOW_ID)
         if (window != null) {
-            executeCommandInTerminal(window, listener, commandLine)
+            executeCommandInTerminal(window, listener, commandLine, workingDir)
         }
     }
 
-    override fun runSync(
-        commandLine: List<String>
-    ): BackgroundCommandRunner {
+    override fun runSync(commandLine: List<String>, workingDir: String?): BackgroundCommandRunner {
         throw UnsupportedOperationException(OPERATION_IS_NOT_SUPPORTED)
     }
 
-    override suspend fun runAsync(commandLine: List<String>): Deferred<BackgroundCommandRunner> {
+    override suspend fun runAsync(commandLine: List<String>, workingDir: String?): Deferred<BackgroundCommandRunner> {
         throw UnsupportedOperationException(OPERATION_IS_NOT_SUPPORTED)
     }
 
-    private fun resolveWorkingDir() = workingDir ?: project.basePath
-
     private fun executeCommandInTerminal(
         window: ToolWindow,
         listener: CommandRunner.CommandEndedListener?,
-        commandLine: List<String>
+        commandLine: List<String>,
+        workingDir: String?
     ) {
         window.show()
         val contentManager = window.contentManager
         val stackSpotTab = contentManager.contents.firstOrNull { Constants.MODULE_TYPE_NAME == it.tabName }
-        val workingDir = resolveWorkingDir()
+        val resolvedWorkingDir = workingDir ?: project.basePath
         val terminalView = TerminalView.getInstance(project)
         if (stackSpotTab != null) {
             terminalView.closeTab(stackSpotTab)
         }
-        val widget = getTerminalWidgetToRunCommand(terminalView, workingDir, contentManager)
-        executeCommand(widget, workingDir, commandLine, listener)
+        val widget = getTerminalWidgetToRunCommand(terminalView, resolvedWorkingDir, contentManager)
+        executeCommand(widget, resolvedWorkingDir, commandLine, listener)
     }
 
     private fun executeCommand(
@@ -133,10 +130,7 @@ class StackSpotTerminalRunner(private val project: Project, private val workingD
             )
             ProgressManager.getInstance().run(monitoringTask)
         } else {
-            shellWidget.executeCommand(
-                "cd $workDir && " +
-                        "${commandLine.joinToString(CMD_SEPARATOR)}"
-            )
+            shellWidget.executeCommand("cd $workDir && ${commandLine.joinToString(CMD_SEPARATOR)}")
         }
     }
 
@@ -170,8 +164,8 @@ class StackSpotTerminalRunner(private val project: Project, private val workingD
 
     private fun getSetStkChannelEnvironmentVariableCommand(): String {
         if (SystemInfo.isWindows) {
-            return "set ${CommandRunner.STK_CHANNEL_ENVIRONMENT_VARIABLE}=${CommandRunner.STK_CHANNLE_INTELLIJ}"
+            return "set ${CommandRunner.STK_CHANNEL_ENVIRONMENT_VARIABLE}=${CommandRunner.STK_CHANNEL_INTELLIJ}"
         }
-        return "export ${CommandRunner.STK_CHANNEL_ENVIRONMENT_VARIABLE}=${CommandRunner.STK_CHANNLE_INTELLIJ}"
+        return "export ${CommandRunner.STK_CHANNEL_ENVIRONMENT_VARIABLE}=${CommandRunner.STK_CHANNEL_INTELLIJ}"
     }
 }
diff --git a/src/main/kotlin/com/stackspot/intellij/ui/project_wizard/panels/StackSpotNoStackfilesErrorPanel.kt b/src/main/kotlin/com/stackspot/intellij/ui/project_wizard/panels/StackSpotNoStackfilesErrorPanel.kt
diff --git a/src/test/kotlin/com/stackspot/intellij/commands/BackgroundCommandRunnerTest.kt b/src/test/kotlin/com/stackspot/intellij/commands/BackgroundCommandRunnerTest.kt

Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,5 @@ import com.stackspot.model.Stack`
`23`	`23`
`24`	`24`	`class DeleteStack(private val stack: Stack, private val project: Project) :`
`25`	`25`	`BaseCommand(StackSpotTerminalRunner(project)) {`
`26`		`- override fun commandLine() = listOf("stk", "delete", "stack", "${stack.name}")`
	`26`	`+ override fun commandLine() = listOf("stk", "delete", "stack", stack.name)`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,6 @@ import com.intellij.openapi.project.Project`
`20`	`20`	`import com.stackspot.intellij.commands.BaseCommand`
`21`	`21`	`import com.stackspot.intellij.ui.StackSpotTerminalRunner`
`22`	`22`
`23`		`-class UpdateAllStacks(private val project: Project) :`
`24`		`- BaseCommand(StackSpotTerminalRunner(project)) {`
	`23`	`+class UpdateAllStacks(project: Project) : BaseCommand(StackSpotTerminalRunner(project)) {`
`25`	`24`	`override fun commandLine() = listOf("stk", "update", "stack")`
`26`	`25`	`}`