ma-agents 3.5.0 → 3.5.2

package/lib/bmad-cache/bmb/skills/bmad-module-builder/scripts/tests/test-validate-module.py

@@ -0,0 +1,314 @@
+#!/usr/bin/env python3
+# /// script
+# requires-python = ">=3.10"
+# ///
+"""Tests for validate-module.py"""
+
+import json
+import subprocess
+import sys
+import tempfile
+from pathlib import Path
+
+SCRIPT = Path(__file__).resolve().parent.parent / "validate-module.py"
+
+CSV_HEADER = "module,skill,display-name,menu-code,description,action,args,phase,after,before,required,output-location,outputs\n"
+
+
+def create_module(tmp: Path, skills: list[str] | None = None, csv_rows: str = "",
+                  yaml_content: str = "", setup_name: str = "tst-setup") -> Path:
+    """Create a minimal module structure for testing."""
+    module_dir = tmp / "module"
+    module_dir.mkdir()
+
+    # Setup skill
+    setup = module_dir / setup_name
+    setup.mkdir()
+    (setup / "SKILL.md").write_text("---\nname: " + setup_name + "\n---\n# Setup\n")
+    (setup / "assets").mkdir()
+    (setup / "assets" / "module.yaml").write_text(
+        yaml_content or 'code: tst\nname: "Test Module"\ndescription: "A test module"\n'
+    )
+    (setup / "assets" / "module-help.csv").write_text(CSV_HEADER + csv_rows)
+
+    # Other skills
+    for skill in (skills or []):
+        skill_dir = module_dir / skill
+        skill_dir.mkdir()
+        (skill_dir / "SKILL.md").write_text(f"---\nname: {skill}\n---\n# {skill}\n")
+
+    return module_dir
+
+
+def run_validate(module_dir: Path) -> tuple[int, dict]:
+    """Run the validation script and return (exit_code, parsed_json)."""
+    result = subprocess.run(
+        [sys.executable, str(SCRIPT), str(module_dir)],
+        capture_output=True, text=True,
+    )
+    try:
+        data = json.loads(result.stdout)
+    except json.JSONDecodeError:
+        data = {"raw_stdout": result.stdout, "raw_stderr": result.stderr}
+    return result.returncode, data
+
+
+def test_valid_module():
+    """A well-formed module should pass."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        csv_rows = 'Test Module,tst-foo,Do Foo,DF,Does the foo thing,run,,anytime,,,false,output_folder,report\n'
+        module_dir = create_module(tmp, skills=["tst-foo"], csv_rows=csv_rows)
+
+        code, data = run_validate(module_dir)
+        assert code == 0, f"Expected pass: {data}"
+        assert data["status"] == "pass"
+        assert data["summary"]["total_findings"] == 0
+
+
+def test_missing_setup_skill():
+    """Module with no setup skill should fail critically."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        module_dir = tmp / "module"
+        module_dir.mkdir()
+        skill = module_dir / "tst-foo"
+        skill.mkdir()
+        (skill / "SKILL.md").write_text("---\nname: tst-foo\n---\n")
+
+        code, data = run_validate(module_dir)
+        assert code == 1
+        assert any(f["category"] == "structure" for f in data["findings"])
+
+
+def test_missing_csv_entry():
+    """Skill without a CSV entry should be flagged."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        module_dir = create_module(tmp, skills=["tst-foo", "tst-bar"],
+                                   csv_rows='Test Module,tst-foo,Do Foo,DF,Does foo,run,,anytime,,,false,output_folder,report\n')
+
+        code, data = run_validate(module_dir)
+        assert code == 1
+        missing = [f for f in data["findings"] if f["category"] == "missing-entry"]
+        assert len(missing) == 1
+        assert "tst-bar" in missing[0]["message"]
+
+
+def test_orphan_csv_entry():
+    """CSV entry for nonexistent skill should be flagged."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        csv_rows = 'Test Module,tst-ghost,Ghost,GH,Does not exist,run,,anytime,,,false,output_folder,report\n'
+        module_dir = create_module(tmp, skills=[], csv_rows=csv_rows)
+
+        code, data = run_validate(module_dir)
+        orphans = [f for f in data["findings"] if f["category"] == "orphan-entry"]
+        assert len(orphans) == 1
+        assert "tst-ghost" in orphans[0]["message"]
+
+
+def test_duplicate_menu_codes():
+    """Duplicate menu codes should be flagged."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        csv_rows = (
+            'Test Module,tst-foo,Do Foo,DF,Does foo,run,,anytime,,,false,output_folder,report\n'
+            'Test Module,tst-foo,Also Foo,DF,Also does foo,other,,anytime,,,false,output_folder,report\n'
+        )
+        module_dir = create_module(tmp, skills=["tst-foo"], csv_rows=csv_rows)
+
+        code, data = run_validate(module_dir)
+        dupes = [f for f in data["findings"] if f["category"] == "duplicate-menu-code"]
+        assert len(dupes) == 1
+        assert "DF" in dupes[0]["message"]
+
+
+def test_invalid_before_after_ref():
+    """Before/after references to nonexistent capabilities should be flagged."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        csv_rows = 'Test Module,tst-foo,Do Foo,DF,Does foo,run,,anytime,tst-ghost:phantom,,false,output_folder,report\n'
+        module_dir = create_module(tmp, skills=["tst-foo"], csv_rows=csv_rows)
+
+        code, data = run_validate(module_dir)
+        refs = [f for f in data["findings"] if f["category"] == "invalid-ref"]
+        assert len(refs) == 1
+        assert "tst-ghost:phantom" in refs[0]["message"]
+
+
+def test_missing_yaml_fields():
+    """module.yaml with missing required fields should be flagged."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        csv_rows = 'Test Module,tst-foo,Do Foo,DF,Does foo,run,,anytime,,,false,output_folder,report\n'
+        module_dir = create_module(tmp, skills=["tst-foo"], csv_rows=csv_rows,
+                                   yaml_content='code: tst\n')
+
+        code, data = run_validate(module_dir)
+        yaml_findings = [f for f in data["findings"] if f["category"] == "yaml"]
+        assert len(yaml_findings) >= 1  # at least name or description missing
+
+
+def test_empty_csv():
+    """CSV with header but no rows should be flagged."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        module_dir = create_module(tmp, skills=["tst-foo"], csv_rows="")
+
+        code, data = run_validate(module_dir)
+        assert code == 1
+        empty = [f for f in data["findings"] if f["category"] == "csv-empty"]
+        assert len(empty) == 1
+
+
+def create_standalone_module(tmp: Path, skill_name: str = "my-skill",
+                             csv_rows: str = "", yaml_content: str = "",
+                             include_setup_md: bool = True,
+                             include_merge_scripts: bool = True) -> Path:
+    """Create a minimal standalone module structure for testing."""
+    module_dir = tmp / "module"
+    module_dir.mkdir()
+
+    skill = module_dir / skill_name
+    skill.mkdir()
+    (skill / "SKILL.md").write_text(f"---\nname: {skill_name}\n---\n# {skill_name}\n")
+
+    assets = skill / "assets"
+    assets.mkdir()
+    (assets / "module.yaml").write_text(
+        yaml_content or 'code: tst\nname: "Test Module"\ndescription: "A standalone test module"\n'
+    )
+    if not csv_rows:
+        csv_rows = f'Test Module,{skill_name},Do Thing,DT,Does the thing,run,,anytime,,,false,output_folder,artifact\n'
+    (assets / "module-help.csv").write_text(CSV_HEADER + csv_rows)
+
+    if include_setup_md:
+        (assets / "module-setup.md").write_text("# Module Setup\nStandalone registration.\n")
+
+    if include_merge_scripts:
+        scripts = skill / "scripts"
+        scripts.mkdir()
+        (scripts / "merge-config.py").write_text("# merge-config\n")
+        (scripts / "merge-help-csv.py").write_text("# merge-help-csv\n")
+
+    return module_dir
+
+
+def test_valid_standalone_module():
+    """A well-formed standalone module should pass with standalone=true in info."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        module_dir = create_standalone_module(tmp)
+
+        code, data = run_validate(module_dir)
+        assert code == 0, f"Expected pass: {data}"
+        assert data["status"] == "pass"
+        assert data["info"].get("standalone") is True
+        assert data["summary"]["total_findings"] == 0
+
+
+def test_standalone_missing_module_setup_md():
+    """Standalone module without assets/module-setup.md should fail."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        module_dir = create_standalone_module(tmp, include_setup_md=False)
+
+        code, data = run_validate(module_dir)
+        assert code == 1
+        structure_findings = [f for f in data["findings"] if f["category"] == "structure"]
+        assert any("module-setup.md" in f["message"] for f in structure_findings)
+
+
+def test_standalone_missing_merge_scripts():
+    """Standalone module without merge scripts should fail."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        module_dir = create_standalone_module(tmp, include_merge_scripts=False)
+
+        code, data = run_validate(module_dir)
+        assert code == 1
+        structure_findings = [f for f in data["findings"] if f["category"] == "structure"]
+        assert any("merge-config.py" in f["message"] for f in structure_findings)
+
+
+def test_standalone_csv_validation():
+    """Standalone module CSV should be validated the same as multi-skill."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        # Duplicate menu codes
+        csv_rows = (
+            'Test Module,my-skill,Do Thing,DT,Does thing,run,,anytime,,,false,output_folder,artifact\n'
+            'Test Module,my-skill,Also Thing,DT,Also does thing,other,,anytime,,,false,output_folder,report\n'
+        )
+        module_dir = create_standalone_module(tmp, csv_rows=csv_rows)
+
+        code, data = run_validate(module_dir)
+        dupes = [f for f in data["findings"] if f["category"] == "duplicate-menu-code"]
+        assert len(dupes) == 1
+        assert "DT" in dupes[0]["message"]
+
+
+def test_multi_skill_not_detected_as_standalone():
+    """A folder with two skills and no setup skill should fail (not detected as standalone)."""
+    with tempfile.TemporaryDirectory() as tmp:
+        tmp = Path(tmp)
+        module_dir = tmp / "module"
+        module_dir.mkdir()
+
+        for name in ("skill-a", "skill-b"):
+            skill = module_dir / name
+            skill.mkdir()
+            (skill / "SKILL.md").write_text(f"---\nname: {name}\n---\n")
+            (skill / "assets").mkdir()
+            (skill / "assets" / "module.yaml").write_text(f'code: tst\nname: "Test"\ndescription: "Test"\n')
+
+        code, data = run_validate(module_dir)
+        assert code == 1
+        # Should fail because it's neither a setup-skill module nor a single-skill standalone
+        assert any("No setup skill found" in f["message"] for f in data["findings"])
+
+
+def test_nonexistent_directory():
+    """Nonexistent path should return error."""
+    result = subprocess.run(
+        [sys.executable, str(SCRIPT), "/nonexistent/path"],
+        capture_output=True, text=True,
+    )
+    assert result.returncode == 2
+    data = json.loads(result.stdout)
+    assert data["status"] == "error"
+
+
+if __name__ == "__main__":
+    tests = [
+        test_valid_module,
+        test_missing_setup_skill,
+        test_missing_csv_entry,
+        test_orphan_csv_entry,
+        test_duplicate_menu_codes,
+        test_invalid_before_after_ref,
+        test_missing_yaml_fields,
+        test_empty_csv,
+        test_valid_standalone_module,
+        test_standalone_missing_module_setup_md,
+        test_standalone_missing_merge_scripts,
+        test_standalone_csv_validation,
+        test_multi_skill_not_detected_as_standalone,
+        test_nonexistent_directory,
+    ]
+    passed = 0
+    failed = 0
+    for test in tests:
+        try:
+            test()
+            print(f"  PASS: {test.__name__}")
+            passed += 1
+        except AssertionError as e:
+            print(f"  FAIL: {test.__name__}: {e}")
+            failed += 1
+        except Exception as e:
+            print(f"  ERROR: {test.__name__}: {e}")
+            failed += 1
+    print(f"\n{passed} passed, {failed} failed")
+    sys.exit(1 if failed else 0)

