Files
fiona-assistant/tests/test_mdlinter.py
T
2026-09-29 16:01:16 +02:00

271 lines
9.1 KiB
Python

"""Tests for the MarkdownLinter (mdlinter) module.
Covers the custom markdown linter in the customlinter framework: the
dead-link check (MDL001/MDL002, moved from fiona.wiki.sanity_manager), the
per-file check registry, and the shared linter report format
(SPEC 6.1).
"""
from __future__ import annotations
import shutil
from pathlib import Path
import pytest
from fiona.customlinter.base import LinterError
from fiona.customlinter.mdlinter import MarkdownLinter, find_dead_links
from fiona.wiki.wiki import get_llm_wiki_source_path
def _write_md(path: Path, name: str, body: str, version: str = "1.0.0"):
"""Write a small md file with frontmatter at path."""
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(
f"---\nname: {name}\nversion: {version}\n---\n\n{body}",
encoding="utf-8",
)
@pytest.fixture
def wiki(tmp_path):
"""Small wiki fixture carrying the real template settings."""
wiki_root = tmp_path / "wiki"
wiki_root.mkdir()
shutil.copy2(
get_llm_wiki_source_path() / "fiona-settings.json",
wiki_root / "fiona-settings.json",
)
return wiki_root
@pytest.fixture
def linter(wiki):
"""A MarkdownLinter primed on the fixture wiki."""
return MarkdownLinter(settings_file=wiki / "fiona-settings.json")
# =============================================================================
# Dead Link Check Tests (moved from fiona.wiki.sanity_manager)
# =============================================================================
class TestDeadLinkCheck:
"""Tests for the dead-link check (MDL001/MDL002)."""
def test_no_links(self, linter, wiki):
_write_md(wiki / "wiki" / "index.md", "index", "# Index\n\nNo links.\n")
assert linter.lint_directory(wiki) == []
def test_resolving_relative_link_not_reported(self, linter, wiki):
_write_md(wiki / "page.md", "page", "# Page\n\nSee [schema](wiki/schema.md).\n")
_write_md(wiki / "wiki" / "schema.md", "schema", "# Schema\n")
assert linter.lint_directory(wiki) == []
def test_dead_relative_link_reported_with_position(self, linter, wiki):
_write_md(wiki / "page.md", "page", "# Page\n\nSee [gone](wiki/gone.md).\n")
violations = linter.lint_directory(wiki)
assert len(violations) == 1
violation = violations[0]
assert violation.code == "MDL001"
assert violation.filepath == (wiki / "page.md").resolve()
assert violation.line == 8
assert "wiki/gone.md" in violation.message
def test_anchor_only_link_ignored(self, linter, wiki):
_write_md(wiki / "page.md", "page", "# Page\n\nJump [top](#top).\n")
assert linter.lint_directory(wiki) == []
def test_external_links_ignored(self, linter, wiki):
_write_md(
wiki / "page.md",
"page",
"# Page\n\n[site](https://example.com) and [mail](mailto:a@b.c)\n",
)
assert linter.lint_directory(wiki) == []
def test_anchor_on_existing_target_resolves(self, linter, wiki):
_write_md(wiki / "wiki" / "schema.md", "schema", "# Schema\n")
_write_md(wiki / "page.md", "page", "# Page\n\n[sec](wiki/schema.md#sec)\n")
assert linter.lint_directory(wiki) == []
def test_dead_directory_link_reported(self, linter, wiki):
_write_md(wiki / "page.md", "page", "# Page\n\n[dir](missing/dir)\n")
violations = linter.lint_directory(wiki)
assert len(violations) == 1
assert violations[0].code == "MDL001"
assert "missing/dir" in violations[0].message
def test_wikilink_resolves(self, linter, wiki):
_write_md(wiki / "wiki" / "schema.md", "schema", "# Schema\n")
_write_md(wiki / "page.md", "page", "# Page\n\nSee [[schema]].\n")
assert linter.lint_directory(wiki) == []
def test_dead_wikilink_reported(self, linter, wiki):
_write_md(wiki / "page.md", "page", "# Page\n\nSee [[missing-page]].\n")
violations = linter.lint_directory(wiki)
assert len(violations) == 1
assert violations[0].code == "MDL002"
assert "missing-page" in violations[0].message
def test_wikilink_alias_and_heading_resolve(self, linter, wiki):
_write_md(wiki / "wiki" / "schema.md", "schema", "# Schema\n")
_write_md(
wiki / "page.md",
"page",
"# Page\n\n[[schema|Alias]] and [[schema#Conventions]]\n",
)
assert linter.lint_directory(wiki) == []
def test_links_in_code_fence_ignored(self, linter, wiki):
_write_md(
wiki / "page.md",
"page",
"# Page\n\n```text\n[dead](gone.md) and [[missing]]\n```\n",
)
assert linter.lint_directory(wiki) == []
def test_links_in_inline_code_ignored(self, linter, wiki):
_write_md(
wiki / "page.md",
"page",
"# Page\n\nUse `[dead](gone.md)` and `[[missing]]`.\n",
)
assert linter.lint_directory(wiki) == []
def test_raw_zone_source_skipped(self, linter, wiki):
_write_md(
wiki / "raw" / "article.md",
"article",
"# Article\n\n[dead](gone.md) and [[missing]]\n",
)
assert linter.lint_directory(wiki) == []
def test_personal_zone_source_skipped(self, linter, wiki):
_write_md(
wiki / "personal" / "note.md",
"note",
"# Note\n\n[dead](gone.md)\n",
)
assert linter.lint_directory(wiki) == []
def test_link_into_read_only_zone_resolves(self, linter, wiki):
_write_md(wiki / "raw" / "article.md", "article", "# Article\n")
_write_md(wiki / "page.md", "page", "# Page\n\n[src](raw/article.md)\n")
assert linter.lint_directory(wiki) == []
def test_dead_link_into_read_only_zone_reported(self, linter, wiki):
_write_md(wiki / "page.md", "page", "# Page\n\n[src](raw/missing.md)\n")
violations = linter.lint_directory(wiki)
assert len(violations) == 1
assert "raw/missing.md" in violations[0].message
def test_missing_directory_raises(self, linter, tmp_path):
with pytest.raises(LinterError):
linter.lint_directory(tmp_path / "missing")
# =============================================================================
# Single File Linting
# =============================================================================
class TestLintFile:
"""Tests for linting a single file."""
def test_single_file_dead_links(self, linter, wiki):
page = wiki / "page.md"
_write_md(page, "page", "# Page\n\nSee [gone](wiki/gone.md).\n")
violations = linter.lint_file(page)
assert len(violations) == 1
assert violations[0].code == "MDL001"
def test_single_file_wikilink_resolves_against_parent_tree(
self, linter, wiki
):
_write_md(wiki / "wiki" / "schema.md", "schema", "# Schema\n")
page = wiki / "page.md"
_write_md(page, "page", "# Page\n\nSee [[schema]].\n")
assert linter.lint_file(page) == []
# =============================================================================
# Module-level find_dead_links (moved from fiona.wiki.sanity_manager)
# =============================================================================
class TestFindDeadLinks:
"""Tests for the moved find_dead_links function."""
def test_clean_wiki_has_no_dead_links(self, wiki):
_write_md(wiki / "wiki" / "index.md", "index", "# Index\n\nClean.\n")
assert find_dead_links(wiki) == []
def test_dead_links_found(self, wiki):
_write_md(
wiki / "page.md",
"page",
"# Page\n\n[gone](gone.md) and [[missing]]\n",
)
violations = find_dead_links(wiki)
assert len(violations) == 2
codes = {violation.code for violation in violations}
assert codes == {"MDL001", "MDL002"}
# =============================================================================
# Report Format (SPEC 6.1)
# =============================================================================
class TestReportFormat:
"""Tests for the shared linter report format."""
def _report(self, linter, wiki, violations):
compressed = linter.compress_violations(violations, wiki)
return linter.format_compressed_violations(compressed)
def test_report_structure(self, linter, wiki):
_write_md(wiki / "page.md", "page", "# Page\n\nSee [gone](gone.md).\n")
violations = linter.lint_directory(wiki)
report = self._report(linter, wiki, violations)
assert report.startswith("Markdown Lint Violations\n")
assert f"TARGET: {wiki.resolve().as_posix()}" in report
assert "- DEFINITIONS:" in report
assert "MDL001: Dead Link," in report
assert "- FILE: page.md" in report
assert "- SUMMARY:" in report
assert "Total files with violations: 1" in report
assert "Total violations: 1" in report
def test_clean_report(self, linter, wiki):
report = self._report(linter, wiki, [])
assert report.startswith("Markdown Lint Violations\n")
assert "No violations found." in report
assert "Total violations: 0" in report