Files
zensical/python/tests/unit/extensions/test_links.py
T

71 lines
2.6 KiB
Python
Vendored

# Copyright (c) 2025-2026 Zensical and contributors
# SPDX-License-Identifier: MIT
# All contributions are certified under the DCO
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
from __future__ import annotations
import pytest
from zensical.extensions.links import (
_is_relative,
_md_path_to_html,
_rewrite_url,
)
@pytest.mark.parametrize(
("path", "directory_urls", "expected"),
[
("index.md", True, ""),
("README.md", True, ""),
("guide/README.md", True, "guide/"),
("guide/page.md", True, "guide/page/"),
("myindex.md", True, "myindex/"),
("guide/README.md", False, "guide/index.html"),
("guide/page.md", False, "guide/page.html"),
("assets/app.js", True, "assets/app.js"),
],
)
def test_markdown_path_routing(
path: str, directory_urls: bool, expected: str
) -> None:
"""Markdown links retain the current MkDocs-compatible route shape."""
assert _md_path_to_html(path, directory_urls) == expected
@pytest.mark.parametrize(
"value",
["https://example.com", "//example.com", "/root", "#section"],
)
def test_non_relative_references_are_not_rewritten(value: str) -> None:
"""External, root-relative, and same-page references remain untouched."""
assert not _is_relative(value)
assert _rewrite_url(value, "guide/page.md", True) is None
def test_rewrite_preserves_query_and_fragment() -> None:
"""Only the path component changes when a Markdown URL is rewritten."""
assert (
_rewrite_url("other.md?view=full#details", "guide/page.md", True)
== "../other/?view=full#details"
)