From 44439e2a81d9366708bee92f1cf15ad22a5da0b6 Mon Sep 17 00:00:00 2001
From: Erik Arvstedt <erik.arvstedt@gmail.com>
Date: Mon, 22 Mar 2021 13:19:48 +0100
Subject: [PATCH] tests: optimize building multiple tests at once

The result of `import tests.nix {}` is now an attrset of tests.
This makes it easier and more efficient to evaluate or build multiple
tests in one call to `nix build`.

Simplify tests.nix by removing the large module args scope in favor of
self-contained scenario module definitions.

Add CPU core and memory size defaults to the test configuration to
enable building tests without `run-tests.sh`.

Add the following top-level args to tests.nix:
- `extraScenarios` to provide a nix-level way to define extra scenarios.
- `pkgs` to allow building tests with custom pkgs or systems.
---
 test/lib/make-container.sh |  2 +-
 test/lib/make-test-vm.nix  |  2 +-
 test/lib/make-test.nix     | 15 +++++++--
 test/run-tests.sh          |  6 ++--
 test/tests.nix             | 66 ++++++++++++++++++++++++--------------
 5 files changed, 59 insertions(+), 32 deletions(-)

diff --git a/test/lib/make-container.sh b/test/lib/make-container.sh
index e039dc1..af19185 100755
--- a/test/lib/make-container.sh
+++ b/test/lib/make-container.sh
@@ -84,6 +84,6 @@ if [[ ! ($containerBin && $(realpath $containerBin) == *extra-container-0.6*) ]]
 fi
 
 read -d '' src <<EOF || true
-(import "$scriptDir/tests.nix" { scenario = "$scenario"; }).container
+((import "$scriptDir/tests.nix" {}).getTest "$scenario").container
 EOF
 exec extra-container $containerCommand -E "$src" "$@"
diff --git a/test/lib/make-test-vm.nix b/test/lib/make-test-vm.nix
index 7505199..8742ac2 100644
--- a/test/lib/make-test-vm.nix
+++ b/test/lib/make-test-vm.nix
@@ -1,7 +1,7 @@
 pkgs:
 let
   pythonTesting = import "${toString pkgs.path}/nixos/lib/testing-python.nix" {
-    system = builtins.currentSystem;
+    system = pkgs.stdenv.hostPlatform.system;
     inherit pkgs;
   };
 in
diff --git a/test/lib/make-test.nix b/test/lib/make-test.nix
index 23d71d5..4635607 100644
--- a/test/lib/make-test.nix
+++ b/test/lib/make-test.nix
@@ -1,7 +1,9 @@
+pkgs:
 let
-  pkgs =  import <nixpkgs> { config = {}; overlays = []; };
   makeVM = import ./make-test-vm.nix pkgs;
+  inherit (pkgs) lib;
 in
