docs/test_docs.py

# Copyright (c) 2009, Giampaolo Rodola'. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Sanity checks for the Sphinx docs and blog posts."""

import pathlib
import re
import shutil
import subprocess
import sys
import tempfile
import xml.etree.ElementTree as ET
import zlib
from datetime import datetime
from datetime import timezone

import pytest

HERE = pathlib.Path(__file__).resolve().parent
ROOT = HERE.parent
DOCS = ROOT / "docs"
BLOG = DOCS / "blog"

VALID_BLOG_TAGS = frozenset({
    # platforms
    "bsd",
    "linux",
    "macos",
    "sunos",
    "windows",
    # API / compatibility
    "api-design",
    "compatibility",
    "new-api",
    "new-platform",
    # editorial
    "featured",
    # topics
    "c",
    "community",
    "memory",
    "performance",
    "personal",
    "python-core",
    "release",
    "tests",
    "wheels",
})

sys.path.insert(0, str(HERE))  # so that "import conf" wins
import conf  # noqa: E402
import label_role  # noqa: E402
import substitutions  # noqa: E402
from testutil import feed_urls  # noqa: E402
from testutil import find_canonical  # noqa: E402
from testutil import og_value  # noqa: E402

pytestmark = pytest.mark.skipif(
    sys.platform == "win32", reason="docs are built on Linux only"
)

HTML_DIR = None


@pytest.fixture(scope="module")
def build_html():
    """Build the site once. `make html` already turns warnings into
    errors by default.
    """
    global HTML_DIR

    tmp = tempfile.mkdtemp()
    subprocess.check_call([
        "make",
        "-C",
        str(DOCS),
        "html",
        f"BUILDDIR={tmp}",
        f"PYTHON={sys.executable}",
    ])
    HTML_DIR = pathlib.Path(tmp) / "html"
    yield
    shutil.rmtree(tmp)
    HTML_DIR = None


def blog_posts():
    return sorted(BLOG.rglob("*.rst"))


def read_html(*parts):
    # dirhtml writes each page as <slug>/index.html; only the root
    # index.html stays flat. Translate the historical "<slug>.html".
    rel = pathlib.Path(*parts)
    if rel.name == "index.html":
        path = HTML_DIR / rel
    else:
        path = HTML_DIR / rel.with_suffix("") / "index.html"
    return path.read_text()


def post_title(rst):
    """First H1 in a .rst file (the line above a `===` underline)."""
    lines = rst.read_text().splitlines()
    for i in range(1, len(lines)):
        if re.fullmatch(r"=+", lines[i].strip()):
            return lines[i - 1].strip()
    raise ValueError(f"no RST H1 found in {rst}")


def post_tags(rst):
    """Tags from a blog post's `:tags:` line, or [] if absent."""
    m = re.search(r":tags:\s*(.+)", rst.read_text())
    if not m:
        return []
    return [t.strip() for t in m.group(1).split(",")]


def blog_html(rst):
    """Read the built HTML for a blog post given its source .rst."""
    rel = rst.relative_to(BLOG).with_suffix("")
    return (HTML_DIR / "blog" / rel / "index.html").read_text()


def source_rst_for(html_path):
    """Return the .rst source for a built page, or None for pages
    generated without a source (ablog archives, sphinx auto-pages
    like genindex/search/py-modindex).
    """
    rel = html_path.relative_to(HTML_DIR)
    if rel.name != "index.html":
        return None
    if rel.parent == pathlib.Path("."):
        slug = "index"  # root home page
    else:
        slug = rel.parent.as_posix()
    src = DOCS / (slug + ".rst")
    return src if src.is_file() else None


def all_html_pages():
    """Every "real content" HTML page in the build."""
    for p in sorted(HTML_DIR.rglob("*.html")):
        rel_parts = p.relative_to(HTML_DIR).parts
        if any(part.startswith("_") for part in rel_parts):
            continue
        if source_rst_for(p) is None:
            continue
        yield p


