Merge pull request #156 from PerchunPak/allow-function-patches

Allow patching with functions that accept pkgs

Author: gytis-ivaskevicius

devShell.nix

@@ -75,6 +75,7 @@ devshell.mkShell {
     }
 
     (test "channel-patching")
+    (test "channel-patching-using-func")
     (test "derivation-outputs")
     (test "hosts-config")
     (test "overlays-flow")

flake.nix

@@ -47,13 +47,15 @@
             rhs;
 
         patchChannel = system: channel: patches:
+          let
+            pkgs = (import channel { inherit system; }).pkgs;
+          in
           if patches == [ ] then channel else
-          (import channel { inherit system; }).pkgs.applyPatches {
+          pkgs.applyPatches {
             name = if channel ? shortRev then "nixpkgs-patched-${channel.shortRev}" else "nixpkgs-patched";
             src = channel;
-            patches = patches;
+            patches = map (patch: if pkgs.lib.isFunction patch then patch pkgs else patch) patches;
           };
-
       };
     };
 }

tests/channel-patching-using-func/flake.nix

@@ -0,0 +1,79 @@
+{
+  inputs.utils.url = path:../../;
+  inputs.nixpkgs.url = github:NixOS/nixpkgs/;
+
+  outputs = inputs@{ self, nixpkgs, utils }:
+    utils.lib.mkFlake {
+      inherit self inputs;
+      supportedSystems = [ "x86_64-linux" ];
+
+
+
+
+      #################
+      ### Test Data ###
+      #################
+
+      channelsConfig.allowBroken = true;
+
+      channels.nixpkgs = {
+        input = nixpkgs;
+        patches = [
+          (pkgs: pkgs.runCommand "myNixpkgsPatch.patch" { } "cp ${./myNixpkgsPatch.patch} $out")
+        ];
+        config.allowUnfree = true;
+      };
+
+      hosts.PatchedHost.modules = [
+        ({ lib, ... }: {
+          patchedModule.test = lib.patchedFunction "using patched module via patched function";
+
+          # To keep Nix from complaining
+          boot.loader.grub.devices = [ "nodev" ];
+          fileSystems."/" = { device = "test"; fsType = "ext4"; };
+        })
+      ];
+
+
+      outputsBuilder = channels: {
+
+        packages = {
+          # Using patched channel
+          inherit (channels.nixpkgs) flake-utils-plus-test;
+        };
+
+
+
+        ######################
+        ### Test execution ###
+        ######################
+
+        checks =
+          let
+            inherit (utils.lib.check-utils channels.nixpkgs) hasKey isEqual;
+            hostConfig = self.nixosConfigurations.PatchedHost.config;
+          in
+          {
+
+            # Patched package gets passed to `packageBuilder`
+            patchedPackageGetsPassedToBuilders = isEqual self.packages.x86_64-linux.flake-utils-plus-test.pname "coreutils";
+
+            # Modules (and lib) from patched nixpkgs are used
+            patchedModuleAndFunctionWorks = isEqual hostConfig.patchedModule.test "using patched module via patched function";
+
+            # `channelsConfig.*` is used
+            globalChannelConfigWorks = hasKey hostConfig.nixpkgs.pkgs.config "allowBroken";
+
+            # `channels.nixpkgs.config.*` is also used
+            channelSpecificConfigWorks = hasKey hostConfig.nixpkgs.pkgs.config "allowUnfree";
+
+          };
+      };
+
+
+    };
+}
+
+
+
+

tests/channel-patching-using-func/myNixpkgsPatch.patch

@@ -0,0 +1,34 @@
+diff --git a/lib/default.nix b/lib/default.nix
+index 751738a98965..b689f7744bac 100644
+--- a/lib/default.nix
++++ b/lib/default.nix
+@@ -48,6 +48,7 @@ let
+       callLibs = file: import file { lib = self; };
+     in
+     {
++      patchedFunction = x: x;
+ 
+       # often used, or depending on very little
+       trivial = callLibs ./trivial.nix;
+diff --git a/nixos/modules/module-list.nix b/nixos/modules/module-list.nix
+index 6995f3ba1ed2..49adcce57c6f 100644
+--- a/nixos/modules/module-list.nix
++++ b/nixos/modules/module-list.nix
+@@ -2039,4 +2039,10 @@
+       ./image/repart.nix
+     ];
+   }
++  ({ lib, config, ... }: {
++    options.patchedModule.test = lib.mkOption {
++      default = null;
++      example = "test";
++    };
++  })
+ ]
+diff --git a/pkgs/by-name/fl/flake-utils-plus-test/package.nix b/pkgs/by-name/fl/flake-utils-plus-test/package.nix
+new file mode 100644
+index 000000000000..ad5323375baf
+--- /dev/null
++++ b/pkgs/by-name/fl/flake-utils-plus-test/package.nix
+@@ -0,0 +1 @@
++{ coreutils }: coreutils

tests/channel-patching/myNixpkgsPatch.patch

@@ -1,21 +1,20 @@
 diff --git a/lib/default.nix b/lib/default.nix
-index f931524002f2..5299719bfd92 100644
+index 751738a98965..b689f7744bac 100644
 --- a/lib/default.nix
 +++ b/lib/default.nix
-@@ -10,6 +10,8 @@ let
-   lib = makeExtensible (self: let
-     callLibs = file: import file { lib = self; };
-   in {
-+    patchedFunction = x: x;
-+
+@@ -48,6 +48,7 @@ let
+       callLibs = file: import file { lib = self; };
+     in
+     {
++      patchedFunction = x: x;
 
-     # often used, or depending on very little
-     trivial = callLibs ./trivial.nix;
+       # often used, or depending on very little
+       trivial = callLibs ./trivial.nix;
 diff --git a/nixos/modules/module-list.nix b/nixos/modules/module-list.nix
-index bd3b27c00b55..3cfde568a714 100644
+index 6995f3ba1ed2..49adcce57c6f 100644
 --- a/nixos/modules/module-list.nix
 +++ b/nixos/modules/module-list.nix
-@@ -1818,4 +1818,10 @@
+@@ -2039,4 +2039,10 @@
        ./image/repart.nix
      ];
    }