1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
|
"""Tests for the backlinks module."""
from __future__ import annotations
from textwrap import dedent
from markdown import Markdown
from mkdocs_autorefs import AUTOREF_RE, AutorefsExtension, AutorefsPlugin, Backlink, BacklinkCrumb
from mkdocs_autorefs._internal.references import _html_attrs_parser
from tests.helpers import create_anchor_link, create_page
def test_record_backlinks() -> None:
"""Check that only useful backlinks are recorded."""
plugin = AutorefsPlugin()
plugin._record_backlink("foo", "referenced-by", "foo", "foo.html")
assert "foo" not in plugin._backlinks
plugin.register_anchor(identifier="foo", page=create_page("foo.html"), primary=True)
plugin._record_backlink("foo", "referenced-by", "foo", "foo.html")
assert "foo" in plugin._backlinks
def test_get_backlinks() -> None:
"""Check that backlinks can be retrieved."""
plugin = AutorefsPlugin()
plugin.record_backlinks = True
page = create_page("foo.html")
anchor = create_anchor_link("Foo", "foo")
plugin.register_anchor(page, anchor.id, title=anchor.title, primary=True)
plugin._register_breadcrumbs(page, anchor)
plugin._primary_url_map["bar"] = ["bar.html#bar"]
plugin._record_backlink("bar", "referenced-by", "foo", "foo.html")
assert plugin.get_backlinks("bar", from_url="") == {
"referenced-by": {Backlink(crumbs=(BacklinkCrumb(title="Foo", url="foo.html#foo", parent=None),))},
}
def test_backlinks_treeprocessor() -> None:
"""Check that the backlinks treeprocessor works."""
plugin = AutorefsPlugin()
plugin.record_backlinks = True
plugin.current_page = create_page("foo.html")
md = Markdown(extensions=["attr_list", "toc", AutorefsExtension(plugin)])
html = md.convert(
dedent(
"""
[](){#alias}
## Heading
[Foo][foo]
""",
),
)
match = AUTOREF_RE.search(html)
assert match
attrs = _html_attrs_parser.parse(f"<a {match['attrs']}>")
assert "backlink-type" in attrs
assert "backlink-anchor" in attrs
|