class TestSourceRefs:
    """Checks on the .rst sources, no build needed."""

    def test_src_role_targets_exist(self, subtests):
        # :src:`path` links to the file on GitHub. Nothing validates
        # the path: rename or move the file and the link 404s, with
        # no build warning. Both the bare and the labelled
        # (`text <path>`) forms are used.
        pat = re.compile(r":src:`([^`]+)`")
        for rst in sorted(DOCS.rglob("*.rst")):
            for target in pat.findall(rst.read_text()):
                m = re.search(r"<([^>]+)>", target)
                if m:
                    target = m.group(1)
                with subtests.test(rst=rst.relative_to(ROOT), ref=target):
                    assert (ROOT / target).exists()

    def test_first_commit_date(self):
        # _ext/substitutions.py hardcodes it to keep git out of the
        # build. Check it against the real history.
        cmd = ["git", "log", "--reverse", "--format=%ct"]
        out = subprocess.check_output(cmd, cwd=ROOT).split(b"\n", 1)[0]
        first = datetime.fromtimestamp(int(out), tz=timezone.utc)
        assert first.date() == substitutions.FIRST_COMMIT


class TestBlogPostFiles:

    def test_every_file_has_directives(self):
        missing = []
        for p in blog_posts():
            text = p.read_text()
            missed = [
                k for k in (".. post::", ":author:", ":tags:") if k not in text
            ]
            if missed:
                rel = p.relative_to(ROOT)
                missing.append(f"{rel}: missing {missed}")
        assert missing == []

    def test_date_year_matches_path_year(self):
        mismatches = []
        for p in blog_posts():
            m = re.search(r"\.\. post:: (\d{4})-", p.read_text())
            if m and m.group(1) != p.parent.name:
                rel = p.relative_to(ROOT)
                mismatches.append(
                    f"{rel}: date-year={m.group(1)} dir={p.parent.name}"
                )
        assert mismatches == []

    def test_valid_tags(self):
        invalid = {}
        for p in blog_posts():
            bad = [t for t in post_tags(p) if t not in VALID_BLOG_TAGS]
            if bad:
                invalid[str(p.relative_to(ROOT))] = bad
        assert not invalid, f"invalid tags: {invalid}"


@pytest.mark.usefixtures("build_html")
class TestHtmlBuild:
    """Build sanity: pages exist, extensions wire up, footer dates."""

    def test_files_exist(self):
        assert (HTML_DIR / "index.html").exists()
        assert (HTML_DIR / "blog" / "index.html").exists()

    def test_github_pages_control_files(self):
        # sphinx.ext.githubpages writes these: .nojekyll stops Jekyll
        # from dropping _static/, CNAME is derived from html_baseurl.
        assert (HTML_DIR / ".nojekyll").is_file()
        assert (HTML_DIR / "CNAME").read_text().strip() == "psutil.io"

    def test_substitutions_expanded(self):
        # _ext/substitutions.py expands {{years_in_development}}. If
        # the hook breaks, the literal token ships instead.
        html = read_html("index.html")
        assert f"{substitutions.years_in_development()} years" in html
        assert "{{" not in html

    def test_changelog_anchors(self):
        # Indirectly test _ext/changelog_anchors.py. Every X.Y.Z
        # version heading in changelog.rst must get an `id="XYZ"`
        # anchor in the rendered HTML.
        source = (DOCS / "changelog.rst").read_text()
        html = read_html("changelog.html")
        missing = []
        for m in re.finditer(r"^(\d+)\.(\d+)\.(\d+)", source, re.MULTILINE):
            anchor = "".join(m.groups())
            if f'id="{anchor}"' not in html:
                missing.append(m.group(0))
        assert missing == []

    def test_gh_role_resolves(self):
        # Checks extlinks = {"gh": ...} in conf.py. Without it, every
        # :gh:`NNN` in the docs silently renders as plain text instead
        # of links.
        html = read_html("changelog.html")
        assert 'href="https://github.com/giampaolo/psutil/issues/' in html

    def test_label_role_resolves(self):
        source = (DOCS / "changelog.rst").read_text()
        html = read_html("changelog.html")
        for label in label_role.LABELS:
            badge = f'class="cl-label cl-label-{label}">{label}<'
            assert source.count(f":label:`{label}`") == html.count(badge)

    def test_intersphinx_resolves(self):
        # Check intersphinx_mapping["python"] in conf.py. If it does
        # not work, :mod:`func` refs to the stdlib silently render as
        # plain text instead of links.
        html = read_html("api.html")
        assert 'href="https://docs.python.org/3/' in html

    def test_footer_last_updated_matches_git(self, subtests):
        def is_merge_checkout():
            ret = subprocess.run(
                ["git", "rev-parse", "-q", "--verify", "HEAD^2"],
                capture_output=True,
                check=False,
            )
            return ret.returncode == 0

        if is_merge_checkout():
            pytest.skip("merge commit")
        # Skip pages that pull in external files via `.. include::`
        # or `.. raw:: <fmt> :file:`. sphinx-last-updated-by-git
        # walks those deps and picks the latest commit timestamp,
        # which we don't replicate here.
        dep_pat = re.compile(r"^\.\. (?:include|raw)::", re.MULTILINE)
        date_pat = re.compile(r"Updated: <a\b[^>]*>(\d{4}-\d{2}-\d{2})</a>")
        for html in all_html_pages():
            src = source_rst_for(html)
            if dep_pat.search(src.read_text()):
                continue
            m = date_pat.search(html.read_text())
            if m is None:
                continue  # page doesn't render the footer date
            cmd = [
                "git",
                "log",
                "-1",
                "--author-date-order",
                "--format=%at",
                "--",
                str(src),
            ]
            ts = subprocess.check_output(cmd).strip()
            if not ts:
                continue  # untracked source file
            expected = datetime.fromtimestamp(
                int(ts), tz=timezone.utc
            ).strftime("%Y-%m-%d")
            with subtests.test(page=html.relative_to(HTML_DIR)):
                assert m.group(1) == expected

    def test_footer_github_links_resolve(self, subtests):
        # ablog and codeautolink generate pages with no .rst behind
        # them (blog/tag/*, blog/2025, _modules/*). Their footer
        # links used to be built from the page name anyway, so they
        # 404ed on GitHub.
        pat = re.compile(
            r'github\.com/giampaolo/psutil/(?:edit|commits)/master/(\S+?)"'
        )
        for page in sorted(HTML_DIR.rglob("*.html")):
            html = page.read_text(encoding="utf-8", errors="replace")
            for target in set(pat.findall(html)):
                with subtests.test(page=page.relative_to(HTML_DIR)):
                    assert (ROOT / target).is_file()


