Add tests & coverage badges (#176)

* add coverage to ci & badge to readme

* fix poetry prefix

* fix working dir

* Update coverage badge

* restrict badge commit to one run

* create a separate job for badge

* move env to top

---------

Co-authored-by: github-actions <[email protected]>

.github/workflows/ci_api.yml

@@ -1,9 +1,17 @@
+name: Tests
+
 on:
   push:
     branches: [main]
   pull_request:
     branches: [main]
 
+env:
+  PROVIDER_URI_MAINNET: ${{ secrets.PROVIDER_URI_MAINNET }}
+  PROVIDER_URI_GOERLI: ${{ secrets.PROVIDER_URI_GOERLI }}
+  PROVIDER_URI_SEPOLIA: ${{ secrets.PROVIDER_URI_SEPOLIA }}
+
+
 jobs:
   test:
     runs-on: ${{ matrix.os }}
@@ -13,11 +21,6 @@ jobs:
         os: [ubuntu-latest]
         python-version: [3.9, 3.11]
 
-    env:
-      PROVIDER_URI_MAINNET: ${{ secrets.PROVIDER_URI_MAINNET }}
-      PROVIDER_URI_GOERLI: ${{ secrets.PROVIDER_URI_GOERLI }}
-      PROVIDER_URI_SEPOLIA: ${{ secrets.PROVIDER_URI_SEPOLIA }}
-
     steps:
       - uses: actions/checkout@v3
         with:
@@ -51,3 +54,45 @@ jobs:
       - name: Run tests
         working-directory: ./api
         run: MONKEYPATCH=0 poetry run pytest -vv --durations=0
+
+  add_badge:
+    runs-on: ubuntu-latest
+    needs: test
+    permissions:
+      contents: write
+
+    if: github.ref == 'refs/heads/main'  # run this job only on a push to main
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+          cache: "poetry"
+
+      - name: Install dependencies
+        working-directory: ./api
+        run: poetry install
+
+      - name: Run tests mocked
+        working-directory: ./api
+        run: poetry run pytest -vv --durations=0 --cov-report term-missing --cov=./
+
+      - name: Generate coverage badge
+        working-directory: ./api
+        run: poetry run coverage-badge -fo ../coverage_badge.svg
+
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v9
+        with:
+          author_name: github-actions
+          author_email: [email protected]
+          message: 'Update coverage badge'
+          add: 'coverage_badge.svg'

README.md

@@ -1,5 +1,8 @@
 # NameHash NameGuard
 
+![Tests](https://github.com/namehash/nameguard/actions/workflows/ci_api.yml/badge.svg?branch=main)
+![Coverage](https://raw.githubusercontent.com/namehash/nameguard/main/coverage_badge.svg)
+
 The NameHash team is proud to present NameGuard, a tool for identifying and preventing malicious use of ENS names.
 
 - Offers multiple levels of protection

api/pyproject.toml

@@ -33,6 +33,7 @@ uvicorn = {extras = ["standard"], version = "^0.23.2"}
 pytest-asyncio = "^0.21.1"
 pytest-cov = "^4.1.0"
 pytest-retry = "^1.5.0"
+coverage-badge = "^1.1.0"
 
 
 [build-system]