Merge pull request #93 from mlabs-haskell/marton/hercules-ci

switch to Hercules CI, add checks to flake

Author: szg251

.github/format.sh

@@ -25,8 +25,10 @@ usage:
 	@echo "  ghci                -- Run cabal v2-repl bot-plutus-interface"
 	@echo "  format              -- Apply source code formatting with fourmolu"
 	@echo "  format_check        -- Check source code formatting without making changes"
-	@echo "  nixfmt              -- Apply nix formatting with nixfmt"
-	@echo "  nixfmt_check        -- Check nix files for format errors"
+	@echo "  cabalfmt            -- Apply cabal formatting with cabal-fmt"
+	@echo "  cabalfmt_check      -- Check cabal files for formatting errors without making changes"
+	@echo "  nixpkgsfmt          -- Apply nix formatting with nixfmt"
+	@echo "  nixpkgsfmt_check    -- Check nix files for format errors"
 	@echo "  lint                -- Check the sources with hlint"
 	@echo "  readme_contents     -- Add table of contents to README"
 	@echo "  update_plutus       -- Update plutus version with niv"
@@ -68,7 +70,7 @@ ghci: requires_nix_shell
 	cabal v2-repl $(GHC_FLAGS) bot-plutus-interface
 
 # Source dirs to run fourmolu on
-FORMAT_SOURCES := $(shell git ls-tree -r HEAD --full-tree --name-only | grep -E '.*\.hs' )
+FORMAT_SOURCES := $(shell fd -e hs)
 
 # Extensions we need to tell fourmolu about
 FORMAT_EXTENSIONS := -o -XTemplateHaskell -o -XTypeApplications -o -XImportQualifiedPost -o -XPatternSynonyms -o -fplugin=RecordDotPreprocessor
@@ -81,14 +83,23 @@ format: requires_nix_shell
 format_check: requires_nix_shell
 	fourmolu --mode check --check-idempotence $(FORMAT_EXTENSIONS) $(FORMAT_SOURCES)
 
+# Cabal package definitions
+CABAL_SOURCES := $(shell fd -e cabal)
+
+cabalfmt: requires_nix_shell
+	cabal-fmt --inplace $(CABAL_SOURCES)
+
+cabalfmt_check: requires_nix_shell
+	cabal-fmt --check $(CABAL_SOURCES)
+
 # Nix files to format
-NIX_SOURCES := $(shell git ls-tree -r HEAD --full-tree --name-only | grep -E '.*\.nix' )
+NIX_SOURCES := $(shell fd -e nix)
 
-nixfmt: requires_nix_shell
-	nixfmt $(NIX_SOURCES)
+nixpkgsfmt: requires_nix_shell
+	nixpkgs-fmt $(NIX_SOURCES)
 
-nixfmt_check: requires_nix_shell
-	nixfmt --check $(NIX_SOURCES)
+nixpkgsfmt_check: requires_nix_shell
+	nixpkgsfmt --check $(NIX_SOURCES)
 
 # Check with hlint, currently I couldn't get --refactor to work
 lint: requires_nix_shell
@@ -124,4 +135,3 @@ update_plutus:
 build_path = dist-newstyle/build/x86_64-linux/ghc-8.10.4.20210212/bot-plutus-interface-0.1
 clear_build:
 	@[ ! -e $(build_path) ] || rm -rf $(build_path)
-

.github/workflows/integrate.yaml

@@ -87,6 +87,7 @@ main = do
           , -- | Slot configuration of the network, the default value can be used for the mainnet
             pcSlotConfig = def
           , pcOwnPubKeyHash = "0f45aaf1b2959db6e5ff94dbb1f823bf257680c3c723ac2d49f97546"
+          , pcOwnStakePubKeyHash = Nothing
           , -- Directory name of the script and data files
             pcScriptFileDir = "./scripts"
           , -- Directory for the signing key file(s)

Makefile

@@ -76,16 +76,17 @@ library
   import:          common-lang
   exposed-modules:
     BotPlutusInterface
+    BotPlutusInterface.Balance
     BotPlutusInterface.CardanoCLI
     BotPlutusInterface.ChainIndex
     BotPlutusInterface.Contract
     BotPlutusInterface.Effects
     BotPlutusInterface.Files
-    BotPlutusInterface.Balance
+    BotPlutusInterface.Helpers
+    BotPlutusInterface.Server
     BotPlutusInterface.Types
     BotPlutusInterface.UtxoParser
-    BotPlutusInterface.Server
-    BotPlutusInterface.Helpers
+
   build-depends:
     , aeson                      ^>=1.5.0.0
     , attoparsec                 >=0.13.2.2
@@ -145,10 +146,10 @@ test-suite bot-plutus-interface-test
   main-is:        Spec.hs
   ghc-options:    -fplugin-opt PlutusTx.Plugin:defer-errors
   other-modules:
-    Spec.BotPlutusInterface.Contract
     Spec.BotPlutusInterface.Balance
-    Spec.BotPlutusInterface.UtxoParser
+    Spec.BotPlutusInterface.Contract
     Spec.BotPlutusInterface.Server
+    Spec.BotPlutusInterface.UtxoParser
     Spec.MockContract
 
   build-depends:
@@ -198,8 +199,8 @@ test-suite bot-plutus-interface-test
     , tasty-quickcheck
     , temporary
     , text                       ^>=1.2.4.0
-    , uuid
     , utf8-string
+    , uuid
     , warp
 
   hs-source-dirs: test

README.md

@@ -76,12 +76,12 @@ library
   build-depends:
     , aeson                      ^>=1.5.0.0
     , attoparsec                 >=0.13.2.2
+    , bot-plutus-interface
     , bytestring                 ^>=0.10.12.0
     , cardano-api
     , cardano-crypto
     , cardano-ledger-alonzo
     , containers
-    , bot-plutus-interface
     , data-default
     , data-default-class
     , directory

bot-plutus-interface.cabal

@@ -328,14 +328,15 @@
             withHoogle = true;
             tools.haskell-language-server = {};
             exactDeps = true;
-            nativeBuildInputs = [
-              pkgs'.cabal-install
-              pkgs'.haskellPackages.cabal-fmt
-              pkgs'.haskellPackages.implicit-hie
-              pkgs'.hlint
-              pkgs'.haskellPackages.fourmolu
-              pkgs'.jq
-              pkgs'.websocat
+            nativeBuildInputs = with pkgs'; [
+              cabal-install
+              haskellPackages.cabal-fmt
+              haskellPackages.implicit-hie
+              haskellPackages.fourmolu
+              hlint
+              jq
+              websocat
+              fd
             ];
           };
           modules = haskellModules;
@@ -362,11 +363,21 @@
         (nixpkgsFor system).runCommand "combined-check" {
           nativeBuildInputs = builtins.attrValues self.checks.${system}
             ++ builtins.attrValues self.flake.${system}.packages
-            ++ [ self.devShell.${system}.inputDerivation ];
-        } "touch $out");
+            ++ [ self.devShell.${system}.inputDerivation self.devShell.${system}.nativeBuildInputs ];
+        } ''
+          cd ${self}
+          export LC_CTYPE=C.UTF-8
+          export LC_ALL=C.UTF-8
+          export LANG=C.UTF-8
+          export IN_NIX_SHELL='pure'
+          make format_check cabalfmt_check nixpkgsfmt_check lint
+          mkdir $out
+        '');
 
       # NOTE `nix flake check` will not work at the moment due to use of
       # IFD in haskell.nix
       checks = perSystem (system: self.flake.${system}.checks);
+
+      herculesCI.ciSystems = [ "x86_64-linux" ];
     };
 }