@pytest.mark.usefixtures("build_html")
class TestSitemap:

    def test_known_pages_listed(self, subtests):
        # sphinx-sitemap should emit one <url> per built HTML page
        # (source docs + blog posts + ablog-generated pages), rooted at
        # html_baseurl. dirhtml gives directory-style URLs (trailing
        # slash); the home page is the bare root.
        sitemap = HTML_DIR / "sitemap.xml"
        assert sitemap.exists()
        ns = {"s": "http://www.sitemaps.org/schemas/sitemap/0.9"}
        tree = ET.parse(sitemap)
        urls = {u.text for u in tree.getroot().findall("s:url/s:loc", ns)}
        for page in (
            "",
            "api/",
            "changelog/",
            "blog/2026/event-driven-process-waiting/",
        ):
            with subtests.test(page=page):
                assert conf.html_baseurl + page in urls

    def test_no_duplicate_urls(self):
        # ablog re-renders the blog index on top of blog.rst, so
        # sphinx-sitemap lists that URL twice unless we dedupe.
        sitemap = HTML_DIR / "sitemap.xml"
        ns = {"s": "http://www.sitemaps.org/schemas/sitemap/0.9"}
        urls = [
            u.text
            for u in ET.parse(sitemap).getroot().findall("s:url/s:loc", ns)
        ]
        dupes = sorted({u for u in urls if urls.count(u) > 1})
        assert dupes == []

    def test_listed_pages_have_description(self, subtests):
        # ablog's generated pages come with no doctree, so
        # sphinxext-opengraph skips them and emits no description.
        pat = re.compile(r'<meta[^>]*name="description"', re.IGNORECASE)
        sitemap = HTML_DIR / "sitemap.xml"
        ns = {"s": "http://www.sitemaps.org/schemas/sitemap/0.9"}
        for url in ET.parse(sitemap).getroot().findall("s:url/s:loc", ns):
            rel = url.text.replace(conf.html_baseurl, "")
            page = HTML_DIR / rel / "index.html"
            with subtests.test(page=rel or "/"):
                assert pat.search(page.read_text(errors="replace"))

    def test_excludes_utility_pages(self, subtests):
        # sitemap_excludes must use the dirhtml dir form ("search/",
        # not "search.html") or utility + ablog pages leak in.
        sitemap = HTML_DIR / "sitemap.xml"
        ns = {"s": "http://www.sitemaps.org/schemas/sitemap/0.9"}
        urls = {
            u.text
            for u in ET.parse(sitemap).getroot().findall("s:url/s:loc", ns)
        }
        for slug in (
            "genindex",
            "py-modindex",
            "search",
            "404",
            "blog/archive",
            "blog/drafts",
        ):
            with subtests.test(slug=slug):
                assert conf.html_baseurl + slug + "/" not in urls

    def test_has_every_blog_post(self, subtests):
        # Catches drift between ablog's post registry and
        # sphinx-sitemap. If sphinx-sitemap stops listing some posts
        # (e.g. due to an ablog version bump), search engines stop
        # discovering them.
        sitemap = HTML_DIR / "sitemap.xml"
        ns = {"s": "http://www.sitemaps.org/schemas/sitemap/0.9"}
        urls = {
            u.text
            for u in ET.parse(sitemap).getroot().findall("s:url/s:loc", ns)
        }
        for rst in blog_posts():
            rel = rst.relative_to(BLOG).with_suffix("")
            expected = conf.html_baseurl + "blog/" + rel.as_posix() + "/"
            with subtests.test(rst=rst):
                assert expected in urls


