disko/lib/tests.nix

{ lib
, makeTest
, eval-config
, ...
}:

let
  testLib = {
    # this takes a nixos config and changes the disk devices so we can run them inside the qemu test runner
    # basically changes all the disk.*.devices to something like /dev/vda or /dev/vdb etc.
    prepareDiskoConfig = cfg: devices:
      let
        cleanedTopLevel = lib.filterAttrsRecursive (n: _: !lib.hasPrefix "_" n) cfg;

        preparedDisks = lib.foldlAttrs
          (acc: n: v: {
            devices = lib.tail acc.devices;
            grub-devices = acc.grub-devices ++ (lib.optional (lib.any (part: (part.type or "") == "EF02") (lib.attrValues (v.content.partitions or { }))) (lib.head acc.devices));
            disks = acc.disks // {
              "${n}" = v // {
                device = lib.head acc.devices;
                content = v.content // { device = lib.head acc.devices; };
              };
            };
          })
          {
            inherit devices;
            grub-devices = [ ];
            disks = { };
          }
          cleanedTopLevel.disko.devices.disk;
      in
      cleanedTopLevel // {
        boot.loader.grub.devices = if (preparedDisks.grub-devices != [ ]) then preparedDisks.grub-devices else [ "nodev" ];
        disko.devices = cleanedTopLevel.disko.devices // {
          disk = preparedDisks.disks;
        };
      };

    # list of devices generated inside qemu
    devices = [ "/dev/vda" "/dev/vdb" "/dev/vdc" "/dev/vdd" "/dev/vde" "/dev/vdf" ];

    # This is the test generator for a disko test
    makeDiskoTest =
      { name
      , disko-config
      , extendModules ? null
      , pkgs ? import <nixpkgs> { }
      , extraTestScript ? ""
      , bootCommands ? ""
      , extraInstallerConfig ? { }
      , extraSystemConfig ? { }
      , efi ? !pkgs.hostPlatform.isRiscV64
      , postDisko ? ""
      , testMode ? "module" # can be one of direct module cli
      , testBoot ? true # if we actually want to test booting or just create/mount
      }:
      let
        makeTest' = args:
          makeTest args {
            inherit pkgs;
            inherit (pkgs) system;
          };
        # for installation we skip /dev/vda because it is the test runner disk

        importedDiskoConfig =
          if builtins.isPath disko-config then
            import disko-config
          else
            disko-config;

        diskoConfigWithArgs =
          if builtins.isFunction importedDiskoConfig then
            importedDiskoConfig { inherit lib; }
          else
            importedDiskoConfig;
        testConfigInstall = testLib.prepareDiskoConfig diskoConfigWithArgs (lib.tail testLib.devices);
        # we need to shift the disks by one because the first disk is the /dev/vda of the test runner
        # so /dev/vdb becomes /dev/vda etc.
        testConfigBooted = testLib.prepareDiskoConfig diskoConfigWithArgs testLib.devices;

        tsp-generator = pkgs.callPackage ../. { checked = true; };
        tsp-format = (tsp-generator.formatScript testConfigInstall) pkgs;
        tsp-mount = (tsp-generator.mountScript testConfigInstall) pkgs;
        tsp-disko = (tsp-generator.diskoScript testConfigInstall) pkgs;
        tsp-config = tsp-generator.config testConfigBooted;
        num-disks = builtins.length (lib.attrNames testConfigBooted.disko.devices.disk);

        installed-system = { ... }: {
          imports = [
            (lib.optionalAttrs (testMode == "direct") tsp-config)
            (lib.optionalAttrs (testMode == "module") {
              disko.enableConfig = true;
              imports = [
                ../module.nix
                testConfigBooted
              ];
            })
          ];

          # config for tests to make them run faster or work at all
          documentation.enable = false;
          hardware.enableAllFirmware = lib.mkForce false;
          boot.initrd.preDeviceCommands = ''
            echo -n 'secretsecret' > /tmp/secret.key
          '';
          boot.consoleLogLevel = lib.mkForce 100;
          boot.loader.systemd-boot.enable = lib.mkDefault efi;
        };

        installed-system-eval = eval-config {
          modules = [ installed-system ];
          inherit (pkgs) system;
        };

        installedTopLevel = ((if extendModules != null then extendModules else installed-system-eval.extendModules) {
          modules = [
            ({ config, ... }: {
              imports = [
                extraSystemConfig
                ({ modulesPath, ... }: {
                  imports = [
                    (modulesPath + "/testing/test-instrumentation.nix") # we need these 2 modules always to be able to run the tests
                    (modulesPath + "/profiles/qemu-guest.nix")
                  ];
                  disko.devices = lib.mkForce testConfigBooted.disko.devices;
                })
              ];

              # since we boot on a different machine, the efi payload needs to be portable
              boot.loader.grub.efiInstallAsRemovable = efi;
              boot.loader.grub.efiSupport = efi;
              boot.loader.systemd-boot.graceful = true;

              # we always want the bind-mounted nix store. otherwise tests take forever
              fileSystems."/nix/store" = lib.mkForce {
                device = "nix-store";
                fsType = "9p";
                neededForBoot = true;
                options = [ "trans=virtio" "version=9p2000.L" "cache=loose" ];
              };
              boot.zfs.devNodes = "/dev/disk/by-uuid"; # needed because /dev/disk/by-id is empty in qemu-vms

              # grub will install to these devices, we need to force those or we are offset by 1
              # we use mkOveride 70, so that users can override this with mkForce in case they are testing grub mirrored boots
              boot.loader.grub.devices = lib.mkOverride 70 testConfigInstall.boot.loader.grub.devices;

              assertions = [
                {
                  assertion = builtins.length config.boot.loader.grub.mirroredBoots > 1 -> config.boot.loader.grub.devices == [ ];
                  message = ''
                    When using `--vm-test` in combination with `mirroredBoots`,
                    it is necessary to configure `boot.loader.grub.devices` as an empty list by setting `boot.loader.grub.devices = lib.mkForce [];`.
                    This adjustment is crucial because the `--vm-test` mechanism automatically overrides the grub boot devices as part of the virtual machine test.
                  '';
                }
              ];
            })
          ];
        }).config.system.build.toplevel;

      in
      makeTest' {
        name = "disko-${name}";

        nodes.machine = { pkgs, ... }: {
          imports = [
            (lib.optionalAttrs (testMode == "module") {
              imports = [
                ../module.nix
              ];
              disko = {
                enableConfig = false;
                checkScripts = true;
                devices = testConfigInstall.disko.devices;
              };
            })
            extraInstallerConfig

            # from base.nix
            ({ config, ... }: {
              boot.supportedFilesystems =
                [ "btrfs" "cifs" "f2fs" "jfs" "ntfs" "reiserfs" "vfat" "xfs" ] ++
                lib.optional (config.networking.hostId != null && lib.meta.availableOn pkgs.stdenv.hostPlatform config.boot.zfs.package) "zfs";
            })

            (if lib.versionAtLeast (lib.versions.majorMinor lib.version) "23.11" then {
              boot.swraid.enable = true;
            } else {
              boot.initrd.services.swraid.enable = true;
            })
          ];

          systemd.services.mdmonitor.enable = false; # silence some weird warnings

          environment.systemPackages = [
            pkgs.jq
          ];

          # speed-up eval
          documentation.enable = false;

          nix.settings = {
            substituters = lib.mkForce [ ];
            hashed-mirrors = null;
            connect-timeout = 1;
          };

          networking.hostId = lib.mkIf
            (
              (testConfigInstall ? networking.hostId) && (testConfigInstall.networking.hostId != null)
            )
            testConfigInstall.networking.hostId;

          virtualisation.emptyDiskImages = builtins.genList (_: 4096) num-disks;

          # useful for debugging via repl
          system.build.systemToInstall = installed-system-eval;
        };

        testScript = { nodes, ... }: ''
          def disks(oldmachine, num_disks):
              disk_flags = ""
              for i in range(num_disks):
                  disk_flags += f' -drive file={oldmachine.state_dir}/empty{i}.qcow2,id=drive{i + 1},if=none,index={i + 1},werror=report'
                  disk_flags += f' -device virtio-blk-pci,drive=drive{i + 1}'
              return disk_flags
          def create_test_machine(oldmachine, args={}): # taken from <nixpkgs/nixos/tests/installer.nix>
              startCommand = "${pkgs.qemu_test}/bin/qemu-kvm"
              startCommand += " -cpu max -m 1024 -virtfs local,path=/nix/store,security_model=none,mount_tag=nix-store"
              startCommand += disks(oldmachine, ${toString num-disks})
              ${lib.optionalString efi ''
                startCommand +=" -drive if=pflash,format=raw,unit=0,readonly=on,file=${pkgs.OVMF.firmware} -drive if=pflash,format=raw,unit=1,readonly=on,file=${pkgs.OVMF.variables}"
              ''}
              machine = create_machine({
                "startCommand": startCommand,
              } | args)
              driver.machines.append(machine)
              return machine

          machine.start()
          machine.succeed("echo -n 'additionalSecret' > /tmp/additionalSecret.key")
          machine.succeed("echo -n 'secretsecret' > /tmp/secret.key")
          ${lib.optionalString (testMode == "direct") ''
            # running direct mode
            machine.succeed("${tsp-format}")
            machine.succeed("${tsp-mount}")
            machine.succeed("${tsp-mount}") # verify that mount is idempotent
            machine.succeed("${tsp-disko}") # verify that we can destroy and recreate
            machine.succeed("mkdir -p /mnt/home")
            machine.succeed("touch /mnt/home/testfile")
            machine.succeed("${tsp-format}") # verify that format is idempotent
            machine.succeed("test -e /mnt/home/testfile")
          ''}
          ${lib.optionalString (testMode == "module") ''
            #  running module mode
            machine.succeed("${nodes.machine.system.build.formatScript}")
            machine.succeed("${nodes.machine.system.build.mountScript}")
            machine.succeed("${nodes.machine.system.build.mountScript}") # verify that mount is idempotent
            machine.succeed("${nodes.machine.system.build.diskoScript}") # verify that we can destroy and recreate again
            machine.succeed("mkdir -p /mnt/home")
            machine.succeed("touch /mnt/home/testfile")
            machine.succeed("${nodes.machine.system.build.formatScript}") # verify that format is idempotent
            machine.succeed("test -e /mnt/home/testfile")
          ''}

          ${postDisko}

          ${lib.optionalString testBoot ''
            # mount nix-store in /mnt
            machine.succeed("mkdir -p /mnt/nix/store")
            machine.succeed("mount --bind /nix/store /mnt/nix/store")

            machine.succeed("nix-store --load-db < ${pkgs.closureInfo {rootPaths = [installedTopLevel];}}/registration")

            # fix "this is not a NixOS installation"
            machine.succeed("mkdir -p /mnt/etc")
            machine.succeed("touch /mnt/etc/NIXOS")

            machine.succeed("mkdir -p /mnt/nix/var/nix/profiles")
            machine.succeed("nix-env -p /mnt/nix/var/nix/profiles/system --set ${installedTopLevel}")
            machine.succeed("NIXOS_INSTALL_BOOTLOADER=1 nixos-enter --root /mnt -- ${installedTopLevel}/bin/switch-to-configuration boot")
            machine.succeed("sync")
            machine.shutdown()

            machine = create_test_machine(oldmachine=machine, args={ "name": "booted_machine" })
            machine.start()
            ${bootCommands}
            machine.wait_for_unit("local-fs.target")
          ''}

          ${extraTestScript}
        '';
      };
  };
in
testLib