tests/test_hygiene.py — Docs vs Code Checker

"""Check the complete shipped-file surface for publication hygiene.

By Zero Width Lab (zerowidthlab.com)
"""
from __future__ import annotations

import os
import re
import unicodedata
import unittest
from pathlib import Path

__author__ = "Zero Width Lab"
ROOT = Path(__file__).resolve().parent.parent
SIGNATURE = "By Zero Width Lab (zerowidthlab.com)"
SHIPPED = {
    "SKILL.md", "README.md", "SETUP.md", "LICENSE.txt", "agents/docs-vs-code-checker.md",
    "references/method.md", "scripts/docs_claims.py", "tests/test_docs_claims.py", "tests/test_hygiene.py",
    "tests/fixtures/mini-repo/README.md", "tests/fixtures/mini-repo/app.py", "source-package.json",
}


class HygieneTests(unittest.TestCase):
    def test_shipped_files(self) -> None:
        for path in SHIPPED:
            self.assertTrue((ROOT / path).is_file(), path)

    def test_publication_hygiene(self) -> None:
        invisible = {chr(number) for number in range(0x200B, 0x2010)} | {chr(0xFEFF), chr(0x2060)}
        forbidden_names = (
            "Open" + "AI", "Anth" + "ropic", "Chat" + "G" + "PT", "Gem" + "ini",
            "Clau" + "de", "Co" + "dex", "Co" + "pilot", "Son" + "net", "Op" + "us",
        )
        token_name = "G" + "PT"
        for relative in SHIPPED:
            path = ROOT / relative
            content = path.read_text(encoding="utf-8")
            with self.subTest(path=relative):
                self.assertFalse(any(char in content for char in invisible))
                self.assertFalse(any(unicodedata.category(char) in {"Cf", "Zl", "Zp"} for char in content))
                self.assertIsNone(re.search(r"(?i)\b[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\b", content))
                self.assertIsNone(re.search(r"(?i)\b[\w.+-]+@[\w.-]+\.[a-z]{2,}\b", content))
                self.assertIsNone(re.search(r"(?i)\b[a-z0-9-]+\.onmicrosoft\.com\b", content))
                self.assertIsNone(re.search(r"/(?:Users|home)/[A-Za-z][^/\s]*", content))
                for name in forbidden_names:
                    self.assertNotIn(name.casefold(), content.casefold())
                self.assertIsNone(re.search(r"\b" + token_name + r"\b", content))
                if path.suffix == ".md":
                    self.assertEqual(content.strip().splitlines()[-1], SIGNATURE)
                if path.suffix == ".py":
                    self.assertIn(SIGNATURE, content[:220])
                    self.assertIn('__author__ = "Zero Width Lab"', content)


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

License: MIT (read it).

Back to the listing