|
| 1 | +"""Verify version and count consistency across all documentation files.""" |
| 2 | + |
| 3 | +import re |
| 4 | + |
| 5 | +from conftest import REPO_ROOT |
| 6 | + |
| 7 | + |
| 8 | +# ── Helpers ───────────────────────────────────────────────────────── |
| 9 | + |
| 10 | + |
| 11 | +def _extract_numbers(pattern, text): |
| 12 | + """Extract all integer matches for a regex with one capture group.""" |
| 13 | + return [int(m) for m in re.findall(pattern, text)] |
| 14 | + |
| 15 | + |
| 16 | +# ── Version Consistency ───────────────────────────────────────────── |
| 17 | + |
| 18 | + |
| 19 | +class TestVersionConsistency: |
| 20 | + def test_readme_badge_version(self, plugin_manifest, readme_text): |
| 21 | + version = plugin_manifest["version"] |
| 22 | + assert f"version-{version}-green" in readme_text, ( |
| 23 | + f"README badge does not show version {version}" |
| 24 | + ) |
| 25 | + |
| 26 | + def test_roadmap_current_version(self, plugin_manifest, roadmap_text): |
| 27 | + version = plugin_manifest["version"] |
| 28 | + assert f"v{version}" in roadmap_text and "Current" in roadmap_text, ( |
| 29 | + f"ROADMAP.md does not list v{version} as current" |
| 30 | + ) |
| 31 | + |
| 32 | + def test_claude_md_version(self, plugin_manifest, claude_text): |
| 33 | + version = plugin_manifest["version"] |
| 34 | + assert f"v{version}" in claude_text or version in claude_text, ( |
| 35 | + f"CLAUDE.md does not mention version {version}" |
| 36 | + ) |
| 37 | + |
| 38 | + def test_changelog_has_current_version(self, plugin_manifest, changelog_text): |
| 39 | + version = plugin_manifest["version"] |
| 40 | + assert f"[{version}]" in changelog_text, ( |
| 41 | + f"CHANGELOG.md has no entry for version {version}" |
| 42 | + ) |
| 43 | + |
| 44 | + |
| 45 | +# ── Skill Count Consistency ───────────────────────────────────────── |
| 46 | + |
| 47 | + |
| 48 | +class TestSkillCountConsistency: |
| 49 | + def test_readme_skill_count(self, skill_count, readme_text): |
| 50 | + m = re.search(r"(?:\*\*|<strong>)(\d+)\s+skills(?:\*\*|</strong>)", readme_text) |
| 51 | + assert m, "README.md stats line missing skill count" |
| 52 | + assert int(m.group(1)) == skill_count, ( |
| 53 | + f"README says {m.group(1)} skills, disk has {skill_count}" |
| 54 | + ) |
| 55 | + |
| 56 | + def test_claude_md_skill_count(self, skill_count, claude_text): |
| 57 | + m = re.search(r"Skills\s*\((\d+)\s+total\)", claude_text) |
| 58 | + assert m, "CLAUDE.md missing skills total in header" |
| 59 | + assert int(m.group(1)) == skill_count, ( |
| 60 | + f"CLAUDE.md says {m.group(1)} skills, disk has {skill_count}" |
| 61 | + ) |
| 62 | + |
| 63 | + def test_contributing_skill_count(self, skill_count, contributing_text): |
| 64 | + m = re.search(r"\*\*(\d+)\s+skills\*\*", contributing_text) |
| 65 | + assert m, "CONTRIBUTING.md missing skill count" |
| 66 | + assert int(m.group(1)) == skill_count, ( |
| 67 | + f"CONTRIBUTING.md says {m.group(1)} skills, disk has {skill_count}" |
| 68 | + ) |
| 69 | + |
| 70 | + |
| 71 | +# ── Rule Count Consistency ────────────────────────────────────────── |
| 72 | + |
| 73 | + |
| 74 | +class TestRuleCountConsistency: |
| 75 | + def test_readme_rule_count(self, rule_count, readme_text): |
| 76 | + m = re.search(r"(?:\*\*|<strong>)(\d+)\s+rules(?:\*\*|</strong>)", readme_text) |
| 77 | + assert m, "README.md stats line missing rule count" |
| 78 | + assert int(m.group(1)) == rule_count, ( |
| 79 | + f"README says {m.group(1)} rules, disk has {rule_count}" |
| 80 | + ) |
| 81 | + |
| 82 | + def test_claude_md_rule_count(self, rule_count, claude_text): |
| 83 | + m = re.search(r"Rules\s*\((\d+)\s+total\)", claude_text) |
| 84 | + assert m, "CLAUDE.md missing rules total in header" |
| 85 | + assert int(m.group(1)) == rule_count, ( |
| 86 | + f"CLAUDE.md says {m.group(1)} rules, disk has {rule_count}" |
| 87 | + ) |
| 88 | + |
| 89 | + def test_contributing_rule_count(self, rule_count, contributing_text): |
| 90 | + m = re.search(r"\*\*(\d+)\s+rules\*\*", contributing_text) |
| 91 | + assert m, "CONTRIBUTING.md missing rule count" |
| 92 | + assert int(m.group(1)) == rule_count, ( |
| 93 | + f"CONTRIBUTING.md says {m.group(1)} rules, disk has {rule_count}" |
| 94 | + ) |
| 95 | + |
| 96 | + |
| 97 | +# ── Feature Table Coverage ────────────────────────────────────────── |
| 98 | + |
| 99 | + |
| 100 | +class TestFeatureTableCoverage: |
| 101 | + def _name_found_in_text(self, kebab_name: str, text_lower: str) -> bool: |
| 102 | + """Check if a kebab-case component name appears in text under any variant.""" |
| 103 | + if kebab_name in text_lower: |
| 104 | + return True |
| 105 | + stripped = kebab_name.replace("steam-", "").replace("steamworks-", "") |
| 106 | + words = stripped.split("-") |
| 107 | + spaced = " ".join(words) |
| 108 | + if spaced in text_lower: |
| 109 | + return True |
| 110 | + titled = " ".join(w.capitalize() for w in words) |
| 111 | + if titled.lower() in text_lower: |
| 112 | + return True |
| 113 | + hyphenated = "-".join(words) |
| 114 | + if hyphenated in text_lower: |
| 115 | + return True |
| 116 | + for i in range(len(words)): |
| 117 | + for j in range(i + 1, len(words) + 1): |
| 118 | + chunk = " ".join(words[i:j]) |
| 119 | + if len(chunk) >= 6 and chunk in text_lower: |
| 120 | + return True |
| 121 | + return False |
| 122 | + |
| 123 | + def test_all_skills_in_readme(self, skill_dirs, readme_text): |
| 124 | + readme_lower = readme_text.lower() |
| 125 | + for skill_dir in skill_dirs: |
| 126 | + name = skill_dir.name |
| 127 | + assert self._name_found_in_text(name, readme_lower), ( |
| 128 | + f"skill '{name}' not found in README features table" |
| 129 | + ) |
| 130 | + |
| 131 | + def test_all_rules_in_readme(self, rule_files, readme_text): |
| 132 | + readme_lower = readme_text.lower() |
| 133 | + for rule_file in rule_files: |
| 134 | + stem = rule_file.stem |
| 135 | + assert self._name_found_in_text(stem, readme_lower), ( |
| 136 | + f"rule '{stem}' not found in README features table" |
| 137 | + ) |
0 commit comments