From 04e2e35b563958c15637120143a50d337d66568f Mon Sep 17 00:00:00 2001
From: jeandut <jean.du-terrail@owkin.com>
Date: Wed, 23 Oct 2024 19:27:11 +0200
Subject: [PATCH] Trying to add coverage report (#60)

* Update README.md

* Update README.md

* trying to have a CI with coverage

* Update .github/workflows/pr_validation.yml

* adding badges folder

* Update pr_validation.yml

* Update pr_validation.yml

* Update pr_validation.yml

* Update .github/workflows/pr_validation.yml

* Update pr_validation.yml

* update coverage badge

* Update README.md

---------

Co-authored-by: jeandut <jeandut@users.noreply.github.com>
---
 .github/workflows/pr_validation.yml | 32 ++++++++++++++++++++++++++---
 README.md                           |  3 ++-
 badges/.gitkeep                     |  0
 badges/cov_badge.svg                |  1 +
 4 files changed, 32 insertions(+), 4 deletions(-)
 create mode 100644 badges/.gitkeep
 create mode 100644 badges/cov_badge.svg

diff --git a/.github/workflows/pr_validation.yml b/.github/workflows/pr_validation.yml
index ebfc02f3..68dd3c5c 100644
--- a/.github/workflows/pr_validation.yml
+++ b/.github/workflows/pr_validation.yml
@@ -47,10 +47,10 @@ jobs:
         python: ["3.9"]
         # python: ["3.9", "3.10", "3.11"]  # TODO: expand to other pythons
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
         with:
-          python-version: ${{ matrix.python }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -67,3 +67,29 @@ jobs:
           name: test-coverage-report
           path: htmlcov/
           retention-days: 20
+      - name: Generate coverage status badge
+        if: github.event_name == 'pull_request'
+        run: |
+          set -x
+          total_cov=`grep -Eo '<span class="pc_cov">[0-9]+%</span>' htmlcov/index.html | grep -oe '\([0-9.]*\)'`
+          echo $total_cov
+          if [ "$total_cov" -le "50" ] ; then
+          COLOR=red
+          elif [ "$total_cov" -ge "90" ] ; then
+          COLOR=green
+          else
+          COLOR=orange
+          fi
+          echo $COLOR
+          echo "https://img.shields.io/badge/coverage-${total_cov}%25-${COLOR}"
+          curl "https://img.shields.io/badge/coverage-${total_cov}%25-${COLOR}" > badges/cov_badge.svg
+          echo "" >> badges/cov_badge.svg
+
+      - name: Commit coverage badge
+        if: github.event_name == 'pull_request'
+        uses: EndBug/add-and-commit@v9
+        with:
+          add: badges/cov_badge.svg
+          default_author: github_actor
+          pull: "--no-rebase"
+          message: "update coverage badge"
diff --git a/README.md b/README.md
index 92a0c822..68593e0c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 # FedECA
+<img src="/badges/cov_badge.svg" >
 
 :arrow_right:[The API doc is available here](https://owkin.github.io/fedeca/):arrow_left:
 
@@ -59,4 +60,4 @@ archivePrefix = {arXiv},
       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }
 
-```
\ No newline at end of file
+```
diff --git a/badges/.gitkeep b/badges/.gitkeep
new file mode 100644
index 00000000..e69de29b
diff --git a/badges/cov_badge.svg b/badges/cov_badge.svg
new file mode 100644
index 00000000..704c1cce
--- /dev/null
+++ b/badges/cov_badge.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="96" height="20" role="img" aria-label="coverage: 44%"><title>coverage: 44%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="96" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="35" height="20" fill="#e05d44"/><rect width="96" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="775" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="250">44%</text><text x="775" y="140" transform="scale(.1)" fill="#fff" textLength="250">44%</text></g></svg>