Split out version check for testing

code-asher · code-asher · commit c0805a2ddfaf · 2023-04-05T15:09:44.000-08:00
diff --git a/src/main/kotlin/com/coder/gateway/sdk/CoderSemVer.kt b/src/main/kotlin/com/coder/gateway/sdk/CoderSemVer.kt
@@ -1,5 +1,6 @@
 package com.coder.gateway.sdk
 
+import com.coder.gateway.CoderSupportedVersions
 
 class CoderSemVer(private val major: Long = 0, private val minor: Long = 0, private val patch: Long = 0) : Comparable<CoderSemVer> {
 
@@ -62,5 +63,27 @@ class CoderSemVer(private val major: Long = 0, private val minor: Long = 0, priv
                 if (matchResult.groupValues[3].isNotEmpty()) matchResult.groupValues[3].toLong() else 0,
             )
         }
+
+        /**
+         * Check to see if the plugin is compatible with the provided version.
+         * Throws if not valid.
+         */
+        @JvmStatic
+        fun checkVersionCompatibility(buildVersion: String) {
+            if (!isValidVersion(buildVersion)) {
+                throw InvalidVersionException("Invalid version $buildVersion")
+            }
+
+            if (!parse(buildVersion).isInClosedRange(
+                    CoderSupportedVersions.minCompatibleCoderVersion,
+                    CoderSupportedVersions.maxCompatibleCoderVersion
+                )
+            ) {
+                throw IncompatibleVersionException("Incompatible version $buildVersion")
+            }
+        }
     }
-}
+}
+
+class InvalidVersionException(message: String) : Exception(message)
+class IncompatibleVersionException(message: String) : Exception(message)
diff --git a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt
@@ -1,7 +1,6 @@
 package com.coder.gateway.views.steps
 
 import com.coder.gateway.CoderGatewayBundle
-import com.coder.gateway.CoderSupportedVersions
 import com.coder.gateway.icons.CoderIcons
 import com.coder.gateway.models.CoderWorkspacesWizardModel
 import com.coder.gateway.models.WorkspaceAgentModel
@@ -14,6 +13,8 @@ import com.coder.gateway.sdk.Arch
 import com.coder.gateway.sdk.CoderCLIManager
 import com.coder.gateway.sdk.CoderRestClientService
 import com.coder.gateway.sdk.CoderSemVer
+import com.coder.gateway.sdk.IncompatibleVersionException
+import com.coder.gateway.sdk.InvalidVersionException
 import com.coder.gateway.sdk.OS
 import com.coder.gateway.sdk.TemplateIconDownloader
 import com.coder.gateway.sdk.ex.AuthenticationResponseException
@@ -521,23 +522,21 @@ class CoderWorkspacesStepView(val setNextButtonEnabled: (Boolean) -> Unit) : Cod
         logger.info("Authenticating to ${localWizardModel.coderURL}...")
         coderClient.initClientSession(localWizardModel.coderURL.toURL(), token)
 
-        logger.info("Checking Coder version...")
-        if (!CoderSemVer.isValidVersion(coderClient.buildVersion)) {
-            logger.warn("Got invalid version ${coderClient.buildVersion}")
+        try {
+            logger.info("Checking compatibility with Coder version ${coderClient.buildVersion}...")
+            CoderSemVer.checkVersionCompatibility(coderClient.buildVersion)
+            logger.info("${coderClient.buildVersion} is compatible")
+        } catch (e: InvalidVersionException) {
+            logger.warn(e)
             notificationBanner.apply {
                 component.isVisible = true
                 showWarning(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.invalid.coder.version", coderClient.buildVersion))
             }
-        } else {
-            val coderVersion = CoderSemVer.parse(coderClient.buildVersion)
-            if (!coderVersion.isInClosedRange(CoderSupportedVersions.minCompatibleCoderVersion, CoderSupportedVersions.maxCompatibleCoderVersion)) {
-                logger.warn("Running with incompatible version ${coderClient.buildVersion}")
-                notificationBanner.apply {
-                    component.isVisible = true
-                    showWarning(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.unsupported.coder.version", coderClient.buildVersion))
-                }
-            } else {
-                logger.info("Got version ${coderClient.buildVersion}...")
+        } catch (e: IncompatibleVersionException) {
+            logger.warn(e)
+            notificationBanner.apply {
+                component.isVisible = true
+                showWarning(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.unsupported.coder.version", coderClient.buildVersion))
             }
         }
 
diff --git a/src/test/groovy/CoderSemVerTest.groovy b/src/test/groovy/CoderSemVerTest.groovy
@@ -278,4 +278,49 @@ class CoderSemVerTest extends spock.lang.Specification {
 
         ]
     }
+
+    def "should be invalid"() {
+        when:
+        CoderSemVer.checkVersionCompatibility(version)
+
+        then:
+        thrown(InvalidVersionException)
+
+        where:
+        version << [
+                "",
+                "foo",
+                "1.foo.2",
+        ]
+    }
+
+    def "should be incompatible"() {
+        when:
+        CoderSemVer.checkVersionCompatibility(version)
+
+        then:
+        thrown(IncompatibleVersionException)
+
+        where:
+        version << [
+                "0.0.0",
+                "0.12.8",
+                "9999999999.99999.99",
+        ]
+    }
+
+    def "should be compatible"() {
+        when:
+        CoderSemVer.checkVersionCompatibility(version)
+
+        then:
+        noExceptionThrown()
+
+        where:
+        version << [
+                "0.12.9",
+                "0.99.99",
+                "1.0.0",
+        ]
+    }
 }
