test_func_pattern.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_linter/test_func_pattern.py
 
"""
Purpose
-------
Validate the linter's func = "..." pattern detection logic.
 
Responsibilities
----------------
- Confirm that compliant files pass check_func_pattern().
- Confirm that non-compliant files fail check_func_pattern() with a
  useful error message.
- Confirm that trivial files (< 20 lines) are exempt from the check.
- Confirm that functions with no _dbg() calls are not flagged.
 
Diagnostics
-----------
Domain: LINTER-TESTS
L2: test lifecycle
L3: assertion details
L4: deep tracing
 
Contracts
---------
Inputs:  temp_project_root pytest fixture (conftest.py)
Outputs: pass/fail assertions
"""
 
from pathlib import Path
from oct.linter import oct_lint
 
 
def test_func_pattern_valid(temp_project_root: Path):
    """Files where every _dbg()-using function defines func = "..." pass."""
    fixture = temp_project_root / "tests_linter" / "fixtures" / "dbg_with_func.py"
    text = fixture.read_text(encoding="utf-8")
    ok, msg = oct_lint.check_func_pattern(text)
    assert ok, f"Expected PASS but got: {msg}"
 
 
def test_func_pattern_missing(temp_project_root: Path):
    """Files where _dbg() is called without a preceding func = "..." fail."""
    fixture = temp_project_root / "tests_linter" / "fixtures" / "dbg_without_func.py"
    text = fixture.read_text(encoding="utf-8")
    ok, msg = oct_lint.check_func_pattern(text)
    assert not ok
    assert "func" in msg.lower()
    assert "process" in msg or "helper" in msg
 
 
def test_func_pattern_trivial_exempt(temp_project_root: Path):
    """Files under 20 lines are exempt — same threshold as check_dbg_usage."""
    short_text = "#!/usr/bin/env python3\ndef f():\n    _dbg('L2', 'x')\n"
    ok, msg = oct_lint.check_func_pattern(short_text)
    assert ok
    assert msg == "trivial"
 
 
def test_func_pattern_no_dbg_calls(temp_project_root: Path):
    """Functions that never call _dbg() do not need func = '...'."""
    fixture = temp_project_root / "tests_linter" / "fixtures" / "minimal_valid.py"
    text = fixture.read_text(encoding="utf-8")
    ok, msg = oct_lint.check_func_pattern(text)
    assert ok
 
 
def test_func_pattern_decorated(temp_project_root: Path):
    """Decorated functions with correct func = '...' + _dbg() pass."""
    fixture = temp_project_root / "tests_linter" / "fixtures" / "decorated_func.py"
    text = fixture.read_text(encoding="utf-8")
    ok, msg = oct_lint.check_func_pattern(text)
    assert ok, f"Expected PASS but got: {msg}"
 
 
def test_func_pattern_async(temp_project_root: Path):
    """Async functions with correct func = '...' + _dbg() pass."""
    fixture = temp_project_root / "tests_linter" / "fixtures" / "async_func.py"
    text = fixture.read_text(encoding="utf-8")
    ok, msg = oct_lint.check_func_pattern(text)
    assert ok, f"Expected PASS but got: {msg}"
 
 
def test_func_pattern_nested_inner_missing(temp_project_root: Path):
    """Nested function missing func = '...' fails independently of outer."""
    fixture = temp_project_root / "tests_linter" / "fixtures" / "nested_func.py"
    text = fixture.read_text(encoding="utf-8")
    ok, msg = oct_lint.check_func_pattern(text)
    assert not ok, "Expected FAIL for inner function missing func assignment"
    assert "inner" in msg
    assert "outer" not in msg
 
 
def test_func_pattern_multiline_signature(temp_project_root: Path):
    """Multi-line function signatures with correct pattern pass."""
    fixture = temp_project_root / "tests_linter" / "fixtures" / "multiline_sig.py"
    text = fixture.read_text(encoding="utf-8")
    ok, msg = oct_lint.check_func_pattern(text)
    assert ok, f"Expected PASS but got: {msg}"
 
 
def test_func_pattern_after_type_annotation():
    """func = '...' after a type annotation should pass (OI-409)."""
    source = (
        '# header\n' * 20
        + 'from oc_diagnostics import _dbg\n'
        'def process(data: list) -> None:\n'
        '    """Process data."""\n'
        '    result: list = []\n'
        '    func = "process"\n'
        '    _dbg("GENERAL", 2, f"{func}: starting")\n'
    )
    ok, msg = oct_lint.check_func_pattern(source)
    assert ok, f"Expected PASS but got: {msg}"