Merge pull request #26 from iExecBlockchainComputing/feature/coverage

Display coverage in Github PR checks

Author: james-toussaint

.github/workflows/coverage.yml

@@ -0,0 +1,31 @@
+on:
+  pull_request:
+    branches:
+      - develop
+      - main
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Init
+        run: npm ci
+      - name: Run Coverage
+        run: (npm run coverage 2>&1) | tee /tmp/coverage.out | cat
+      - name: Extract coverage
+        run: echo "COVERAGE=$(cat /tmp/coverage.out | grep "Global test coverage")" >> $GITHUB_ENV
+      - name: Display coverage in Github PR checks
+        # See https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28#create-a-check-run
+        # and https://www.kenmuse.com/blog/creating-github-checks/
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: | # TODO: Set "failure" conclusion if coverage is too low
+          curl -L -X POST \
+           -H "Accept: application/vnd.github+json" \
+           -H "Authorization: Bearer $GH_TOKEN"\
+           -H "X-GitHub-Api-Version: 2022-11-28" \
+           https://api.github.com/repos/${{ github.repository }}/check-runs \
+           -d '{"name":"Coverage ratio", "head_sha":"${{ github.event.pull_request.head.sha }}", "status":"completed", "conclusion":"success", "output":{"title":"${{env.COVERAGE}}", "summary":""}}'
+        

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## vNext
+- Display coverage in Github PR checks. (#26)
 - Add integration test suite. (#21)
 - Add unit test suite. (#20)
 

README.md

@@ -4,6 +4,16 @@ A subgraph to explore the PoCo smarcontracts
 
 [CHANGELOG](./CHANGELOG.md)
 
+# Setup coverage⁠
+
+> In order for Matchstick to check which handlers are being run, those handlers need to be exported from the test file.
+
+Check how to export handlers with [Matchstick - Test Coverage documentation](https://thegraph.com/docs/en/subgraphs/developing/creating/unit-testing-framework/#test-coverage).
+
+> [!NOTE]
+> Since Matchstick code coverage is in very early stages, Matchstick cannot check for branch coverage, but rely on the assertion that a given handler has been called.
+
+
 ## local dev
 
 run local services:

package.json

@@ -7,6 +7,7 @@
     "prepare": "husky",
     "codegen": "graph codegen subgraph.template.yaml",
     "test": "npm run codegen && graph test",
+    "coverage": "npm run codegen && graph test -- -c",
     "test-docker": "npm run codegen && docker run -it --rm -v $(pwd):/matchstick/subgraph rainprotocol/matchstick:main",
     "build": "npm run codegen && cp subgraph.template.yaml subgraph.yaml && graph build --network ${NETWORK_NAME:-bellecour}",
     "create": "graph create ${NETWORK_NAME:-bellecour}/poco --node ${GRAPHNODE_URL:-http://localhost:8020}",

test/Modules/IexecCategoryManager.test.ts

@@ -4,7 +4,7 @@
 import { ethereum } from '@graphprotocol/graph-ts';
 import { assert, describe, newTypedMockEventWithParams, test } from 'matchstick-as/assembly/index';
 import { CreateCategory } from '../../generated/Core/IexecInterfaceToken';
-import { handleCreateCategory } from '../../src/Modules/IexecCategoryManager';
+import { handleCreateCategory } from '../../src/Modules';
 
 describe('IexecCategoryManager', () => {
     test('Should handle CreateCategory', () => {
@@ -33,3 +33,5 @@ describe('IexecCategoryManager', () => {
         });
     });
 });
+
+export { handleCreateCategory };

test/Modules/IexecPoco.test.ts

@@ -40,3 +40,5 @@ describe('IexecPoco', () => {
         assert.fieldEquals('Transaction', transactionId, 'id', transactionId);
     });
 });
+
+export { handleDealSponsored };