Add tests for config dir

code-asher · code-asher · commit fa39f57f3978 · 2023-03-31T15:30:24.000-08:00
diff --git a/src/main/kotlin/com/coder/gateway/sdk/CoderCLIManager.kt b/src/main/kotlin/com/coder/gateway/sdk/CoderCLIManager.kt
@@ -158,8 +158,8 @@ class CoderCLIManager(deployment: URL, buildVersion: String) {
          * Return the URL and token from the CLI config.
          */
         @JvmStatic
-        fun readConfig(): Pair<String?, String?> {
-            val configDir = getConfigDir()
+        fun readConfig(env: Environment = Environment()): Pair<String?, String?> {
+            val configDir = getConfigDir(env)
             CoderWorkspacesStepView.logger.info("Reading config from $configDir")
             return try {
                 val url = Files.readString(configDir.resolve("url"))
@@ -174,24 +174,34 @@ class CoderCLIManager(deployment: URL, buildVersion: String) {
          * Return the config directory used by the CLI.
          */
         @JvmStatic
-        fun getConfigDir(): Path {
-            var dir = System.getenv("CODER_CONFIG_DIR")
+        fun getConfigDir(env: Environment = Environment()): Path {
+            var dir = env.get("CODER_CONFIG_DIR")
             if (!dir.isNullOrBlank()) {
                 return Path.of(dir)
             }
             // The Coder CLI uses https://github.com/kirsle/configdir so this should
             // match how it behaves.
             return when (getOS()) {
-                OS.WINDOWS -> Paths.get(System.getenv("APPDATA"), "coderv2")
-                OS.MAC -> Paths.get(System.getenv("HOME"), "Library/Application Support/coderv2")
+                OS.WINDOWS -> Paths.get(env.get("APPDATA"), "coderv2")
+                OS.MAC -> Paths.get(env.get("HOME"), "Library/Application Support/coderv2")
                 else -> {
-                    dir = System.getenv("XDG_CONFIG_HOME")
+                    dir = env.get("XDG_CONFIG_HOME")
                     if (!dir.isNullOrBlank()) {
                         return Paths.get(dir, "coderv2")
                     }
-                    return Paths.get(System.getenv("HOME"), ".config/coderv2")
+                    return Paths.get(env.get("HOME"), ".config/coderv2")
                 }
             }
         }
     }
 }
+
+class Environment(private val env: Map<String, String> = emptyMap()) {
+    fun get(name: String): String? {
+        val e = env[name]
+        if (e != null) {
+            return e
+        }
+        return System.getenv(name)
+    }
+}
diff --git a/src/test/groovy/CoderCLIManagerTest.groovy b/src/test/groovy/CoderCLIManagerTest.groovy
@@ -1,5 +1,6 @@
 package com.coder.gateway.sdk
 
+import spock.lang.Requires
 import spock.lang.Unroll
 
 import java.nio.file.Files
@@ -70,4 +71,60 @@ class CoderCLIManagerTest extends spock.lang.Specification {
         !downloaded
         ccm.localBinaryPath.toFile().readLines() == ["cli"]
     }
+
+    /**
+     * Get a config dir using default environment variable values.
+     */
+    def configDir(Map<String, String> env = emptyMap()) {
+        return CoderCLIManager.getConfigDir(new Environment([
+                "APPDATA"         : "/tmp/coder-gateway-test/appdata",
+                "HOME"            : "/tmp/coder-gateway-test/home",
+                "XDG_CONFIG_HOME" : "/tmp/coder-gateway-test/xdg",
+                "CODER_CONFIG_DIR": "",
+        ] + env))
+    }
+
+    // Mostly just a sanity check to make sure the default System.getenv runs
+    // without throwing any errors.
+    def "gets config dir"() {
+        when:
+        def dir = CoderCLIManager.getConfigDir(new Environment([
+                "CODER_CONFIG_DIR": "",
+        ]))
+
+        then:
+        dir.toString().contains("coderv2")
+    }
+
+    def "gets config dir from CODER_CONFIG_DIR"() {
+        expect:
+        Path.of(path) == configDir(env)
+
+        where:
+        env                                                  || path
+        ["CODER_CONFIG_DIR": "/tmp/coder-gateway-test/conf"] || "/tmp/coder-gateway-test/conf"
+    }
+
+    @Requires({ os.linux })
+    def "gets config dir from XDG or HOME"() {
+        expect:
+        Path.of(path) == configDir(env)
+
+        where:
+        env                     || path
+        [:]                     || "/tmp/coder-gateway-test/xdg/coderv2"
+        ["XDG_CONFIG_HOME": ""] || "/tmp/coder-gateway-test/home/.config/coderv2"
+    }
+
+    @Requires({ os.macOs })
+    def "gets config dir from HOME"() {
+        expect:
+        Path.of("/tmp/coder-gateway-test/home/Library/Application Support/coderv2") == configDir()
+    }
+
+    @Requires({ os.windows })
+    def "gets config dir from APPDATA"() {
+        expect:
+        Path.of("/tmp/coder-gateway-test/appdata/coderv2") == configDir()
+    }
 }
