add test

Author: Jannis-Mittenzwei

doc/conf.py

@@ -79,4 +79,4 @@
     "accent_color": "grass",
 }
 # -- Configure link checking behavior  ----------------------------------------
-linkcheck_rate_limit_timeout = 15
+linkcheck_rate_limit_timeout = 15

exasol/toolbox/nox/_documentation.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import argparse
 import json
 import os
 import re
@@ -8,18 +9,19 @@
 import sys
 import tempfile
 import webbrowser
+from collections.abc import (
+    Container,
+    Iterable,
+)
 from itertools import repeat
 from pathlib import Path
 from typing import (
-    Container,
-    Iterable,
     Optional,
     Tuple,
 )
-import argparse
 
 import nox
-import requests   # type: ignore
+import requests  # type: ignore
 from nox import Session
 
 from exasol.toolbox.nox._shared import DOCS_OUTPUT_DIR
@@ -58,10 +60,14 @@ def _check_failed_links(results: list[str]):
                 match = re.search(r"https?://[^\s\"\'<>]+", data["uri"])
                 if match:
                     try:
-                        request = requests.head(match.group(), timeout=15)
+                        request = requests.get(match.group(), timeout=15)
                         if request.status_code == 200:
                             data["status"] = "working"
                             data["code"] = request.status_code
+                            if request.history:
+                                data["info"] = (
+                                    f"redirected: {" -> ".join(step.url for step in request.history)} -> {request.url}"
+                                )
                         results[line] = json.dumps(data)
                     except requests.exceptions.Timeout:
                         pass

poetry.lock

@@ -0,0 +1,52 @@
+from unittest.mock import (
+    MagicMock,
+    patch,
+)
+
+import pytest
+
+from exasol.toolbox.nox._documentation import _check_failed_links
+
+
+@pytest.mark.parametrize(
+    "results, expected",
+    [
+        ([""], ([""], [])),
+        (
+            [
+                '{"filename": "ftest.rst", "lineno": 1, "status": "broken", "code": 0, "uri": "https://ftest", "info": ""}',
+                '{"filename": "ttest.rst", "lineno": 1, "status": "working", "code": 0, "uri": "https://ttest", "info": ""}',
+                '{"filename": "rtest.rst", "lineno": 1, "status": "redirected", "code": 0, "uri": "https://rtest", "info": ""}',
+            ],
+            (
+                [
+                    '{"filename": "ftest.rst", "lineno": 1, "status": "broken", "code": 0, "uri": "https://ftest", "info": ""}',
+                    '{"filename": "ttest.rst", "lineno": 1, "status": "working", "code": 0, "uri": "https://ttest", "info": ""}',
+                    '{"filename": "rtest.rst", "lineno": 1, "status": "redirected", "code": 0, "uri": "https://rtest", "info": ""}',
+                ],
+                [
+                    '{"filename": "ftest.rst", "lineno": 1, "status": "broken", "code": 0, '
+                    '"uri": "https://ftest", "info": ""}'
+                ],
+            ),
+        ),
+    ],
+)
+def test_failed_links(results, expected):
+    frequest = MagicMock()
+    frequest.status_code = 404
+    trequest = MagicMock()
+    trequest.status_code = 200
+    history1 = MagicMock()
+    history1.url = "https://rtest"
+    history2 = MagicMock()
+    history2.url = "https://rtest.next"
+    rrequest = MagicMock()
+    rrequest.history = [history1, history2]
+    rrequest.url = "https://rtest.end"
+    with patch(
+        "exasol.toolbox.nox._documentation.requests.get",
+        side_effect=[frequest, rrequest],
+    ):
+        actual = _check_failed_links(results)
+    assert actual == expected