@pytest.mark.usefixtures("build_html")
class TestCanonicalUrl:

    def test_link_on_pages(self, subtests):
        # Sphinx emits <link rel="canonical"> using html_baseurl. If
        # html_baseurl is misconfigured, every shared URL points at a
        # 404.
        for page in (
            "index.html",
            "api.html",
            "blog/2026/event-driven-process-waiting.html",
        ):
            url = find_canonical(read_html(page))
            with subtests.test(page=page):
                assert url is not None
                assert url.startswith(conf.html_baseurl)

    def test_og_urls_rooted_at_baseurl(self, subtests):
        # og:url + og:image must point at the deployed domain; they
        # once lagged html_baseurl and pointed at the old host.
        html = read_html("api.html")
        for prop in ("og:url", "og:image"):
            val = og_value(html, prop)
            with subtests.test(prop=prop):
                assert val is not None
                assert val.startswith(conf.html_baseurl)


@pytest.mark.usefixtures("build_html")
class TestRightToc:

    def test_visibility(self, subtests):
        has_toc = ("api.html", "faq.html", "glossary.html", "blog.html")
        no_toc = ("index.html", "genindex.html", "search.html")
        pat = re.compile(r'<aside[^>]*\bclass="[^"]*\bright-sidebar\b')
        for file in has_toc:
            with subtests.test(file=file):
                assert pat.search(read_html(file))
        for file in no_toc:
            with subtests.test(file=file):
                assert not pat.search(read_html(file))

    def test_hash_targets_resolve(self, subtests):
        # Every <a href="#..."> inside the right-sidebar must point to
        # an id that exists on the same page. Otherwise the JS
        # hash-match path in right-toc.js silently misses on direct
        # URL load.
        html = read_html("api.html")
        m = re.search(
            r'<aside[^>]*\bclass="[^"]*\bright-sidebar\b[^"]*"[^>]*>(.*?)</aside>',
            html,
            re.DOTALL,
        )
        assert m
        hrefs = re.findall(r'href="#([^"]+)"', m.group(1))
        assert hrefs
        ids_on_page = set(re.findall(r'\bid="([^"]+)"', html))
        for href in hrefs:
            with subtests.test(href=href):
                assert href in ids_on_page

    def test_glossary_mode(self):
        # Tests docs/_ext/glossary_toc.py, which injects
        # glossary_terms into the Jinja context.
        html = read_html("glossary.html")
        assert 'data-toc-mode="glossary"' in html
        m = re.search(
            r'<aside class="right-sidebar'
            r' right-sidebar--glossary"[^>]*>(.*?)</aside>',
            html,
            re.DOTALL,
        )
        assert m, "right-sidebar--glossary aside not found"
        terms = re.findall(r'<a href="#term-[^"]*">([^<]+)</a>', m.group(1))
        assert terms
        assert terms == sorted(terms, key=str.lower)


@pytest.mark.usefixtures("build_html")
class TestCodeAutoLink:
    """Checks sphinx-codeautolink integration."""

    def test_enabled(self):
        html = read_html("api-overview.html")
        assert "sphinx-codeautolink-a" in html

    def test_resolves_process_instance_methods(self):
        # Check that things like `p.name()`are resolved.
        html = read_html("api-overview.html")
        assert (
            '<a class="sphinx-codeautolink-a" '
            'href="../api/#psutil.Process.name"'
            in html
        )


