Merge branch 'fix-job-patch' into 'main'

fix: weird jobs patching

See merge request TECHNOFAB/nix-gitlab-ci!15

lib/impl/jobPatched.nix

@@ -3,7 +3,7 @@
   helpers,
 }: let
   inherit (lib) toList optionalAttrs optional;
-  inherit (helpers) prependToBeforeScript appendToAfterScript filterJobVariables;
+  inherit (helpers) prependToBeforeScript appendToAfterScript;
 in
   {
     key,
@@ -11,33 +11,28 @@ in
     pipelineName,
     nixConfig,
   }:
-    (builtins.removeAttrs job ["variables" "cache"])
+    if ! nixConfig.enable then job else
-    // (optionalAttrs nixConfig.enable (
+    (builtins.removeAttrs job [ "variables" "cache" ])
-      (prependToBeforeScript ["source setup_nix_ci \"gitlab-ci:pipeline:${pipelineName}:job-deps:${key}\""] job)
+    // (prependToBeforeScript [ "source setup_nix_ci \"gitlab-ci:pipeline:${pipelineName}:job-deps:${key}\"" ] job)
-      // (appendToAfterScript ["finalize_nix_ci"] job)
+    // (appendToAfterScript [ "finalize_nix_ci" ] job)
-    ))
+    // (let
-    // optionalAttrs nixConfig.enable (
+      variables = job.variables or {} //
-      (let
+        optionalAttrs nixConfig.enableRunnerCache {
-        variables =
+          NIX_CI_CACHE_STRATEGY = "runner";
-          (filterJobVariables false job)
+        };
-          // optionalAttrs nixConfig.enableRunnerCache {
+    in
-            NIX_CI_CACHE_STRATEGY = "runner";
+      # filter empty variables
-          };
+      optionalAttrs (variables != {}) {
-      in
+        inherit variables;
-        # filter empty variables
+      })
-        optionalAttrs (variables != {}) {
+    // (let
-          inherit variables;
+      cache = (toList (job.cache or [])) ++
-        })
+      (optional nixConfig.enableRunnerCache {
-      // (let
+        key = nixConfig.runnerCacheKey;
-        cache =
+        paths = [ ".nix-cache/" ];
-          (toList (job.cache or []))
+      });
-          ++ (optional nixConfig.enableRunnerCache {
+    in
-            key = nixConfig.runnerCacheKey;
+      # filter empty cache
-            paths = [".nix-cache/"];
+      optionalAttrs (cache != []) {
-          });
+        inherit cache;
-      in
+      })
-        # filter empty cache
-        optionalAttrs (cache != []) {
-          inherit cache;
-        })
-    )

tests/cilib_test.nix

