test_test_file_index.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_linter/test_test_file_index.py
 
"""
Purpose
-------
OI-510 / FS-516 regression coverage — :func:`build_test_index` must
walk ``tests_dir`` exactly once per linter run and produce two lookup
sets on :class:`LinterContext`. :func:`check_tests_exist` then becomes
O(1) per call, replacing the previous O(N·M) rglob-and-read loop that
dominated ``oct lint`` runtime on medium-to-large projects.
 
Responsibilities
----------------
- Verify first call builds and caches ``ctx.test_index``; subsequent
  calls return the cached dict without re-walking.
- Verify both naming-convention and import-statement paths populate the
  index.
- Verify ``check_tests_exist`` returns True for either lookup path.
 
Diagnostics
-----------
Domain: LINTER-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- First call builds and caches ``ctx.test_index``; subsequent calls
  return the cached dict without re-walking.
- Both naming-convention and import-statement paths populate the index.
- ``check_tests_exist`` returns True for either path.
"""
 
from __future__ import annotations
 
import threading
from pathlib import Path
 
from oct.linter.oct_lint import (
    LinterContext,
    build_test_index,
    check_tests_exist,
)
 
 
def _make_ctx(project: Path) -> LinterContext:
    return LinterContext(
        project_root=project,
        project_name="demo",
        diagnostics_dir=project / "oc_diagnostics",
        tests_dir=project / "tests",
        docs_dir=project / "docs",
        log_lock=threading.Lock(),
    )
 
 
def test_index_populates_both_sets(tmp_path: Path):
    """OI-510: name-matched and import-matched stems both land in the index."""
    (tmp_path / "tests").mkdir()
    (tmp_path / "tests" / "test_foo.py").write_text("assert True\n", encoding="utf-8")
    (tmp_path / "tests" / "test_explicit.py").write_text(
        "from bar import baz\nimport qux\n", encoding="utf-8",
    )
    ctx = _make_ctx(tmp_path)
    index = build_test_index(ctx)
    assert "foo" in index["name_stems"]
    assert "explicit" in index["name_stems"]
    assert "bar" in index["imported_stems"]
    assert "qux" in index["imported_stems"]
 
 
def test_index_is_cached(tmp_path: Path):
    """OI-510: the index is built on first call and reused thereafter."""
    (tmp_path / "tests").mkdir()
    (tmp_path / "tests" / "test_a.py").write_text("\n", encoding="utf-8")
    ctx = _make_ctx(tmp_path)
    first = build_test_index(ctx)
    # Mutating the disk after first call must not affect the cached result.
    (tmp_path / "tests" / "test_b.py").write_text("\n", encoding="utf-8")
    second = build_test_index(ctx)
    assert first is second
    assert "b" not in second["name_stems"]
 
 
def test_check_tests_exist_uses_index(tmp_path: Path):
    """OI-510: check_tests_exist returns True via either path, False otherwise."""
    (tmp_path / "tests").mkdir()
    (tmp_path / "tests" / "test_named_hit.py").write_text("\n", encoding="utf-8")
    (tmp_path / "tests" / "test_imports.py").write_text(
        "import import_hit\n", encoding="utf-8",
    )
    ctx = _make_ctx(tmp_path)
    assert check_tests_exist(Path("src/named_hit.py"), ctx) is True
    assert check_tests_exist(Path("src/import_hit.py"), ctx) is True
    assert check_tests_exist(Path("src/no_hit.py"), ctx) is False
 
 
def test_missing_tests_dir_yields_empty_index(tmp_path: Path):
    """OI-510: absent tests/ folder → empty sets, no exception."""
    ctx = _make_ctx(tmp_path)  # no tests/ on disk
    index = build_test_index(ctx)
    assert index["name_stems"] == set()
    assert index["imported_stems"] == set()
    assert check_tests_exist(Path("anything.py"), ctx) is False