2020-04-11 23:38:55 +03:00
|
|
|
{ system ? builtins.currentSystem,
|
|
|
|
config ? {},
|
|
|
|
pkgs ? import ../.. { inherit system config; }
|
|
|
|
}:
|
|
|
|
|
|
|
|
with import ../lib/testing-python.nix { inherit system pkgs; };
|
|
|
|
with pkgs.lib;
|
|
|
|
|
2020-06-14 21:14:43 +03:00
|
|
|
let
|
|
|
|
common = {
|
2020-04-11 23:38:55 +03:00
|
|
|
virtualisation.useBootLoader = true;
|
2020-12-23 22:58:12 +03:00
|
|
|
virtualisation.useEFIBoot = true;
|
2020-04-11 23:38:55 +03:00
|
|
|
boot.loader.systemd-boot.enable = true;
|
2020-06-14 06:25:34 +03:00
|
|
|
boot.loader.efi.canTouchEfiVariables = true;
|
|
|
|
environment.systemPackages = [ pkgs.efibootmgr ];
|
2020-04-11 23:38:55 +03:00
|
|
|
};
|
2024-02-01 05:51:12 +03:00
|
|
|
|
|
|
|
commonXbootldr = { config, lib, pkgs, ... }:
|
|
|
|
let
|
|
|
|
diskImage = import ../lib/make-disk-image.nix {
|
|
|
|
inherit config lib pkgs;
|
|
|
|
label = "nixos";
|
|
|
|
format = "qcow2";
|
|
|
|
partitionTableType = "efixbootldr";
|
|
|
|
touchEFIVars = true;
|
|
|
|
installBootLoader = true;
|
|
|
|
};
|
|
|
|
in
|
|
|
|
{
|
|
|
|
imports = [ common ];
|
|
|
|
virtualisation.useBootLoader = lib.mkForce false; # Only way to tell qemu-vm not to create the default system image
|
|
|
|
virtualisation.directBoot.enable = false; # But don't direct boot either because we're testing systemd-boot
|
|
|
|
|
|
|
|
system.build.diskImage = diskImage; # Use custom disk image with an XBOOTLDR partition
|
|
|
|
virtualisation.efi.variables = "${diskImage}/efi-vars.fd";
|
|
|
|
|
|
|
|
virtualisation.useDefaultFilesystems = false; # Needs custom setup for `diskImage`
|
|
|
|
virtualisation.bootPartition = null;
|
|
|
|
virtualisation.fileSystems = {
|
|
|
|
"/" = {
|
|
|
|
device = "/dev/vda3";
|
|
|
|
fsType = "ext4";
|
|
|
|
};
|
|
|
|
"/boot" = {
|
|
|
|
device = "/dev/vda2";
|
|
|
|
fsType = "vfat";
|
|
|
|
noCheck = true;
|
|
|
|
};
|
|
|
|
"/efi" = {
|
|
|
|
device = "/dev/vda1";
|
|
|
|
fsType = "vfat";
|
|
|
|
noCheck = true;
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
boot.loader.systemd-boot.enable = true;
|
|
|
|
boot.loader.efi.efiSysMountPoint = "/efi";
|
|
|
|
boot.loader.systemd-boot.xbootldrMountPoint = "/boot";
|
|
|
|
};
|
|
|
|
|
|
|
|
customDiskImage = nodes: ''
|
|
|
|
import os
|
|
|
|
import subprocess
|
|
|
|
import tempfile
|
|
|
|
|
|
|
|
tmp_disk_image = tempfile.NamedTemporaryFile()
|
|
|
|
|
|
|
|
subprocess.run([
|
|
|
|
"${nodes.machine.virtualisation.qemu.package}/bin/qemu-img",
|
|
|
|
"create",
|
|
|
|
"-f",
|
|
|
|
"qcow2",
|
|
|
|
"-b",
|
|
|
|
"${nodes.machine.system.build.diskImage}/nixos.qcow2",
|
|
|
|
"-F",
|
|
|
|
"qcow2",
|
|
|
|
tmp_disk_image.name,
|
|
|
|
])
|
|
|
|
|
|
|
|
# Set NIX_DISK_IMAGE so that the qemu script finds the right disk image.
|
|
|
|
os.environ['NIX_DISK_IMAGE'] = tmp_disk_image.name
|
|
|
|
'';
|
2020-06-14 21:14:43 +03:00
|
|
|
in
|
2024-08-14 04:47:05 +03:00
|
|
|
{
|
2020-06-14 21:14:43 +03:00
|
|
|
basic = makeTest {
|
|
|
|
name = "systemd-boot";
|
2023-11-04 04:38:11 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ danielfullmer julienmalka ];
|
2020-06-14 21:14:43 +03:00
|
|
|
|
2022-03-21 02:15:30 +03:00
|
|
|
nodes.machine = common;
|
2020-06-14 21:14:43 +03:00
|
|
|
|
|
|
|
testScript = ''
|
|
|
|
machine.start()
|
|
|
|
machine.wait_for_unit("multi-user.target")
|
2020-04-11 23:38:55 +03:00
|
|
|
|
2020-06-14 21:14:43 +03:00
|
|
|
machine.succeed("test -e /boot/loader/entries/nixos-generation-1.conf")
|
2024-08-14 04:47:05 +03:00
|
|
|
machine.succeed("grep 'sort-key nixos' /boot/loader/entries/nixos-generation-1.conf")
|
2020-06-14 21:14:43 +03:00
|
|
|
|
|
|
|
# Ensure we actually booted using systemd-boot
|
|
|
|
# Magic number is the vendor UUID used by systemd-boot.
|
|
|
|
machine.succeed(
|
|
|
|
"test -e /sys/firmware/efi/efivars/LoaderEntrySelected-4a67b082-0a4c-41cf-b6c7-440b29bb8c4f"
|
|
|
|
)
|
2020-06-14 06:25:34 +03:00
|
|
|
|
|
|
|
# "bootctl install" should have created an EFI entry
|
|
|
|
machine.succeed('efibootmgr | grep "Linux Boot Manager"')
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2024-02-04 16:28:30 +03:00
|
|
|
# Test that systemd-boot works with secure boot
|
|
|
|
secureBoot = makeTest {
|
|
|
|
name = "systemd-boot-secure-boot";
|
|
|
|
|
|
|
|
nodes.machine = {
|
|
|
|
imports = [ common ];
|
|
|
|
environment.systemPackages = [ pkgs.sbctl ];
|
|
|
|
virtualisation.useSecureBoot = true;
|
|
|
|
};
|
|
|
|
|
2024-03-02 00:34:43 +03:00
|
|
|
testScript = let
|
|
|
|
efiArch = pkgs.stdenv.hostPlatform.efiArch;
|
|
|
|
in { nodes, ... }: ''
|
2024-02-04 16:28:30 +03:00
|
|
|
machine.start(allow_reboot=True)
|
|
|
|
machine.wait_for_unit("multi-user.target")
|
|
|
|
|
|
|
|
machine.succeed("sbctl create-keys")
|
|
|
|
machine.succeed("sbctl enroll-keys --yes-this-might-brick-my-machine")
|
2024-03-02 00:34:43 +03:00
|
|
|
machine.succeed('sbctl sign /boot/EFI/systemd/systemd-boot${efiArch}.efi')
|
|
|
|
machine.succeed('sbctl sign /boot/EFI/BOOT/BOOT${toUpper efiArch}.EFI')
|
|
|
|
machine.succeed('sbctl sign /boot/EFI/nixos/*${nodes.machine.system.boot.loader.kernelFile}.efi')
|
2024-02-04 16:28:30 +03:00
|
|
|
|
|
|
|
machine.reboot()
|
|
|
|
|
|
|
|
assert "Secure Boot: enabled (user)" in machine.succeed("bootctl status")
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2024-02-01 05:51:12 +03:00
|
|
|
basicXbootldr = makeTest {
|
|
|
|
name = "systemd-boot-xbootldr";
|
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ sdht0 ];
|
|
|
|
|
|
|
|
nodes.machine = commonXbootldr;
|
|
|
|
|
|
|
|
testScript = { nodes, ... }: ''
|
|
|
|
${customDiskImage nodes}
|
|
|
|
|
|
|
|
machine.start()
|
|
|
|
machine.wait_for_unit("multi-user.target")
|
|
|
|
|
|
|
|
machine.succeed("test -e /efi/EFI/systemd/systemd-bootx64.efi")
|
|
|
|
machine.succeed("test -e /boot/loader/entries/nixos-generation-1.conf")
|
|
|
|
|
|
|
|
# Ensure we actually booted using systemd-boot
|
|
|
|
# Magic number is the vendor UUID used by systemd-boot.
|
|
|
|
machine.succeed(
|
|
|
|
"test -e /sys/firmware/efi/efivars/LoaderEntrySelected-4a67b082-0a4c-41cf-b6c7-440b29bb8c4f"
|
|
|
|
)
|
|
|
|
|
|
|
|
# "bootctl install" should have created an EFI entry
|
|
|
|
machine.succeed('efibootmgr | grep "Linux Boot Manager"')
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2021-01-03 21:29:34 +03:00
|
|
|
# Check that specialisations create corresponding boot entries.
|
|
|
|
specialisation = makeTest {
|
|
|
|
name = "systemd-boot-specialisation";
|
2023-11-04 04:38:11 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ lukegb julienmalka ];
|
2021-01-03 21:29:34 +03:00
|
|
|
|
2022-03-21 02:15:30 +03:00
|
|
|
nodes.machine = { pkgs, lib, ... }: {
|
2021-01-03 21:29:34 +03:00
|
|
|
imports = [ common ];
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
specialisation.something.configuration = {
|
|
|
|
boot.loader.systemd-boot.sortKey = "something";
|
2024-08-01 21:18:32 +03:00
|
|
|
|
|
|
|
# Since qemu will dynamically create a devicetree blob when starting
|
|
|
|
# up, it is not straight forward to create an export of that devicetree
|
|
|
|
# blob without knowing before-hand all the flags we would pass to qemu
|
|
|
|
# (we would then be able to use `dumpdtb`). Thus, the following config
|
|
|
|
# will not boot, but it does allow us to assert that the boot entry has
|
|
|
|
# the correct contents.
|
|
|
|
boot.loader.systemd-boot.installDeviceTree = pkgs.stdenv.hostPlatform.isAarch64;
|
|
|
|
hardware.deviceTree.name = "dummy.dtb";
|
|
|
|
hardware.deviceTree.package = lib.mkForce (pkgs.runCommand "dummy-devicetree-package" { } ''
|
|
|
|
mkdir -p $out
|
|
|
|
cp ${pkgs.emptyFile} $out/dummy.dtb
|
|
|
|
'');
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
};
|
2021-01-03 21:29:34 +03:00
|
|
|
};
|
|
|
|
|
2024-08-01 21:18:32 +03:00
|
|
|
testScript = { nodes, ... }: ''
|
2021-01-03 21:29:34 +03:00
|
|
|
machine.start()
|
|
|
|
machine.wait_for_unit("multi-user.target")
|
|
|
|
|
|
|
|
machine.succeed(
|
|
|
|
"test -e /boot/loader/entries/nixos-generation-1-specialisation-something.conf"
|
|
|
|
)
|
|
|
|
machine.succeed(
|
|
|
|
"grep -q 'title NixOS (something)' /boot/loader/entries/nixos-generation-1-specialisation-something.conf"
|
|
|
|
)
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
machine.succeed(
|
|
|
|
"grep 'sort-key something' /boot/loader/entries/nixos-generation-1-specialisation-something.conf"
|
|
|
|
)
|
2024-08-01 21:18:32 +03:00
|
|
|
'' + pkgs.lib.optionalString pkgs.stdenv.hostPlatform.isAarch64 ''
|
|
|
|
machine.succeed(
|
2024-08-21 08:28:24 +03:00
|
|
|
r"grep 'devicetree /EFI/nixos/[a-z0-9]\{32\}.*dummy' /boot/loader/entries/nixos-generation-1-specialisation-something.conf"
|
2024-08-01 21:18:32 +03:00
|
|
|
)
|
2021-01-03 21:29:34 +03:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2020-06-14 06:25:34 +03:00
|
|
|
# Boot without having created an EFI entry--instead using default "/EFI/BOOT/BOOTX64.EFI"
|
|
|
|
fallback = makeTest {
|
|
|
|
name = "systemd-boot-fallback";
|
2023-11-04 04:38:11 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ danielfullmer julienmalka ];
|
2020-06-14 06:25:34 +03:00
|
|
|
|
2022-03-21 02:15:30 +03:00
|
|
|
nodes.machine = { pkgs, lib, ... }: {
|
2020-06-14 06:25:34 +03:00
|
|
|
imports = [ common ];
|
|
|
|
boot.loader.efi.canTouchEfiVariables = mkForce false;
|
|
|
|
};
|
|
|
|
|
|
|
|
testScript = ''
|
|
|
|
machine.start()
|
|
|
|
machine.wait_for_unit("multi-user.target")
|
|
|
|
|
|
|
|
machine.succeed("test -e /boot/loader/entries/nixos-generation-1.conf")
|
|
|
|
|
|
|
|
# Ensure we actually booted using systemd-boot
|
|
|
|
# Magic number is the vendor UUID used by systemd-boot.
|
|
|
|
machine.succeed(
|
|
|
|
"test -e /sys/firmware/efi/efivars/LoaderEntrySelected-4a67b082-0a4c-41cf-b6c7-440b29bb8c4f"
|
|
|
|
)
|
|
|
|
|
|
|
|
# "bootctl install" should _not_ have created an EFI entry
|
|
|
|
machine.fail('efibootmgr | grep "Linux Boot Manager"')
|
2020-06-14 21:14:43 +03:00
|
|
|
'';
|
|
|
|
};
|
2020-04-11 23:38:55 +03:00
|
|
|
|
2020-06-14 21:14:43 +03:00
|
|
|
update = makeTest {
|
|
|
|
name = "systemd-boot-update";
|
2023-11-04 04:38:11 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ danielfullmer julienmalka ];
|
2020-04-11 23:38:55 +03:00
|
|
|
|
2022-03-21 02:15:30 +03:00
|
|
|
nodes.machine = common;
|
2020-06-14 21:14:43 +03:00
|
|
|
|
|
|
|
testScript = ''
|
|
|
|
machine.succeed("mount -o remount,rw /boot")
|
|
|
|
|
2024-07-31 05:04:14 +03:00
|
|
|
def switch():
|
|
|
|
# Replace version inside sd-boot with something older. See magic[] string in systemd src/boot/efi/boot.c
|
|
|
|
machine.succeed(
|
|
|
|
"""
|
|
|
|
find /boot -iname '*boot*.efi' -print0 | \
|
|
|
|
xargs -0 -I '{}' sed -i 's/#### LoaderInfo: systemd-boot .* ####/#### LoaderInfo: systemd-boot 000.0-1-notnixos ####/' '{}'
|
|
|
|
"""
|
|
|
|
)
|
|
|
|
return machine.succeed("/run/current-system/bin/switch-to-configuration boot 2>&1")
|
|
|
|
|
|
|
|
output = switch()
|
2023-10-10 11:18:53 +03:00
|
|
|
assert "updating systemd-boot from 000.0-1-notnixos to " in output, "Couldn't find systemd-boot update message"
|
2024-07-11 10:40:32 +03:00
|
|
|
assert 'to "/boot/EFI/systemd/systemd-bootx64.efi"' in output, "systemd-boot not copied to to /boot/EFI/systemd/systemd-bootx64.efi"
|
|
|
|
assert 'to "/boot/EFI/BOOT/BOOTX64.EFI"' in output, "systemd-boot not copied to to /boot/EFI/BOOT/BOOTX64.EFI"
|
2024-07-31 05:04:14 +03:00
|
|
|
|
|
|
|
with subtest("Test that updating works with lowercase bootx64.efi"):
|
|
|
|
machine.succeed(
|
|
|
|
# Move to tmp file name first, otherwise mv complains the new location is the same
|
|
|
|
"mv /boot/EFI/BOOT/BOOTX64.EFI /boot/EFI/BOOT/bootx64.efi.new",
|
|
|
|
"mv /boot/EFI/BOOT/bootx64.efi.new /boot/EFI/BOOT/bootx64.efi",
|
|
|
|
)
|
|
|
|
output = switch()
|
|
|
|
assert "updating systemd-boot from 000.0-1-notnixos to " in output, "Couldn't find systemd-boot update message"
|
|
|
|
assert 'to "/boot/EFI/systemd/systemd-bootx64.efi"' in output, "systemd-boot not copied to to /boot/EFI/systemd/systemd-bootx64.efi"
|
|
|
|
assert 'to "/boot/EFI/BOOT/BOOTX64.EFI"' in output, "systemd-boot not copied to to /boot/EFI/BOOT/BOOTX64.EFI"
|
2020-06-14 21:14:43 +03:00
|
|
|
'';
|
|
|
|
};
|
2021-12-19 07:53:47 +03:00
|
|
|
|
2024-08-19 17:51:18 +03:00
|
|
|
memtest86 = with pkgs.lib; optionalAttrs (meta.availableOn { inherit system; } pkgs.memtest86plus) (makeTest {
|
2021-12-19 07:53:47 +03:00
|
|
|
name = "systemd-boot-memtest86";
|
2024-08-19 17:51:18 +03:00
|
|
|
meta.maintainers = with maintainers; [ julienmalka ];
|
2021-12-19 07:53:47 +03:00
|
|
|
|
2022-03-21 02:15:30 +03:00
|
|
|
nodes.machine = { pkgs, lib, ... }: {
|
2021-12-19 07:53:47 +03:00
|
|
|
imports = [ common ];
|
|
|
|
boot.loader.systemd-boot.memtest86.enable = true;
|
|
|
|
};
|
|
|
|
|
|
|
|
testScript = ''
|
|
|
|
machine.succeed("test -e /boot/loader/entries/memtest86.conf")
|
2023-04-18 11:39:38 +03:00
|
|
|
machine.succeed("test -e /boot/efi/memtest86/memtest.efi")
|
2021-12-19 07:53:47 +03:00
|
|
|
'';
|
2024-08-19 17:51:18 +03:00
|
|
|
});
|
2021-12-19 07:53:47 +03:00
|
|
|
|
|
|
|
netbootxyz = makeTest {
|
|
|
|
name = "systemd-boot-netbootxyz";
|
2024-07-09 07:21:18 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ julienmalka ];
|
2021-12-19 07:53:47 +03:00
|
|
|
|
2022-03-21 02:15:30 +03:00
|
|
|
nodes.machine = { pkgs, lib, ... }: {
|
2021-12-19 07:53:47 +03:00
|
|
|
imports = [ common ];
|
|
|
|
boot.loader.systemd-boot.netbootxyz.enable = true;
|
|
|
|
};
|
|
|
|
|
|
|
|
testScript = ''
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
machine.succeed("test -e /boot/loader/entries/netbootxyz.conf")
|
2021-12-19 07:53:47 +03:00
|
|
|
machine.succeed("test -e /boot/efi/netbootxyz/netboot.xyz.efi")
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
memtestSortKey = makeTest {
|
|
|
|
name = "systemd-boot-memtest-sortkey";
|
2024-07-09 07:21:18 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ julienmalka ];
|
2021-12-19 07:53:47 +03:00
|
|
|
|
2022-03-21 02:15:30 +03:00
|
|
|
nodes.machine = { pkgs, lib, ... }: {
|
2021-12-19 07:53:47 +03:00
|
|
|
imports = [ common ];
|
|
|
|
boot.loader.systemd-boot.memtest86.enable = true;
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
boot.loader.systemd-boot.memtest86.sortKey = "apple";
|
2021-12-19 07:53:47 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
testScript = ''
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
machine.succeed("test -e /boot/loader/entries/memtest86.conf")
|
2023-04-18 11:39:38 +03:00
|
|
|
machine.succeed("test -e /boot/efi/memtest86/memtest.efi")
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
machine.succeed("grep 'sort-key apple' /boot/loader/entries/memtest86.conf")
|
2024-02-01 05:51:12 +03:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
entryFilenameXbootldr = makeTest {
|
|
|
|
name = "systemd-boot-entry-filename-xbootldr";
|
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ sdht0 ];
|
|
|
|
|
|
|
|
nodes.machine = { pkgs, lib, ... }: {
|
|
|
|
imports = [ commonXbootldr ];
|
|
|
|
boot.loader.systemd-boot.memtest86.enable = true;
|
|
|
|
};
|
|
|
|
|
|
|
|
testScript = { nodes, ... }: ''
|
|
|
|
${customDiskImage nodes}
|
|
|
|
|
|
|
|
machine.start()
|
|
|
|
machine.wait_for_unit("multi-user.target")
|
|
|
|
|
|
|
|
machine.succeed("test -e /efi/EFI/systemd/systemd-bootx64.efi")
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
machine.succeed("test -e /boot/loader/entries/memtest86.conf")
|
2024-02-01 05:51:12 +03:00
|
|
|
machine.succeed("test -e /boot/EFI/memtest86/memtest.efi")
|
2021-12-19 07:53:47 +03:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
extraEntries = makeTest {
|
|
|
|
name = "systemd-boot-extra-entries";
|
2024-07-09 07:21:18 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ julienmalka ];
|
2021-12-19 07:53:47 +03:00
|
|
|
|
2022-03-21 02:15:30 +03:00
|
|
|
nodes.machine = { pkgs, lib, ... }: {
|
2021-12-19 07:53:47 +03:00
|
|
|
imports = [ common ];
|
|
|
|
boot.loader.systemd-boot.extraEntries = {
|
|
|
|
"banana.conf" = ''
|
|
|
|
title banana
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
testScript = ''
|
|
|
|
machine.succeed("test -e /boot/loader/entries/banana.conf")
|
|
|
|
machine.succeed("test -e /boot/efi/nixos/.extra-files/loader/entries/banana.conf")
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
extraFiles = makeTest {
|
|
|
|
name = "systemd-boot-extra-files";
|
2024-07-09 07:21:18 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ julienmalka ];
|
2021-12-19 07:53:47 +03:00
|
|
|
|
2022-03-21 02:15:30 +03:00
|
|
|
nodes.machine = { pkgs, lib, ... }: {
|
2021-12-19 07:53:47 +03:00
|
|
|
imports = [ common ];
|
|
|
|
boot.loader.systemd-boot.extraFiles = {
|
|
|
|
"efi/fruits/tomato.efi" = pkgs.netbootxyz-efi;
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
testScript = ''
|
|
|
|
machine.succeed("test -e /boot/efi/fruits/tomato.efi")
|
|
|
|
machine.succeed("test -e /boot/efi/nixos/.extra-files/efi/fruits/tomato.efi")
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
switch-test = makeTest {
|
|
|
|
name = "systemd-boot-switch-test";
|
2024-07-09 07:21:18 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ julienmalka ];
|
2021-12-19 07:53:47 +03:00
|
|
|
|
|
|
|
nodes = {
|
|
|
|
inherit common;
|
|
|
|
|
2023-06-10 18:50:57 +03:00
|
|
|
machine = { pkgs, nodes, ... }: {
|
2021-12-19 07:53:47 +03:00
|
|
|
imports = [ common ];
|
|
|
|
boot.loader.systemd-boot.extraFiles = {
|
|
|
|
"efi/fruits/tomato.efi" = pkgs.netbootxyz-efi;
|
|
|
|
};
|
2023-06-10 18:50:57 +03:00
|
|
|
|
|
|
|
# These are configs for different nodes, but we'll use them here in `machine`
|
|
|
|
system.extraDependencies = [
|
|
|
|
nodes.common.system.build.toplevel
|
|
|
|
nodes.with_netbootxyz.system.build.toplevel
|
|
|
|
];
|
2021-12-19 07:53:47 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
with_netbootxyz = { pkgs, ... }: {
|
|
|
|
imports = [ common ];
|
|
|
|
boot.loader.systemd-boot.netbootxyz.enable = true;
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
testScript = { nodes, ... }: let
|
2023-06-10 18:51:44 +03:00
|
|
|
originalSystem = nodes.machine.system.build.toplevel;
|
|
|
|
baseSystem = nodes.common.system.build.toplevel;
|
|
|
|
finalSystem = nodes.with_netbootxyz.system.build.toplevel;
|
2021-12-19 07:53:47 +03:00
|
|
|
in ''
|
|
|
|
machine.succeed("test -e /boot/efi/fruits/tomato.efi")
|
|
|
|
machine.succeed("test -e /boot/efi/nixos/.extra-files/efi/fruits/tomato.efi")
|
|
|
|
|
|
|
|
with subtest("remove files when no longer needed"):
|
|
|
|
machine.succeed("${baseSystem}/bin/switch-to-configuration boot")
|
|
|
|
machine.fail("test -e /boot/efi/fruits/tomato.efi")
|
|
|
|
machine.fail("test -d /boot/efi/fruits")
|
|
|
|
machine.succeed("test -d /boot/efi/nixos/.extra-files")
|
|
|
|
machine.fail("test -e /boot/efi/nixos/.extra-files/efi/fruits/tomato.efi")
|
|
|
|
machine.fail("test -d /boot/efi/nixos/.extra-files/efi/fruits")
|
|
|
|
|
|
|
|
with subtest("files are added back when needed again"):
|
|
|
|
machine.succeed("${originalSystem}/bin/switch-to-configuration boot")
|
|
|
|
machine.succeed("test -e /boot/efi/fruits/tomato.efi")
|
|
|
|
machine.succeed("test -e /boot/efi/nixos/.extra-files/efi/fruits/tomato.efi")
|
|
|
|
|
|
|
|
with subtest("simultaneously removing and adding files works"):
|
|
|
|
machine.succeed("${finalSystem}/bin/switch-to-configuration boot")
|
|
|
|
machine.fail("test -e /boot/efi/fruits/tomato.efi")
|
|
|
|
machine.fail("test -e /boot/efi/nixos/.extra-files/efi/fruits/tomato.efi")
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
machine.succeed("test -e /boot/loader/entries/netbootxyz.conf")
|
2021-12-19 07:53:47 +03:00
|
|
|
machine.succeed("test -e /boot/efi/netbootxyz/netboot.xyz.efi")
|
systemd-boot: introduce options to set a sort-key for systemd-boot entries
Without sort-keys specified on entries, the entries are sorted only by
file name (in decreasing order, so starting at the end of the alphabet!),
without taking any other fields into account (see
[the boot loader specification reference][1]).
Moreover, entries without a sort-key are always ordered after all
entries with a sort-key, so by not adding a sort-key to the NixOS ones,
we cannot add a sort-key to any other entry while keeping it below the
NixOS entries.
So currently we have options to set the file names for additional entries like
memtest and netbootxyz.
However, as mentioned above, the sorting by file name is not very intuitive and
actually sorts in the opposite order of what is currently mentioned in the option
descriptions.
With this commit, we set a configurable sort-key on all NixOS entries,
and add options for setting the sort-keys for the memtest and netbootxyz
entries.
The sorting by sort-key is more intuitive (it starts at the start of the
alphabet) and also takes into account the machine-id and version for entries
with identical sort-keys.
We use a bootspec extension to store the sort keys, which allows us to
redefine the sort key for individual specialisations without needing any
special casing.
[1]: https://uapi-group.org/specifications/specs/boot_loader_specification/#sorting
2024-01-24 20:15:28 +03:00
|
|
|
machine.succeed("test -e /boot/efi/nixos/.extra-files/loader/entries/netbootxyz.conf")
|
2021-12-19 07:53:47 +03:00
|
|
|
machine.succeed("test -e /boot/efi/nixos/.extra-files/efi/netbootxyz/netboot.xyz.efi")
|
|
|
|
'';
|
|
|
|
};
|
2023-05-31 01:42:50 +03:00
|
|
|
|
2024-08-14 04:47:05 +03:00
|
|
|
garbage-collect-entry = makeTest {
|
|
|
|
name = "systemd-boot-garbage-collect-entry";
|
2023-11-04 04:29:08 +03:00
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ julienmalka ];
|
|
|
|
|
|
|
|
nodes = {
|
|
|
|
inherit common;
|
|
|
|
machine = { pkgs, nodes, ... }: {
|
|
|
|
imports = [ common ];
|
2024-08-14 04:47:05 +03:00
|
|
|
|
2023-11-04 04:29:08 +03:00
|
|
|
# These are configs for different nodes, but we'll use them here in `machine`
|
|
|
|
system.extraDependencies = [
|
|
|
|
nodes.common.system.build.toplevel
|
|
|
|
];
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
testScript = { nodes, ... }:
|
|
|
|
let
|
|
|
|
baseSystem = nodes.common.system.build.toplevel;
|
|
|
|
in
|
|
|
|
''
|
|
|
|
machine.succeed("nix-env -p /nix/var/nix/profiles/system --set ${baseSystem}")
|
|
|
|
machine.succeed("nix-env -p /nix/var/nix/profiles/system --delete-generations 1")
|
|
|
|
machine.succeed("${baseSystem}/bin/switch-to-configuration boot")
|
2024-08-14 04:47:05 +03:00
|
|
|
machine.fail("test -e /boot/loader/entries/nixos-generation-1.conf")
|
2023-11-04 04:29:08 +03:00
|
|
|
machine.succeed("test -e /boot/loader/entries/nixos-generation-2.conf")
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2023-11-17 02:48:19 +03:00
|
|
|
no-bootspec = makeTest
|
|
|
|
{
|
|
|
|
name = "systemd-boot-no-bootspec";
|
|
|
|
meta.maintainers = with pkgs.lib.maintainers; [ julienmalka ];
|
|
|
|
|
|
|
|
nodes.machine = {
|
|
|
|
imports = [ common ];
|
|
|
|
boot.bootspec.enable = false;
|
|
|
|
};
|
|
|
|
|
|
|
|
testScript = ''
|
|
|
|
machine.start()
|
|
|
|
machine.wait_for_unit("multi-user.target")
|
|
|
|
'';
|
|
|
|
};
|
2020-04-11 23:38:55 +03:00
|
|
|
}
|