package/lib/bmad-cache/bmb/skills/bmad-module-builder/scripts/validate-module.py

@@ -0,0 +1,293 @@
+#!/usr/bin/env python3
+# /// script
+# requires-python = ">=3.10"
+# ///
+"""Validate a BMad module's structure and help CSV integrity.
+
+Supports two module types:
+- Multi-skill modules with a dedicated setup skill (*-setup directory)
+- Standalone single-skill modules with self-registration (assets/module-setup.md)
+
+Performs deterministic structural checks:
+- Required files exist (setup skill or standalone structure)
+- All skill folders have at least one capability entry in the CSV
+- No orphan CSV entries pointing to nonexistent skills
+- Menu codes are unique
+- Before/after references point to real capability entries
+- Required module.yaml fields are present
+- CSV column count is consistent
+"""
+
+import argparse
+import csv
+import json
+import sys
+from io import StringIO
+from pathlib import Path
+
+REQUIRED_YAML_FIELDS = {"code", "name", "description"}
+CSV_HEADER = [
+    "module", "skill", "display-name", "menu-code", "description",
+    "action", "args", "phase", "after", "before", "required",
+    "output-location", "outputs",
+]
+
+
+def find_setup_skill(module_dir: Path) -> Path | None:
+    """Find the setup skill folder (*-setup)."""
+    for d in module_dir.iterdir():
+        if d.is_dir() and d.name.endswith("-setup"):
+            return d
+    return None
+
+
+def find_skill_folders(module_dir: Path, exclude_name: str = "") -> list[str]:
+    """Find all skill folders (directories with SKILL.md), optionally excluding one."""
+    skills = []
+    for d in module_dir.iterdir():
+        if d.is_dir() and d.name != exclude_name and (d / "SKILL.md").is_file():
+            skills.append(d.name)
+    return sorted(skills)
+
+
+def detect_standalone_module(module_dir: Path) -> Path | None:
+    """Detect a standalone module: single skill folder with assets/module.yaml."""
+    skill_dirs = [
+        d for d in module_dir.iterdir()
+        if d.is_dir() and (d / "SKILL.md").is_file()
+    ]
+    if len(skill_dirs) == 1:
+        candidate = skill_dirs[0]
+        if (candidate / "assets" / "module.yaml").is_file():
+            return candidate
+    return None
+
+
+def parse_yaml_minimal(text: str) -> dict[str, str]:
+    """Parse top-level YAML key-value pairs (no nested structures)."""
+    result = {}
+    for line in text.splitlines():
+        line = line.strip()
+        if ":" in line and not line.startswith("#") and not line.startswith("-"):
+            key, _, value = line.partition(":")
+            key = key.strip()
+            value = value.strip().strip('"').strip("'")
+            if value and not value.startswith(">"):
+                result[key] = value
+    return result
+
+
+def parse_csv_rows(csv_text: str) -> tuple[list[str], list[dict[str, str]]]:
+    """Parse CSV text into header and list of row dicts."""
+    reader = csv.DictReader(StringIO(csv_text))
+    header = reader.fieldnames or []
+    rows = list(reader)
+    return header, rows
+
+
+def validate(module_dir: Path, verbose: bool = False) -> dict:
+    """Run all structural validations. Returns JSON-serializable result."""
+    findings: list[dict] = []
+    info: dict = {}
+
+    def finding(severity: str, category: str, message: str, detail: str = ""):
+        findings.append({
+            "severity": severity,
+            "category": category,
+            "message": message,
+            "detail": detail,
+        })
+
+    # 1. Find setup skill or detect standalone module
+    setup_dir = find_setup_skill(module_dir)
+    standalone_dir = None
+
+    if not setup_dir:
+        standalone_dir = detect_standalone_module(module_dir)
+        if not standalone_dir:
+            finding("critical", "structure",
+                    "No setup skill found (*-setup directory) and no standalone module detected")
+            return {"status": "fail", "findings": findings, "info": info}
+
+    # Branch: standalone vs multi-skill
+    if standalone_dir:
+        info["standalone"] = True
+        info["skill_dir"] = standalone_dir.name
+        skill_dir = standalone_dir
+
+        # 2s. Check required files for standalone module
+        required_files = {
+            "assets/module.yaml": skill_dir / "assets" / "module.yaml",
+            "assets/module-help.csv": skill_dir / "assets" / "module-help.csv",
+            "assets/module-setup.md": skill_dir / "assets" / "module-setup.md",
+            "scripts/merge-config.py": skill_dir / "scripts" / "merge-config.py",
+            "scripts/merge-help-csv.py": skill_dir / "scripts" / "merge-help-csv.py",
+        }
+        for label, path in required_files.items():
+            if not path.is_file():
+                finding("critical", "structure", f"Missing required file: {label}")
+
+        if not all(p.is_file() for p in required_files.values()):
+            return {"status": "fail", "findings": findings, "info": info}
+
+        yaml_dir = skill_dir
+        csv_dir = skill_dir
+    else:
+        info["setup_skill"] = setup_dir.name
+
+        # 2. Check required files in setup skill
+        required_files = {
+            "SKILL.md": setup_dir / "SKILL.md",
+            "assets/module.yaml": setup_dir / "assets" / "module.yaml",
+            "assets/module-help.csv": setup_dir / "assets" / "module-help.csv",
+        }
+        for label, path in required_files.items():
+            if not path.is_file():
+                finding("critical", "structure", f"Missing required file: {label}")
+
+        if not all(p.is_file() for p in required_files.values()):
+            return {"status": "fail", "findings": findings, "info": info}
+
+        yaml_dir = setup_dir
+        csv_dir = setup_dir
+
+    # 3. Validate module.yaml
+    yaml_text = (yaml_dir / "assets" / "module.yaml").read_text(encoding="utf-8")
+    yaml_data = parse_yaml_minimal(yaml_text)
+    info["module_code"] = yaml_data.get("code", "")
+    info["module_name"] = yaml_data.get("name", "")
+
+    for field in REQUIRED_YAML_FIELDS:
+        if not yaml_data.get(field):
+            finding("high", "yaml", f"module.yaml missing or empty required field: {field}")
+
+    # 4. Parse and validate CSV
+    csv_text = (csv_dir / "assets" / "module-help.csv").read_text(encoding="utf-8")
+    header, rows = parse_csv_rows(csv_text)
+
+    # Check header
+    if header != CSV_HEADER:
+        missing = set(CSV_HEADER) - set(header)
+        extra = set(header) - set(CSV_HEADER)
+        detail_parts = []
+        if missing:
+            detail_parts.append(f"missing: {', '.join(sorted(missing))}")
+        if extra:
+            detail_parts.append(f"extra: {', '.join(sorted(extra))}")
+        finding("high", "csv-header", f"CSV header mismatch: {'; '.join(detail_parts)}")
+
+    if not rows:
+        finding("high", "csv-empty", "module-help.csv has no capability entries")
+        return {"status": "fail", "findings": findings, "info": info}
+
+    info["csv_entries"] = len(rows)
+
+    # 5. Check column count consistency
+    expected_cols = len(CSV_HEADER)
+    for i, row in enumerate(rows):
+        if len(row) != expected_cols:
+            finding("medium", "csv-columns", f"Row {i + 2} has {len(row)} columns, expected {expected_cols}",
+                    f"skill={row.get('skill', '?')}")
+
+    # 6. Collect skills from CSV and filesystem
+    csv_skills = {row.get("skill", "") for row in rows}
+    exclude_name = setup_dir.name if setup_dir else ""
+    skill_folders = find_skill_folders(module_dir, exclude_name)
+    info["skill_folders"] = skill_folders
+    info["csv_skills"] = sorted(csv_skills)
+
+    # 7. Skills without CSV entries
+    for skill in skill_folders:
+        if skill not in csv_skills:
+            finding("high", "missing-entry", f"Skill '{skill}' has no capability entries in the CSV")
+
+    # 8. Orphan CSV entries
+    setup_name = setup_dir.name if setup_dir else ""
+    for skill in csv_skills:
+        if skill not in skill_folders and skill != setup_name:
+            # Check if it's the setup skill itself (valid)
+            if not (module_dir / skill / "SKILL.md").is_file():
+                finding("high", "orphan-entry", f"CSV references skill '{skill}' which does not exist in the module folder")
+
+    # 9. Unique menu codes
+    menu_codes: dict[str, list[str]] = {}
+    for row in rows:
+        code = row.get("menu-code", "").strip()
+        if code:
+            menu_codes.setdefault(code, []).append(row.get("display-name", "?"))
+
+    for code, names in menu_codes.items():
+        if len(names) > 1:
+            finding("high", "duplicate-menu-code", f"Menu code '{code}' used by multiple entries: {', '.join(names)}")
+
+    # 10. Before/after reference validation
+    # Build set of valid capability references (skill:action)
+    valid_refs = set()
+    for row in rows:
+        skill = row.get("skill", "").strip()
+        action = row.get("action", "").strip()
+        if skill and action:
+            valid_refs.add(f"{skill}:{action}")
+
+    for row in rows:
+        display = row.get("display-name", "?")
+        for field in ("after", "before"):
+            value = row.get(field, "").strip()
+            if not value:
+                continue
+            # Can be comma-separated
+            for ref in value.split(","):
+                ref = ref.strip()
+                if ref and ref not in valid_refs:
+                    finding("medium", "invalid-ref",
+                            f"'{display}' {field} references '{ref}' which is not a valid capability",
+                            "Expected format: skill-name:action-name")
+
+    # 11. Required fields in each row
+    for row in rows:
+        display = row.get("display-name", "?")
+        for field in ("skill", "display-name", "menu-code", "description"):
+            if not row.get(field, "").strip():
+                finding("high", "missing-field", f"Entry '{display}' is missing required field: {field}")
+
+    # Summary
+    severity_counts = {"critical": 0, "high": 0, "medium": 0, "low": 0}
+    for f in findings:
+        severity_counts[f["severity"]] = severity_counts.get(f["severity"], 0) + 1
+
+    status = "pass" if severity_counts["critical"] == 0 and severity_counts["high"] == 0 else "fail"
+
+    return {
+        "status": status,
+        "info": info,
+        "findings": findings,
+        "summary": {
+            "total_findings": len(findings),
+            "by_severity": severity_counts,
+        },
+    }
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(
+        description="Validate a BMad module's setup skill structure and help CSV integrity"
+    )
+    parser.add_argument(
+        "module_dir",
+        help="Path to the module's skills folder (containing the setup skill and other skills)",
+    )
+    parser.add_argument("--verbose", action="store_true", help="Print progress to stderr")
+    args = parser.parse_args()
+
+    module_path = Path(args.module_dir)
+    if not module_path.is_dir():
+        print(json.dumps({"status": "error", "message": f"Not a directory: {module_path}"}))
+        return 2
+
+    result = validate(module_path, verbose=args.verbose)
+    print(json.dumps(result, indent=2))
+    return 0 if result["status"] == "pass" else 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())