Use .bat for Windows version test

Mostly a proof of concept, should expand to other tests at some point.

Author: code-asher

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

@@ -22,8 +22,10 @@ open class CoderSettings(
     private val state: CoderSettingsState,
     // The location of the SSH config.  Defaults to ~/.ssh/config.
     val sshConfigPath: Path = Path.of(System.getProperty("user.home")).resolve(".ssh/config"),
-    // Env allows overriding the default environment.
+    // Overrides the default environment (for tests).
     private val env: Environment = Environment(),
+    // Overrides the default binary name (for tests).
+    private val binaryName: String? = null,
 ) {
     val tls = CoderTLSSettings(state)
     val enableDownloads: Boolean
@@ -68,10 +70,10 @@ open class CoderSettings(
      * To where the specified deployment should download the binary.
      */
     fun binPath(url: URL, forceDownloadToData: Boolean = false): Path {
-        val binaryName = getCoderCLIForOS(getOS(), getArch())
+        val name = binaryName ?: getCoderCLIForOS(getOS(), getArch())
         val dir = if (forceDownloadToData || state.binaryDirectory.isBlank()) dataDir(url)
         else withHost(Path.of(expand(state.binaryDirectory)), url)
-        return dir.resolve(binaryName).toAbsolutePath()
+        return dir.resolve(name).toAbsolutePath()
     }
 
     /**

src/test/kotlin/com/coder/gateway/cli/CoderCLIManagerTest.kt

@@ -33,17 +33,18 @@ import kotlin.test.assertTrue
 
 internal class CoderCLIManagerTest {
     private fun mkbin(version: String): String {
-        return listOf("#!/bin/sh", """echo '{"version": "$version"}'""")
-            .joinToString("\n")
+        return if (getOS() == OS.WINDOWS) {
+            // Must use a .bat extension for this to work.
+            listOf("@echo off", """echo {"version": "$version"}""")
+        } else {
+            listOf("#!/bin/sh", """echo '{"version": "$version"}'""")
+        }.joinToString(System.lineSeparator())
     }
 
     private fun mockServer(errorCode: Int = 0, version: String? = null): Pair<HttpServer, URL> {
         val srv = HttpServer.create(InetSocketAddress(0), 0)
         srv.createContext("/") {exchange ->
             var code = HttpURLConnection.HTTP_OK
-            // TODO: Is there some simple way to create an executable file on
-            // Windows without having to execute something to generate said
-            // executable or having to commit one to the repo?
             var response = mkbin(version ?: "${srv.address.port}.0.0")
             val eTags = exchange.requestHeaders["If-None-Match"]
             if (exchange.requestURI.path == "/bin/override") {
@@ -109,8 +110,7 @@ internal class CoderCLIManagerTest {
 
         val (srv, url) = mockServer()
         val ccm = CoderCLIManager(url, CoderSettings(CoderSettingsState(
-            dataDirectory = tmpdir.resolve("cli-dir-fail-to-write").toString()))
-        )
+            dataDirectory = tmpdir.resolve("cli-dir-fail-to-write").toString())))
 
         ccm.localBinaryPath.parent.toFile().mkdirs()
         ccm.localBinaryPath.parent.toFile().setWritable(false)
@@ -135,8 +135,7 @@ internal class CoderCLIManagerTest {
         }
 
         val ccm = CoderCLIManager(url.toURL(), CoderSettings(CoderSettingsState(
-            dataDirectory = tmpdir.resolve("real-cli").toString()))
-        )
+            dataDirectory = tmpdir.resolve("real-cli").toString())))
 
         assertTrue(ccm.download())
         assertDoesNotThrow { ccm.version() }
@@ -154,27 +153,19 @@ internal class CoderCLIManagerTest {
     fun testDownloadMockCLI() {
         val (srv, url) = mockServer()
         var ccm = CoderCLIManager(url, CoderSettings(CoderSettingsState(
-            dataDirectory = tmpdir.resolve("mock-cli").toString()))
-        )
+            dataDirectory = tmpdir.resolve("mock-cli").toString()),
+            binaryName = "coder-windows.bat"))
 
         assertEquals(true, ccm.download())
-
-        // The mock does not serve a binary that works on Windows so do not
-        // actually execute.  Checking the contents works just as well as proof
-        // that the binary was correctly downloaded anyway.
-        assertContains(ccm.localBinaryPath.toFile().readText(), url.port.toString())
-        if (getOS() != OS.WINDOWS) {
-            assertEquals(SemVer(url.port.toLong(), 0, 0), ccm.version())
-        }
+        assertEquals(SemVer(url.port.toLong(), 0, 0), ccm.version())
 
         // It should skip the second attempt.
         assertEquals(false, ccm.download())
 
         // Should use the source override.
         ccm = CoderCLIManager(url, CoderSettings(CoderSettingsState(
             binarySource = "/bin/override",
-            dataDirectory = tmpdir.resolve("mock-cli").toString()))
-        )
+            dataDirectory = tmpdir.resolve("mock-cli").toString())))
 
         assertEquals(true, ccm.download())
         assertContains(ccm.localBinaryPath.toFile().readText(), "0.0.0")
@@ -185,8 +176,7 @@ internal class CoderCLIManagerTest {
     @Test
     fun testRunNonExistentBinary() {
         val ccm = CoderCLIManager(URL("https://foo"), CoderSettings(CoderSettingsState(
-            dataDirectory = tmpdir.resolve("does-not-exist").toString()))
-        )
+            dataDirectory = tmpdir.resolve("does-not-exist").toString())))
 
         assertFailsWith(
             exceptionClass = ProcessInitException::class,
@@ -197,8 +187,7 @@ internal class CoderCLIManagerTest {
     fun testOverwitesWrongVersion() {
         val (srv, url) = mockServer()
         val ccm = CoderCLIManager(url, CoderSettings(CoderSettingsState(
-            dataDirectory = tmpdir.resolve("overwrite-cli").toString()))
-        )
+            dataDirectory = tmpdir.resolve("overwrite-cli").toString())))
 
         ccm.localBinaryPath.parent.toFile().mkdirs()
         ccm.localBinaryPath.toFile().writeText("cli")
@@ -325,9 +314,7 @@ internal class CoderCLIManagerTest {
                 sshConfigPath = tmpdir.resolve("configured$it.conf"))
             settings.sshConfigPath.parent.toFile().mkdirs()
             Path.of("src/test/fixtures/inputs").resolve("$it.conf").toFile().copyTo(
-                settings.sshConfigPath.toFile(),
-                true,
-            )
+                settings.sshConfigPath.toFile(), true)
 
             val ccm = CoderCLIManager(URL("https://test.coder.invalid"), settings)
 
@@ -345,8 +332,7 @@ internal class CoderCLIManagerTest {
 
         tests.forEach {
             val ccm = CoderCLIManager(URL("https://test.coder.invalid"), CoderSettings(CoderSettingsState(
-                headerCommand = it))
-            )
+                headerCommand = it)))
 
             assertFailsWith(
                 exceptionClass = Exception::class,
@@ -370,8 +356,7 @@ internal class CoderCLIManagerTest {
         )
 
         val ccm = CoderCLIManager(URL("https://test.coder.parse-fail.invalid"), CoderSettings(CoderSettingsState(
-            binaryDirectory = tmpdir.resolve("bad-version").toString()))
-        )
+            binaryDirectory = tmpdir.resolve("bad-version").toString())))
         ccm.localBinaryPath.parent.toFile().mkdirs()
 
         tests.forEach {
@@ -412,8 +397,7 @@ internal class CoderCLIManagerTest {
             Triple("""exit 1""", "v1.0.0", null))
 
         val ccm = CoderCLIManager(URL("https://test.coder.matches-version.invalid"), CoderSettings(CoderSettingsState(
-            binaryDirectory = tmpdir.resolve("matches-version").toString()))
-        )
+            binaryDirectory = tmpdir.resolve("matches-version").toString())))
         ccm.localBinaryPath.parent.toFile().mkdirs()
 
         test.forEach {
@@ -567,8 +551,7 @@ internal class CoderCLIManagerTest {
         tests.forEach {
             val (srv, url) = mockServer(version = it.first)
             val ccm = CoderCLIManager(url, CoderSettings(CoderSettingsState(
-                dataDirectory = tmpdir.resolve("features").toString()))
-            )
+                dataDirectory = tmpdir.resolve("features").toString())))
             assertEquals(true, ccm.download())
             assertEquals(it.second, ccm.features, "version: ${it.first}")