ci: cardano-node artifact test using nixosTests

Author: johnalotoski

flake.nix

@@ -166,9 +166,12 @@
         profiled = project.profiled.shell;
       };
 
-      # NixOS tests run a node and submit-api and validate it listens
+      # NixOS tests a sandboxed mainnet edge node with submit-api, ensuring
+      # startup and port listening functionality using the nixos service. It
+      # also tests Linux binary artifact start up with each set of pre-bundled
+      # environment configuration files.
       nixosTests = import ./nix/nixos/tests {
-        inherit pkgs;
+        inherit pkgs ciJobs;
       };
 
       checks =

nix/nixos/tests/cardano-node-artifact.nix

@@ -0,0 +1,80 @@
+{
+  pkgs,
+  cardano-node-linux,
+  ...
+}: let
+  inherit (builtins) attrNames fromJSON readFile toString;
+  inherit (cardanoLib) environments;
+  inherit (cardanoNodePackages) cardano-cli;
+  inherit (lib) getAttrs getExe foldl' makeBinPath recursiveUpdate;
+  inherit (pkgs) cardanoLib cardanoNodePackages gnutar gzip jq lib;
+
+  # NixosTest script fns supporting a timeout have a default of 900 seconds.
+  timeout = toString 30;
+
+  environments' = getAttrs ["mainnet" "preprod" "preview"] environments;
+  envs = attrNames environments';
+  getMagic = env: toString (fromJSON (readFile environments.${env}.nodeConfig.ShelleyGenesisFile)).networkMagic;
+
+  mkSvcTest = env: {
+    "cardano-node-${env}" = {
+      serviceConfig = {
+        WorkingDirectory = "/var/lib/cardano-node-${env}";
+        StateDirectory = "cardano-node-${env}";
+      };
+
+      preStart = ''
+        mkdir config
+        cp -v /opt/cardano-node-linux/share/${env}/* ./
+      '';
+
+      script = ''
+        /opt/cardano-node-linux/bin/cardano-node run \
+          --config config.json \
+          --topology topology.json \
+          --database-path db \
+          --socket-path node.socket \
+          --port 3001
+      '';
+    };
+  };
+
+  mkScriptTest = env: ''
+    machine.systemctl("start cardano-node-${env}")
+    machine.wait_until_succeeds("[ -S /var/lib/cardano-node-${env}/node.socket ]", timeout=${timeout})
+    machine.wait_until_succeeds("nc -z localhost 12798", timeout=${timeout})
+    machine.wait_until_succeeds("nc -z localhost 3001", timeout=${timeout})
+    out = machine.succeed(
+      "${getExe cardano-cli} ping -h 127.0.0.1 -c 1 -m ${getMagic env} -q --json | ${getExe jq} -c"
+    )
+    print("ping ${env}:", out)
+    machine.succeed("systemctl status cardano-node-${env}")
+    machine.succeed("systemctl stop cardano-node-${env}")
+    machine.wait_until_fails("nc -z localhost 12798", timeout=${timeout})
+    machine.wait_until_fails("nc -z localhost 3001", timeout=${timeout})
+  '';
+in {
+  name = "cardano-node-artifact-test";
+  nodes = {
+    machine = {config, ...}: {
+      nixpkgs.pkgs = pkgs;
+
+      system.activationScripts.prepTest.text = let
+        binPath = makeBinPath [gnutar gzip];
+      in ''
+        export PATH=${binPath}:$PATH
+        mkdir -p /opt/cardano-node-linux
+        cp -v ${cardano-node-linux}/cardano-node-*-linux.tar.gz /opt/cardano-node-linux.tar.gz
+        tar -zxvf /opt/cardano-node-linux.tar.gz -C /opt/cardano-node-linux
+      '';
+
+      systemd.services = foldl' (acc: env: recursiveUpdate acc (mkSvcTest env)) {} envs;
+    };
+  };
+
+  testScript =
+    ''
+      start_all()
+    ''
+    + lib.concatMapStringsSep "\n" mkScriptTest envs;
+}

nix/nixos/tests/default.nix

@@ -1,20 +1,30 @@
-{ pkgs
-, supportedSystems ? [ "x86_64-linux" ]
-}:
+{
+  pkgs,
+  ciJobs,
+  supportedSystems ? ["x86_64-linux"],
+}: let
+  inherit (ciJobs.musl) cardano-node-linux;
+  inherit (pkgs.lib) genAttrs hydraJob;
 
-with pkgs;
-with pkgs.commonLib;
-
- let
   forAllSystems = genAttrs supportedSystems;
+
   importTest = fn: args: system: let
     imported = import fn;
     test = import (pkgs.path + "/nixos/tests/make-test-python.nix") imported;
-  in test ({
-    inherit pkgs system config;
-  } // args);
+  in
+    test ({
+        inherit pkgs system;
+        inherit (pkgs.commonLib) config;
+      }
+      // args);
+
+  # These tests are sandboxed and don't transmit data across the network for
+  # syncing but can still ensure services start and listen as expected.
   callTest = fn: args: forAllSystems (system: hydraJob (importTest fn args system));
-in rec {
-  # only tests that port is open since the test can't access network to actually sync
-  cardanoNodeEdge  = callTest ./cardano-node-edge.nix {};
+in {
+  # Tests the linux release binary envs with pre-bundled config.
+  cardanoNodeArtifact = callTest ./cardano-node-artifact.nix {inherit cardano-node-linux;};
+
+  # Tests a mainnet edge node with submit-api using nixos service config.
+  cardanoNodeEdge = callTest ./cardano-node-edge.nix {};
 }