Nix builds work (#39)

robcohen · web-flow · commit 53ef851c494c · 2018-07-27T00:23:10.000-04:00
* Changes to CI.md

* changed CI notes and nixpkgs

* attempt to fix universum issue, still persisting

* default.nix finally overrides universum correctly

* nixpkgs back to cardano-sl nixpkgs

* table added for files

* Improved file descriptions

* minor comment

* reformatting

* reformatting

* changed a few sections on nixpkgs-src

* detailed instructions

* detailed instructions fix

* CI resources

* CI resources

* Detailed which files are unchanged from cardano sl

* minor fixes to docs

* Modify change

* reorg

* fixed quotes

* quote fix

* deleted repetitive parts

* Minor changes to install and readme

* Nix instructions added

* Minor correction

* Minor rename

* jq command is better

* minor rephasing
diff --git a/CI-NIX.md b/CI-NIX.md
@@ -0,0 +1,68 @@
+# Buildkite & Nix Builds
+
+## Buildkite
+The buildkite pipeline is automatically triggered by any commits that are pushed to the log-classifier repo.
+The pipeline that is executed is located in the .buildkite folder.
+
+
+## Nix related files and their purposes
+
+| File | How to Make | Description |
+| --- | --- | --- |
+| default.nix | Manually | Contains the primary nix expression used to build log-classifier. This is likely the only nix expression that a developer may need to modify. |
+| cabal2nix.nix | `$ cabal2nix . > cabal2nix.nix` | The cabal2nix generated output from the log-classifier.cabal file. |
+| fetch-nixpkgs.nix | [cardano sl](https://github.com/input-output-hk/cardano-sl) | Used for pinning a specific version of nixpkgs. Reads nixpkgs-src.json. |
+| fetchNixpkgs.nix | [cardano sl](https://github.com/input-output-hk/cardano-sl) | Used for pinning a specific version of nixpkgs. Verifies and pulls nixpkgs. |
+| lib.nix | [cardano sl](https://github.com/input-output-hk/cardano-sl) | Used for pinning a specific verison of nixpkgs. Checks for cardano sl pkgs and runs fetch-nixpkgs.nix otherwise. |
+| shell.nix | Manually | Used by nix-shell to set nix environment. |
+| universum.nix | `$ cabal2nix cabal://universum-1.1.0 > universum.nix` | Created by cabal2nix, essentially overrides the Universum in nixpkgs. |
+| nixpkgs-src.json | See Below | Where version of nixpkgs is defined. See below for instructions to update. |
+
+## Developing / Building via Nix
+
+These are the instructions for using nix to build log-classifier.
+
+All the commands below are executed in the cloned log-classifier directory.
+
+```
+$ nix build -f default.nix
+```
+
+You can also build within nix-shell: 
+
+```
+$ nix-shell
+nix-shell $ runhaskell Setup.hs configure
+nix-shell $ runhaskell Setup.hs build
+```
+
+If you would prefer to use the repl:
+```
+$ nix-env -f '<nixpkgs>' -iA haskellPackages.ghcid
+$ nix-shell
+nix-shell $ ghcid -c "runhaskell Setup.hs repl Lib" # or replace log-classifier-exe if preferred
+```
+
+### To change version of nixpkgs
+
+Get $REV from https://howoldis.herokuapp.com/ (click commit, copy the string next to commit)
+
+```
+$ REV="d7d31fea7e7eef8ff4495e75be5dcbb37fb215d0"
+$ cat ./nixpkgs-src.json | jq ".rev = \"${REV}\"" | \
+jq ".sha256 = \"`nix-prefetch-url https://github.com/nixos/nixpkgs/archive/${REV}.tar.gz`\"" | \
+jq ".sha256unpacked = \"`nix-prefetch-url --unpack https://github.com/nixos/nixpkgs/archive/${REV}.tar.gz`\""
+```
+
+### To get versions of haskell packages
+```
+nix-shell --run 'ghc-pkg list' | grep universum
+```
+
+## Useful Nix Resources
+
+- [Nix by example](https://medium.com/@MrJamesFisher/nix-by-example-a0063a1a4c55)
+- [Nix Cheatsheet](https://nixos.wiki/wiki/Cheatsheet)
+- [Pinning Nixpkgs](https://nixos.wiki/wiki/FAQ/Pinning_Nixpkgs)
+- [Nix Overrides](https://nixos.org/nixpkgs/manual/#sec-overrides)
+- [How I Develop with Nix](https://ocharles.org.uk/posts/2014-02-04-how-i-develop-with-nixos.html)
diff --git a/CI.md b/CI.md
diff --git a/INSTALL.md b/INSTALL.md
@@ -2,11 +2,8 @@
 
 ---
 ## Prerequisites
+We presently support using either Stack or Nix:
 - [Stack](https://github.com/commercialhaskell/stack/blob/master/doc/install_and_upgrade.md)
-
----
-
-## Optional
 - [Nix](https://nixos.org/nix/download.html)
 
 ```
@@ -23,8 +20,6 @@ $ git clone https://github.com/input-output-hk/log-classifier.git /home/$USER/lo
 $ cd /home/$USER/log-classifier
 ```
 
-Congratulations, you have downloaded log-classifier.
-
 ## Configuring log-classifier
 You will need the following:
   - Numeric ID of the user assigned tickets you want to analyze ($ASSIGNED_TO)
@@ -44,3 +39,18 @@ NOTE: The -n is important, without it echo will append a newline char and it wil
 
 The above instructions are reflected in the simulated terminal below.
 ![Terminal Example](./log-classifier.svg)
+
+## Stack Instructons
+```
+$ stack build
+$ stack exec log-classifier-exe
+```
+
+## Nix Instructions (CI/Buildkite instructons as well)
+
+```
+$ nix-env -i -f default.nix 
+$ log-classifier-exe
+```
+
+Please see [CI](CI-NIX.md) for more detailed instructions pertaining to Nix.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Original version by Hiroto Shioi (https://github.com/HirotoShioi).
 The purpose of this project is to analyze Cardano log file and provide a solution to the end user while collecting statistics so Cardano developers can prioritize the issues.
 
 ## Installation and Configuration Instructions
-Please read the instructions available in [INSTALL.md](INSTALL.md)
+Installation Instructions are available at [INSTALL.md](INSTALL.md)
 
 ## What it is
 
diff --git a/default.nix b/default.nix
@@ -1,5 +1,17 @@
-let lib = import ./lib.nix;
+let
+  config = {
+    packageOverrides = pkgs: rec {
+      haskellPackages = pkgs.haskell.packages.ghc822.override {
+        overrides = haskellPackagesNew: haskellPackagesOld: rec {
+          universum =
+            haskellPackagesNew.callPackage ./universum.nix { };
+        };
+      };
+    };
+  };
 
-    pkgs = import lib.fetchNixPkgs {};
+  lib = import ./lib.nix;
+
+  pkgs = import lib.fetchNixPkgs {inherit config; };
 in
-  pkgs.haskell.packages.ghc822.callPackage ./cabal2nix.nix {}
+  pkgs.haskellPackages.callPackage ./cabal2nix.nix {}
diff --git a/universum.nix b/universum.nix
@@ -0,0 +1,27 @@
+{ mkDerivation, base, bytestring, containers, criterion, deepseq
+, doctest, ghc-prim, Glob, hashable, hedgehog, microlens
+, microlens-mtl, mtl, safe-exceptions, semigroups, stdenv, stm
+, tasty, tasty-hedgehog, text, text-format, transformers
+, type-operators, unordered-containers, utf8-string, vector
+}:
+mkDerivation {
+  pname = "universum";
+  version = "1.1.0";
+  sha256 = "177635a009f38edb8fc764bf9504077fb41af033c49b2a0ae2c725b55a9a2f4c";
+  libraryHaskellDepends = [
+    base bytestring containers deepseq ghc-prim hashable microlens
+    microlens-mtl mtl safe-exceptions stm text text-format transformers
+    type-operators unordered-containers utf8-string vector
+  ];
+  testHaskellDepends = [
+    base bytestring doctest Glob hedgehog tasty tasty-hedgehog text
+    utf8-string
+  ];
+  benchmarkHaskellDepends = [
+    base containers criterion deepseq hashable mtl semigroups text
+    unordered-containers
+  ];
+  homepage = "https://github.com/serokell/universum";
+  description = "Custom prelude used in Serokell";
+  license = stdenv.lib.licenses.mit;
+}
