Lab 12: Software Quality Audit & SQA Plan¶

import subprocess
import json
import os
from pathlib import Path

TARGET = "audit_target"

print(f"=== Software Quality Audit: {TARGET} ===\n")

# ── 1. Codebase Size ──────────────────────────────────────────────
result = subprocess.run(
    ["pygount", "--format=json", TARGET],
    capture_output=True, text=True
)
if result.stdout:
    size_data = json.loads(result.stdout)
    # pygount summary
    total_code = sum(v.get("Code", 0) for v in size_data.values() if isinstance(v, dict))
    total_doc  = sum(v.get("Documentation", 0) for v in size_data.values() if isinstance(v, dict))
    total_empty = sum(v.get("Empty", 0) for v in size_data.values() if isinstance(v, dict))
    print(f"Codebase Size:")
    print(f"  Code lines:    {total_code:,}")
    print(f"  Comment lines: {total_doc:,}")
    print(f"  Empty lines:   {total_empty:,}")
    comment_ratio = total_doc / max(total_code, 1) * 100
    print(f"  Comment ratio: {comment_ratio:.1f}% (industry standard: 15-25%)")

# ── 2. Test Coverage ───────────────────────────────────────────────
print("\nTest Coverage:")
cov = subprocess.run(
    ["python", "-m", "pytest", "--co", "-q"],
    capture_output=True, text=True, cwd=TARGET
)
test_count = len([l for l in cov.stdout.split("\n") if "::" in l])
print(f"  Test functions found: {test_count}")

# ── 3. Code Complexity ─────────────────────────────────────────────
cc = subprocess.run(
    ["radon", "cc", TARGET, "-s", "-a", "--json"],
    capture_output=True, text=True
)
if cc.stdout:
    try:
        cc_data = json.loads(cc.stdout)
        all_blocks = [b for blocks in cc_data.values() for b in blocks]
        complexities = [b["complexity"] for b in all_blocks]
        if complexities:
            import statistics
            print(f"\nCyclomatic Complexity:")
            print(f"  Functions analyzed: {len(complexities)}")
            print(f"  Average CC: {statistics.mean(complexities):.2f}")
            print(f"  Max CC: {max(complexities)}")
            high_risk = [b for b in all_blocks if b["complexity"] > 10]
            print(f"  High-risk functions (CC>10): {len(high_risk)}")
    except:
        print("  (radon CC parse error — run manually)")

# ── 4. Technical Debt ──────────────────────────────────────────────
print("\nTechnical Debt Indicators:")
todos = subprocess.run(
    ["grep", "-r", "-n", "TODO\\|FIXME\\|HACK\\|XXX\\|NOQA", TARGET, "--include=*.py"],
    capture_output=True, text=True
)
todo_lines = [l for l in todos.stdout.split("\n") if l.strip()]
print(f"  TODO/FIXME/HACK comments: {len(todo_lines)}")
for line in todo_lines[:5]:
    print(f"    {line[:80]}")

# ── 5. Git History ─────────────────────────────────────────────────
print("\nVersion Control Health:")
commits = subprocess.run(
    ["git", "log", "--oneline", "--since=6 months ago"],
    capture_output=True, text=True, cwd=TARGET
)
commit_list = [l for l in commits.stdout.split("\n") if l.strip()]
print(f"  Commits (last 6 months): {len(commit_list)}")

contributors = subprocess.run(
    ["git", "shortlog", "-s", "-n", "--since=6 months ago"],
    capture_output=True, text=True, cwd=TARGET
)
contrib_list = [l for l in contributors.stdout.split("\n") if l.strip()]
print(f"  Active contributors: {len(contrib_list)}")
for c in contrib_list[:5]:
    print(f"    {c.strip()}")

# ── 6. Open Issues (manual check) ─────────────────────────────────
print("\n[Manual] Open Issues: visit https://github.com/<owner>/<repo>/issues")
print("[Manual] Last release date: check GitHub Releases tab")