Files
graphify/tests/test_partial_extraction_warning.py
T
ayushcodes10 97608ef573 Add regression tests for the symbolless file warning
Covers a plain data literal getting named and marked as likely data,
a real function staying silent, no overlap with the existing syntax
error warning on a genuinely broken file, and the total size count
across more than one file. Confirmed to fail against pre fix code.

(cherry picked from commit 32ad059ebc)
2026-10-04 02:11:27 +01:00

146 lines
5.9 KiB
Python

"""The partial-extraction warning must be actionable and must not misdirect.
It used to end in a hardcoded `(#2551)` for EVERY language. #2551 is closed and
Kotlin-specific ("bundled grammar rejects one-line type bodies"), so a reader
following the only lead the message offered landed on a resolved problem in a
different language — and at least one did, recording an Astro failure as
"already tracked upstream" on the strength of that number (#2788).
The message also could not distinguish a file that contributed nothing but its
own file node from one that yielded most of its symbols and lost an ERROR
region. Both rendered as "may be partially extracted".
Part 1 of #2788 — the Astro frontmatter parse itself — is NOT addressed here;
that belongs to the .svelte/.astro AST work in #2731.
"""
import re
import pytest
from graphify.extract import extract
# Any hardcoded issue citation, not just 2551 — re-introducing a different
# number for a message that covers every grammar is the same mistake.
_ISSUE_CITATION = re.compile(r"\(#\d+\)")
def _partial_parse_fixture(tmp_path):
"""A file the parser ACCEPTS only through ERROR recovery — an unclosed table
constructor swallowing the function that follows it.
Deliberately not the Kotlin one-line body from #2551: whether that shape
trips the gate depends on the bundled grammar build, and these tests are
about the MESSAGE, which must read the same whichever grammar produced it.
"""
f = tmp_path / "broken.lua"
f.write_text("local t = {\nfunction f() end\n", encoding="utf-8")
return f
def _run(tmp_path, files, capsys):
extract([*files], root=tmp_path)
return capsys.readouterr().err
def test_warning_carries_no_hardcoded_issue_number(tmp_path, capsys):
err = _run(tmp_path, [_partial_parse_fixture(tmp_path)], capsys)
assert "partially extracted" in err, f"fixture no longer trips the gate: {err!r}"
assert not _ISSUE_CITATION.search(err), (
f"the warning still cites a single issue for every language: {err!r}")
assert "#2551" not in err
def test_warning_names_the_file_and_how_much_survived(tmp_path, capsys):
err = _run(tmp_path, [_partial_parse_fixture(tmp_path)], capsys)
assert "partially extracted" in err, err
assert "broken.lua" in err
assert ("no symbols extracted" in err
or re.search(r"\d+ symbol\(s\) extracted", err)), (
f"the warning does not say how much survived: {err!r}")
def test_warning_still_reports_the_first_error_line(tmp_path, capsys):
"""The line number was the one actionable thing the old message had; it must
survive the rewrite."""
err = _run(tmp_path, [_partial_parse_fixture(tmp_path)], capsys)
assert re.search(r"first error at line \d+", err), err
def test_a_clean_file_is_silent(tmp_path, capsys):
f = tmp_path / "fine.py"
f.write_text("def ok():\n return 1\n", encoding="utf-8")
err = _run(tmp_path, [f], capsys)
assert "partially extracted" not in err
assert "syntax errors" not in err
def test_the_citation_is_gone_from_the_source_not_just_one_path():
import graphify.extract as ex
text = open(ex.__file__, encoding="utf-8").read()
assert "may be partially extracted: {_shown}{_more} (#2551)" not in text
assert "no symbols extracted" in text
assert "symbol(s) extracted" in text
# ── #3946: a clean-parse file that yields nothing but its own file node ─────
def _data_only_fixture(tmp_path):
"""A plain data literal with no functions, classes or imports — the AST
extractor has nothing to model, but the file parses with zero errors, so
the syntax-error warning above must stay silent for it."""
f = tmp_path / "data.js"
f.write_text("module.exports = [{a: 1}, {b: 2}];\n", encoding="utf-8")
return f
def test_symbolless_warning_names_the_file(tmp_path, capsys):
err = _run(tmp_path, [_data_only_fixture(tmp_path)], capsys)
assert "yielded no symbols" in err, err
assert "data.js" in err
# neutral wording: a symbol-less file may be data OR source the extractor
# models nothing for — do NOT assert it is "data rather than code".
assert "may be data rather than code" not in err
def test_symbolless_warning_is_silent_for_an_empty_init(tmp_path, capsys):
"""An empty __init__.py is symbol-less *code*, ubiquitous in Python
packages. It has nothing to model, so the warning must stay silent rather
than fire on essentially every package scan."""
pkg = tmp_path / "pkg"
pkg.mkdir()
(pkg / "__init__.py").write_text("", encoding="utf-8")
err = _run(tmp_path, [pkg / "__init__.py"], capsys)
assert "yielded no symbols" not in err
def test_symbolless_warning_is_silent_for_a_whitespace_only_file(tmp_path, capsys):
f = tmp_path / "blank.py"
f.write_text("\n \n\t\n", encoding="utf-8")
err = _run(tmp_path, [f], capsys)
# whitespace-only: nothing to model, so the strip-empty guard keeps it quiet
assert "yielded no symbols" not in err
def test_symbolless_warning_does_not_fire_for_a_real_function(tmp_path, capsys):
f = tmp_path / "real.js"
f.write_text("function run() { return 1; }\n", encoding="utf-8")
err = _run(tmp_path, [f], capsys)
assert "yielded no symbols" not in err
def test_symbolless_warning_does_not_overlap_the_syntax_error_warning(tmp_path, capsys):
"""A file already explained by the partial-extraction warning (a genuine
parse error) must not ALSO be counted as a clean-parse data file."""
err = _run(tmp_path, [_partial_parse_fixture(tmp_path)], capsys)
assert "yielded no symbols" not in err
def test_symbolless_warning_counts_total_size(tmp_path, capsys):
a = tmp_path / "a.js"
a.write_text("module.exports = [1, 2, 3];\n", encoding="utf-8")
b = tmp_path / "b.js"
b.write_text("export default [4, 5, 6];\n", encoding="utf-8")
err = _run(tmp_path, [a, b], capsys)
assert "2 code file(s) yielded no symbols" in err
assert "a.js" in err and "b.js" in err