feat: Add --build-on flag with settings: auto, local, remote

Add `--build-on` flag with the following settings: `auto`(default), `local`, `remote`.

- `auto`: Will check, if a local build is possible and gracefully fall
  back to a remote build.
- `local`: Will build on the local host.
- `remote`: Will build on the remote host.

Author: a-kenji

README.md

@@ -68,8 +68,6 @@ data has been migrated.
 - Source Machine:
 
   - Can be any machine with Nix installed, e.g. a NixOS machine.
-  - Should be able to build nix derivations for the target platform. Otherwise
-    `--build-on-remote` can be used.
 
 - Target Machine:
 

docs/cli.md

@@ -53,4 +53,9 @@ Options:
   build the closure on the remote machine instead of locally and copy-closuring it
 * --vm-test
   build the system and test the disk configuration inside a VM without installing it to the target.
+* --build-on auto|remote|local
+  sets the build on settings to auto, remote or local. Default is auto.
+  auto: tries to figure out, if the build is possible on the local host, if not falls back gracefully to remote build
+  local: will build on the local host
+  remote: will build on the remote host
 ```

docs/requirements.md

@@ -15,9 +15,6 @@
    - NixOS
    - Windows systems using WSL2.
 
-   _Note_: Should be able to build nix derivations for the target platform.
-   Otherwise `--build-on-remote` can be used.
-
 2. **Nix Installation:** If Nix is not yet installed on your system, refer to
    the [nix installation page](https://nixos.org/download#download-nix).
 

src/nixos-anywhere.sh

@@ -35,6 +35,7 @@ fi
 sshConnection=
 postKexecSshPort=22
 buildOnRemote=n
+buildOn=auto
 envPassword=n
 
 # Facts set by get-facts.sh
@@ -126,8 +127,11 @@ Options:
 * --disko-mode disko|mount|format
   set the disko mode to format, mount or destroy. Default is disko.
   disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
-  mount: mount the partition at the specified root-mountpoint
-  format: create partition tables, zpools, lvms, raids and filesystems (Experimental: Can be run increntally, but use with caution and good backups)
+* --build-on auto|remote|local
+  sets the build on settings to auto, remote or local. Default is auto.
+  auto: tries to figure out, if the build is possible on the local host, if not falls back gracefully to remote build
+  local: will build on the local host
+  remote: will build on the remote host
 USAGE
 }
 
@@ -143,6 +147,7 @@ step() {
 parseArgs() {
   local substituteOnDestination=y
   local printBuildLogs=n
+  local buildOnRemote=n
   while [[ $# -gt 0 ]]; do
     case "$1" in
     -f | --flake)
@@ -227,6 +232,18 @@ parseArgs() {
         ;;
       esac
 
+      shift
+      ;;
+    --build-on)
+      case "$2" in
+      auto | local | remote)
+        buildOn=$2
+        ;;
+      *)
+        abort "Supported values for --build-on are auto, local and remote. Unknown mode : $2"
+        ;;
+      esac
+
       shift
       ;;
     --extra-files)
@@ -281,7 +298,9 @@ parseArgs() {
       substituteOnDestination=n
       ;;
     --build-on-remote)
+      echo "WARNING: --build-on-remote is deprecated, use --build-on remote instead" 2>&1
       buildOnRemote=y
+      buildOn="remote"
       ;;
     --env-password)
       envPassword=y
@@ -313,6 +332,10 @@ parseArgs() {
     abort "ssh-host must be set"
   fi
 
+  if [[ $buildOn == "local" ]] && [[ $buildOnRemote == "y" ]]; then
+    abort "Conflicting flags: --build-on local and --build-on-remote used."
+  fi
+
   if [[ -n ${flake} ]]; then
     if [[ $flake =~ ^(.*)\#([^\#\"]*)$ ]]; then
       flake="${BASH_REMATCH[1]}"
@@ -364,7 +387,7 @@ runVmTest() {
     exit 1
   fi
 
-  if [[ ${buildOnRemote} == "y" ]]; then
+  if [[ ${buildOn} == "remote" ]]; then
     echo "--vm-test is not supported with --build-on-remote" >&2
     exit 1
   fi
@@ -450,6 +473,36 @@ importFacts() {
   done
 }
 
+canBuildLocally() {
+  local system extraPlatforms machineSystem
+  system="$(nix --extra-experimental-features 'nix-command flakes' config show system)"
+  extraPlatforms="$(nix --extra-experimental-features 'nix-command flakes' config show extra-platforms)"
+  machineSystem="$(nix --extra-experimental-features 'nix-command flakes' eval --raw "${flake}"#"${flakeAttr}".nixpkgs.hostPlatform)"
+
+  if [[ ${system} == "${machineSystem}" ]]; then
+    return
+  fi
+
+  if [[ ${extraPlatforms} == "*${machineSystem}*" ]]; then
+    return
+  fi
+
+  local entropy nonSubstitutableDrv
+  entropy="$(date +'%Y%m%d%H%M%S')"
+  nonSubstitutableDrv=$(nix eval \
+    --impure \
+    --raw \
+    -L \
+    "${nixOptions[@]}" \
+    --expr \
+    "((builtins.getFlake \"$flake\").inputs.nixpkgs.legacyPackages.$system.runCommandNoCC \"nixos-anywhere-can-build-$entropy\" { } \"echo > \$out\").drvPath")
+
+  if ! nix build "${nixOptions[@]}" "${nonSubstitutableDrv}^*"; then
+    # The local build failed
+    export buildOn=remote
+  fi
+}
+
 generateHardwareConfig() {
   local maybeSudo="$maybeSudo"
   mkdir -p "$(dirname "$hardwareConfigPath")"
@@ -557,7 +610,7 @@ runDisko() {
   done
   if [[ -n ${diskoScript} ]]; then
     nixCopy --to "ssh://$sshConnection" "$diskoScript"
-  elif [[ ${buildOnRemote} == "y" ]]; then
+  elif [[ ${buildOn} == "remote" ]]; then
     step Building disko script
     # We need to do a nix copy first because nix build doesn't have --no-check-sigs
     # Use ssh:// here to avoid https://github.com/NixOS/nix/issues/7359
@@ -579,7 +632,7 @@ nixosInstall() {
   if [[ -n ${nixosSystem} ]]; then
     step Uploading the system closure
     nixCopy --to "ssh://$sshConnection?remote-store=local?root=/mnt" "$nixosSystem"
-  elif [[ ${buildOnRemote} == "y" ]]; then
+  elif [[ ${buildOn} == "remote" ]]; then
     step Building the system closure
     # We need to do a nix copy first because nix build doesn't have --no-check-sigs
     # Use ssh:// here to avoid https://github.com/NixOS/nix/issues/7359
@@ -644,9 +697,13 @@ main() {
     exit 0
   fi
 
+  if [[ ${buildOn} == "auto" ]]; then
+    canBuildLocally
+  fi
+
   # parse flake nixos-install style syntax, get the system attr
   if [[ -n ${flake} ]]; then
-    if [[ ${buildOnRemote} == "n" ]] && [[ ${hardwareConfigBackend} == "none" ]]; then
+    if [[ ${buildOn} == "remote" ]] && [[ ${hardwareConfigBackend} == "none" ]]; then
       if [[ ${phases[disko]} == 1 ]]; then
         diskoScript=$(nixBuild "${flake}#${flakeAttr}.system.build.${diskoMode}Script")
       fi
@@ -708,7 +765,7 @@ main() {
     generateHardwareConfig
   fi
 
-  if [[ ${buildOnRemote} == "n" ]] && [[ -n ${flake} ]] && [[ ${hardwareConfigBackend} != "none" ]]; then
+  if [[ ${buildOn} != "remote" ]] && [[ -n ${flake} ]] && [[ ${hardwareConfigBackend} != "none" ]]; then
     if [[ ${phases[disko]} == 1 ]]; then
       diskoScript=$(nixBuild "${flake}#${flakeAttr}.system.build.${diskoMode}Script")
     fi