rollback(cilib_test) Synchronized the test file of the Ci library

Updated the continuous integration test file to be compatible with the newer main branch.

lib/impl/jobPatched.nix

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

lib/impl/modules/job.nix

@@ -646,7 +646,7 @@ in rec {
       };
       depsDrv = cilib.mkJobDeps {
         key = name;
-        job = config.finalConfig;
+        inherit job;
         nixConfig = config.nix;
       };
       runnerDrv = cilib.mkJobRun {

nix/repo/ci.nix

@@ -1,5 +1,5 @@
 {inputs, ...}: let
-  inherit (inputs) cilib;
+  inherit (inputs) cilib pkgs;
 in
   cilib.mkCI {
     config.soonix = {
@@ -58,9 +58,25 @@ in
       };
     };
     pipelines."default" = {
-      stages = ["test" "build" "deploy"];
+      stages = ["check" "test" "build" "deploy"];
+      variables = {
+        EXAMPLE = "empty";
+        CURL = toString pkgs.curl;
+      };
       jobs = {
+        "check" = {
+          stage = "check";
+          script = [
+            "set -euo pipefail"
+            "echo EXAMPLE=$EXAMPLE CURL=$CURL SAMPLE=$SAMPLE HELLO=$HELLO"
+          ];
+          variables = {
+            SAMPLE = "working";
+            HELLO = toString pkgs.hello;
+          };
+        };
         "test" = {
+          nix.deps = with pkgs; [coreutils nix];
           stage = "test";
           script = [
             "nix run .#tests -- --junit=junit.xml"
@@ -73,6 +89,7 @@ in
         };
         "docs" = {
           stage = "build";
+          nix.deps = with pkgs; [coreutils nix];
           script = [
             # sh
             ''

tests/cilib_test.nix

@@ -56,28 +56,26 @@
       }
       {
         name = "jobPatched nix disabled";
+        expected = {};
+        actual = mkJobPatched {
+          key = "test";
+          pipelineName = "test";
+          job = {};
+          nixConfig.enable = false;
+        };
+      }
+      {
+        name = "jobPatched nix disabled with variables and cache";
         expected = {
-          cache = {
+          variables."HELLO" = "world";
-            name = "some";
+          cache = [{key = "example";}];
-            paths = [ "this" ];
-          };
-          variables = {
-            BASH = toString pkgs.bash;
-            TEST = "work";
-          };
         };
         actual = mkJobPatched {
           key = "test";
           pipelineName = "test";
           job = {
-            cache = {
+            variables."HELLO" = "world";
-              name = "some";
+            cache = [{key = "example";}];
-              paths = [ "this" ];
-            };
-            variables = {
-              BASH = toString pkgs.bash;
-              TEST = "work";
-            };
           };
           nixConfig.enable = false;
         };
@@ -87,28 +85,11 @@
         expected = {
           after_script = ["finalize_nix_ci"];
           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;
@@ -120,32 +101,18 @@
         expected = {
           after_script = ["finalize_nix_ci"];
           before_script = ["source setup_nix_ci \"gitlab-ci:pipeline:test:job-deps:test\""];
-          cache = [{
+          cache = [
-            name = "some";
+            {
-            paths = [ "this" ];
-          }{
               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;
@@ -194,108 +161,46 @@
           '';
       }
       {
-        name = "handle store paths in variables without nix config";
+        name = "ignore store paths in variables with nix disabled";
         expected = {
           stages = ["test"];
-          variables = {
-            EXAMPLE = "empty";
-            CURL = toString pkgs.curl;
-          };
           test = {
             stage = "test";
-            before_script = [ "./init" ];
+            variables."TEST" = "${pkgs.hello}";
-            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";
             nixConfig.enable = false;
             pipeline = {
               stages = ["test"];
-            variables = {
-              EXAMPLE = "empty";
-              CURL = toString pkgs.curl;
-            };
               jobs.test = {
                 stage = "test";
-              before_script = [ "./init" ];
+                variables."TEST" = "${pkgs.hello}";
-              script = [ "echo Hello World!" ];
-              after_script = [ "./clean" ];
-              cache = {
-                key = "simple";
-                paths = [ "~/random/" ];
-              };
-              variables = {
-                SAMPLE = "working";
-                HELLO = toString pkgs.hello;
-              };
               };
             };
           }).finalConfig;
       }
       {
-        name = "handle store paths in variables with nix config";
+        # it doesn't make much sense to have any nix store path in variables, but we ignore it for global variables
+        name = "ignore store paths in global variables";
         expected = {
-          stages = [ "test" ];
           variables = {
-            EXAMPLE = "empty";
+            HELLO = "world";
             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 {
-        actual = (mkPipeline {
             name = "test";
-          nixConfig = {
+            nixConfig.enable = true;
-            enable = true;
-            enableRunnerCache = true;
-            runnerCacheKey = "random";
-          };
             pipeline = {
-            stages = [ "test" ];
               variables = {
-              EXAMPLE = "empty";
+                HELLO = "world";
                 CURL = toString pkgs.curl;
               };
-            jobs.test = {
+              jobs = {};
-              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;
       }

tests/modules_test.nix

@@ -10,9 +10,17 @@
       simplePipeline = cilib.mkCI {
         pipelines."test" = {
           stages = ["test"];
+          variables = {
+            EXAMPLE = "empty";
+            CURL = toString pkgs.curl;
+          };
           jobs."test" = {
             stage = "test";
             script = ["echo hello world"];
+            variables = {
+              SAMPLE = "working";
+              HELLO = toString pkgs.hello;
+            };
           };
         };
       };
@@ -30,21 +38,29 @@
           (cilib.mkCI {}).packages;
       }
       {
-        name = "simple pipeline";
+        name = "simple pipeline final config";
         expected = {
           stages = [".pre" "test" ".post"];
+          variables = {
+            EXAMPLE = "empty";
+            CURL = toString pkgs.curl;
+          };
           "test" = {
             image = "$NIX_CI_IMAGE";
             stage = "test";
             before_script = ["source setup_nix_ci \"gitlab-ci:pipeline:test:job-deps:test\""];
             script = ["echo hello world"];
             after_script = ["finalize_nix_ci"];
+            variables = {
+              SAMPLE = "working";
+              #HELLO = toString pkgs.hello;
+            };
           };
         };
         actual = simplePipeline.pipelines."test".finalConfig;
       }
       {
-        name = "simple pipeline yaml";
+        name = "simple pipeline json";
         type = "script";
         script = let
           package = simplePipeline.packages."gitlab-ci:pipeline:test";
@@ -56,25 +72,23 @@
             assert_file_contains ${package} 'gitlab-ci:pipeline:test:job-deps:test'
             assert_file_contains ${package} 'finalize_nix_ci'
             assert_file_contains ${package} 'echo hello world'
+            assert_file_contains ${package} '"EXAMPLE":"empty"'
+            assert_file_contains ${package} '"SAMPLE":"working"'
+            assert_file_contains ${package} '"CURL":"/nix/store/.*-curl-.*"'
           '';
       }
       {
-        name = "dont fail on store paths";
+        name = "simple pipeline deps drv";
         type = "script";
         script = let
-          package =
+          package = simplePipeline.packages."gitlab-ci:pipeline:test:job-deps:test";
-            (cilib.mkCI {
-              pipelines."test" = {
-                variables.EXAMPLE = "${pkgs.hello}";
-              };
-            }).packages."gitlab-ci:pipeline:test";
         in
           # sh
           ''
             ${ntlib.helpers.path [pkgs.gnugrep]}
             ${ntlib.helpers.scriptHelpers}
-            assert_file_contains ${package} '[".pre",".post"]'
+            assert_file_contains ${package} ':$PATH'
-            assert_file_contains ${package} '"EXAMPLE":"/nix/store/.*-hello-.*"'
+            assert_file_contains ${package} 'HELLO="/nix/store/.*-hello-.*"'
           '';
       }
     ];