Enhance test coverage and CI workflow configuration

Author: MirkoZETA

.github/workflows/gke-cd.yml

@@ -1,44 +1,17 @@
-name: Test FNS API and deploy to Cloud Run
+name: Deploy to Cloud Run
 
 on:
   push:
     branches:
       - master
-      - feature/*
-      - develop
-  pull_request:
-    branches:
-      - master
-      - feature/*
-      - develop
 
 jobs:
-  test:
-    name: Run Backend Tests
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-
-      - name: Install dependencies
-        run: pip install -r requirements.txt
-
-      - name: Run tests
-        run: python -m unittest tests/test_backend.py
-
   build-and-push-image:
     name: Build and Push Docker Image
     runs-on: ubuntu-latest
-    needs: test
-    if: github.ref == 'refs/heads/master' # Condition: Only run on master branch
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Google Cloud Auth
         uses: google-github-actions/auth@v2
@@ -67,10 +40,9 @@ jobs:
     name: Deploy to Cloud Run
     runs-on: ubuntu-latest
     needs: build-and-push-image
-    if: github.ref == 'refs/heads/master' # Condition: Only run on master branch
     steps:
-      - name: Checkout code (again, if needed)
-        uses: actions/checkout@v2
+      - name: Checkout code
+        uses: actions/checkout@v3
 
       - name: Google Cloud Auth
         uses: google-github-actions/auth@v2

.github/workflows/test-coverage.yml

@@ -0,0 +1,49 @@
+name: Test Coverage
+
+on:
+  push:
+    branches:
+      - master
+      - feature/*
+      - develop
+  pull_request:
+    branches:
+      - master
+      - feature/*
+      - develop
+
+jobs:
+  test-coverage:
+    name: Run Tests with Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run tests with coverage
+        run: |
+          pytest --cov=backend --cov-report=xml --cov-report=html tests/
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+
+      - name: Deploy coverage report to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        if: github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/master'
+        with:
+          folder: htmlcov
+          branch: gh-pages
+          clean: true

README.md

@@ -3,6 +3,8 @@
 [![Static Badge](https://img.shields.io/badge/version-1.1.0-blue)](https://github.com/MirkoZETA/FlexNetSim-API)
 ![Static Badge](https://img.shields.io/badge/language-python-blue)
 [![Static Badge](https://img.shields.io/badge/licese-MIT-green)](https://github.com/MirkoZETA/FlexNetSim-API/blob/master/LICENSE)
+[![Test Coverage](https://github.com/MirkoZETA/FlexNetSim-API/actions/workflows/test-coverage.yml/badge.svg)](https://github.com/MirkoZETA/FlexNetSim-API/actions/workflows/test-coverage.yml)
+[![Coverage Report](https://img.shields.io/badge/coverage-report-blue)](https://mirkoZETA.github.io/FlexNetSim-API/)
 
 A lightweight API for running optical network simulations with [Flex Net Sim C++](https://gitlab.com/DaniloBorquez/flex-net-sim).
 

requirements.txt

@@ -1,4 +1,5 @@
 flask
 gunicorn
 pytest
+pytest-cov
 flask-testing