+
 name: testConfig:
 {
   vm = makeVM {
@@ -9,8 +11,15 @@ name: testConfig:
 
     machine = {
       imports = [ testConfig ];
-      # Needed because duplicity requires 270 MB of free temp space, regardless of backup size
-      virtualisation.diskSize = 1024;
+      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;
+      };
     };
 
     testScript = nodes: let
diff --git a/test/run-tests.sh b/test/run-tests.sh
index 25a13df..f07c835 100755
--- a/test/run-tests.sh
+++ b/test/run-tests.sh
@@ -110,7 +110,7 @@ trap 'eval "$runAtExit"' EXIT
 if [[ $scenario = *' '* ]]; then
     export scenarioOverridesFile=$(mktemp ${XDG_RUNTIME_DIR:-/tmp}/nb-scenario.XXX)
     runAtExit+='rm -f "$scenarioOverridesFile";'
-    echo "{ testEnv, config, pkgs, lib }: with testEnv; with lib; { tmp = $scenario; }" > "$scenarioOverridesFile"
+    echo "{ scenarios, pkgs, lib }: with lib; { tmp = $scenario; }" > "$scenarioOverridesFile"
     scenario=tmp
 fi
 
@@ -120,7 +120,7 @@ run() {
     export TMPDIR=$(mktemp -d /tmp/nix-bitcoin-test.XXX)
     runAtExit+="rm -rf $TMPDIR;"
 
-    nix-build --out-link $TMPDIR/driver -E "(import \"$scriptDir/tests.nix\" { scenario = \"$scenario\"; }).vm" -A driver
+    nix-build --out-link $TMPDIR/driver -E "((import \"$scriptDir/tests.nix\" {}).getTest \"$scenario\").vm" -A driver
 
     # Variable 'tests' contains the Python code that is executed by the driver on startup
     if [[ $1 == --interactive ]]; then
@@ -212,7 +212,7 @@ vmTestNixExpr() {
     fi
 
     cat <<EOF
-    (import "$scriptDir/tests.nix" { scenario = "$scenario"; }).vm.overrideAttrs (old: rec {
+    ((import "$scriptDir/tests.nix" {}).getTest "$scenario").vm.overrideAttrs (old: rec {
       buildCommand = ''
         export QEMU_OPTS="-smp $numCPUs -m $memoryMiB $extraQEMUOpts"
         echo "VM stats: CPUs: $numCPUs, memory: $memoryMiB MiB"
diff --git a/test/tests.nix b/test/tests.nix
index f9db2e0..14d2877 100644
--- a/test/tests.nix
+++ b/test/tests.nix
@@ -1,14 +1,20 @@
 # Integration tests, can be run without internet access.
 
-{ scenario ? "default" }:
+let
+  nixpkgs = (import ../pkgs/nixpkgs-pinned.nix).nixpkgs;
+in
 
-import ./lib/make-test.nix scenario (
-{ config, pkgs, lib, ... }: with lib;
-let testEnv = rec {
-  cfg = config.services;
-  mkIfTest = test: mkIf (config.tests.${test} or false);
+{ extraScenarios ? { ... }: {}
+, pkgs ? import nixpkgs { config = {}; overlays = []; }
+}:
+with pkgs.lib;
+let
+  globalPkgs = pkgs;
 
-  baseConfig = {
+  baseConfig = { pkgs, config, ... }: let
+    cfg = config.services;
+    mkIfTest = test: mkIf (config.tests.${test} or false);
+  in {
     imports = [
       ./lib/test-lib.nix
       ../modules/modules.nix
@@ -26,6 +32,9 @@ let testEnv = rec {
     };
 
     config = mkMerge [{
+      # Share the same pkgs instance among tests
+      nixpkgs.pkgs = mkDefault globalPkgs;
+
       tests.bitcoind = cfg.bitcoind.enable;
       services.bitcoind = {
         enable = true;
@@ -183,14 +192,14 @@ let testEnv = rec {
       ];
     };
 
-    netnsBase = {
+    netnsBase = { config, pkgs, ... }: {
       nix-bitcoin.netns-isolation.enable = true;
       test.data.netns = config.nix-bitcoin.netns-isolation.netns;
       tests.netns-isolation = true;
       environment.systemPackages = [ pkgs.fping ];
     };
 
-    regtestBase = {
+    regtestBase = { config, ... }: {
       tests.regtest = true;
 
       services.bitcoind.regtest = true;
@@ -241,20 +250,29 @@ let testEnv = rec {
       # You can also set the env var `scenarioOverridesFile` (used below) to define custom scenarios.
     };
   };
-};
-in
-  let
-    overrides = builtins.getEnv "scenarioOverridesFile";
-    scenarios = testEnv.scenarios // (optionalAttrs (overrides != "") (import overrides {
-      inherit testEnv config pkgs lib;
-    }));
-    autoScenario = {
-      services.${scenario}.enable = true;
+
+  overrides = builtins.getEnv "scenarioOverridesFile";
+  extraScenarios' = (if (overrides != "") then import overrides else extraScenarios) {
+    inherit scenarios pkgs;
+    inherit (pkgs) lib;
+  };
+  allScenarios = scenarios // extraScenarios';
+
+  makeTest = name: config:
+    makeTest' name {
+      imports = [
+        allScenarios.base
+        config
+      ];
     };
-  in {
-    imports = [
-      scenarios.base
-      (scenarios.${scenario} or autoScenario)
-    ];
+  makeTest' = import ./lib/make-test.nix pkgs;
+
+  tests = builtins.mapAttrs makeTest allScenarios;
+
+  getTest = name: tests.${name} or (makeTest name {
+    services.${name}.enable = true;
+  });
+in
+  tests // {
+    inherit getTest;
   }
-)