feat(context): add more information to errors

Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>

Author: fzipi

src/secrules_parsing/parser.py

@@ -40,6 +40,7 @@ def process_rules(files, verbose=False, debug=False):
                 "line": e.line,
                 "col": e.col,
                 "message": e.message,
+                "context": e.context,
             }
         models.append(model)
     return models
@@ -86,7 +87,7 @@ def get_correctness(files, output_type, models):
                 )
             else:
                 print(
-                    f"Syntax invalid: Syntax error in line {e['line']} col {e['col']}: {e['message']}"
+                    f"Syntax invalid: Syntax error in line {e['line']} col {e['col']}: {e['message']} - {e['context']}"
                 )
             exitcode = 1
         else:
@@ -109,5 +110,6 @@ def process_from_str(str, verbose=False, debug=False):
             "line": e.line,
             "col": e.col,
             "message": e.message,
+            "context": e.context,
         }
     return model

tests/conftest.py

@@ -68,8 +68,14 @@ def assert_parse_success(parsed_result: Union[Any, Dict]) -> None:
         assert_parse_success(result)
         # Now safe to use result.rules
     """
-    assert not isinstance(parsed_result, dict), \
-        f"Parse failed: {parsed_result.get('message', 'Unknown error')} at line {parsed_result.get('line', '?')}"
+    if isinstance(parsed_result, dict):
+        context = parsed_result.get('context', '')
+        context_str = f" - Context: {context}" if context else ""
+        raise AssertionError(
+            f"Parse failed: {parsed_result.get('message', 'Unknown error')} "
+            f"at line {parsed_result.get('line', '?')} "
+            f"col {parsed_result.get('col', '?')}{context_str}"
+        )
 
 
 def get_rules_by_type(parsed_result: Any, rule_type: str) -> List[Any]:

tests/test_api.py

@@ -408,3 +408,124 @@ def test_setenv_without_value() -> None:
                 matches += 1
     assert matches == 1
 
+
+# Parse Error Context Tests
+
+
+def test_parse_error_includes_context_field() -> None:
+    """
+    Test that parse errors include the 'context' field
+    This verifies that error responses contain context information
+    """
+    rule_text = """
+    SecRule ARGS @rx "missing quotes
+    """
+    result = parser.process_from_str(rule_text)
+
+    # Should return error dict, not a model
+    assert isinstance(result, dict), "Expected parse error to return dict"
+
+    # Verify all error fields are present
+    assert 'line' in result, "Error should include line number"
+    assert 'col' in result, "Error should include column number"
+    assert 'message' in result, "Error should include error message"
+    assert 'context' in result, "Error should include context field"
+
+    # Verify context is not None or empty
+    assert result['context'] is not None, "Context should not be None"
+    assert len(str(result['context'])) > 0, "Context should not be empty"
+
+
+def test_parse_error_context_with_invalid_directive() -> None:
+    """
+    Test that invalid directive syntax provides context
+    """
+    rule_text = """
+    InvalidDirective ARGS "@rx test"
+    """
+    result = parser.process_from_str(rule_text)
+
+    assert isinstance(result, dict), "Expected parse error"
+    assert 'context' in result, "Error should include context"
+    assert result['line'] > 0, "Should have line number"
+    assert result['col'] > 0, "Should have column number"
+
+
+def test_parse_error_context_with_missing_operator() -> None:
+    """
+    Test that incomplete operator syntax provides context
+    """
+    rule_text = """
+    SecRule ARGS @ "id:1,deny"
+    """
+    result = parser.process_from_str(rule_text)
+
+    assert isinstance(result, dict), "Expected parse error"
+    assert 'context' in result, "Error should include context"
+    assert 'message' in result, "Error should include message"
+
+
+def test_parse_error_context_with_malformed_actions() -> None:
+    """
+    Test that malformed actions provide context
+    """
+    rule_text = """
+    SecRule ARGS "@rx test" "id:,phase:2"
+    """
+    result = parser.process_from_str(rule_text)
+
+    assert isinstance(result, dict), "Expected parse error"
+    assert 'context' in result, "Error should include context"
+    assert result['line'] > 0, "Should have line number"
+
+
+def test_parse_error_context_with_unclosed_quotes() -> None:
+    """
+    Test that unclosed quotes provide context
+    """
+    rule_text = """
+    SecRule ARGS "@rx test" "id:1,msg:'unclosed message
+    """
+    result = parser.process_from_str(rule_text)
+
+    assert isinstance(result, dict), "Expected parse error"
+    assert 'context' in result, "Error should include context"
+    assert 'line' in result, "Error should include line"
+    assert 'col' in result, "Error should include col"
+
+
+def test_successful_parse_does_not_return_dict() -> None:
+    """
+    Test that successful parses return model, not dict
+    This ensures we can distinguish between success and error
+    """
+    rule_text = """
+    SecRule ARGS "@rx test" "id:1,phase:2,deny"
+    """
+    result = parser.process_from_str(rule_text)
+
+    # Successful parse should NOT return a dict
+    assert not isinstance(result, dict), "Successful parse should return model, not dict"
+
+    # Should have rules attribute
+    assert hasattr(result, 'rules'), "Model should have rules attribute"
+    assert len(result.rules) > 0, "Should have at least one rule"
+
+
+def test_parse_error_context_multiline() -> None:
+    """
+    Test that parse errors in multiline rules include context
+    """
+    rule_text = """
+    SecRule ARGS "@rx test" \\
+        "id:1,\\
+        phase:2,\\
+        invalid_action_here,\\
+        deny"
+    """
+    result = parser.process_from_str(rule_text)
+
+    assert isinstance(result, dict), "Expected parse error"
+    assert 'context' in result, "Error should include context"
+    assert result['line'] > 0, "Should have line number"
+

tests/test_conftest_examples.py

@@ -123,6 +123,8 @@ def test_example_parse_error_handling():
     if isinstance(result, dict):
         assert 'message' in result
         assert 'line' in result
+        assert 'col' in result
+        assert 'context' in result  # NEW: context field added in recent update
         # Test passes - we expected a parse error
         return