[Help wanted] Add URL anchor breakage tests

[databyjp]

Code of Conduct

• I have read and agree to the Weaviate's Code of Conduct

What part of document/web-page on weaviate.io is affected?

We have CI pipeline tests for broken links. However, it is not possible for that test to currently check for broken in-page anchors.

The site already includes a suite of tests that can be run via pytest.

It would be great if a test could be added to our pytest suite, checking whether links to any in-page anchors are actually valid, so that they can be run periodically.

Additional comments?

A community contribution would be fantastic :).

[ankur0904]

Hey @databyjp I want to work on this issue.

[ankur0904]

I have decided to create a new file here named test_in_page_anchors.py and add the logic of the unit test.

Basic Code:

import requests
import pytest

@pytest.mark.parametrize("url", [REQUIRED_URL])
def test_inpage_anchors(url):
    response = requests.get(url)
    assert response.status_code == 200

    anchor_links = set()
    for anchor in response.html.find("a"):
        href = anchor.attrs.get("href")
        if href and href.startswith("#"):
            anchor_links.add(href)

    for anchor_link in anchor_links:
        target_id = anchor_link[1:] 
        target_element = response.html.find(f"#{target_id}")
        assert target_element, f"Missing target element for {anchor_link}"

@databyjp What are your thoughts about this approach?