Add setting to ignore setup command failures

Author: code-asher

src/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt

@@ -62,7 +62,11 @@ class CoderRemoteConnectionHandle {
                             // indicator.text is the text above the progress bar.
                             indicator.text = CoderGatewayBundle.message("gateway.connector.coder.connecting.retry", attempt)
                         }
-                        val deployInputs = parameters.deploy(indicator, Duration.ofMinutes(10), settings.setupCommand)
+                        val deployInputs = parameters.deploy(
+                            indicator,
+                            Duration.ofMinutes(10),
+                            settings.setupCommand,
+                            settings.ignoreSetupFailure)
                         SshMultistagePanelContext(deployInputs)
                     },
                     retryIf = {

src/main/kotlin/com/coder/gateway/CoderSettingsConfigurable.kt

@@ -124,6 +124,14 @@ class CoderSettingsConfigurable : BoundConfigurable("Coder") {
                         CoderGatewayBundle.message("gateway.connector.settings.setup-command.comment")
                     )
             }.layout(RowLayout.PARENT_GRID)
+            row {
+                cell() // For alignment.
+                checkBox(CoderGatewayBundle.message("gateway.connector.settings.ignore-setup-failure.title"))
+                    .bindSelected(state::ignoreSetupFailure)
+                    .comment(
+                        CoderGatewayBundle.message("gateway.connector.settings.ignore-setup-failure.comment")
+                    )
+            }.layout(RowLayout.PARENT_GRID)
         }
     }
 

src/main/kotlin/com/coder/gateway/models/WorkspaceProjectIDE.kt

@@ -65,7 +65,11 @@ class WorkspaceProjectIDE(
      * necessary.  If a deployment was necessary, the IDE path on the host will
      * be updated to reflect the location on disk.
      */
-    suspend fun deploy(indicator: ProgressIndicator, timeout: Duration, setupCommand: String): HostDeployInputs {
+    suspend fun deploy(
+        indicator: ProgressIndicator,
+        timeout: Duration,
+        setupCommand: String,
+        ignoreSetupFailure: Boolean): HostDeployInputs {
         this.lastOpened = localTimeFormatter.format(LocalDateTime.now())
         indicator.text = "Connecting to remote worker..."
         logger.info("Connecting to remote worker on $hostname")
@@ -108,7 +112,13 @@ class WorkspaceProjectIDE(
             // The accessor does not appear to provide a generic exec.
             indicator.text = "Running setup command..."
             logger.info("Running setup command `$setupCommand` in $path on $hostname...")
-            exec(setupCommand)
+            try {
+                exec(setupCommand)
+            } catch (ex: Exception) {
+                if (!ignoreSetupFailure) {
+                    throw ex
+                }
+            }
         } else {
             logger.info("No setup command to run on $hostname")
         }

src/main/kotlin/com/coder/gateway/settings/CoderSettings.kt

@@ -61,9 +61,11 @@ open class CoderSettingsState(
     open var disableAutostart: Boolean = getOS() == OS.MAC,
     // Extra SSH config options.
     open var sshConfigOptions: String = "",
-    // An external command that is ran in the directory of the IDE before
-    // connecting to it.
+    // An external command to run in the directory of the IDE before connecting
+    // to it.
     open var setupCommand: String = "",
+    // Whether to ignore setup command failures.
+    open var ignoreSetupFailure: Boolean = false,
 )
 
 /**
@@ -132,6 +134,12 @@ open class CoderSettings(
     val setupCommand: String
         get() = state.setupCommand
 
+    /**
+     * Whether to ignore a failed setup command.
+     */
+    val ignoreSetupFailure: Boolean
+        get() = state.ignoreSetupFailure
+
     /**
      * Where the specified deployment should put its data.
      */

src/main/resources/messages/CoderGatewayBundle.properties

@@ -125,5 +125,11 @@ gateway.connector.settings.ssh-config-options.comment=Extra SSH config options \
 gateway.connector.settings.setup-command.title=Setup command:
 gateway.connector.settings.setup-command.comment=An external command that \
   will be executed on the remote in the bin directory of the IDE before \
-  connecting to it.
+  connecting to it. If the command exits with non-zero, the exit code, stdout, \
+  and stderr will be displayed to the user and the connection will be aborted \
+  unless configured to be ignored below.
+gateway.connector.settings.ignore-setup-failure.title=Ignore setup command failure
+gateway.connector.settings.ignore-setup-failure.comment=Checking this box will \
+  cause the plugin to ignore failures (any non-zero exit code) from the setup \
+  command and continue connecting.
 

src/test/kotlin/com/coder/gateway/settings/CoderSettingsTest.kt

@@ -199,6 +199,7 @@ internal class CoderSettingsTest {
                 tlsAlternateHostname = "tls alt hostname",
                 disableAutostart = true,
                 setupCommand = "test setup",
+                ignoreSetupFailure = true,
             )
         )
 
@@ -211,5 +212,6 @@ internal class CoderSettingsTest {
         assertEquals("tls alt hostname", settings.tls.altHostname)
         assertEquals(true, settings.disableAutostart)
         assertEquals("test setup", settings.setupCommand)
+        assertEquals(true, settings.ignoreSetupFailure)
     }
 }