Merge pull request #4 from tindzk/feat/macos

Support building on macOS

Author: tindzk

README.md

@@ -31,7 +31,7 @@ The generated Docker image allows you to compile your Rust project for any of th
 
 ## Requirements
 - Docker
-- [Bubblewrap](https://github.com/containers/bubblewrap) (optional)
+- [Bubblewrap](https://github.com/containers/bubblewrap) (optional, Linux only)
 - A minimum of 15 GB free disk space is recommended
 
 ## Installation
@@ -62,7 +62,7 @@ mkdir sample-project && cd sample-project
 cp $RUSTX_PATH/config.nuon.sample rustx.nuon
 ```
 
-Edit `rustx.nuon` to match your requirements.
+Edit `rustx.nuon` to match your requirements. Please note that Linux targets currently support only the `musl` variant.
 
 Build all toolchains and generate the `Dockerfile`:
 

config.nuon.sample

@@ -5,6 +5,8 @@
 {
     rust_version: "1.87.0"
     alpine_version: "3.21"
+
+    # Note: Linux targets currently only support the musl variant.
     targets: [
         "x86_64-unknown-linux-musl"
         "aarch64-unknown-linux-musl"
@@ -30,7 +32,12 @@
 
     # Isolation mechanism used for building toolchains
     #
+    # When building on macOS, set this to `docker` as `bubblewrap` is not available.
+    #
     # Possible values: bubblewrap (default), docker
     #
+    # The Docker isolation creates a volume named alpine-rustx-build. It is reused
+    # across cache runs and can be removed.
+    #
     #isolation: "docker"
 }

rustx

@@ -2,22 +2,48 @@
 
 NU_VERSION=$(cat $(dirname $0)/.nu_version)
 
-if [ ! -f build/nu-$NU_VERSION ]; then
-	name=nu-$NU_VERSION-$(uname -m)-unknown-linux-musl
+os=$(uname -s)
+arch=$(uname -m)
+
+case "$os" in
+	"Darwin")
+		[ "$arch" = "arm64" ] && arch="aarch64"
+		native_nu="nu-${NU_VERSION}-${arch}-apple-darwin"
+		;;
+	"Linux")
+		native_nu="nu-${NU_VERSION}-${arch}-unknown-linux-musl"
+		;;
+	*)
+		echo "Unsupported operating system: $os" >&2
+		exit 1
+		;;
+esac
+
+linux_nu="nu-${NU_VERSION}-${arch}-unknown-linux-musl"
+
+fetch_nu() {
+	name="$1"
 
 	mkdir -p build/
 	cd build/
 
 	wget "https://github.com/nushell/nushell/releases/download/$NU_VERSION/$name.tar.gz"
+
 	tar -zxvf ${name}.tar.gz $name/nu
 	rm ${name}.tar.gz
-	mv $name/nu nu-$NU_VERSION
-	rmdir $name
 
 	cd -
+}
+
+if [ ! -f build/$native_nu/nu ]; then
+	fetch_nu "$native_nu"
+fi
+
+if [ ! -f build/$linux_nu/nu ]; then
+	fetch_nu "$linux_nu"
 fi
 
 script="$(dirname "$0")/src/commands/$1.nu"
 shift
 
-exec build/nu-$NU_VERSION $script "$@"
+exec build/$native_nu/nu $script "$@"

src/commands/build.nu

@@ -5,26 +5,33 @@ use ../config.nu
 
 def main [config_path: string] {
     let root_path = ($env.FILE_PWD | path join "../../")
+
+    mut host_arch = (uname | get machine)
+    if $host_arch == "arm64" {
+        # Needed if host system is macOS
+        $host_arch = "aarch64"
+    }
+
     let nu_version = (open ($root_path | path join ".nu_version") | str trim)
     let cfg = config normalise (open $config_path)
 
     mkdir build
     mkdir toolchains
 
-    let spec = {
+    mut spec = {
         rw_bind: {
-            $"(pwd)/build": "/build",
             $"(pwd)/toolchains": "/toolchains"
         }
         ro_bind: {
-            $"(pwd)/build/nu-($nu_version)": "/bin/nu",
+            $"(pwd)/build/nu-($nu_version)-($host_arch)-unknown-linux-musl/nu": "/bin/nu",
             ($config_path | path expand): "/build/config.nuon",
             ($root_path | path join "src"): "/src"
         }
         command: "/src/build.nu"
     }
 
     if $cfg.isolation == "bubblewrap" {
+        $spec.rw_bind = $spec.rw_bind | insert $"(pwd)/build" "/build"
         bubblewrap run $spec
     } else if $cfg.isolation == "docker" {
         docker run $spec

src/dockerfile.nu

@@ -45,7 +45,12 @@ export def generate [config: record] {
     }
 
     let macos_commands = if ($all_targets.macos | is-not-empty) {
-        let host_arch = (uname | get machine)
+        mut host_arch = (uname | get machine)
+        if $host_arch == "arm64" {
+            # Needed if host system is macOS
+            $host_arch = "aarch64"
+        }
+
         let rust_objcopy = $"/usr/local/rustup/toolchains/($config.rust_version)-($host_arch)-unknown-linux-musl/lib/rustlib/($host_arch)-unknown-linux-musl/bin/rust-objcopy"
 
         $apk_deps = [...$apk_deps, "clang", "llvm"]

src/isolation/bubblewrap.nu

@@ -4,8 +4,10 @@ export def run [spec: record] {
     if not ("rootfs" | path exists) {
         mkdir rootfs
 
+        let major_alpine_version = ($ALPINE_VERSION | split row '.' | take 2 | str join ".")
+
         let host_arch = (uname | get machine)
-        wget -O - $"https://dl-cdn.alpinelinux.org/alpine/latest-stable/releases/($host_arch)/alpine-minirootfs-($ALPINE_VERSION)-($host_arch).tar.gz" | tar -xz -C rootfs
+        wget -O - $"https://dl-cdn.alpinelinux.org/alpine/v($major_alpine_version)/releases/($host_arch)/alpine-minirootfs-($ALPINE_VERSION)-($host_arch).tar.gz" | tar -xz -C rootfs
     }
 
     let rw_bind = $spec.rw_bind | transpose name value | each {|it| ["--bind", $it.name, $it.value]} | flatten

src/isolation/common.nu

@@ -1 +1 @@
-export const ALPINE_VERSION = "3.21.3"
+export const ALPINE_VERSION = "3.22.0"

src/isolation/docker.nu

@@ -4,5 +4,10 @@ export def run [spec: record] {
     let rw_bind = $spec.rw_bind | transpose name value | each {|it| ["--mount", $"type=bind,src=($it.name),dst=($it.value)"]} | flatten
     let ro_bind = $spec.ro_bind | transpose name value | each {|it| ["--mount", $"type=bind,src=($it.name),dst=($it.value),ro"]} | flatten
 
-    (docker run --rm -t -i ...$rw_bind ...$ro_bind $"alpine:($ALPINE_VERSION)" $spec.command)
+    # For macOS compatibility, create a separate volume for the build cache.
+    # Otherwise, some files appear to be missing when linking the toolchain.
+    # Using a volume should also speed up builds on macOS.
+    (docker volume create alpine-rustx-build)
+
+    (docker run --rm -t -i -v alpine-rustx-build:/build ...$rw_bind ...$ro_bind $"alpine:($ALPINE_VERSION)" $spec.command)
 }