@pytest.mark.usefixtures("build_html")
class TestAtomFeed:

    def test_entry_count(self):
        feed = HTML_DIR / "blog" / "atom.xml"
        ns = {"a": "http://www.w3.org/2005/Atom"}
        entries = ET.parse(feed).getroot().findall("a:entry", ns)
        assert len(entries) == len(blog_posts())

    def test_uses_utc(self):
        feed = HTML_DIR / "blog" / "atom.xml"
        ns = {"a": "http://www.w3.org/2005/Atom"}
        entries = ET.parse(feed).getroot().findall("a:entry", ns)
        assert entries
        non_utc = []
        for e in entries:
            for tag in ("a:updated", "a:published"):
                el = e.find(tag, ns)
                assert el is not None
                if not (el.text.endswith("+00:00") or el.text.endswith("Z")):
                    non_utc.append(el.text)
        assert non_utc == []

    def test_uses_canonical_url(self):
        # Regression: feed-level + per-entry URLs must be rooted at
        # html_baseurl so they match the deployed location. Without
        # it, feed readers 404.
        feed = HTML_DIR / "blog" / "atom.xml"
        root = ET.parse(feed).getroot()
        bad = [
            u for u in feed_urls(root) if not u.startswith(conf.html_baseurl)
        ]
        assert bad == []

    def test_link_on_every_page_exactly_once(self, subtests):
        # Every page must auto-discover the atom feed (so feed readers
        # find it from any post URL), and the <link> must appear only
        # once. layout.html used to inject it unconditionally,
        # duplicating ablog's auto-injection.
        needle = 'type="application/atom+xml"'
        for html in all_html_pages():
            with subtests.test(page=html.relative_to(HTML_DIR)):
                head = html.read_text()[:8192]
                assert head.count(needle) == 1


@pytest.mark.usefixtures("build_html")
class TestOpenGraph:
    """og:* and twitter:* social-preview meta tags."""

    def test_tags_on_source_pages(self, subtests):
        for rst in sorted(DOCS.rglob("*.rst")):
            if rst.name == "blog.rst":
                continue
            rel = rst.relative_to(DOCS)
            if rel.name == "index.rst" and rel.parent == pathlib.Path("."):
                html_path = HTML_DIR / "index.html"
            else:
                html_path = HTML_DIR / rel.with_suffix("") / "index.html"
            html = html_path.read_text()
            with subtests.test(rst=rst):
                for needle in (
                    "og:title",
                    "og:site_name",
                    "og:description",
                    "og:image",
                ):
                    assert needle in html

    def test_tags_on_blog_posts(self, subtests):
        # sphinxext-opengraph should emit og:* meta tags on every
        # post page so that shared URLs render as rich previews.
        properties = (
            "og:title",
            "og:url",
            "og:site_name",
            "og:description",
            "og:image",
        )
        for rst in blog_posts():
            html = blog_html(rst)
            for prop in properties:
                with subtests.test(rst=rst, prop=prop):
                    assert f'property="{prop}"' in html

    def test_type(self, subtests):
        # For blog posts it must be og:type="article" else "website".
        for rst in blog_posts():
            with subtests.test(rst=rst, expected="article"):
                assert og_value(blog_html(rst), "og:type") == "article"
        for page in ("index.html", "api.html", "install.html"):
            with subtests.test(page=page, expected="website"):
                assert og_value(read_html(page), "og:type") == "website"

    def test_blog_index_metadata(self, subtests):
        # Regression: ablog renders blog.html without a doctree, so
        # sphinxext-opengraph skips emitting og:* tags. Our
        # opengraph_override extension synthesizes them.
        html = read_html("blog.html")
        for tag in (
            'name="description"',
            'property="og:title"',
            'property="og:type"',
            'property="og:url"',
            'property="og:site_name"',
            'property="og:description"',
            'property="og:image"',
            'name="twitter:card"',
        ):
            with subtests.test(tag=tag):
                assert tag in html

    def test_description_uses_post_excerpt(self):
        # Blog post og:description (and the social card PNG sourced
        # from the same value) should be the curated excerpt from the
        # `.. post::` directive body, not the page body's first
        # paragraph. Spot-check on a known post.
        html = read_html("blog", "2026", "event-driven-process-waiting.html")
        desc = og_value(html, "og:description")
        # Excerpt opens with "Replacing"; the page body opens with
        # "One of the less fun aspects of process management ...".
        assert desc is not None
        assert desc.startswith("Replacing")

    def test_description_excludes_post_banner(self, subtests):
        # Regression: the post banner (author/date/readtime/tags)
        # used to leak into og:description, making social previews
        # start with "Giampaolo Rodola 2026-01-28 5 min read ...".
        for rst in blog_posts():
            desc = og_value(blog_html(rst), "og:description")
            with subtests.test(rst=rst):
                assert desc is not None
                assert not desc.startswith("Giampaolo")
                assert "min read" not in desc[:80]


