Skip to content

Commit 01d15e6

Browse files
deepydeepy
authored
Merge pull request #318 from node-gradle/win-arm64-support
Add support for ARM64 Windows
2 parents 70eb5c1 + 8b2f4cf commit 01d15e6

4 files changed

Lines changed: 117 additions & 48 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
## Version 7.x *(unreleased)*
44

5+
## Version 7.0.3 *(unreleased)*
6+
* Add support for ARM64 Windows [#315](https://github.com/node-gradle/gradle-node-plugin/issues/315)
7+
58
## Version 7.0.2 *(2024-02-02)*
69
* Prevent misconfigured `workDir` from removing all unrelated files [#297](https://github.com/node-gradle/gradle-node-plugin/issues/297)
710

‎src/main/kotlin/com/github/gradle/node/NodePlugin.kt‎

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ import com.github.gradle.node.variant.computeNodeDir
1616
import com.github.gradle.node.yarn.task.YarnInstallTask
1717
import com.github.gradle.node.yarn.task.YarnSetupTask
1818
import com.github.gradle.node.yarn.task.YarnTask
19+
import org.gradle.api.Action
1920
import org.gradle.api.Plugin
2021
import org.gradle.api.Project
2122
import org.gradle.api.provider.Property
2223
import org.gradle.kotlin.dsl.*
24+
import org.gradle.process.ExecSpec
2325
import org.gradle.util.GradleVersion
2426
import java.io.ByteArrayOutputStream
2527
import java.io.File
@@ -62,28 +64,40 @@ class NodePlugin : Plugin<Project> {
6264
}
6365

6466
private fun addPlatform(extension: NodeExtension) {
67+
val osType = parseOsType(System.getProperty("os.name"))
68+
val arch = System.getProperty("os.arch")
69+
70+
val unameSpec: Action<ExecSpec> = Action {
71+
if (osType == OsType.WINDOWS) {
72+
this.executable = "powershell"
73+
this.args = listOf(
74+
"-NoProfile", // Command runs in ~175ms, -NoProfile saves ~300ms
75+
"-Command",
76+
"(Get-WmiObject Win32_Processor).Architecture",
77+
)
78+
} else {
79+
this.executable = "uname"
80+
this.args = listOf("-m")
81+
}
82+
}
83+
6584
val uname = {
6685
if (GradleVersion.current() >= GradleVersion.version("7.5")) {
67-
val cmd = project.providers.exec {
68-
this.executable = "uname"
69-
this.args = listOf("-m")
70-
}
86+
val cmd = project.providers.exec(unameSpec)
7187
cmd.standardOutput.asText.get().trim()
7288
} else {
7389
val out = ByteArrayOutputStream()
90+
project.exec(unameSpec)
7491
val cmd = project.exec {
75-
this.executable = "uname"
76-
this.args = listOf("-m")
92+
unameSpec.execute(this)
7793
this.standardOutput = out
7894
}
7995

8096
cmd.assertNormalExitValue()
8197
out.toString().trim()
8298
}
8399
}
84-
val name = System.getProperty("os.name")
85-
val arch = System.getProperty("os.arch")
86-
val platform = parsePlatform(name, arch, uname)
100+
val platform = parsePlatform(osType, arch, uname)
87101
extension.resolvedPlatform.set(platform)
88102
extension.computedPlatform.convention(extension.resolvedPlatform)
89103
}

‎src/main/kotlin/com/github/gradle/node/util/PlatformHelper.kt‎

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,32 @@ package com.github.gradle.node.util
22

33
import java.util.concurrent.Callable
44

5+
internal enum class OsType(val osName: String) {
6+
WINDOWS("win"),
7+
MAC("darwin"),
8+
LINUX("linux"),
9+
FREEBSD("linux"), // https://github.com/node-gradle/gradle-node-plugin/issues/178
10+
SUN("sunos"),
11+
}
12+
13+
internal fun parsePlatform(type: OsType, arch: String, uname: () -> String): Platform {
14+
val osArch = if (type == OsType.WINDOWS) parseWindowsArch(arch.toLowerCase(), uname)
15+
else parseOsArch(arch.toLowerCase(), uname)
16+
return Platform(type.osName, osArch)
17+
}
18+
19+
internal fun parseOsType(type: String): OsType {
20+
val name = type.toLowerCase()
21+
return when {
22+
name.contains("windows") -> OsType.WINDOWS
23+
name.contains("mac") -> OsType.MAC
24+
name.contains("linux") -> OsType.LINUX
25+
name.contains("freebsd") -> OsType.FREEBSD
26+
name.contains("sunos") -> OsType.SUN
27+
else -> error("Unsupported OS: $name")
28+
}
29+
}
30+
531
fun parsePlatform(name: String, arch: String, uname: () -> String): Platform {
632
return Platform(parseOsName(name.toLowerCase()), parseOsArch(arch.toLowerCase(), uname))
733
}
@@ -33,10 +59,45 @@ fun parseOsArch(arch: String, uname: Callable<String>): String {
3359
}
3460
}
3561

62+
fun parseWindowsArch(arch: String, uname: Callable<String>): String {
63+
//
64+
return when {
65+
arch.startsWith("aarch") || arch.startsWith("arm")
66+
-> {
67+
val wmiArch = uname.call()
68+
return when (wmiArch) {
69+
/*
70+
* Parse Win32_Processor.Architectures to real processor type
71+
*
72+
* Table from https://learn.microsoft.com/en-us/windows/win32/api/sysinfoapi/ns-sysinfoapi-system_info#members
73+
*/
74+
"12" -> "arm64"
75+
"9" -> "x64"
76+
// "6" -> "IA64"
77+
// "5" -> "arm" // 32-bit
78+
"0" -> "x86"
79+
// "0xffff" -> "Unknown"
80+
else -> error("Unexpected Win32_Processor.Architecture: $arch")
81+
}
82+
}
83+
arch.contains("64") -> "x64"
84+
else -> "x86"
85+
}
86+
}
87+
3688
fun main(args: Array<String>) {
3789
val osName = System.getProperty("os.name")
3890
val osArch = System.getProperty("os.arch")
39-
val uname = { execute("uname", "-m", timeout = 10) }
91+
92+
val osType = parseOsType(osName)
93+
val uname = {
94+
val args = if (osType == OsType.WINDOWS) {
95+
listOf("powershell", "-NoProfile", "-Command", "(Get-WmiObject Win32_Processor).Architecture")
96+
} else {
97+
listOf("uname", "-m")
98+
}
99+
execute(*args.toTypedArray(), timeout = 10)
100+
}
40101
val platform = parsePlatform(osName, osArch, uname)
41102

42103
println("Your os.name is: '${osName}' and is parsed as: '${platform.name}'")

‎src/test/groovy/com/github/gradle/node/util/PlatformHelperTest.groovy‎

Lines changed: 29 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -16,53 +16,44 @@ class PlatformHelperTest extends Specification {
1616
platform.windows == isWindows
1717

1818
where:
19-
osProp | archProp | osName | osArch | isWindows
20-
'Windows 8' | 'x86' | 'win' | 'x86' | true
21-
'Windows 8' | 'x86_64' | 'win' | 'x64' | true
22-
'Mac OS X' | 'x86' | 'darwin' | 'x86' | false
23-
'Mac OS X' | 'x86_64' | 'darwin' | 'x64' | false
24-
'Linux' | 'x86' | 'linux' | 'x86' | false
25-
'Linux' | 'x86_64' | 'linux' | 'x64' | false
26-
'Linux' | 'ppc64le' | 'linux' | 'ppc64le' | false
27-
'Linux' | 's390x' | 'linux' | 's390x' | false
28-
'SunOS' | 'x86' | 'sunos' | 'x86' | false
29-
'SunOS' | 'x86_64' | 'sunos' | 'x64' | false
19+
osProp | archProp || osName | osArch | isWindows
20+
'Windows 8' | 'x86' || 'win' | 'x86' | true
21+
'Windows 8' | 'x86_64' || 'win' | 'x64' | true
22+
'Windows 10' | 'x86_64' || 'win' | 'x64' | true
23+
'Mac OS X' | 'x86' || 'darwin' | 'x86' | false
24+
'Mac OS X' | 'x86_64' || 'darwin' | 'x64' | false
25+
'Linux' | 'x86' || 'linux' | 'x86' | false
26+
'Linux' | 'x86_64' || 'linux' | 'x64' | false
27+
'Linux' | 'ppc64le' || 'linux' | 'ppc64le' | false
28+
'Linux' | 's390x' || 'linux' | 's390x' | false
29+
'SunOS' | 'x86' || 'sunos' | 'x86' | false
30+
'SunOS' | 'x86_64' || 'sunos' | 'x64' | false
3031
}
3132

3233
@Unroll
33-
def "verify ARM handling #archProp (#unameProp)"() {
34+
def "verify #osProp ARM handling #archProp (#unameProp)"() {
3435
given:
35-
def platform = PlatformHelperKt.parsePlatform("Linux", archProp, { unameProp })
36+
def osType = PlatformHelperKt.parseOsType(osProp)
37+
def platform = PlatformHelperKt.parsePlatform(osType, archProp, { unameProp })
3638

3739
expect:
38-
platform.name == "linux"
39-
platform.arch == osArch
40-
41-
where:
42-
archProp | unameProp | osArch
43-
'arm' | 'armv7l' | 'armv7l' // Raspberry Pi 3
44-
'arm' | 'armv8l' | 'arm64'
45-
'aarch32' | 'arm' | 'arm'
46-
'aarch64' | 'arm64' | 'arm64'
47-
'aarch64' | 'aarch64' | 'arm64'
48-
'ppc64le' | 'ppc64le' | 'ppc64le'
49-
}
50-
51-
@Unroll
52-
def "verify ARM handling Mac OS #archProp (#unameProp)"() {
53-
given:
54-
def platform = PlatformHelperKt.parsePlatform("Mac OS X", archProp, { unameProp })
55-
56-
expect:
57-
platform.name == "darwin"
40+
platform.name == osName
5841
platform.arch == osArch
5942

6043
where:
61-
archProp | unameProp | osArch
62-
'aarch32' | 'arm' | 'arm'
63-
'aarch64' | 'arm64' | 'arm64'
64-
'aarch64' | 'aarch64' | 'arm64'
65-
'aarch64' | 'x86_64' | 'x64' // This shouldn't really happen but according to PR #204 it does
44+
osProp | archProp || osName | unameProp | osArch
45+
'Linux' | 'arm' || 'linux' | 'armv7l' | 'armv7l' // Raspberry Pi 3
46+
'Linux' | 'arm' || 'linux' | 'armv8l' | 'arm64'
47+
'Linux' | 'aarch32' || 'linux' | 'arm' | 'arm'
48+
'Linux' | 'aarch64' || 'linux' | 'arm64' | 'arm64'
49+
'Linux' | 'aarch64' || 'linux' | 'aarch64' | 'arm64'
50+
'Linux' | 'ppc64le' || 'linux' | 'ppc64le' | 'ppc64le'
51+
'Mac OS X' | 'aarch32' || 'darwin' | 'arm' | 'arm'
52+
'Mac OS X' | 'aarch64' || 'darwin' | 'arm64' | 'arm64'
53+
'Mac OS X' | 'aarch64' || 'darwin' | 'aarch64' | 'arm64'
54+
'Mac OS X' | 'aarch64' || 'darwin' | 'x86_64' | 'x64' // This unfortunately happens see PR #204
55+
'Windows 10' | 'aarch64' || 'win' | '12' | 'arm64'
56+
'Windows 11' | 'aarch64' || 'win' | '9' | 'x64' // Not sure if this can actually happen
6657
}
6758

6859
def "throw exception if unsupported os"() {

0 commit comments

Comments
 (0)