feat: add /health endpoint

* add a new route
* add CHANGELOG.md
* Update Dockerfile
* Update tests

Author: mansab

CHANGELOG.md

@@ -0,0 +1,15 @@
+## 2.2.0
+
+Added /health endpoint
+
+## 2.1.0
+
+Added Authentication functionality
+
+## 2.0.0
+
+Multi threading and improved performance
+
+## 1.0.0
+
+Initial Release

Dockerfile

@@ -18,6 +18,7 @@ WORKDIR /app
 
 COPY --from=build /usr/local/lib/python3.9/site-packages /usr/local/lib/python3.9/site-packages
 COPY app.py ./
+COPY CHANGELOG.md ./
 
 RUN chown -R app:app /app
 

app.py

@@ -1,11 +1,12 @@
 """App Module"""
 import os
+import re
 import logging
 from concurrent.futures import ThreadPoolExecutor
 
 import xml.etree.ElementTree as ET
 import requests
-from flask import Flask, request, make_response
+from flask import Flask, request, make_response, jsonify
 from flask_basicauth import BasicAuth
 
 logging.basicConfig(level=logging.INFO)
@@ -149,6 +150,29 @@ def index():
     return response
 
 
+@app.route('/health')
+def health():
+    """Endpoint for checking the health status.
+
+    Returns:
+        flask.Response: JSON response containing the status and version.
+    """
+
+    with open('CHANGELOG.md', 'r', encoding='utf-8') as changelog_file:
+        changelog_content = changelog_file.read()
+
+    latest_version_match = re.search(r'##\s*(\d+\.\d+\.\d+)', changelog_content)
+    latest_version = latest_version_match.group(1) if latest_version_match else 'Unknown'
+
+
+    response = {
+        'status': 'ok',
+        'version': f'{latest_version}'
+    }
+
+    return jsonify(response)
+
+
 @app.errorhandler(Exception)
 def handle_error(exception):
     """Error handler for handling exceptions raised in the application.

tests/test_app.py

@@ -17,6 +17,12 @@ def setUp(self):
             'Authorization': 'Basic dXNlcjpwYXNz'
         }
 
+    def test_health_endpoint(self):
+        """Test health check status & version in the health route."""
+        response = self.client.get('/health')
+        self.assertEqual(response.status_code, 200)
+        self.assertIn(b'{"status":"ok","version":"2.2.0"}', response.data)
+
     def test_index_missing_parameters(self):
         """Test handling missing parameters in the index route."""
         response = self.client.get('/', headers=self.headers)