test_format_async.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_formatter/test_format_async.py
 
"""
Purpose
-------
OI-520 regression tests — verify ``fix_func_pattern`` also handles
``async def`` functions (previously only ``ast.FunctionDef`` was inspected,
so async functions were silently skipped).
 
Responsibilities
----------------
- Plain async function missing ``func = "..."`` gets one injected.
- Async function that already has the pattern is unchanged.
- Mixed sync + async file: both get fixed in the same pass.
- Async method inside a class is also covered.
 
Diagnostics
-----------
Domain: TESTS.FORMATTER
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- The formatter must treat ``async def`` bodies identically to ``def`` bodies.
"""
 
from pathlib import Path
 
from oct.formatter.oct_format import FormatterContext, fix_func_pattern
 
 
def _make_nontrivial(content: str) -> str:
    lines = content.split("\n")
    while len(lines) < 22:
        lines.append("# padding")
    return "\n".join(lines)
 
 
def test_async_function_gets_func_pattern(
    temp_project_root: Path, formatter_ctx_fix: FormatterContext
):
    test_file = temp_project_root / "async_single.py"
    content = _make_nontrivial(
        "#!/usr/bin/env python3\n"
        "from oc_diagnostics import _dbg\n"
        "\n"
        "async def my_async():\n"
        "    _dbg('TEST', 'start')\n"
        "    return 42\n"
    )
    test_file.write_text(content, encoding="utf-8")
 
    changed, new_content, _ = fix_func_pattern(test_file, content, formatter_ctx_fix)
 
    assert changed is True
    assert 'func = "my_async"' in new_content
 
 
def test_async_function_with_pattern_unchanged(
    temp_project_root: Path, formatter_ctx_fix: FormatterContext
):
    test_file = temp_project_root / "async_ok.py"
    content = _make_nontrivial(
        "#!/usr/bin/env python3\n"
        "from oc_diagnostics import _dbg\n"
        "\n"
        "async def ok_async():\n"
        '    func = "ok_async"\n'
        "    _dbg('TEST', func, 'msg', 2)\n"
        "    return 1\n"
    )
    test_file.write_text(content, encoding="utf-8")
 
    changed, _, _ = fix_func_pattern(test_file, content, formatter_ctx_fix)
 
    assert changed is False
 
 
def test_mixed_sync_and_async_both_fixed(
    temp_project_root: Path, formatter_ctx_fix: FormatterContext
):
    test_file = temp_project_root / "mixed.py"
    content = _make_nontrivial(
        "#!/usr/bin/env python3\n"
        "from oc_diagnostics import _dbg\n"
        "\n"
        "def sync_func():\n"
        "    _dbg('TEST', 'a')\n"
        "    return 1\n"
        "\n"
        "async def async_func():\n"
        "    _dbg('TEST', 'b')\n"
        "    return 2\n"
    )
    test_file.write_text(content, encoding="utf-8")
 
    changed, new_content, _ = fix_func_pattern(test_file, content, formatter_ctx_fix)
 
    assert changed is True
    assert 'func = "sync_func"' in new_content
    assert 'func = "async_func"' in new_content
 
 
def test_async_method_in_class_gets_func_pattern(
    temp_project_root: Path, formatter_ctx_fix: FormatterContext
):
    test_file = temp_project_root / "async_method.py"
    content = _make_nontrivial(
        "#!/usr/bin/env python3\n"
        "from oc_diagnostics import _dbg\n"
        "\n"
        "class Foo:\n"
        "    async def bar(self):\n"
        "        _dbg('TEST', 'method')\n"
        "        return 0\n"
    )
    test_file.write_text(content, encoding="utf-8")
 
    changed, new_content, _ = fix_func_pattern(test_file, content, formatter_ctx_fix)
 
    assert changed is True
    assert 'func = "bar"' in new_content