Files
wehub-resource-sync 2cab53bc94
Test Vector Database Adaptors / Test MCP Vector DB Tools (push) Has been cancelled
Tests / Code Quality (Ruff & Mypy) (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (macos-latest, 3.11) (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (macos-latest, 3.12) (push) Has been cancelled
Tests / Tests (push) Has been cancelled
Docker Publish / Build and Push Docker Images (map[description:Skill Seekers CLI - Convert documentation to AI skills dockerfile:Dockerfile name:skill-seekers]) (push) Has been cancelled
Docker Publish / Build and Push Docker Images (map[description:Skill Seekers MCP Server - 25 tools for AI assistants dockerfile:Dockerfile.mcp name:skill-seekers-mcp]) (push) Has been cancelled
Docker Publish / Test Docker Images (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (ubuntu-latest, 3.10) (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (ubuntu-latest, 3.11) (push) Has been cancelled
Tests / Fast Unit Tests (parallel) (ubuntu-latest, 3.12) (push) Has been cancelled
Tests / Serial / Integration / E2E Tests (push) Has been cancelled
Tests / MCP Server Tests (push) Has been cancelled
Test Vector Database Adaptors / Test chroma Adaptor (push) Has been cancelled
Test Vector Database Adaptors / Test faiss Adaptor (push) Has been cancelled
Test Vector Database Adaptors / Test qdrant Adaptor (push) Has been cancelled
Test Vector Database Adaptors / Test weaviate Adaptor (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 12:46:28 +08:00

414 lines
13 KiB
Python

#!/usr/bin/env python3
"""
Tests for quality metrics dashboard.
Validates:
- Completeness analysis
- Accuracy analysis
- Coverage analysis
- Health analysis
- Overall scoring
- Report generation
"""
import argparse
import json
import pytest
from pathlib import Path
import sys
import tempfile
# Add src to path
sys.path.insert(0, str(Path(__file__).parent.parent / "src"))
from skill_seekers.cli.quality_metrics import QualityAnalyzer, MetricLevel
@pytest.fixture
def complete_skill_dir():
"""Create complete skill directory."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "complete_skill"
skill_dir.mkdir()
# Create SKILL.md with substantial content
skill_md = skill_dir / "SKILL.md"
skill_md.write_text("# Complete Skill\n\n" + ("## Section\nContent. " * 20))
# Create references
refs_dir = skill_dir / "references"
refs_dir.mkdir()
(refs_dir / "getting_started.md").write_text("# Getting Started\nGuide content")
(refs_dir / "api_reference.md").write_text("# API Reference\nAPI docs")
(refs_dir / "examples.md").write_text("# Examples\nExample code")
yield skill_dir
@pytest.fixture
def minimal_skill_dir():
"""Create minimal skill directory."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "minimal_skill"
skill_dir.mkdir()
# Only SKILL.md
(skill_dir / "SKILL.md").write_text("# Minimal")
yield skill_dir
def test_completeness_full(complete_skill_dir):
"""Test completeness analysis with complete skill."""
analyzer = QualityAnalyzer(complete_skill_dir)
score = analyzer.analyze_completeness()
assert score >= 70 # Should be high (70 is good for test fixture)
def test_completeness_minimal(minimal_skill_dir):
"""Test completeness analysis with minimal skill."""
analyzer = QualityAnalyzer(minimal_skill_dir)
score = analyzer.analyze_completeness()
assert score < 80 # Should be lower
def test_accuracy_clean():
"""Test accuracy analysis with clean content."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "clean_skill"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("# Clean Skill\n\nNo issues here.")
analyzer = QualityAnalyzer(skill_dir)
score = analyzer.analyze_accuracy()
assert score == 100 # Perfect score
def test_accuracy_with_todos():
"""Test accuracy detects TODO markers."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "todo_skill"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("# Skill\n\nTODO: Add content\nTODO: Fix this")
analyzer = QualityAnalyzer(skill_dir)
score = analyzer.analyze_accuracy()
assert score < 100 # Deducted for TODOs
def test_accuracy_with_placeholder():
"""Test accuracy detects placeholder text."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "placeholder_skill"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("# Skill\n\nLorem ipsum dolor sit amet")
analyzer = QualityAnalyzer(skill_dir)
score = analyzer.analyze_accuracy()
assert score < 100 # Deducted for placeholder
def test_accuracy_does_not_flag_placeholder_discussion():
"""Mentioning placeholders in explanatory text should not count as template residue."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "placeholder_note_skill"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text(
"# Skill\n\nQuick reference entries are filtered to avoid low-signal placeholders."
)
analyzer = QualityAnalyzer(skill_dir)
score = analyzer.analyze_accuracy()
assert score == 100
def test_coverage_high(complete_skill_dir):
"""Test coverage analysis with good coverage."""
analyzer = QualityAnalyzer(complete_skill_dir)
score = analyzer.analyze_coverage()
assert score >= 60 # Should have decent coverage
def test_coverage_low():
"""Test coverage analysis with low coverage."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "low_coverage"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("# Skill")
analyzer = QualityAnalyzer(skill_dir)
score = analyzer.analyze_coverage()
assert score < 50 # Low coverage
def test_coverage_counts_nested_reference_files():
"""Unified skills may store references under nested per-source directories."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "nested_refs_skill"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("# Skill\n\nContent")
nested_refs = skill_dir / "references" / "documentation" / "source_a"
nested_refs.mkdir(parents=True)
(nested_refs / "getting_started.md").write_text("# Getting Started")
(nested_refs / "api.md").write_text("# API")
(nested_refs / "examples.md").write_text("# Examples")
analyzer = QualityAnalyzer(skill_dir)
score = analyzer.analyze_coverage()
stats = analyzer.calculate_statistics()
assert score >= 60
assert stats["reference_files"] == 3
def test_health_good():
"""Test health analysis with healthy skill."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "healthy_skill"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("# Healthy Skill\n\nGood content")
refs_dir = skill_dir / "references"
refs_dir.mkdir()
analyzer = QualityAnalyzer(skill_dir)
score = analyzer.analyze_health()
assert score >= 80 # Healthy
def test_health_empty_files():
"""Test health detects empty files."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "empty_files"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("") # Empty
analyzer = QualityAnalyzer(skill_dir)
score = analyzer.analyze_health()
assert score < 100 # Deducted for empty file
def test_calculate_statistics(complete_skill_dir):
"""Test statistics calculation."""
analyzer = QualityAnalyzer(complete_skill_dir)
stats = analyzer.calculate_statistics()
assert stats["total_files"] > 0
assert stats["markdown_files"] > 0
assert stats["total_words"] > 0
def test_overall_score_calculation():
"""Test overall score calculation."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "test_skill"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("# Test Skill\n\nContent")
analyzer = QualityAnalyzer(skill_dir)
# Manually set scores
completeness = 80.0
accuracy = 90.0
coverage = 70.0
health = 85.0
overall = analyzer.calculate_overall_score(completeness, accuracy, coverage, health)
assert overall.completeness == 80.0
assert overall.accuracy == 90.0
assert overall.coverage == 70.0
assert overall.health == 85.0
assert 70 <= overall.total_score <= 90 # Weighted average
def test_grade_assignment():
"""Test grade assignment based on score."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "test_skill"
skill_dir.mkdir()
analyzer = QualityAnalyzer(skill_dir)
# Test various scores
score_95 = analyzer.calculate_overall_score(95, 95, 95, 95)
assert score_95.grade == "A+"
score_85 = analyzer.calculate_overall_score(85, 85, 85, 85)
assert score_85.grade in ["A-", "B+"]
score_70 = analyzer.calculate_overall_score(70, 70, 70, 70)
assert score_70.grade in ["B-", "C+", "C"]
def test_generate_recommendations():
"""Test recommendation generation."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "test_skill"
skill_dir.mkdir()
analyzer = QualityAnalyzer(skill_dir)
# Low completeness
score = analyzer.calculate_overall_score(60, 80, 70, 80)
recommendations = analyzer.generate_recommendations(score)
assert len(recommendations) > 0
assert any("completeness" in r.lower() for r in recommendations)
def test_generate_report(complete_skill_dir):
"""Test full report generation."""
analyzer = QualityAnalyzer(complete_skill_dir)
report = analyzer.generate_report()
assert report.skill_name == "complete_skill"
assert report.overall_score is not None
assert len(report.metrics) == 4 # 4 analyses
assert len(report.statistics) > 0
assert report.timestamp is not None
def test_format_report(complete_skill_dir):
"""Test report formatting."""
analyzer = QualityAnalyzer(complete_skill_dir)
report = analyzer.generate_report()
formatted = analyzer.format_report(report)
assert "QUALITY METRICS DASHBOARD" in formatted
assert "OVERALL SCORE" in formatted
assert "COMPONENT SCORES" in formatted
# RECOMMENDATIONS only appears if there are recommendations
if report.recommendations:
assert "RECOMMENDATIONS" in formatted
def test_metric_levels():
"""Test metric level assignment."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "test_skill"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("# Test")
analyzer = QualityAnalyzer(skill_dir)
analyzer.analyze_completeness()
assert len(analyzer.metrics) > 0
assert analyzer.metrics[0].level in [MetricLevel.INFO, MetricLevel.WARNING]
def test_empty_skill_directory():
"""Test handling empty skill directory."""
with tempfile.TemporaryDirectory() as tmpdir:
empty_dir = Path(tmpdir) / "empty"
empty_dir.mkdir()
analyzer = QualityAnalyzer(empty_dir)
report = analyzer.generate_report()
assert report.overall_score.total_score < 50 # Very low score
def test_metric_suggestions():
"""Test metrics include suggestions."""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "incomplete_skill"
skill_dir.mkdir()
# Minimal content to trigger suggestions
(skill_dir / "SKILL.md").write_text("# Minimal")
analyzer = QualityAnalyzer(skill_dir)
analyzer.analyze_completeness()
# Should have suggestions
assert len(analyzer.metrics) > 0
if analyzer.metrics[0].value < 100:
assert len(analyzer.metrics[0].suggestions) > 0
if __name__ == "__main__":
pytest.main([__file__, "-v"])
def _quality_args(skill_dir, **overrides):
"""Full namespace as the unified CLI dispatch would pass it (Phase 5c:
backfill_parser_defaults is gone — the central parser defines every dest,
so main(args=...) callers must pass a complete namespace)."""
ns = argparse.Namespace(skill_dir=str(skill_dir), report=False, output=None, threshold=None)
for key, value in overrides.items():
setattr(ns, key, value)
return ns
def test_main_report_only_exits_zero(minimal_skill_dir):
"""Without --threshold the command only reports (historical contract:
CI steps that just want quality_report.json must keep exiting 0)."""
from skill_seekers.cli.quality_metrics import main
assert main(_quality_args(minimal_skill_dir)) == 0
assert (minimal_skill_dir / "quality_report.json").exists()
def test_main_explicit_threshold_gates(minimal_skill_dir):
"""An explicit --threshold enforces the quality gate."""
from skill_seekers.cli.quality_metrics import main
assert main(_quality_args(minimal_skill_dir, threshold=10.0)) == 1
assert main(_quality_args(minimal_skill_dir, threshold=0.0)) == 0
def test_main_prints_score_summary(minimal_skill_dir, capsys):
"""`quality` must show the score on stdout even without --report; a bare
'Report saved' left users having to open the JSON to learn the score."""
from skill_seekers.cli.quality_metrics import main
main(_quality_args(minimal_skill_dir))
out = capsys.readouterr().out
assert "Quality Score" in out
assert "Grade" in out
def test_report_json_uses_plain_enum_values(minimal_skill_dir, tmp_path):
"""Saved JSON must record metric levels as 'info'/'warning', not the enum
repr 'MetricLevel.INFO' (which leaked via json.dumps(default=str))."""
from skill_seekers.cli.quality_metrics import main
out_file = tmp_path / "q.json"
main(_quality_args(minimal_skill_dir, output=str(out_file)))
text = out_file.read_text()
assert "MetricLevel." not in text
data = json.loads(text)
levels = {m["level"] for m in data["metrics"]}
assert levels <= {"info", "warning", "error", "critical"}
def test_json_default_serializes_enum_value():
from skill_seekers.cli.quality_metrics import _json_default
assert _json_default(MetricLevel.INFO) == "info"
assert _json_default(MetricLevel.WARNING) == "warning"