From fc4d569886bd28b12a5989a16ffdeca94289b554 Mon Sep 17 00:00:00 2001
From: Fabian Hauser <fabian@fh2.ch>
Date: Mon, 24 Mar 2025 21:50:44 +0200
Subject: [PATCH] fixup! Add tests documentation to docs page

---
 checks/default.nix                            |  2 +-
 checks/nixos-modules/default.nix              | 59 +++++++++++++++++--
 checks/nixos-modules/static-page/default.nix  | 39 ------------
 lib/default.nix                               | 24 ++++----
 .../static-page/test.nix                      |  0
 .../static-page/test.py                       |  0
 6 files changed, 70 insertions(+), 54 deletions(-)
 delete mode 100644 checks/nixos-modules/static-page/default.nix
 rename {checks/nixos-modules => nixos-modules}/static-page/test.nix (100%)
 rename {checks/nixos-modules => nixos-modules}/static-page/test.py (100%)

diff --git a/checks/default.nix b/checks/default.nix
index bf629ba..81883ba 100644
--- a/checks/default.nix
+++ b/checks/default.nix
@@ -17,7 +17,7 @@
     '';
 
     nixos-modules = pkgs.callPackage ./nixos-modules {
-      inherit (self.lib) loadSubmodulesFrom;
+      inherit (self.lib) getSubDirs isFolderWithFile;
     };
 
     #TODO(#29): Integration/System tests
diff --git a/checks/nixos-modules/default.nix b/checks/nixos-modules/default.nix
index 8ddddcf..ea8eace 100644
--- a/checks/nixos-modules/default.nix
+++ b/checks/nixos-modules/default.nix
@@ -1,9 +1,60 @@
 {
   linkFarmFromDrvs,
-  callPackage,
-  loadSubmodulesFrom,
+  isFolderWithFile,
+  getSubDirs,
+  lib,
+  testers,
 }:
 let
-  tests = map (test: callPackage test { }) (loadSubmodulesFrom ./.);
+  inherit (lib)
+    filter
+    path
+    mkDefault
+    readFile
+    attrNames
+    concatStringsSep
+    pipe
+    ;
+  modulesBaseDir = ../../nixos-modules;
+  mkTest =
+    name:
+    let
+      getFilePath = file: path.append modulesBaseDir "./${name}/${file}";
+    in
+    testers.runNixOSTest {
+      inherit name;
+      imports = [
+        (import (getFilePath "test.nix") {
+          inherit name;
+          inherit lib;
+        })
+      ];
+
+      defaults.imports = [ (getFilePath "default.nix") ];
+
+      # Calls a `test(...)` python function in the test's python file with the list of nodes and helper functions.
+      # Helper symbols may be added as function args when needed and can be found in:
+      #   https://github.com/NixOS/nixpkgs/blob/master/nixos/lib/test-driver/src/test_driver/driver.py#L121
+      testScript = mkDefault (
+        { nodes, ... }:
+        let
+          script = readFile (getFilePath "test.py");
+          nodeArgs = pipe nodes [
+            attrNames
+            (map (val: "${val}=${val}"))
+            (concatStringsSep ", ")
+          ];
+        in
+        ''
+          ${script}
+          test(${nodeArgs}, subtest=subtest)
+        ''
+      );
+    };
 in
-linkFarmFromDrvs "nixos-modules" tests
+pipe modulesBaseDir [
+  getSubDirs
+  (filter (isFolderWithFile "test.nix"))
+  (map mkTest)
+  (linkFarmFromDrvs "nixos-modules")
+]
diff --git a/checks/nixos-modules/static-page/default.nix b/checks/nixos-modules/static-page/default.nix
deleted file mode 100644
index 44967a5..0000000
--- a/checks/nixos-modules/static-page/default.nix
+++ /dev/null
@@ -1,39 +0,0 @@
-{
-  testers,
-  lib,
-  ...
-}:
-let
-  inherit (lib)
-    mkDefault
-    readFile
-    attrNames
-    concatStringsSep
-    ;
-  name = "static-page";
-in
-testers.runNixOSTest {
-  inherit name;
-  imports = [
-    (import ./test.nix {
-      inherit name;
-      inherit lib;
-    })
-  ];
-  defaults.imports = [ ../../../nixos-modules/${name} ];
-
-  # Calls a test function with the list of nodes and helper functions.
-  # Helper symbols may be added as function args needed and can be found in:
-  #   https://github.com/NixOS/nixpkgs/blob/master/nixos/lib/test-driver/src/test_driver/driver.py#L121
-  testScript = mkDefault (
-    { nodes, ... }:
-    let
-      script = readFile ./test.py;
-      nodeArgs = concatStringsSep ", " (map (val: "${val}=${val}") (attrNames nodes));
-    in
-    ''
-      ${script}
-      test(${nodeArgs}, subtest=subtest)
-    ''
-  );
-}
diff --git a/lib/default.nix b/lib/default.nix
index 404d93e..8df2940 100644
--- a/lib/default.nix
+++ b/lib/default.nix
@@ -1,18 +1,22 @@
 { pkgs, ... }:
 let
-  lib = pkgs.lib;
-  foldersWithNix =
-    path:
-    let
-      folders = lib.attrNames (lib.filterAttrs (n: t: t == "directory") (builtins.readDir path));
-      isFolderWithDefaultNix = folder: lib.pathExists (lib.path.append path "./${folder}/default.nix");
-    in
-    lib.filter isFolderWithDefaultNix folders;
+  inherit (pkgs.lib)
+    attrNames
+    filterAttrs
+    filter
+    pathExists
+    path
+    ;
+  isFolderWithFile =
+    fileName: basePath: folderName:
+    (pathExists (path.append basePath "./${folderName}/${fileName}.nix"));
+  getSubDirs = base: attrNames (filterAttrs (n: t: t == "directory") (builtins.readDir base));
+  foldersWithNix = base: filter (isFolderWithFile "default.nix") (getSubDirs base);
 
 in
 {
-  inherit foldersWithNix;
+  inherit isFolderWithFile foldersWithNix;
 
   loadSubmodulesFrom =
-    path: map (folder: lib.path.append path "./${folder}/default.nix") (foldersWithNix path);
+    basePath: map (folder: path.append basePath "./${folder}/default.nix") (foldersWithNix basePath);
 }
diff --git a/checks/nixos-modules/static-page/test.nix b/nixos-modules/static-page/test.nix
similarity index 100%
rename from checks/nixos-modules/static-page/test.nix
rename to nixos-modules/static-page/test.nix
diff --git a/checks/nixos-modules/static-page/test.py b/nixos-modules/static-page/test.py
similarity index 100%
rename from checks/nixos-modules/static-page/test.py
rename to nixos-modules/static-page/test.py