evm: include forge coverage report (#393)

fixes #334
unionlabs · Jul 28, 2023 · db24760 · db24760
2 parents 389ba65 + ee60ff3
commit db24760
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 30 deletions.
diff --git a/evm/contracts/apps/00-example/PingPong.sol → ...ntracts/apps/ucs/00-pingpong/PingPong.sol b/evm/contracts/apps/00-example/PingPong.sol → ...ntracts/apps/ucs/00-pingpong/PingPong.sol
@@ -1,7 +1,7 @@
 pragma solidity ^0.8.18;
 
-import "../Base.sol";
-import "../../core/25-handler/IBCHandler.sol";
+import "../../Base.sol";
+import "../../../core/25-handler/IBCHandler.sol";
 
 contract PingPong is IBCAppBase {
     IBCHandler private ibcHandler;

diff --git a/evm/evm.nix b/evm/evm.nix
@@ -1,5 +1,5 @@
 { ... }: {
-  perSystem = { self', inputs', pkgs, proto, forge, nix-filter, ... }:
+  perSystem = { self', inputs', pkgs, proto, nix-filter, ... }:
     let
       solidity-stringutils = pkgs.fetchFromGitHub {
         owner = "Arachnid";
@@ -84,7 +84,7 @@
       };
       wrappedForge = pkgs.symlinkJoin {
         name = "forge";
-        paths = [ forge ];
+        paths = [ pkgs.foundry-bin ];
         buildInputs = [ pkgs.makeWrapper ];
         postBuild = ''
           wrapProgram $out/bin/forge \
@@ -94,23 +94,6 @@
              ${pkgs.lib.foldlAttrs (acc: name: value: "${acc} --set-default ${name} '${value}'") "" foundryEnv}
         '';
       };
-      mkEvmContracts = pkgs.stdenv.mkDerivation {
-        name = "evm-contracts";
-        src = evmSources;
-        buildInputs = [ wrappedForge ];
-        buildPhase = ''
-          forge build --revert-strings debug
-        '';
-        doCheck = true;
-        checkPhase = ''
-          forge test --revert-strings debug -vvv --gas-report
-        '';
-        installPhase = ''
-          mkdir -p $out
-          mv out $out
-          mv cache $out
-        '';
-      };
 
       do-deploy = { where, rpc-url, private-key }:
         let
@@ -217,7 +200,38 @@
             '';
         };
 
-        evm-contracts = mkEvmContracts;
+        evm-contracts = pkgs.stdenv.mkDerivation {
+          name = "evm-contracts";
+          src = evmSources;
+          buildInputs = [ wrappedForge ];
+          buildPhase = ''
+            forge build --revert-strings debug
+          '';
+          doCheck = true;
+          checkPhase = ''
+            forge --version
+            forge test --revert-strings debug -vvv --gas-report
+          '';
+          installPhase = ''
+            mkdir -p $out
+            mv out $out
+            mv cache $out
+          '';
+        };
+
+        evm-coverage =
+          pkgs.runCommand "evm-coverage.log"
+            {
+              buildInputs = [ wrappedForge pkgs.lcov ];
+            } "forge coverage --ir-minimum --report lcov && genhtml lcov.info -o $out --branch-coverage";
+
+        show-evm-coverage = pkgs.writeShellApplication {
+          name = "show-evm-coverage";
+          runtimeInputs = [ wrappedForge ];
+          text = ''
+            xdg-open ${self'.packages.evm-coverage}/index.html
+          '';
+        };
       } //
       builtins.listToAttrs (
         builtins.map

diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -19,7 +19,8 @@
       inputs.nixpkgs.follows = "nixpkgs";
     };
     foundry = {
-      url = "github:shazow/foundry.nix/monthly";
+      # Move back to monthly branch after 08 2023 as they fixed a coverage issue between 07-08
+      url = "github:shazow/foundry.nix/main";
       inputs.nixpkgs.follows = "nixpkgs";
     };
     rust-overlay = {
@@ -103,6 +104,7 @@
                 overlays = with inputs; [
                   rust-overlay.overlays.default
                   iohk-nix.overlays.crypto
+                  foundry.overlay
                 ];
               };
 
@@ -126,8 +128,6 @@
                 };
               };
 
-              forge = foundry.defaultPackage.${system};
-
               nix-filter = nix-filter.lib;
 
               proto = {
@@ -264,8 +264,8 @@
               });
               evm = pkgs.mkShell (baseShell // {
                 buildInputs = baseShell.buildInputs ++ [
-                  foundry.defaultPackage.${system}
                   pkgs.solc
+                  pkgs.foundry-bin
                   pkgs.go-ethereum
                 ];
               });