fixup! Add tests documentation to docs page

checks/nixos-modules/static-page/default.nix

@@ -1,45 +1,39 @@
 {
   testers,
-  curl,
   lib,
-  gnugrep,
   ...
 }:
-testers.runNixOSTest {
+let
+  inherit (lib)
+    mkDefault
+    readFile
+    attrNames
+    concatStringsSep
+    ;
   name = "static-page";
-
-  nodes.webserver =
-    { ... }:
-    {
-      # Service under test
-      imports = [ ../../../nixos-modules/static-page ];
-      qois.static-page = {
-        enable = true;
-        pages = lib.mkForce {
-          "localhost" = {
-            domainAliases = [ "example.com" ];
-          };
-        };
-      };
-
-      # Test environment
-      environment.systemPackages = [
-        curl
-        gnugrep
+in
+testers.runNixOSTest {
+  inherit name;
+  imports = [
+    (import ./test.nix {
+      inherit name;
+      inherit lib;
+    })
   ];
-      # Disable TLS services
-      services.nginx.virtualHosts =
-        let
-          tlsOff = {
-            forceSSL = lib.mkForce false;
-            enableACME = lib.mkForce false;
-          };
-        in
-        {
-          "localhost" = tlsOff;
-          "example.com" = tlsOff;
-        };
-    };
+  defaults.imports = [ ../../../nixos-modules/${name} ];
 
-  testScript = lib.readFile ./test.py;
+  # 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)
+    ''
+  );
 }

checks/nixos-modules/static-page/test.nix

@@ -0,0 +1,30 @@
+{
+  ...
+}:
+{
+  nodes.webserver =
+    { pkgs, lib, ... }:
+    let
+      inherit (pkgs) curl gnugrep;
+      inherit (lib) mkForce genAttrs const;
+    in
+    {
+      # Setup simple localhost page with an example.com redirect
+      qois.static-page = {
+        enable = true;
+        pages."localhost".domainAliases = [ "example.com" ];
+      };
+
+      # Disable TLS services
+      services.nginx.virtualHosts = genAttrs [ "localhost" "example.com" ] (const {
+        forceSSL = mkForce false;
+        enableACME = mkForce false;
+      });
+
+      # Test environment
+      environment.systemPackages = [
+        curl
+        gnugrep
+      ];
+    };
+}

checks/nixos-modules/static-page/test.py

@@ -1,43 +1,43 @@
-webserver.wait_for_unit("nginx")
-webserver.wait_for_open_port(80)
+def test(subtest, webserver):
+    webserver.wait_for_unit("nginx")
+    webserver.wait_for_open_port(80)
 
-# Preparations
-webserverRoot = "/var/lib/nginx-localhost/root"
-indexContent = "It works!"
-webserver.succeed(f"mkdir {webserverRoot}")
-webserver.succeed(f"echo '{indexContent}' > {webserverRoot}/index.html")
-webserver.succeed(f"chown -R nginx-localhost\: {webserverRoot}")
+    # Preparations
+    webserverRoot = "/var/lib/nginx-localhost/root"
+    indexContent = "It works!"
+    webserver.succeed(f"mkdir {webserverRoot}")
+    webserver.succeed(f"echo '{indexContent}' > {webserverRoot}/index.html")
+    webserver.succeed(f"chown -R nginx-localhost\: {webserverRoot}")
 
-# Helpers
+    # Helpers
+    def curl_variable_test(node, variable, expected, url):
+        value = node.succeed(
+            f"curl -s --no-location -o /dev/null -w '%{{{variable}}}' '{url}'")
+        assert value == expected, \
+            f"expected {variable} to be '{expected}' but got '{value}'"
 
+    def expect_http_code(node, code, url):
+        curl_variable_test(node, "http_code", code, url)
 
-def expect_http_code(node, code, url):
-    http_code = node.succeed(
-        f"curl -s --no-location -o /dev/null -w '%{{http_code}}' '{url}'")
-    assert http_code == code, \
-        f"expected {code} but got following response:\n{http_code}"
+    def expect_http_location(node, location, url):
+        curl_variable_test(node, "redirect_url", location, url)
 
-
-def expect_http_location(node, location, url):
-    redirect_url = node.succeed(
-        f"curl -s --no-location -o /dev/null -w '%{{redirect_url}}' '{url}'")
-    assert redirect_url == location, \
-        f"expected redirect to {location} but got:\n{redirect_url}"
-
-
-def expect_http_content(node, expectedContent, url):
+    def expect_http_content(node, expectedContent, url):
         content = node.succeed(f"curl --no-location --silent '{url}'")
-    assert content.strip() == expectedContent.strip(), \
-        f"expected:\n{expectedContent}\n at {
-            url} but got following content:\n'{content}'"
+        assert content.strip() == expectedContent.strip(), f'''
+                expected content:
+                  {expectedContent}
+                at {url} but got following content:
+                  {content}
+            '''
 
-
-# Tests
-with subtest("website is successfully served on localhost"):
+    # Tests
+    with subtest("website is successfully served on localhost"):
         expect_http_code(webserver, "200", "http://localhost/index.html")
-    expect_http_content(webserver, indexContent, "http://localhost/index.html")
+        expect_http_content(webserver, indexContent,
+                            "http://localhost/index.html")
 
-with subtest("example.com is a hosts alias and redirects to localhost"):
+    with subtest("example.com is a hosts alias and redirects to localhost"):
         webserver.succeed("grep example.com /etc/hosts")
 
         url = "http://example.com/index.html"