Merge pull request #11 from feel-co/no-extra-special-args

modules: rename `hjem.extraSpecialArgs` to `hjem.specialArgs`

.github/workflows/vm-tests.yml

@@ -12,8 +12,10 @@ jobs:
       matrix:
         system:
           - x86_64-linux
+          - aarch64-linux
         test:
           - hjem-basic
+          - hjem-special-args
 
     runs-on: ubuntu-latest
     steps:

flake.nix

@@ -20,6 +20,7 @@
       };
     in {
       hjem-basic = import ./tests/basic.nix checkArgs;
+      hjem-special-args = import ./tests/special-args.nix checkArgs;
     });
 
     formatter = forAllSystems (system: nixpkgs.legacyPackages.${system}.alejandra);

modules/common.nix

@@ -1,6 +1,7 @@
 # The common module that contains Hjem's per-user options. To ensure Hjem remains
-# somewhat compliant with cross-platform paradigms (e.g. NixOS or Darwin) distro
-# specific options, such as packages, must be avoided here.
+# somewhat compliant with cross-platform paradigms (e.g. NixOS or Darwin.) Platform
+# specific options such as nixpkgs module system or nix-darwin module system should
+# be avoided here.
 {
   config,
   pkgs,

modules/nixos/default.nix

@@ -16,7 +16,7 @@
   hjemModule = submoduleWith {
     description = "Hjem NixOS module";
     class = "hjem";
-    specialArgs = {inherit pkgs lib;} // cfg.extraSpecialArgs;
+    specialArgs = {inherit pkgs lib;} // cfg.specialArgs;
     modules = concatLists [
       [
         ({name, ...}: {
@@ -41,6 +41,10 @@ in {
     # namespace to occupy. Added 2024-12-27, remove 2025-01-27 to allow
     # sufficient time to migrate.
     (lib.mkRenamedOptionModule ["homes"] ["hjem" "users"])
+
+    # 'extraSpecialArgs' is confusing and obscure. 'hjem.specialArgs' better
+    # describes what the option is really for.
+    (lib.mkRenamedOptionModule ["hjem" "extraSpecialArgs"] ["hjem" "specialArgs"])
   ];
 
   options.hjem = {
@@ -72,7 +76,7 @@ in {
       '';
     };
 
-    extraSpecialArgs = mkOption {
+    specialArgs = mkOption {
       type = attrs;
       default = {};
       example = literalExpression "{ inherit inputs; }";

tests/basic.nix

@@ -1,7 +1,7 @@
 let
   userHome = "/home/alice";
 in
-  (import ./lib.nix) {
+  (import ./lib) {
     name = "hjem-basic";
     nodes = {
       node1 = {

tests/special-args.nix

@@ -0,0 +1,45 @@
+let
+  userHome = "/home/alice";
+in
+  (import ./lib) {
+    name = "hjem-basic";
+    nodes = {
+      node1 = {self, ...}: {
+        imports = [self.nixosModules.hjem];
+
+        users.groups.alice = {};
+        users.users.alice = {
+          isNormalUser = true;
+          home = userHome;
+          password = "";
+        };
+
+        hjem = {
+          # Things like username, home directory or credentials should not really
+          # be put into specialArgs, but users do it anyway. Lets test for a very
+          # basic case of 'username' being passed to specialArgs as a string and
+          # is consumed in a file later on.
+          specialArgs = {username = "alice";};
+          users.alice = {
+            pkgs,
+            username,
+            ...
+          }: {
+            enable = true;
+            packages = [pkgs.hello];
+            files.".config/fooconfig" = {
+              text = "My username is ${username}";
+            };
+          };
+        };
+      };
+    };
+
+    testScript = ''
+      machine.succeed("loginctl enable-linger alice")
+      machine.wait_until_succeeds("systemctl --user --machine=alice@ is-active systemd-tmpfiles-setup.service")
+
+      # Test if the config file is properly generated, and contains the desired string1
+      machine.succeed("grep alice ~alice/.config/fooconfig")
+    '';
+  }