Merge pull request #184 from theuselessai/fix/drop-gherlint

theuseless-ai · web-flow · commit 67cc20a9e891 · 2026-03-21T07:29:04.000+10:30
refactor: drop gherlint, use pure Python AST lint checks
diff --git a/platform/components/validate_gherkin.py b/platform/components/validate_gherkin.py
@@ -1,12 +1,14 @@
-"""Validate Gherkin tool component — syntax parsing and lint checks."""
+"""Validate Gherkin tool component — syntax parsing and structural lint checks.
+
+Tier 1: Syntax validation via gherkin-official parser.
+Tier 2: Structural lint checks via pure Python against the parsed AST.
+No external lint tools or subprocess calls required.
+"""
 
 from __future__ import annotations
 
-import base64
 import json
 import logging
-import shlex
-import uuid
 
 from langchain_core.tools import tool
 
@@ -19,27 +21,6 @@
 def validate_gherkin_factory(node):
     """Return a LangChain tool that validates Gherkin .feature specs."""
 
-    # Resolve parent workspace and build sandbox backend (same pattern as run_command)
-    from components.run_command import _resolve_parent_workspace
-    from components._agent_shared import _build_backend
-
-    parent_extra = _resolve_parent_workspace(node)
-    backend = None
-    if parent_extra.get("workspace_id"):
-        try:
-            backend = _build_backend(parent_extra)
-            logger.info(
-                "validate_gherkin %s: using sandbox backend (workspace_id=%s)",
-                node.node_id,
-                parent_extra["workspace_id"],
-            )
-        except Exception:
-            logger.warning(
-                "validate_gherkin %s: failed to build sandbox backend, lint checks will be skipped",
-                node.node_id,
-                exc_info=True,
-            )
-
     @tool
     def validate_gherkin(gherkin_spec: str) -> str:
         """Validate a Gherkin feature spec for syntax errors and lint warnings.
@@ -71,15 +52,13 @@ def validate_gherkin(gherkin_spec: str) -> str:
             from gherkin.parser import Parser
 
             parser = Parser()
-            parser.parse(gherkin_spec)
+            doc = parser.parse(gherkin_spec)
         except Exception as e:
             result["valid"] = False
             error_info = {"message": str(e), "line": 0}
-            # Try to extract line number from the error message
             err_str = str(e)
             if "(" in err_str and ":" in err_str:
                 try:
-                    # gherkin-official errors often contain "(line:col)" patterns
                     parts = err_str.split("(")
                     for part in parts:
                         if ":" in part and ")" in part:
@@ -92,106 +71,134 @@ def validate_gherkin(gherkin_spec: str) -> str:
             result["parse_errors"].append(error_info)
             return json.dumps(result)
 
-        # ── Tier 2: Lint via gherlint CLI (sandboxed) ────────────────────
-        if backend is not None:
-            try:
-                # Encode content as base64 so arbitrary Gherkin can be safely
-                # embedded in a shell command without quoting issues.
-                encoded = base64.b64encode(gherkin_spec.encode()).decode()
-                temp_filename = f"/tmp/_validate_gherkin_{uuid.uuid4().hex}.feature"
-                cmd = (
-                    f"echo {shlex.quote(encoded)} | base64 -d > {shlex.quote(temp_filename)}"
-                    f" && gherlint lint {shlex.quote(temp_filename)}"
-                    f"; STATUS=$?; rm -f {shlex.quote(temp_filename)}; exit $STATUS"
-                )
-                resp = backend.execute(cmd, timeout=30)
-                _parse_gherlint_output(resp.output or "", "", resp.exit_code or 0, result)
-            except Exception:
-                logger.warning("gherlint lint failed", exc_info=True)
-        else:
-            logger.debug("validate_gherkin: no sandbox backend, skipping lint checks")
+        # ── Tier 2: Structural lint checks against parsed AST ────────────
+        _lint_ast(doc, result)
 
         return json.dumps(result)
 
     return validate_gherkin
 
 
-def _parse_gherlint_output(
-    stdout: str, stderr: str, returncode: int, result: dict
-) -> None:
-    """Parse gherlint CLI output and populate result dict."""
-    output = (stdout + "\n" + stderr).strip()
-    if not output:
+def _lint_ast(doc: dict, result: dict) -> None:
+    """Run structural lint checks against a parsed Gherkin AST."""
+    feature = doc.get("feature")
+
+    if not feature:
+        result["lint_errors"].append({
+            "code": "E001",
+            "message": "No Feature block found",
+            "line": 0,
+        })
+        result["valid"] = False
         return
 
-    for line in output.splitlines():
-        line = line.strip()
-        if not line:
-            continue
+    # Check feature has a name
+    if not feature.get("name", "").strip():
+        result["lint_warnings"].append({
+            "code": "W001",
+            "message": "Feature has no name",
+            "line": feature.get("location", {}).get("line", 0),
+        })
+
+    children = feature.get("children", [])
+    scenarios = [c for c in children if "scenario" in c]
+    backgrounds = [c for c in children if "background" in c]
+
+    # Check feature has scenarios
+    if not scenarios:
+        result["lint_warnings"].append({
+            "code": "W002",
+            "message": "Feature has no scenarios",
+            "line": feature.get("location", {}).get("line", 0),
+        })
+        return
+
+    # Check for duplicate scenario names
+    seen_names: dict[str, int] = {}
+    for child in scenarios:
+        sc = child["scenario"]
+        name = sc.get("name", "").strip()
+        line = sc.get("location", {}).get("line", 0)
+        if name:
+            if name in seen_names:
+                result["lint_warnings"].append({
+                    "code": "W003",
+                    "message": f"Duplicate scenario name: '{name}' (first at line {seen_names[name]})",
+                    "line": line,
+                })
+            else:
+                seen_names[name] = line
+
+    # Check each scenario
+    for child in scenarios:
+        sc = child["scenario"]
+        name = sc.get("name", "").strip()
+        line = sc.get("location", {}).get("line", 0)
+        steps = sc.get("steps", [])
+
+        # Unnamed scenario
+        if not name:
+            result["lint_warnings"].append({
+                "code": "W004",
+                "message": "Scenario has no name",
+                "line": line,
+            })
 
-        # gherlint output format is typically:
-        # filename:line:col: CODE message
-        # or just warning/error messages
-        entry = _parse_lint_line(line)
-        if entry is None:
+        # Empty scenario
+        if not steps:
+            result["lint_warnings"].append({
+                "code": "W005",
+                "message": f"Scenario '{name or '(unnamed)'}' has no steps",
+                "line": line,
+            })
             continue
 
-        code = entry.get("code", "")
-        # Convention: Cxxx = convention, Wxxx = warning, Exxx = error
-        if code.startswith("E"):
-            result["lint_errors"].append(entry)
-            result["valid"] = False
-        else:
-            # W, C, and other codes are treated as warnings
-            result["lint_warnings"].append(entry)
-
-
-def _parse_lint_line(line: str) -> dict | None:
-    """Parse a single gherlint output line into a structured dict.
-
-    Expected formats:
-        filename.feature:10:1: C0101 Step should start with a capital letter
-        filename.feature:5: W0301 Scenario has no Given step
-        C0101: Step should start with a capital letter (line 10)
-    """
-    # Format: path:line:col: CODE message
-    parts = line.split(":", maxsplit=3)
-    if len(parts) >= 4:
-        try:
-            line_no = int(parts[1].strip())
-            remainder = parts[3].strip()
-            code, _, message = remainder.partition(" ")
-            if code and code[0].isalpha() and any(c.isdigit() for c in code):
-                return {"code": code, "message": message.strip(), "line": line_no}
-        except (ValueError, IndexError):
-            pass
-
-    # Format: path:line: CODE message (no column)
-    if len(parts) >= 3:
-        try:
-            line_no = int(parts[1].strip())
-            remainder = parts[2].strip()
-            code, _, message = remainder.partition(" ")
-            if code and code[0].isalpha() and any(c.isdigit() for c in code):
-                return {"code": code, "message": message.strip(), "line": line_no}
-        except (ValueError, IndexError):
-            pass
-
-    # Format: CODE: message (line N) or CODE message
-    if line and line[0].isalpha():
-        code_part = line.split()[0].rstrip(":")
-        if any(c.isdigit() for c in code_part):
-            message = line[len(code_part):].strip().lstrip(": ")
-            line_no = 0
-            # Try to extract (line N) from message
-            if "(line" in message:
-                try:
-                    idx = message.index("(line")
-                    num = message[idx + 5:].split(")")[0].strip()
-                    line_no = int(num)
-                    message = message[:idx].strip()
-                except (ValueError, IndexError):
-                    pass
-            return {"code": code_part, "message": message, "line": line_no}
+        # Extract keyword types (Given, When, Then, And, But, *)
+        keywords = [s.get("keyword", "").strip() for s in steps]
+
+        # Check for missing Given
+        if "Given" not in keywords:
+            result["lint_warnings"].append({
+                "code": "C001",
+                "message": f"Scenario '{name or '(unnamed)'}' has no Given step",
+                "line": line,
+            })
+
+        # Check for missing When
+        if "When" not in keywords:
+            result["lint_warnings"].append({
+                "code": "C002",
+                "message": f"Scenario '{name or '(unnamed)'}' has no When step",
+                "line": line,
+            })
+
+        # Check for missing Then
+        if "Then" not in keywords:
+            result["lint_warnings"].append({
+                "code": "C003",
+                "message": f"Scenario '{name or '(unnamed)'}' has no Then step",
+                "line": line,
+            })
+
+    # Check backgrounds
+    for child in backgrounds:
+        bg = child["background"]
+        bg_steps = bg.get("steps", [])
+        bg_line = bg.get("location", {}).get("line", 0)
+
+        if not bg_steps:
+            result["lint_warnings"].append({
+                "code": "W006",
+                "message": "Background has no steps",
+                "line": bg_line,
+            })
 
-    return None
+        # Background should only contain Given steps
+        for step in bg_steps:
+            kw = step.get("keyword", "").strip()
+            if kw not in ("Given", "And", "But", "*"):
+                result["lint_warnings"].append({
+                    "code": "C004",
+                    "message": f"Background contains non-Given step: '{kw}'",
+                    "line": step.get("location", {}).get("line", 0),
+                })
diff --git a/platform/requirements.txt b/platform/requirements.txt
@@ -24,10 +24,6 @@ requests>=2.31
 jinja2>=3.1
 pyotp>=2.9
 gherkin-official>=29.0.0
-# gherlint is used via subprocess (CLI), NOT as a Python import.
-# It requires pydantic v1 which conflicts with our stack.
-# Install separately: pipx install gherlint
-# The validate_gherkin tool gracefully handles gherlint being absent.
 
 # Testing
 pytest>=8.0
diff --git a/platform/tests/test_validate_gherkin.py b/platform/tests/test_validate_gherkin.py
