Docstrings

Author: chr1st1ank

tests/test_flask.py

@@ -73,6 +73,7 @@ def log_exception():
 
 @pytest.mark.parametrize("level", ["debug", "info", "error"])
 def test_record_format_per_log_level(client_and_log_handler, level):
+    """Test if log messages are formatted correctly for all log levels"""
     api_client, handler = client_and_log_handler
 
     response = api_client.get("/log/levels/" + level)
@@ -92,6 +93,7 @@ def test_record_format_per_log_level(client_and_log_handler, level):
 
 
 def test_correlation_id_given(client_and_log_handler):
+    """Test if a given correlation ID is added to the logs"""
     api_client, handler = client_and_log_handler
 
     response = api_client.get("/log/levels/debug", headers={"X-Correlation-Id": "abc-def"})
@@ -104,6 +106,7 @@ def test_correlation_id_given(client_and_log_handler):
 
 
 def test_correlation_id_generated(client_and_log_handler):
+    """Test if a missing correlation ID is replaced by an autogenerated UUID"""
     api_client, handler = client_and_log_handler
 
     response = api_client.get("/log/levels/debug")
@@ -119,6 +122,7 @@ def test_correlation_id_generated(client_and_log_handler):
 
 
 def test_extra_property(client_and_log_handler):
+    """Test adding an extra property to a log message"""
     api_client, handler = client_and_log_handler
 
     response = api_client.get("/log/extra_property")
@@ -131,6 +135,7 @@ def test_extra_property(client_and_log_handler):
 
 
 def test_exception_logged_with_stack_trace(client_and_log_handler):
+    """Test if the details of a stack trace are logged"""
     api_client, handler = client_and_log_handler
 
     response = api_client.get("/log/exception")