nix-bitcoin/test/lib/make-test.nix

pkgs:
let
  makeVM = import ./make-test-vm.nix pkgs;
  inherit (pkgs) lib;
in

name: testConfig:
{
  vm = makeVM {
    name = "nix-bitcoin-${name}";

    nodes.machine = { config, ... }: {
      imports = [ testConfig ];

      virtualisation = {
        # Needed because duplicity requires 270 MB of free temp space, regardless of backup size
        diskSize = 1024;

        # Min. 800 MiB needed to avoid 'out of memory' errors
        memorySize = lib.mkDefault 2048;

        cores = lib.mkDefault 2;
      };

      # Run shellcheck on all nix-bitcoin services during machine build time
      system.extraDependencies = [ config.test.shellcheckServices ];
    };

    testScript = nodes: let
      cfg = nodes.nodes.machine.config;
      data = {
        data = cfg.test.data;
        tests = cfg.tests;
      };
      dataFile = pkgs.writeText "test-data" (builtins.toJSON data);
      initData = ''
        import json

        with open("${dataFile}") as f:
            data = json.load(f)

        enabled_tests = set(test for (test, enabled) in data["tests"].items() if enabled)
        test_data = data["data"]
      '';
    in
      builtins.concatStringsSep "\n\n" [
        initData
        (builtins.readFile ./../tests.py)
        cfg.test.extraTestScript
        # Don't run tests in interactive mode.
        # is_interactive is set in ../run-tests.sh
        ''
          if not "is_interactive" in vars():
              run_tests()
        ''
      ];
  };

  container = {
    # The container name has a 11 char length limit
    containers.nb-test = { config, ... }: {
      imports = [
        {
          config = {
            extra = config.config.test.container;
            config = testConfig;
          };
        }

        # Enable FUSE inside the container when clightning replication
        # is enabled.
        # TODO-EXTERNAL: Remove this when
        # https://github.com/systemd/systemd/issues/17607
        # has been resolved. This will also improve security.
        (
          let
            clightning = config.config.services.clightning;
          in
            lib.mkIf (clightning.enable && clightning.replication.enable) {
              bindMounts."/dev/fuse" = { hostPath = "/dev/fuse"; };
              allowedDevices = [ { node = "/dev/fuse"; modifier = "rw"; } ];
            }
        )
      ];
    };
  };

  # This allows running a test scenario in a regular NixOS VM.
  # No tests are executed.
  vmWithoutTests = (pkgs.nixos ({ config, ... }: {
    imports = [
      testConfig
      "${toString pkgs.path}/nixos/modules/virtualisation/qemu-vm.nix"
    ];
    virtualisation.graphics = false;
    services.getty.autologinUser = "root";

    # Provide a shortcut for instant poweroff from within the machine
    environment.systemPackages = with pkgs; [
      (lowPrio (writeScriptBin "q" ''
         echo o >/proc/sysrq-trigger
       ''))
    ];

    system.stateVersion = lib.mkDefault config.system.nixos.release;
  })).config.system.build.vm;

  config = testConfig;
}