2023.1 release notes

Implements #3, a /ping endpoint

See merge request ruben/jail2ban-pf!5

CHANGELOG

@@ -0,0 +1,3 @@
+- 2023.1
+
+* Implement #3, a /ping health check endpoint

jail2ban/__init__.py

@@ -42,6 +42,15 @@ def create_app():
                 check_password_hash(users.get(username), password):
             return username
 
+    @app.route("/ping", methods=['GET'])
+    @auth.login_required
+    def ping():
+        remote_user = auth.username()
+        app.logger.info('Received ping for'
+                        f' anchor f2b-jail/{remote_user}')
+        return jsonify({'anchor': f'f2b-jail/{remote_user}',
+                        'operation': 'ping',
+                        'result': 'pong'})
     @app.route("/flush/<name>", methods=['GET'])
     @auth.login_required
     def flush(name):

tests/test_ping.py

@@ -0,0 +1,10 @@
+def test_ping(client, mocker, valid_credentials):
+    '''
+    Test application health check
+    '''
+
+    response = client.get("/ping",
+                          headers={"Authorization":
+                                   "Basic " + valid_credentials})
+
+    assert response.json['operation'] == 'ping'