Support Windows ARM (#54)

In this changeset, we add a dependency to Windows ARM binaries since we
recently
[introduced](TeamDev-IP/JxBrowser#2990) the
support of this architecture. As for now, this will only be supported in
JxBrowser 8.

Also, I added a check for some artifacts supported only in JxBrowser 8.
From now on, if the user decides to use the `jxbrowser-kotlin` artifact
with JxBrowser 7, for example, the build will fail.

Author: ivan-diachenko-td

README.md

@@ -48,6 +48,7 @@ dependencies {
     implementation(jxbrowser.macArm)
     implementation(jxbrowser.win32)
     implementation(jxbrowser.win64)
+    implementation(jxbrowser.win64Arm)
     implementation(jxbrowser.linux64)
     implementation(jxbrowser.linuxArm)
 }

build.gradle.kts

@@ -56,6 +56,7 @@ repositories {
 
 dependencies {
     implementation(kotlin("stdlib"))
+    implementation("com.vdurmont:semver4j:3.1.0")
 
     testImplementation(kotlin("test"))
     testImplementation(gradleTestKit())

src/main/kotlin/com/teamdev/jxbrowser/gradle/JxBrowserExtension.kt

@@ -28,6 +28,7 @@ import com.teamdev.jxbrowser.gradle.Environment.isWindows
 import com.teamdev.jxbrowser.gradle.Environment.isX64Bit
 import com.teamdev.jxbrowser.gradle.Environment.jvmArch
 import com.teamdev.jxbrowser.gradle.Environment.osName
+import com.vdurmont.semver4j.Semver
 import org.gradle.api.Project
 import org.gradle.api.provider.Provider
 
@@ -73,12 +74,16 @@ public open class JxBrowserExtension(private val project: Project) {
     /**
      * Returns a dependency notation for the `jxbrowser-kotlin`,
      * an artifact with the Kotlin API of the library.
+     *
+     * Kotlin API is only supported in JxBrowser 8.x.x.
      */
     public val kotlin: Provider<String> = artifact("kotlin")
 
     /**
      * Returns a dependency notation for the `jxbrowser-compose`,
      * an artifact with Compose integration.
+     *
+     * Compose is only supported in JxBrowser 8.x.x.
      */
     public val compose: Provider<String> = artifact("compose")
 
@@ -112,6 +117,14 @@ public open class JxBrowserExtension(private val project: Project) {
      */
     public val win32: Provider<String> = artifact("win32")
 
+    /**
+     * Returns a dependency notation for the `jxbrowser-win64-arm`,
+     * an artifact with Chromium Windows ARM 64-bit binaries.
+     *
+     * Windows ARM is only supported in JxBrowser 8.x.x.
+     */
+    public val win64Arm: Provider<String> = artifact("win64-arm")
+
     /**
      * Returns a dependency notation for the `jxbrowser-linux64`,
      * an artifact with Chromium Linux 64-bit binaries.
@@ -151,12 +164,13 @@ public open class JxBrowserExtension(private val project: Project) {
     private fun currentPlatform(): Provider<String> {
         val platformMap =
             mapOf(
-                Pair({ isX64Bit() && isWindows() }, win64),
-                Pair({ isX64Bit() && isLinux() }, linux64),
-                Pair({ isX64Bit() && isMac() }, mac),
-                Pair({ is32Bit() && isWindows() }, win32),
-                Pair({ isArm() && isLinux() }, linuxArm),
-                Pair({ isArm() && isMac() }, macArm),
+                { isX64Bit() && isWindows() } to win64,
+                { is32Bit() && isWindows() } to win32,
+                { isArm() && isWindows() } to win64Arm,
+                { isX64Bit() && isLinux() } to linux64,
+                { isX64Bit() && isMac() } to mac,
+                { isArm() && isLinux() } to linuxArm,
+                { isArm() && isMac() } to macArm,
             )
         return platformMap.entries.firstOrNull { it.key() }?.value
             ?: project.providers.provider {
@@ -169,13 +183,34 @@ public open class JxBrowserExtension(private val project: Project) {
     private fun artifact(shortName: String) =
         project.providers.provider {
             check(version.isNotBlank()) { "JxBrowser version is not specified." }
+            checkArtifactSupported(shortName)
             if (shortName == "core") {
                 "$GROUP:jxbrowser:$version"
             } else {
                 "$GROUP:jxbrowser-$shortName:$version"
             }
         }
 
+    /**
+     * Check if the artifact with `shortName` exists in JxBrowser `version`.
+     */
+    private fun checkArtifactSupported(shortName: String) {
+        val artifactNameToReleaseVersion =
+            mapOf(
+                "compose" to "8.0.0-eap.1",
+                "kotlin" to "8.0.0-eap.1",
+                "win64-arm" to "8.0.0",
+            )
+        val artifactReleaseVersion = artifactNameToReleaseVersion[shortName]
+        if (artifactReleaseVersion != null) {
+            val releaseVersion = Semver(artifactReleaseVersion)
+            val actualVersion = Semver(version)
+            check(actualVersion.isGreaterThanOrEqualTo(releaseVersion)) {
+                "Artifact '$shortName' is not supported by JxBrowser $version. Use $artifactReleaseVersion or greater."
+            }
+        }
+    }
+
     private companion object {
         private const val GROUP = "com.teamdev.jxbrowser"
     }

src/test/kotlin/com/teamdev/jxbrowser/gradle/JxBrowserPluginFunctionalTest.kt

@@ -30,6 +30,7 @@ import org.junit.jupiter.api.io.TempDir
 import java.io.File
 import kotlin.test.BeforeTest
 import kotlin.test.Test
+import kotlin.test.assertFails
 
 @DisplayName("JxBrowserPlugin should")
 internal class JxBrowserPluginFunctionalTest {
@@ -94,7 +95,6 @@ internal class JxBrowserPluginFunctionalTest {
                 "jxbrowser-mac-$jxBrowserVersion.jar",
                 "jxbrowser-mac-arm-$jxBrowserVersion.jar",
             )
-
         buildFile.writeText(
             """ 
             plugins {
@@ -194,6 +194,39 @@ internal class JxBrowserPluginFunctionalTest {
         libsFolder.files() shouldContainExactlyInAnyOrder filesToCheck
     }
 
+    @Test
+    fun `fail to download unsupported artifacts`() {
+        val jxBrowserVersion = "7.40.0" // This version doesn't contain artifacts bellow.
+        val unsupportedArtifacts = listOf("kotlin", "compose", "win64-arm")
+
+        for (artifact in unsupportedArtifacts) {
+            buildFile.writeText(
+                """ 
+                plugins {
+                    java
+                    id("com.teamdev.jxbrowser")
+                }
+                
+                jxbrowser {
+                    version = "$jxBrowserVersion"
+                }
+                
+                dependencies {
+                    implementation(jxbrowser.$artifact)
+                }
+                """.trimIndent(),
+            )
+
+            assertFails {
+                GradleRunner.create()
+                    .withProjectDir(testProjectDir)
+                    .withPluginClasspath()
+                    .withArguments("build")
+                    .build()
+            }
+        }
+    }
+
     private fun BuildResult.outcome(taskName: String) = this.task(taskName)!!.outcome
 
     private fun File.files() = this.listFiles()!!.map { it.name }