deployment shell: factor into a reusable component

Author: deepfire

nix/default.nix

@@ -110,6 +110,7 @@ let
       inherit overlays;
       modules = self.importWithPkgs ../modules;
       roles = self.importWithPkgs ../roles;
+      deployment-shell = import ./deployment-shell.nix { pkgs = self; };
     };
     sourcePaths = (super.sourcePaths or {}) // sourcePaths;
   };

nix/deployment-shell.nix

@@ -0,0 +1,64 @@
+##
+## This allows us to build cardano-ops-like shells with deployment capability.
+##
+{ pkgs }:
+
+let
+  inherit (pkgs) globals lib;
+  nivOverrides = pkgs.writeShellScriptBin "niv-overrides" ''
+    niv --sources-file ${toString globals.sourcesJsonOverride} $@
+  '';
+in
+{
+  nativeBuildInputs =
+    with pkgs;
+    [
+    awscli2
+    bashInteractive
+    cardano-cli
+    dnsutils
+    niv
+    locli.components.exes.locli
+    nivOverrides
+    nix
+    nix-diff
+    nixops
+    pandoc
+    perl
+    pstree
+    telnet
+    cardano-ping
+    git
+    direnv
+    nix-direnv
+    lorri
+    relayUpdateTimer
+  ] ++ (lib.optionals stdenv.hostPlatform.isLinux ([
+    # Those fail to compile under macOS:
+    node-update
+    # script NOT for use on mainnet:
+  ] ++ lib.optional (globals.environmentName != "mainnet") kes-rotation));
+
+  passthru =
+    {
+      gen-graylog-creds = lib.iohk-ops-lib.scripts.gen-graylog-creds { staticPath = ./static; };
+    };
+
+  extraMkShellAttributes =
+    {
+      NIX_PATH = "nixpkgs=${pkgs.path}";
+      NIXOPS_DEPLOYMENT = "${globals.deploymentName}";
+    }
+    // globals.environmentVariables;
+
+  cardanoOpsMkShellDefault =
+    with pkgs;
+
+    ## Note: we're using the non-rec, verbose, pkgs-relative references on purpose:
+    ##       this serves as a reference on how to define a derived shell.
+    mkShell
+      ({
+        inherit (cardano-ops.deployment-shell) nativeBuildInputs passthru;
+       }
+       // cardano-ops.deployment-shell.extraMkShellAttributes);
+}

shell.nix

@@ -10,43 +10,8 @@
     inherit config;
   }
 }:
-with pkgs; with lib;
-let
-  nivOverrides = writeShellScriptBin "niv-overrides" ''
-    niv --sources-file ${toString globals.sourcesJsonOverride} $@
-  '';
 
-in  mkShell (rec {
-  nativeBuildInputs = [
-    awscli2
-    bashInteractive
-    cardano-cli
-    dnsutils
-    niv
-    locli
-    nivOverrides
-    nix
-    nix-diff
-    nixops
-    pandoc
-    perl
-    pstree
-    telnet
-    cardano-ping
-    git
-    direnv
-    nix-direnv
-    lorri
-    relayUpdateTimer
-  ] ++ (lib.optionals pkgs.stdenv.hostPlatform.isLinux ([
-    # Those fail to compile under macOS:
-    node-update
-    # script NOT for use on mainnet:
-  ] ++ lib.optional (globals.environmentName != "mainnet") kes-rotation));
+## See the definition of `cardanoOpsMkShellDefault` for a reference implementation
+##   of a cardano-ops-like shell with deployment capability.
+pkgs.cardano-ops.deployment-shell.cardanoOpsMkShellDefault
 
-  NIX_PATH = "nixpkgs=${path}";
-  NIXOPS_DEPLOYMENT = "${globals.deploymentName}";
-  passthru = {
-    gen-graylog-creds = iohk-ops-lib.scripts.gen-graylog-creds { staticPath = ./static; };
-  };
-} // globals.environmentVariables)