Merge pull request #8 from alexandre-eymael/sprint5-cicd-pytest

Sprint5 cicd pytest

Author: alexandre-eymael

.github/workflows/pytest.yml

@@ -0,0 +1,28 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Pytest
+
+on: [push]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10.13
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10.13"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements/tests/requirements.txt
+    - name: Test with pytest
+      run: |
+        pytest tests/

requirements/tests/requirements.txt

@@ -0,0 +1,2 @@
+pytest
+requests

tests/test_api.py

@@ -0,0 +1,27 @@
+"""
+Tests for the API
+"""
+
+import requests
+
+URLS_API = ["http://hessian.be/api", "http://hessian.be/api/billing"]
+
+def test_api_status():
+    """
+    Test that the API is:
+        (1) reachable
+        (2) available (i.e. returns status code 200)
+    """
+
+    for url in URLS_API:
+
+        # (1) Check if the API is reachable
+        try:
+            response = requests.get(url, timeout=5)
+        except requests.exceptions.RequestException as e:
+            error = f"Error occured while trying to API `{url}`: {e}"
+            raise requests.exceptions.RequestException(error)
+
+        # (2) Check if the API is available
+        assert response.status_code == 200, \
+            f"API `{url}` is reachable but returned status code {response.status_code}"