tambo 0.6.4

Install and prove the whole AI knowledge-tool kit
Documentation 
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

#!/usr/bin/env python3
# arming: ci Documentation workflow, after its pinned lychee install
"""Real-lychee controls for the production self-repository remap wrapper."""
import json
import os
from pathlib import Path
import shutil
import socket
import subprocess
import tempfile
import threading
import unittest
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer

REPO = Path(__file__).resolve().parent.parent
OWN = "https://github.com/scbrown/caboodle/blob/main/"
LEGACY = "https://github.com/scbrown/tambo/blob/main/"
CANONICAL = "https://github.com/intigraph/tambo/blob/main/"
TARGETS = [
    "skills/tambo/SKILL.md",
    "docs/design/txtai-gap-analysis.md",
    "docs/design/vision.md",
    "docs/stack/README-STANDARD.md",
    "docs/stack/README-TEMPLATE.md",
]


class DocumentationLinks(unittest.TestCase):
    def setUp(self):
        self.temp = tempfile.TemporaryDirectory(prefix="caboodle-doc-links-")
        self.addCleanup(self.temp.cleanup)
        self.root = Path(self.temp.name) / "space $cash #hash"
        (self.root / "scripts").mkdir(parents=True)
        shutil.copyfile(REPO / "scripts/check-doc-links.sh", self.root / "scripts/check-doc-links.sh")
        shutil.copyfile(REPO / ".lychee.toml", self.root / ".lychee.toml")
        self.env = dict(os.environ, HOME=str(self.root))
        for name in ("GITHUB_TOKEN", "GH_TOKEN"):
            self.env.pop(name, None)
        self.input = self.root / "input.md"

    def check(self, links, offline=True):
        self.input.write_text("\n".join(f"[target]({url})" for url in links) + "\n")
        argv = [
            "sh", str(self.root / "scripts/check-doc-links.sh"),
            "--no-progress", "--format", "json", "--max-retries", "0", "--timeout", "2",
        ]
        if offline:
            argv.append("--offline")
        site = self.root / "site"
        site.mkdir(exist_ok=True)
        argv += ["--root-dir", str(site), str(self.input)]
        result = subprocess.run(argv, env=self.env, capture_output=True, text=True, timeout=20)
        self.assertTrue(result.stdout.startswith("{"), result.stdout + result.stderr)
        return result.returncode, json.loads(result.stdout)

    def test_actual_five_targets_checked_not_excluded_and_deleted_target_fails(self):
        for target in TARGETS:
            dest = self.root / target
            dest.parent.mkdir(parents=True, exist_ok=True)
            shutil.copyfile(REPO / target, dest)
        links = [prefix + target for prefix in (OWN, LEGACY, CANONICAL) for target in TARGETS]
        rc, result = self.check(links)
        self.assertEqual(rc, 0, result)
        self.assertEqual((result["successful"], result["remaps"], result["excludes"]), (15, 15, 0))
        (self.root / TARGETS[0]).unlink()
        rc, result = self.check(links)
        self.assertNotEqual(rc, 0)
        self.assertEqual((result["successful"], result["errors"], result["excludes"]), (12, 3, 0))
        self.assertIn("SKILL.md", json.dumps(result["error_map"]))

    def test_existing_anchor_passes_missing_anchor_fails(self):
        (self.root / "target.md").write_text("# Target\n\n## Present\n")
        rc, result = self.check([OWN + "target.md#present"])
        self.assertEqual(rc, 0, result)
        self.assertEqual((result["successful"], result["excludes"]), (1, 0))
        rc, result = self.check([OWN + "target.md#missing"])
        self.assertNotEqual(rc, 0)
        self.assertEqual(result["errors"], 1)

    def test_own_pages_anchor_uses_fresh_build(self):
        site = self.root / "site" / "tambo"
        site.mkdir(parents=True)
        page = site / "introduction.html"
        page.write_text('<h2 id="why-use-it">Why use it</h2>')
        link = "https://scbrown.github.io/caboodle/introduction.html#why-use-it"
        canonical = "https://scbrown.github.io/tambo/introduction.html#why-use-it"
        rc, result = self.check([link, canonical, "https://intigraph.github.io/tambo/introduction.html#why-use-it"])
        self.assertEqual(rc, 0, result)
        self.assertEqual((result["successful"], result["remaps"], result["excludes"]), (3, 3, 0))
        page.write_text('<h2 id="new-heading">New heading</h2>')
        rc, result = self.check([link, canonical, "https://intigraph.github.io/tambo/introduction.html#why-use-it"])
        self.assertNotEqual(rc, 0, result)
        self.assertEqual((result["errors"], result["excludes"]), (3, 0))

    def test_other_pages_books_are_not_remapped(self):
        rc, result = self.check([
            "https://other.github.io/caboodle/missing.html",
            "https://scbrown.github.io/other/missing.html",
            "https://scbrown.github.io/caboodle-other/missing.html",
            "https://scbrown.github.io/tambo-other/missing.html",
        ])
        self.assertEqual(rc, 0, result)
        self.assertEqual((result["remaps"], result["excludes"]), (0, 4))

    def test_other_owner_repo_and_branch_are_not_remapped(self):
        # Offline is a scope probe, not evidence that remote links pass.
        # An overbroad remap would turn these missing paths into file errors.
        links = [
            "https://github.com/other/caboodle/blob/main/missing.md",
            "https://github.com/scbrown/other/blob/main/missing.md",
            "https://github.com/scbrown/caboodle/blob/v1.0.0/missing.md",
            "https://github.com/scbrown/caboodle/tree/main/missing.md",
            "https://github.com/other/tambo/blob/main/missing.md",
            "https://github.com/scbrown/tambo/blob/v1.0.0/missing.md",
            "https://github.com/intigraph/other/blob/main/missing.md",
            "https://github.com/intigraph/tambo/blob/v1.0.0/missing.md",
            "https://github.com/intigraph/tambo/tree/main/missing.md",
        ]
        rc, result = self.check(links)
        self.assertEqual(rc, 0, result)
        self.assertEqual((result["remaps"], result["excludes"], result["successful"]), (0, 9, 0))

    def test_normal_mode_still_checks_unrelated_remote_failure(self):
        # A real disposable HTTP server supplies a positive 200 control and a
        # negative 404. NORMAL mode must contact it; no offline switch may
        # swallow the error. IPv6 is outside the illustrative URL exclusions.
        hits = []

        class Handler(BaseHTTPRequestHandler):
            def do_GET(self):
                hits.append(self.path)
                self.send_response(200 if self.path == "/present" else 404)
                self.end_headers()
                self.wfile.write(b"fixture")

            def log_message(self, *args):
                pass

        class Server(ThreadingHTTPServer):
            address_family = socket.AF_INET6

        server = Server(("::1", 0), Handler)
        thread = threading.Thread(target=server.serve_forever, daemon=True)
        thread.start()
        self.addCleanup(server.server_close)
        self.addCleanup(server.shutdown)
        base = f"http://[::1]:{server.server_port}"
        rc, result = self.check([base + "/present"], offline=False)
        self.assertEqual(rc, 0, result)
        self.assertEqual((result["successful"], result["excludes"]), (1, 0))
        rc, result = self.check([base + "/missing"], offline=False)
        self.assertNotEqual(rc, 0)
        self.assertEqual((result["errors"], result["excludes"], result["remaps"]), (1, 0, 0))
        self.assertIn("/missing", hits)
        self.assertIn("404", json.dumps(result["error_map"]))


if __name__ == "__main__":
    unittest.main(verbosity=2)