From 74026bb1014460d511534da8a955bee6948716ee Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Fri, 20 Jan 2023 14:43:26 +0100
Subject: [PATCH 1/3] tests: Move NixOS tests to tests/nixos

This will allow contributors to find them more easily.
---
 flake.nix                                       | 14 +++++++-------
 tests/{ => nixos/containers}/containers.nix     |  0
 tests/{ => nixos/containers}/id-test.nix        |  0
 tests/{ => nixos/containers}/systemd-nspawn.nix |  0
 tests/{ => nixos}/github-flakes.nix             |  0
 tests/{ => nixos}/nix-copy-closure.nix          |  0
 tests/{ => nixos}/nss-preload.nix               |  0
 tests/{ => nixos}/remote-builds.nix             |  0
 tests/{ => nixos}/setuid.nix                    |  0
 tests/{ => nixos}/sourcehut-flakes.nix          |  0
 10 files changed, 7 insertions(+), 7 deletions(-)
 rename tests/{ => nixos/containers}/containers.nix (100%)
 rename tests/{ => nixos/containers}/id-test.nix (100%)
 rename tests/{ => nixos/containers}/systemd-nspawn.nix (100%)
 rename tests/{ => nixos}/github-flakes.nix (100%)
 rename tests/{ => nixos}/nix-copy-closure.nix (100%)
 rename tests/{ => nixos}/nss-preload.nix (100%)
 rename tests/{ => nixos}/remote-builds.nix (100%)
 rename tests/{ => nixos}/setuid.nix (100%)
 rename tests/{ => nixos}/sourcehut-flakes.nix (100%)

diff --git a/flake.nix b/flake.nix
index 573373c42..0dc8c4c2e 100644
--- a/flake.nix
+++ b/flake.nix
@@ -475,37 +475,37 @@
           };
 
         # System tests.