@pytest.mark.usefixtures("build_html")
class TestBlogPosts:
    """Rendered blog post pages and the blog index listing."""

    def test_banner_on_every_post(self, subtests):
        css_names = (
            "post-meta-banner",
            "post-meta-author",
            "post-meta-date",
            "post-meta-readtime",
            "post-meta-tags",
        )
        for rst in blog_posts():
            html = blog_html(rst)
            for css in css_names:
                with subtests.test(rst=rst, css=css):
                    assert css in html

    def test_listing_has_all_posts(self, subtests):
        # blog.html should list all posts, each containing the post's
        # title.
        posts = blog_posts()
        html = read_html("blog.html")
        assert len(re.findall(r'<li class="blog-card[^"]*"', html)) == len(
            posts
        )
        for rst in posts:
            with subtests.test(rst=rst):
                assert post_title(rst) in html

    def test_listing_shows_summary(self, subtests):
        # Each post should have a summary below the title.
        html = read_html("blog.html")
        summaries = re.findall(
            r'<div class="blog-card-summary">(.*?)</div>', html, re.DOTALL
        )
        posts = blog_posts()
        assert len(summaries) == len(posts)
        for i, summary in enumerate(summaries):
            plain = re.sub(r"<[^>]+>", "", summary).strip()
            with subtests.test(card=i):
                assert plain

    def test_featured_pill(self, subtests):
        # Posts with the "featured" tag show a "Featured" pill in
        # their post-meta banner via _ext/post_banner.py. Other posts
        # must not.
        for rst in blog_posts():
            is_featured = "featured" in post_tags(rst)
            html = blog_html(rst)
            with subtests.test(rst=rst, is_featured=is_featured):
                if is_featured:
                    assert "post-meta-featured" in html
                else:
                    assert "post-meta-featured" not in html


@pytest.mark.usefixtures("build_html")
class TestNoExternalAssets:
    """Stylesheets and fonts are self-hosted, not pulled from a CDN."""

    ASSET_LINK_RE = re.compile(
        r'<link\b[^>]*\brel="(?:stylesheet|preload)"[^>]*>', re.IGNORECASE
    )
    HREF_RE = re.compile(r'\bhref="([^"]+)"')

    @staticmethod
    def is_external(url):
        return url.startswith(("http://", "https://", "//"))

    def test_no_external_stylesheets(self, subtests):
        # Analytics <script>s are deliberately external; only links count.
        for page in all_html_pages():
            urls = []
            for tag in self.ASSET_LINK_RE.findall(page.read_text()):
                urls += self.HREF_RE.findall(tag)
            external = [u for u in urls if self.is_external(u)]
            with subtests.test(page=page.relative_to(HTML_DIR)):
                assert external == []

    def test_no_external_css_urls(self, subtests):
        css_dir = HTML_DIR / "_static" / "css"
        for css in sorted(css_dir.glob("*.css")):
            if css.name == "giscus.css":
                continue  # runs in the giscus iframe, imports its theme
            urls = re.findall(r'url\(\s*["\']?([^"\')]+)', css.read_text())
            external = [u for u in urls if self.is_external(u)]
            with subtests.test(css=css.name):
                assert external == []


@pytest.mark.usefixtures("build_html")
class TestFonts:
    """Every @font-face points at a font file that ships in the build."""

    def test_font_face_files_exist(self, subtests):
        css_dir = HTML_DIR / "_static" / "css"
        face_re = re.compile(r"@font-face\s*\{[^}]*\}", re.DOTALL)
        url_re = re.compile(r'url\(\s*["\']?([^"\')]+)')
        found = 0
        for css in sorted(css_dir.glob("*.css")):
            for block in face_re.findall(css.read_text()):
                for url in url_re.findall(block):
                    found += 1
                    resolved = (css.parent / url).resolve()
                    with subtests.test(css=css.name, url=url):
                        assert resolved.is_file()
        assert found > 0


