Merge pull request #26 from MatrixAI/gitlab_ci_configuration

Setup gitlab ci

Author: CMCDragonkai

.gitlab-ci.yml

@@ -1,20 +1,41 @@
+variables:
+  GIT_SUBMODULE_STRATEGY: recursive
+
 stages:
+  - check
   - build
 
-cache:
-  key: ${CI_COMMIT_REF_SLUG}
-  paths:
-    - .cabal-sandbox
+image: registry.gitlab.com/matrixai/engineering/maintenance/gitlab-runner
+
+hlint:
+  stage: check
+  script:
+    - nix-shell --run 'hlint lint ./src ./app ./test'
+
+brittany:
+  stage: check
+  script:
+    - nix-shell --run "find ./src ./app ./test -type f -name '*.hs' -print0 | xargs -0 -I{} sh -c 'brittany --check-mode \"{}\" || echo \"{}\"; exit 1'"
+
+test:
+  stage: check
+  script:
+    - nix-shell --run 'cabal v2-test'
+
+nix-dry:
+  stage: check
+  script:
+    - nix-build -v -v --dry-run ./release.nix --attr library
+    - nix-build -v -v --dry-run ./release.nix --attr application
+    - nix-build -v -v --dry-run ./release.nix --attr docker
 
-cabal:
+nix:
   stage: build
-  image: haskell:8.6.5
   script:
-    - cabal update
-    - cabal sandbox init
-    - cabal install hpack
-    - cabal exec hpack
-    - cabal install --only-dependencies --enable-tests
-    - cabal configure --enable-tests
-    - cabal build
-    - cabal test
+    - >
+      nix-build ./release.nix
+      --attr library
+      --attr application
+      --attr docker
+  only:
+    - master

.hlint.yaml

@@ -0,0 +1,65 @@
+# HLint configuration file
+# https://github.com/ndmitchell/hlint
+##########################
+
+# This file contains a template configuration file, which is typically
+# placed as .hlint.yaml in the root of your project
+
+
+# Warnings currently triggered by your code
+- ignore: {name: "Redundant $"}
+- ignore: {name: "Reduce duplication"}
+
+
+# Specify additional command line arguments
+#
+# - arguments: [--color, --cpp-simple, -XQuasiQuotes]
+
+
+# Control which extensions/flags/modules/functions can be used
+#
+# - extensions:
+#   - default: false # all extension are banned by default
+#   - name: [PatternGuards, ViewPatterns] # only these listed extensions can be used
+#   - {name: CPP, within: CrossPlatform} # CPP can only be used in a given module
+#
+# - flags:
+#   - {name: -w, within: []} # -w is allowed nowhere
+#
+# - modules:
+#   - {name: [Data.Set, Data.HashSet], as: Set} # if you import Data.Set qualified, it must be as 'Set'
+#   - {name: Control.Arrow, within: []} # Certain modules are banned entirely
+#
+# - functions:
+#   - {name: unsafePerformIO, within: []} # unsafePerformIO can only appear in no modules
+
+
+# Add custom hints for this project
+#
+# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"
+# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}
+
+
+# Turn on hints that are off by default
+#
+# Ban "module X(module X) where", to require a real export list
+# - warn: {name: Use explicit module export list}
+#
+# Replace a $ b $ c with a . b $ c
+# - group: {name: dollar, enabled: true}
+#
+# Generalise map to fmap, ++ to <>
+# - group: {name: generalise, enabled: true}
+
+
+# Ignore some builtin hints
+# - ignore: {name: Use let}
+# - ignore: {name: Use const, within: SpecialModule} # Only within certain modules
+
+
+# Define some custom infix operators
+# - fixity: infixr 3 ~^#^~
+
+
+# To generate a suitable file for HLint do:
+# $ hlint --default > .hlint.yaml

app/ffi/Main.hs

@@ -1,16 +1,16 @@
 module Main where
 
-import qualified FFI as F
-import           Lib (someFunc)
+import qualified FFI                           as F
+import           Lib                            ( someFunc )
 
 main :: IO ()
 main = do
   time <- F.getTime
-  let foreignPi = F.getPi
-  let negPi = F.getNegPi
+  let foreignPi  = F.getPi
+  let negPi      = F.getNegPi
   let foreignSum = F.negAdd 1 2
-  putStrLn $ show time
-  putStrLn $ show foreignPi
-  putStrLn $ show negPi
-  putStrLn $ show foreignSum
+  print time
+  print foreignPi
+  print negPi
+  print foreignSum
   someFunc

app/library/Main.hs

@@ -52,7 +52,7 @@ bar' msg = L.runFileLoggingT "/tmp/demo.log" $ do
   $(L.logInfo) $ T.pack $ "[bar'] Got user input: " ++ msg
   -- get the logging action from caller's logging context
   logAction <- L.askLoggerIO
-  out <- liftIO $ runBarWithLogger (flip runLoggingT $ logAction) $ preBar msg
+  out       <- liftIO $ runBarWithLogger (`runLoggingT` logAction) $ preBar msg
   liftIO $ putStrLn out
 
 -- run runFooBarT and supply a file based logging capability

app/service/Main.hs

@@ -1,6 +1,6 @@
 module Main where
 
-import Demo as Demo
+import           Demo
 
 main :: IO ()
 main = Demo.runDemoApp

brittany.yaml

@@ -0,0 +1,14 @@
+conf_forward:
+  options_ghc:
+  - -XLambdaCase
+  - -XMultiWayIf
+  - -XGADTs
+  - -XPatternGuards
+  - -XViewPatterns
+  - -XRecursiveDo
+  - -XTupleSections
+  - -XExplicitForAll
+  - -XImplicitParams
+  - -XQuasiQuotes
+  - -XTemplateHaskell
+  - -XBangPatterns

pkgs.nix

@@ -1,4 +1,4 @@
 import (
-  let rev = "2867d1963aac8a5f587930644070b7d07e526db3"; in
+  let rev = "3b2c06909ea24573023a0cef192ab6b4d2936288"; in
   fetchTarball "https://github.com/NixOS/nixpkgs-channels/archive/${rev}.tar.gz"
 ) {}

release.nix

@@ -3,21 +3,18 @@
 with pkgs;
 let
   haskellPackages = haskell.packages.ghc865;
-  strict = drv: haskell.lib.buildStrictly drv;
   drv = haskellPackages.callPackage ./default.nix {
     hello = hello;
   };
 in
   rec {
     library = drv;
-    libraryStrict = strict drv;
     application = drv;
-    applicationStrict = strict drv;
     docker = dockerTools.buildImage {
-      name = applicationStrict.name;
-      contents = applicationStrict;
+      name = application.name;
+      contents = application;
       config = {
-        Cmd = [ "/bin/haskell-demo-exe" ];
+        Cmd = [ "/bin/haskell-demo-library-exe" ];
       };
     };
   }

shell.nix

@@ -13,6 +13,8 @@ in
       cabal-install
       cabal2nix
       hpack
+      hlint
+      brittany
     ]);
     shellHook = attrs.shellHook + ''
       echo 'Entering ${attrs.name}'

src/Demo.hs

@@ -62,8 +62,7 @@ newtype DemoT m a = DemoT
 type Demo = DemoT IO
 
 runDemo :: DemoEnv -> Demo a -> IO a
-runDemo env demo = do
-  L.runStderrLoggingT $ runReaderT (runDemoT demo) env
+runDemo env demo = L.runStderrLoggingT $ runReaderT (runDemoT demo) env
 
 warpApp :: Application
 warpApp req respond = E.bracket_