module: throw if no disks are defined

nix-community · Sep 19, 2024 · c5853dc · c5853dc
1 parent 706a172
commit c5853dc
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 66 deletions.
diff --git a/lib/default.nix b/lib/default.nix
@@ -388,55 +388,59 @@ let
             description = ''
               The scripts generated by disko
             '';
-            default = { pkgs, checked ? false }: {
-              destroyScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-destroy" ''
-                export PATH=${lib.makeBinPath (with pkgs; [
-                  util-linux
-                  e2fsprogs
-                  mdadm
-                  zfs
-                  lvm2
-                  bash
-                  jq
-                  gnused
-                  gawk
-                  coreutils-full
-                ])}:$PATH
-                ${cfg.config._destroy}
-              '';
-
-              formatScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-format" ''
-                export PATH=${lib.makeBinPath (cfg.config._packages pkgs)}:$PATH
-                ${cfg.config._create}
-              '';
-
-              mountScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-mount" ''
-                export PATH=${lib.makeBinPath (cfg.config._packages pkgs)}:$PATH
-                ${cfg.config._mount}
-              '';
-
-              diskoScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko" ''
-                export PATH=${lib.makeBinPath ((cfg.config._packages pkgs) ++ [ pkgs.bash ])}:$PATH
-                ${cfg.config._disko}
-              '';
-
-              # These are useful to skip copying executables uploading a script to an in-memory installer
-              destroyScriptNoDeps = (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-destroy" ''
-                ${cfg.config._destroy}
-              '';
-
-              formatScriptNoDeps = (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-format" ''
-                ${cfg.config._create}
-              '';
-
-              mountScriptNoDeps = (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-mount" ''
-                ${cfg.config._mount}
-              '';
-
-              diskoScriptNoDeps = (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko" ''
-                ${cfg.config._disko}
-              '';
-            };
+            default = { pkgs, checked ? false }:
+              let
+                throwIfNoDisksDetected = _: v: if devices.disk == { } then throw "No disks defined, did you forget to import your disko config?" else v;
+              in
+              mapAttrs throwIfNoDisksDetected {
+                destroyScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-destroy" ''
+                  export PATH=${lib.makeBinPath (with pkgs; [
+                    util-linux
+                    e2fsprogs
+                    mdadm
+                    zfs
+                    lvm2
+                    bash
+                    jq
+                    gnused
+                    gawk
+                    coreutils-full
+                  ])}:$PATH
+                  ${cfg.config._destroy}
+                '';
+
+                formatScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-format" ''
+                  export PATH=${lib.makeBinPath (cfg.config._packages pkgs)}:$PATH
+                  ${cfg.config._create}
+                '';
+
+                mountScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-mount" ''
+                  export PATH=${lib.makeBinPath (cfg.config._packages pkgs)}:$PATH
+                  ${cfg.config._mount}
+                '';
+
+                diskoScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko" ''
+                  export PATH=${lib.makeBinPath ((cfg.config._packages pkgs) ++ [ pkgs.bash ])}:$PATH
+                  ${cfg.config._disko}
+                '';
+
+                # These are useful to skip copying executables uploading a script to an in-memory installer
+                destroyScriptNoDeps = (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-destroy" ''
+                  ${cfg.config._destroy}
+                '';
+
+                formatScriptNoDeps = (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-format" ''
+                  ${cfg.config._create}
+                '';
+
+                mountScriptNoDeps = (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-mount" ''
+                  ${cfg.config._mount}
+                '';
+
+                diskoScriptNoDeps = (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko" ''
+                  ${cfg.config._disko}
+                '';
+              };
           };
           _destroy = lib.mkOption {
             internal = true;

diff --git a/module.nix b/module.nix
@@ -200,23 +200,28 @@ in
       eval-config = import (pkgs.path + "/nixos/lib/eval-config.nix");
     };
 
-    system.build = (cfg.devices._scripts { inherit pkgs; checked = cfg.checkScripts; }) // {
-      # we keep these old outputs for compatibility
-      disko = builtins.trace "the .disko output is deprecated, please use .diskoScript instead" (cfg.devices._scripts { inherit pkgs; }).diskoScript;
-      diskoNoDeps = builtins.trace "the .diskoNoDeps output is deprecated, please use .diskoScriptNoDeps instead" (cfg.devices._scripts { inherit pkgs; }).diskoScriptNoDeps;
-
-      installTest = diskoLib.testLib.makeDiskoTest {
-        inherit extendModules pkgs;
-        name = "${config.networking.hostName}-disko";
-        disko-config = builtins.removeAttrs config [ "_module" ];
-        testMode = "direct";
-        efi = cfg.tests.efi;
-        extraSystemConfig = cfg.tests.extraConfig;
-        extraTestScript = cfg.tests.extraChecks;
-      };
-
-      vmWithDisko = lib.mkDefault config.virtualisation.vmVariantWithDisko.system.build.vmWithDisko;
-    };
+    system.build = (cfg.devices._scripts { inherit pkgs; checked = cfg.checkScripts; }) // (
+      let
+        throwIfNoDisksDetected = _: v: if cfg.devices.disk == { } then throw "No disks defined, did you forget to import your disko config?" else v;
+      in
+      lib.mapAttrs throwIfNoDisksDetected {
+        # we keep these old outputs for compatibility
+        disko = builtins.trace "the .disko output is deprecated, please use .diskoScript instead" (cfg.devices._scripts { inherit pkgs; }).diskoScript;
+        diskoNoDeps = builtins.trace "the .diskoNoDeps output is deprecated, please use .diskoScriptNoDeps instead" (cfg.devices._scripts { inherit pkgs; }).diskoScriptNoDeps;
+
+        installTest = diskoLib.testLib.makeDiskoTest {
+          inherit extendModules pkgs;
+          name = "${config.networking.hostName}-disko";
+          disko-config = builtins.removeAttrs config [ "_module" ];
+          testMode = "direct";
+          efi = cfg.tests.efi;
+          extraSystemConfig = cfg.tests.extraConfig;
+          extraTestScript = cfg.tests.extraChecks;
+        };
+
+        vmWithDisko = lib.mkDefault config.virtualisation.vmVariantWithDisko.system.build.vmWithDisko;
+      }
+    );
 
     # we need to specify the keys here, so we don't get an infinite recursion error
     # Remember to add config keys here if they are added to types