@pytest.mark.usefixtures("build_html")
class TestNoIndex:
    """Utility pages are noindex'd (layout.html); content pages aren't."""

    NOINDEX_RE = re.compile(
        r'<meta[^>]*name="robots"[^>]*content="noindex"', re.IGNORECASE
    )

    def test_utility_pages_noindex(self, subtests):
        for name in ("genindex", "py-modindex", "404"):
            path = HTML_DIR / name / "index.html"
            if not path.is_file():
                continue
            with subtests.test(page=name):
                assert self.NOINDEX_RE.search(path.read_text())

    def test_content_pages_indexable(self, subtests):
        for name in ("index.html", "api.html", "install.html"):
            with subtests.test(page=name):
                assert not self.NOINDEX_RE.search(read_html(name))


@pytest.mark.usefixtures("build_html")
class TestLogo:
    """The top-bar logo must land on the site root from every page."""

    LOGO_RE = re.compile(r'<a class="topbar-logo" href="([^"]+)"')

    def logo_href(self, *parts):
        m = self.LOGO_RE.search(read_html(*parts))
        assert m
        return m.group(1)

    def test_home_logo_targets_root(self):
        # Not "#", which would strand the user on /# (regression).
        assert self.logo_href("index.html") == "./"

    def test_content_page_logo_targets_root(self):
        assert self.logo_href("faq.html") == "../"

    def test_404_logo_is_absolute_root(self):
        # The 404 is served from arbitrary paths, so a relative/self
        # link breaks; it must be the absolute root.
        assert self.logo_href("404.html") == "/"


@pytest.mark.usefixtures("build_html")
class TestNotFound:
    """The 404 is served from arbitrary paths, so every link on it must
    be absolute; a relative one resolves against the request path and
    404s again.
    """

    def test_root_404_html_exists(self):
        # notfound_extras copies 404/index.html -> /404.html so static
        # servers (GitHub Pages, Starlette) serve it for missing paths.
        assert (HTML_DIR / "404.html").is_file()

    def test_content_root_is_absolute(self):
        # data-content_root drives JS-built URLs (search, highlight).
        # On the 404, served from any depth, it must be absolute or a
        # deep-path 404's search results resolve against the wrong base.
        m = re.search(r'data-content_root="([^"]+)"', read_html("404.html"))
        assert m
        assert m.group(1) == "/"

    def test_all_links_absolute(self):
        html = read_html("404.html")
        links = re.findall(r'(?:href|src|action)="([^"]+)"', html)
        rel = [
            u
            for u in links
            if not u.startswith(
                ("/", "http://", "https://", "//", "#", "mailto:")
            )
        ]
        assert rel == []

    def test_helpful_links_present(self, subtests):
        # Body "jump to ..." cross-references. Regression: notfound
        # leaves these relative, so they used to break from deep paths.
        html = read_html("404.html")
        for target in ("/install/", "/api/", "/faq/", "/recipes/", "/blog/"):
            with subtests.test(target=target):
                assert f'href="{target}"' in html


@pytest.mark.usefixtures("build_html")
class TestSidebarIcons:
    """Left-sidebar icons attach via href-based selectors in
    doc-icons.css. When the URL scheme changed (.html -> dirhtml dirs)
    the selectors silently stopped matching and every icon vanished.
    """

    def test_every_sidebar_link_has_icon_selector(self, subtests):
        css = (HTML_DIR / "_static" / "css" / "doc-icons.css").read_text()
        fragments = re.findall(r'href\*="([^"]+)"', css)
        assert fragments
        nav = re.search(
            r'<nav[^>]*class="[^"]*left-sidebar.*?</nav>',
            read_html("faq.html"),
            re.DOTALL,
        )
        assert nav, "left-sidebar not found"
        # Non-current page links look like "../<slug>/".
        hrefs = re.findall(r'href="(\.\./[a-z-]+/)"', nav.group(0))
        assert hrefs
        for href in sorted(set(hrefs)):
            with subtests.test(href=href):
                assert any(frag in href for frag in fragments)