-        tests.remoteBuilds = import ./tests/remote-builds.nix {
+        tests.remoteBuilds = import ./tests/nixos/remote-builds.nix {
           system = "x86_64-linux";
           inherit nixpkgs;
           overlay = self.overlays.default;
         };
 
-        tests.nix-copy-closure = import ./tests/nix-copy-closure.nix {
+        tests.nix-copy-closure = import ./tests/nixos/nix-copy-closure.nix {
           system = "x86_64-linux";
           inherit nixpkgs;
           overlay = self.overlays.default;
         };
 
-        tests.nssPreload = (import ./tests/nss-preload.nix rec {
+        tests.nssPreload = (import ./tests/nixos/nss-preload.nix rec {
           system = "x86_64-linux";
           inherit nixpkgs;
           overlay = self.overlays.default;
         });
 
-        tests.githubFlakes = (import ./tests/github-flakes.nix rec {
+        tests.githubFlakes = (import ./tests/nixos/github-flakes.nix rec {
           system = "x86_64-linux";
           inherit nixpkgs;
           overlay = self.overlays.default;
         });
 
-        tests.sourcehutFlakes = (import ./tests/sourcehut-flakes.nix rec {
+        tests.sourcehutFlakes = (import ./tests/nixos/sourcehut-flakes.nix rec {
           system = "x86_64-linux";
           inherit nixpkgs;
           overlay = self.overlays.default;
         });
 
-        tests.containers = (import ./tests/containers.nix rec {
+        tests.containers = (import ./tests/nixos/containers/containers.nix rec {
           system = "x86_64-linux";
           inherit nixpkgs;
           overlay = self.overlays.default;
@@ -514,7 +514,7 @@
         tests.setuid = nixpkgs.lib.genAttrs
           ["i686-linux" "x86_64-linux"]
           (system:
-            import ./tests/setuid.nix rec {
+            import ./tests/nixos/setuid.nix rec {
               inherit nixpkgs system;
               overlay = self.overlays.default;
             });
diff --git a/tests/containers.nix b/tests/nixos/containers/containers.nix
similarity index 100%
rename from tests/containers.nix
rename to tests/nixos/containers/containers.nix
diff --git a/tests/id-test.nix b/tests/nixos/containers/id-test.nix
similarity index 100%
rename from tests/id-test.nix
rename to tests/nixos/containers/id-test.nix
diff --git a/tests/systemd-nspawn.nix b/tests/nixos/containers/systemd-nspawn.nix
similarity index 100%
rename from tests/systemd-nspawn.nix
rename to tests/nixos/containers/systemd-nspawn.nix
diff --git a/tests/github-flakes.nix b/tests/nixos/github-flakes.nix
similarity index 100%
rename from tests/github-flakes.nix
rename to tests/nixos/github-flakes.nix
diff --git a/tests/nix-copy-closure.nix b/tests/nixos/nix-copy-closure.nix
similarity index 100%
rename from tests/nix-copy-closure.nix
rename to tests/nixos/nix-copy-closure.nix
diff --git a/tests/nss-preload.nix b/tests/nixos/nss-preload.nix
similarity index 100%
rename from tests/nss-preload.nix
rename to tests/nixos/nss-preload.nix
diff --git a/tests/remote-builds.nix b/tests/nixos/remote-builds.nix
similarity index 100%
rename from tests/remote-builds.nix
rename to tests/nixos/remote-builds.nix
diff --git a/tests/setuid.nix b/tests/nixos/setuid.nix
similarity index 100%
rename from tests/setuid.nix
rename to tests/nixos/setuid.nix
diff --git a/tests/sourcehut-flakes.nix b/tests/nixos/sourcehut-flakes.nix
similarity index 100%
rename from tests/sourcehut-flakes.nix
rename to tests/nixos/sourcehut-flakes.nix

From 261c25601d9a4efd5245e3ef161fb52bf0543083 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Fri, 20 Jan 2023 15:32:31 +0100
Subject: [PATCH 2/3] Use the official, documented NixOS runTest interface

---
 flake.nix                             | 55 ++++++++++-----------------
 tests/nixos/containers/containers.nix | 11 ++----
 tests/nixos/github-flakes.nix         | 15 ++------
 tests/nixos/nix-copy-closure.nix      | 17 +++++----
 tests/nixos/nss-preload.nix           | 16 +++-----
 tests/nixos/remote-builds.nix         | 14 ++-----
 tests/nixos/setuid.nix                | 11 +++---
 tests/nixos/sourcehut-flakes.nix      | 14 ++-----
 8 files changed, 56 insertions(+), 97 deletions(-)

diff --git a/flake.nix b/flake.nix
index 0dc8c4c2e..31d7f1fcf 100644
--- a/flake.nix
+++ b/flake.nix
@@ -401,6 +401,18 @@
           };
         };
 
+      nixos-lib = import (nixpkgs + "/nixos/lib") { };
+
+      # https://nixos.org/manual/nixos/unstable/index.html#sec-calling-nixos-tests
+      runNixOSTestFor = system: test: nixos-lib.runTest {
+        imports = [ test ];
+        hostPkgs = nixpkgsFor.${system};
+        defaults = {
+          nixpkgs.pkgs = nixpkgsFor.${system};
+        };
+        _module.args.nixpkgs = nixpkgs;
+      };
+
     in {
 
       # A Nixpkgs overlay that overrides the 'nix' and
@@ -475,49 +487,22 @@
           };
 
         # System tests.
-        tests.remoteBuilds = import ./tests/nixos/remote-builds.nix {
-          system = "x86_64-linux";
-          inherit nixpkgs;
-          overlay = self.overlays.default;
-        };
+        tests.remoteBuilds = runNixOSTestFor "x86_64-linux" ./tests/nixos/remote-builds.nix;
 
-        tests.nix-copy-closure = import ./tests/nixos/nix-copy-closure.nix {
-          system = "x86_64-linux";
-          inherit nixpkgs;
-          overlay = self.overlays.default;
-        };
+        tests.nix-copy-closure = runNixOSTestFor "x86_64-linux" ./tests/nixos/nix-copy-closure.nix;
 
-        tests.nssPreload = (import ./tests/nixos/nss-preload.nix rec {
-          system = "x86_64-linux";
-          inherit nixpkgs;
-          overlay = self.overlays.default;
-        });
+        tests.nssPreload = runNixOSTestFor "x86_64-linux" ./tests/nixos/nss-preload.nix;
 
-        tests.githubFlakes = (import ./tests/nixos/github-flakes.nix rec {
-          system = "x86_64-linux";
-          inherit nixpkgs;
-          overlay = self.overlays.default;
-        });
+        tests.githubFlakes = runNixOSTestFor "x86_64-linux" ./tests/nixos/github-flakes.nix;
 
-        tests.sourcehutFlakes = (import ./tests/nixos/sourcehut-flakes.nix rec {
-          system = "x86_64-linux";
-          inherit nixpkgs;
-          overlay = self.overlays.default;
-        });
+        tests.sourcehutFlakes = runNixOSTestFor "x86_64-linux" ./tests/nixos/sourcehut-flakes.nix;
 
-        tests.containers = (import ./tests/nixos/containers/containers.nix rec {
-          system = "x86_64-linux";
-          inherit nixpkgs;
-          overlay = self.overlays.default;
-        });
+        tests.containers = runNixOSTestFor "x86_64-linux" ./tests/nixos/containers/containers.nix;
 
         tests.setuid = nixpkgs.lib.genAttrs
           ["i686-linux" "x86_64-linux"]
-          (system:
-            import ./tests/nixos/setuid.nix rec {
-              inherit nixpkgs system;
-              overlay = self.overlays.default;
-            });
+          (system: runNixOSTestFor system ./tests/nixos/setuid.nix);
+
 
         # Make sure that nix-env still produces the exact same result
         # on a particular version of Nixpkgs.
diff --git a/tests/nixos/containers/containers.nix b/tests/nixos/containers/containers.nix
index a4856b2df..c8ee78a4a 100644
--- a/tests/nixos/containers/containers.nix
+++ b/tests/nixos/containers/containers.nix
@@ -1,12 +1,7 @@
 # Test whether we can run a NixOS container inside a Nix build using systemd-nspawn.
-{ nixpkgs, system, overlay }:
+{ lib, nixpkgs, ... }:
 
-with import (nixpkgs + "/nixos/lib/testing-python.nix") {
-  inherit system;
-  extraConfigurations = [ { nixpkgs.overlays = [ overlay ]; } ];
-};
-
-makeTest ({
+{
   name = "containers";
 
   nodes =
@@ -65,4 +60,4 @@ makeTest ({
     host.succeed("[[ $(cat ./result/msg) = 'Hello World' ]]")
   '';
 
-})
+}
diff --git a/tests/nixos/github-flakes.nix b/tests/nixos/github-flakes.nix
index a8b036b17..e4d347691 100644
--- a/tests/nixos/github-flakes.nix
+++ b/tests/nixos/github-flakes.nix
@@ -1,14 +1,9 @@
-{ nixpkgs, system, overlay }:
-
-with import (nixpkgs + "/nixos/lib/testing-python.nix") {
-  inherit system;
-  extraConfigurations = [ { nixpkgs.overlays = [ overlay ]; } ];
-};
-
+{ lib, config, nixpkgs, ... }:
 let
+  pkgs = config.nodes.client.nixpkgs.pkgs;
 
   # Generate a fake root CA and a fake api.github.com / github.com / channels.nixos.org certificate.
-  cert = pkgs.runCommand "cert" { buildInputs = [ pkgs.openssl ]; }
+  cert = pkgs.runCommand "cert" { nativeBuildInputs = [ pkgs.openssl ]; }
     ''
       mkdir -p $out
 
@@ -92,8 +87,6 @@ let
     '';
 in
 
-makeTest (
-
 {
   name = "github-flakes";
 
@@ -207,4 +200,4 @@ makeTest (
     client.succeed("nix build nixpkgs#fuse --tarball-ttl 0")
   '';
 
-})
+}
diff --git a/tests/nixos/nix-copy-closure.nix b/tests/nixos/nix-copy-closure.nix
index 2dc164ae4..66cbfb033 100644
--- a/tests/nixos/nix-copy-closure.nix
+++ b/tests/nixos/nix-copy-closure.nix
@@ -1,13 +1,16 @@
 # Test ‘nix-copy-closure’.
 
-{ nixpkgs, system, overlay }:
+{ lib, config, nixpkgs, hostPkgs, ... }:
 
-with import (nixpkgs + "/nixos/lib/testing-python.nix") {
-  inherit system;
-  extraConfigurations = [ { nixpkgs.overlays = [ overlay ]; } ];
-};
+let
+  pkgs = config.nodes.client.nixpkgs.pkgs;
 
-makeTest (let pkgA = pkgs.cowsay; pkgB = pkgs.wget; pkgC = pkgs.hello; pkgD = pkgs.tmux; in {
+  pkgA = pkgs.cowsay;
+  pkgB = pkgs.wget;
+  pkgC = pkgs.hello;
+  pkgD = pkgs.tmux;
+
+in {
   name = "nix-copy-closure";
 
   nodes =
@@ -74,4 +77,4 @@ makeTest (let pkgA = pkgs.cowsay; pkgB = pkgs.wget; pkgC = pkgs.hello; pkgD = pk
     # )
     # client.succeed("nix-store --check-validity ${pkgC}")
   '';
-})
+}
diff --git a/tests/nixos/nss-preload.nix b/tests/nixos/nss-preload.nix
index 5a6ff3f68..cef62e95b 100644
--- a/tests/nixos/nss-preload.nix
+++ b/tests/nixos/nss-preload.nix
@@ -1,11 +1,9 @@
-{ nixpkgs, system, overlay }:
-
-with import (nixpkgs + "/nixos/lib/testing-python.nix") {
-  inherit system;
-  extraConfigurations = [ { nixpkgs.overlays = [ overlay ]; } ];
-};
+{ lib, config, nixpkgs, ... }:
 
 let
+
+  pkgs = config.nodes.client.nixpkgs.pkgs;
+
   nix-fetch = pkgs.writeText "fetch.nix" ''
     derivation {
         # This derivation is an copy from what is available over at
@@ -41,9 +39,7 @@ let
   '';
 in
 
-makeTest (
-
-rec {
+{
   name = "nss-preload";
 
   nodes = {
@@ -122,4 +118,4 @@ rec {
           nix-build ${nix-fetch} >&2
           """)
   '';
-})
+}
diff --git a/tests/nixos/remote-builds.nix b/tests/nixos/remote-builds.nix
index 9f88217fe..696cd2652 100644
--- a/tests/nixos/remote-builds.nix
+++ b/tests/nixos/remote-builds.nix
@@ -1,15 +1,9 @@
 # Test Nix's remote build feature.
 
-{ nixpkgs, system, overlay }:
-
-with import (nixpkgs + "/nixos/lib/testing-python.nix") {
-  inherit system;
-  extraConfigurations = [ { nixpkgs.overlays = [ overlay ]; } ];
-};
-
-makeTest (
+{ config, lib, hostPkgs, ... }:
 
 let
+  pkgs = config.nodes.client.nixpkgs.pkgs;
 
   # The configuration of the remote builders.
   builder =
@@ -75,7 +69,7 @@ in
 
     # Create an SSH key on the client.
     subprocess.run([
-      "${pkgs.openssh}/bin/ssh-keygen", "-t", "ed25519", "-f", "key", "-N", ""
+      "${hostPkgs.openssh}/bin/ssh-keygen", "-t", "ed25519", "-f", "key", "-N", ""
     ], capture_output=True, check=True)
     client.succeed("mkdir -p -m 700 /root/.ssh")
     client.copy_from_host("key", "/root/.ssh/id_ed25519")
@@ -109,4 +103,4 @@ in
     builder1.block()
     client.succeed("nix-build ${expr nodes.client.config 4}")
   '';
-})
+}
diff --git a/tests/nixos/setuid.nix b/tests/nixos/setuid.nix
index 6784615e4..2b66320dd 100644
--- a/tests/nixos/setuid.nix
+++ b/tests/nixos/setuid.nix
@@ -1,13 +1,12 @@
 # Verify that Linux builds cannot create setuid or setgid binaries.
 
-{ nixpkgs, system, overlay }:
+{ lib, config, nixpkgs, ... }:
 
-with import (nixpkgs + "/nixos/lib/testing-python.nix") {
-  inherit system;
-  extraConfigurations = [ { nixpkgs.overlays = [ overlay ]; } ];
-};
+let
+  pkgs = config.nodes.machine.nixpkgs.pkgs;
 
-makeTest {
+in
+{
   name = "setuid";
 
   nodes.machine =
diff --git a/tests/nixos/sourcehut-flakes.nix b/tests/nixos/sourcehut-flakes.nix
index b77496ab6..a76fed020 100644
--- a/tests/nixos/sourcehut-flakes.nix
+++ b/tests/nixos/sourcehut-flakes.nix
@@ -1,12 +1,8 @@
-{ nixpkgs, system, overlay }:
-
-with import (nixpkgs + "/nixos/lib/testing-python.nix")
-{
-  inherit system;
-  extraConfigurations = [{ nixpkgs.overlays = [ overlay ]; }];
-};
+{ lib, config, hostPkgs, nixpkgs, ... }:
 
 let
+  pkgs = config.nodes.sourcehut.nixpkgs.pkgs;
+
   # Generate a fake root CA and a fake git.sr.ht certificate.
   cert = pkgs.runCommand "cert" { buildInputs = [ pkgs.openssl ]; }
     ''
@@ -64,8 +60,6 @@ let
 
 in
 
-makeTest (
-
   {
     name = "sourcehut-flakes";
 
@@ -164,4 +158,4 @@ makeTest (
       client.succeed("nix build nixpkgs#fuse --tarball-ttl 0")
     '';
 
-  })
+}

From 3c08a3e6b68135af126a05e9e3be417b604edded Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Fri, 20 Jan 2023 15:35:46 +0100
Subject: [PATCH 3/3] PR template: Specify path to integration tests

---
 .github/PULL_REQUEST_TEMPLATE.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index a268d7caf..344f9405f 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -21,7 +21,7 @@ Maintainers: tick if completed or explain if not relevant
  - [ ] tests, as appropriate
    - functional tests - `tests/**.sh`
    - unit tests - `src/*/tests`
-   - integration tests
+   - integration tests - `tests/nixos/*`
  - [ ] documentation in the manual
  - [ ] code and comments are self-explanatory
  - [ ] commit message explains why the change was made