Merge pull request #3761 from input-output-hk/devops-1083-nix-cleanup

[DEVOPS-1083] Nix documentation and cleanup part II

Author: rvl

default.nix

@@ -36,6 +36,10 @@
 #   - lib.nix     - the localLib common functions.
 #   - nix/*       - other nix code modules used by this file.
 #
+# See also:
+#   - docs/how-to/build-cardano-sl-and-daedalus-from-source-code.md
+#   - docs/nix.md
+#
 ########################################################################
 
 let
@@ -237,12 +241,7 @@ let
     };
 
     # Tool for generating ./pkgs/default.nix
-    stack2nix = self.callPackage (pkgs.fetchFromGitHub {
-      owner = "avieth";
-      repo = "stack2nix";
-      rev = "c51db2d31892f7c4e7ff6acebe4504f788c56dca";
-      sha256 = "10jcj33sxpq18gxf3zcck5i09b2y4jm6qjggqdlwd9ss86wg3ksb";
-    }) { };
+    stack2nix = self.callPackage ./nix/stack2nix.nix { };
 
     validateJson = self.callPackage ./tools/src/validate-json {};
 
@@ -255,7 +254,32 @@ let
 
     inherit (self.haskellPackages.cardano-sl) version;
     inherit gitrev;
-  });
+  }
+   # fixme: Temporary fix for hydra evaluation
+   // { inherit (self.cardanoPackages)
+          cardano-sl
+          cardano-sl-auxx
+          cardano-sl-chain
+          cardano-sl-cluster
+          cardano-sl-core
+          cardano-sl-crypto
+          cardano-sl-db
+          cardano-sl-explorer
+          cardano-sl-explorer-frontend
+          cardano-sl-explorer-static
+          cardano-sl-generator
+          cardano-sl-infra
+          cardano-sl-networking
+          cardano-sl-node-static
+          cardano-sl-tools
+          cardano-sl-tools-post-mortem
+          cardano-sl-util
+          cardano-sl-wallet
+          cardano-sl-wallet-new
+          cardano-sl-x509
+          cardano-report-server
+          cardano-report-server-static; }
+  );
 
 in
   # The top-level package set

lib.nix

@@ -9,6 +9,8 @@ let
   # applied to the given args.
   importPkgs = args: import fetchNixPkgs ({ overlays = [ (import ./nix/overlays/jemalloc.nix) ]; } // args);
 
+  # Gets the value of an environment variable, with a default if it's
+  # unset or empty.
   maybeEnv = env: default:
     let
       result = builtins.getEnv env;
@@ -79,9 +81,16 @@ in lib // (rec {
 
   # Generates an attrset for the three cardano-sl networks by applying
   # the given function to each environment.
-  forEnvironments = f: lib.mapAttrs'
-    (name: env: lib.nameValuePair name (f (env // { environment = name; }))) # fixme: simplify
-    (lib.filterAttrs (name: env: !env.private) environments);
+  #
+  # Example:
+  #   forEnvironments ({ environment, confKey, ... }: "key for ${environment} is ${confKey}")
+  #   => { demo = "key for demo is dev";
+  #        mainnet = "key for mainnet is mainnet_full";
+  #        staging = "key for staging is mainnet_dryrun_full";
+  #        testnet = "key for testnet is testnet_full"; }
+  forEnvironments = f: lib.mapAttrs
+    (name: env: f (env // { environment = name; }))
+    environments;
 
   runHaskell = name: hspkgs: deps: env: code: let
     ghc = hspkgs.ghcWithPackages deps;
@@ -93,6 +102,7 @@ in lib // (rec {
     ${builtBinary}/bin/$name
   '';
 
+  # Overrides the lib.commitIdFromGitRepo function in nixpkgs
   commitIdFromGitRepo = import ./nix/commit-id.nix { inherit lib; };
 
   # Plucks all the cardano-sl packages from the haskellPackages set,

scripts/test/acceptance/default.nix

@@ -18,7 +18,7 @@ let
   allDeps =  demoClusterDeps ++ cardanoDeps;
 
   wallet = connect {
-    inherit environment;
+    inherit environment stateDir;
 
     # This will limit heap size to 1GB, along with the usual RTS options.
     ghcRuntimeArgs = "-N2 -qg -A1m -I0 -T -M1G";