@pytest.mark.usefixtures("build_html")
class TestUrlScheme:
    """dirhtml URL-scheme invariants.

    Pages are served as directories (/faq/), so any hand-rolled
    "<page>.html" link is dead. These guard the scheme site-wide
    rather than one feature at a time.
    """

    SKIP = ("http://", "https://", "//", "mailto:", "data:", "#")

    def resolve(self, page, url):
        """On-disk path a link points at, or None if not checkable."""
        url = url.split("#", 1)[0].split("?", 1)[0]
        if not url or url.startswith(self.SKIP):
            return None
        if url.startswith("/"):
            return HTML_DIR / url.lstrip("/")
        return (page.parent / url).resolve()

    def test_no_broken_internal_links(self):
        # Offline link checker over every built page. This is the net
        # that catches ".html" URLs dirhtml turned into 404s: blog tag
        # refs, the search form action, raw-HTML blocks, extensions.
        broken = []
        pages = sorted(HTML_DIR.rglob("*.html"))
        assert pages
        for page in pages:
            rel = page.relative_to(HTML_DIR)
            if any(part.startswith("_") for part in rel.parts):
                continue
            html = page.read_text(encoding="utf-8", errors="replace")
            for url in re.findall(r'(?:href|src|action)="([^"]*)"', html):
                target = self.resolve(page, url)
                if target is None:
                    continue
                if not (target.is_file() or (target / "index.html").is_file()):
                    broken.append(f"{rel} -> {url}")
        assert broken == []

    def test_pages_canonicalize_to_directory_urls(self, subtests):
        for page, slug in (
            ("faq.html", "faq/"),
            ("api.html", "api/"),
            ("blog.html", "blog/"),
        ):
            with subtests.test(page=page):
                expected = conf.html_baseurl + slug
                assert find_canonical(read_html(page)) == expected

    def test_blog_index_og_url_is_directory(self):
        # opengraph_override hand-builds this one; it used to emit
        # blog.html, a URL dirhtml never writes.
        val = og_value(read_html("blog.html"), "og:url")
        assert val == conf.html_baseurl + "blog/"

    def test_home_canonical_is_root(self):
        # The home page canonicalizes to the bare domain, not /index.
        assert find_canonical(read_html("index.html")) == conf.html_baseurl

    def test_sitemap_urls_are_extensionless(self):
        # The sitemap must agree with the canonical URLs; a stray
        # .html means the two disagree.
        sitemap = HTML_DIR / "sitemap.xml"
        ns = {"s": "http://www.sitemaps.org/schemas/sitemap/0.9"}
        urls = [
            u.text
            for u in ET.parse(sitemap).getroot().findall("s:url/s:loc", ns)
        ]
        assert urls
        assert not [u for u in urls if u.endswith(".html")]

    def test_search_builder_is_dirhtml(self):
        # searchtools.js builds result URLs as "<docname>/" only when
        # BUILDER == "dirhtml"; otherwise it appends LINK_SUFFIX
        # (.html) and every search result 404s.
        opts = (HTML_DIR / "_static" / "documentation_options.js").read_text()
        assert "BUILDER: 'dirhtml'" in opts

    def test_no_absolute_self_links_with_html(self):
        # The link checker skips absolute http(s) URLs, so a hardcoded
        # "https://psutil.io/faq.html" would slip straight past it.
        base = conf.html_baseurl.rstrip("/")
        pat = re.compile(re.escape(base) + r"/[^\s\"'<>]*\.html")
        bad = []
        for page in sorted(HTML_DIR.rglob("*.html")):
            rel = page.relative_to(HTML_DIR)
            if any(part.startswith("_") for part in rel.parts):
                continue
            text = page.read_text(encoding="utf-8", errors="replace")
            bad += [f"{rel} -> {hit}" for hit in pat.findall(text)]
        assert bad == []

    def test_atom_feed_urls_are_extensionless(self):
        # Feed readers persist these; a .html entry id is a dead link
        # that stays dead in every subscriber's reader.
        root = ET.parse(HTML_DIR / "blog" / "atom.xml").getroot()
        urls = feed_urls(root)
        assert urls
        assert [u for u in urls if ".html" in u] == []

    def test_objects_inv_uris_are_extensionless(self):
        # Other projects intersphinx against this inventory; a stale
        # .html URI breaks every cross-reference they make into us.
        raw = (HTML_DIR / "objects.inv").read_bytes()
        # 4 plain-text header lines, then zlib-compressed entries.
        entries = zlib.decompress(raw.split(b"\n", 4)[4]).decode("utf-8")
        assert entries
        assert ".html" not in entries