chore(contracts): github workflow for contracts testing (#10)

Author: jaybuidl

.github/workflows/contracts-testing.yml

@@ -0,0 +1,60 @@
+name: Contracts Testing
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - "*"
+      
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Setup Node.js environment
+      uses: actions/setup-node@v2.5.1
+      with:
+        node-version: 16.x   
+        
+    - uses: actions/checkout@v2.4.0
+    
+    - name: Cache node modules
+      uses: actions/cache@v2.1.7
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: | 
+          ~/.npm
+          **/node_modules
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+          
+    #- name: Install parent dependencies
+    #  run: |
+    #    echo "current dir: $PWD"
+    #    yarn install
+             
+    - name: Install contracts dependencies
+      run: |
+        yarn workspace @kleros/kleros-v2-contracts install
+      
+    - name: Compile
+      run: |
+        npx hardhat compile
+      working-directory: contracts
+      
+    - name: Test with coverage
+      run: |         
+        npx hardhat coverage --solcoverjs ./.solcover.js --temp artifacts --testfiles \"./test/**/*.ts\"
+      working-directory: contracts
+
+    - name: Upload a build artifact
+      uses: actions/upload-artifact@v2.3.1
+      with:    
+        name: code-coverage-report    
+        path: contracts/coverage

README.md

@@ -9,6 +9,7 @@
 </p>
 
 <p align="center">
+  <a href="https://github.com/kleros/kleros-v2/actions/workflows/contracts-testing.yml"><img src="https://github.com/kleros/kleros-v2/actions/workflows/contracts-testing.yml/badge.svg" alt="Unit testing"></a>
   <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits"></a>
   <a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen Friendly"></a>
   <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="Styled with Prettier"></a>

contracts/.gitignore

@@ -1,6 +1,7 @@
 # Hardhat files
 cache
 artifacts
+coverage.json
 
 ## Hardhat typechain bindings/types
 typechain

contracts/.solcover.js

@@ -0,0 +1,19 @@
+/* eslint-disable node/no-extraneous-require */
+
+const shell = require("shelljs");
+
+// The environment variables are loaded in hardhat.config.ts
+
+module.exports = {
+  istanbulReporter: ["html"],
+  onCompileComplete: async function (_config) {
+    await run("typechain");
+  },
+  onIstanbulComplete: async function (_config) {
+    // We need to do this because solcover generates bespoke artifacts.
+    shell.rm("-rf", "./artifacts");
+    shell.rm("-rf", "./typechain");
+  },
+  providerOptions: {},
+  skipFiles: ["mocks", "test"],
+};