@@ -56,24 +56,59 @@
       }
       {
         name = "jobPatched nix disabled";
-        expected = {};
+        expected = {
+          cache = {
+            name = "some";
+            paths = [ "this" ];
+          };
+          variables = {
+            BASH = toString pkgs.bash;
+            TEST = "work";
+          };
+        };
         actual = mkJobPatched {
           key = "test";
           pipelineName = "test";
-          job = {};
+          job = {
+            cache = {
+              name = "some";
+              paths = [ "this" ];
+            };
+            variables = {
+              BASH = toString pkgs.bash;
+              TEST = "work";
+            };
+          };
           nixConfig.enable = false;
         };
       }
       {
         name = "jobPatched without runner cache";
         expected = {
-          after_script = ["finalize_nix_ci"];
+          after_script = [ "finalize_nix_ci" ];
-          before_script = ["source setup_nix_ci \"gitlab-ci:pipeline:test:job-deps:test\""];
+          before_script = [ "source setup_nix_ci \"gitlab-ci:pipeline:test:job-deps:test\"" ];
+          variables = {
+            BASH = toString pkgs.bash;
+            TEST = "work";
+          };
+          cache = [{
+            name = "some";
+            paths = [ "this" ];
+          }];
         };
         actual = mkJobPatched {
           key = "test";
           pipelineName = "test";
-          job = {};
+          job = {
+            cache = {
+              name = "some";
+              paths = [ "this" ];
+            };
+            variables = {
+              BASH = toString pkgs.bash;
+              TEST = "work";
+            };
+          };
           nixConfig = {
             enable = true;
             enableRunnerCache = false;
@@ -83,20 +118,34 @@
       {
         name = "jobPatched with runner cache";
         expected = {
-          after_script = ["finalize_nix_ci"];
+          after_script = [ "finalize_nix_ci" ];
-          before_script = ["source setup_nix_ci \"gitlab-ci:pipeline:test:job-deps:test\""];
+          before_script = [ "source setup_nix_ci \"gitlab-ci:pipeline:test:job-deps:test\"" ];
-          cache = [
+          cache = [{
-            {
+            name = "some";
-              key = "test";
+            paths = [ "this" ];
-              paths = [".nix-cache/"];
+          }{
-            }
+            key = "test";
-          ];
+            paths = [ ".nix-cache/" ];
-          variables."NIX_CI_CACHE_STRATEGY" = "runner";
+          }];
+          variables = {
+            NIX_CI_CACHE_STRATEGY = "runner";
+            BASH = toString pkgs.bash;
+            TEST = "work";
+          };
         };
         actual = mkJobPatched {
           key = "test";
           pipelineName = "test";
-          job = {};
+          job = {
+            cache = {
+              name = "some";
+              paths = [ "this" ];
+            };
+            variables = {
+              BASH = toString pkgs.bash;
+              TEST = "work";
+            };
+          };
           nixConfig = {
             enable = true;
             enableRunnerCache = true;
@@ -145,23 +194,110 @@
           '';
       }
       {
-        name = "handle store paths in variables";
+        name = "handle store paths in variables without nix config";
         expected = {
-          stages = ["test"];
+          stages = [ "test" ];
-          test.stage = "test";
+          variables = {
+            EXAMPLE = "empty";
+            CURL = toString pkgs.curl;
+          };
+          test = {
+            stage = "test";
+            before_script = [ "./init" ];
+            script = [ "echo Hello World!" ];
+            after_script = [ "./clean" ];
+            cache = {
+              key = "simple";
+              paths = [ "~/random/" ];
+            };
+            variables = {
+              SAMPLE = "working";
+              HELLO = toString pkgs.hello;
+            };
+          };
         };
-        actual =
+        actual = (mkPipeline {
-          (mkPipeline {
+          name = "test";
-            name = "test";
+          nixConfig.enable = false;
-            nixConfig.enable = false;
+          pipeline = {
-            pipeline = {
+            stages = [ "test" ];
-              stages = ["test"];
+            variables = {
-              jobs.test = {
+              EXAMPLE = "empty";
-                stage = "test";
+              CURL = toString pkgs.curl;
-                variables."TEST" = "${pkgs.hello}";
+            };
+            jobs.test = {
+              stage = "test";
+              before_script = [ "./init" ];
+              script = [ "echo Hello World!" ];
+              after_script = [ "./clean" ];
+              cache = {
+                key = "simple";
+                paths = [ "~/random/" ];
+              };
+              variables = {
+                SAMPLE = "working";
+                HELLO = toString pkgs.hello;
               };
             };
-          }).finalConfig;
+          };
+        }).finalConfig;
+      }
+      {
+        name = "handle store paths in variables with nix config";
+        expected = {
+          stages = [ "test" ];
+          variables = {
+            EXAMPLE = "empty";
+            CURL = toString pkgs.curl;
+          };
+          test = {
+            stage = "test";
+            before_script = [ "source setup_nix_ci \"gitlab-ci:pipeline:test:job-deps:test\"" "./init" ];
+            script = [ "echo Hello World!" ];
+            after_script = [ "./clean" "finalize_nix_ci" ];
+            cache = [{
+              key = "simple";
+              paths = [ "~/random/" ];
+            }{
+              key = "random";
+              paths = [ ".nix-cache/" ];
+            }];
+            variables = {
+              SAMPLE = "working";
+              HELLO = toString pkgs.hello;
+              NIX_CI_CACHE_STRATEGY = "runner";
+            };
+          };
+        };
+        actual = (mkPipeline {
+          name = "test";
+          nixConfig = {
+            enable = true;
+            enableRunnerCache = true;
+            runnerCacheKey = "random";
+          };
+          pipeline = {
+            stages = [ "test" ];
+            variables = {
+              EXAMPLE = "empty";
+              CURL = toString pkgs.curl;
+            };
+            jobs.test = {
+              stage = "test";
+              before_script = [ "./init" ];
+              script = [ "echo Hello World!" ];
+              after_script = [ "./clean" ];
+              cache = {
+                key = "simple";
+                paths = [ "~/random/" ];
+              };
+              variables = {
+                SAMPLE = "working";
+                HELLO = toString pkgs.hello;
+              };
+            };
+          };
+        }).finalConfig;
       }
     ];
   };