Compare commits
1 Commits
step35/121
...
step35/162
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
180464cc5e |
366
scripts/code_duplication_detector.py
Normal file
366
scripts/code_duplication_detector.py
Normal file
@@ -0,0 +1,366 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Code Duplication Detector — Issue #162
|
||||
|
||||
Finds duplicate functions and code blocks across Python source files.
|
||||
Reports duplication percentage and outputs a duplication report.
|
||||
|
||||
Usage:
|
||||
python3 scripts/code_duplication_detector.py --output reports/code_duplication.json
|
||||
python3 scripts/code_duplication_detector.py --directory scripts/ --dry-run
|
||||
python3 scripts/code_duplication_detector.py --test # Run built-in test
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import hashlib
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
from collections import defaultdict
|
||||
from datetime import datetime, timezone
|
||||
from pathlib import Path
|
||||
from typing import List, Dict, Tuple, Optional
|
||||
|
||||
|
||||
# ── AST helpers ────────────────────────────────────────────────────────────
|
||||
|
||||
def normalize_code(text: str) -> str:
|
||||
"""Normalize code for comparison: strip comments, normalize whitespace."""
|
||||
# Remove comments (both # and docstring triple-quote strings)
|
||||
text = re.sub(r'#.*$', '', text, flags=re.MULTILINE)
|
||||
text = re.sub(r'""".*?"""', '', text, flags=re.DOTALL)
|
||||
text = re.sub(r"'''.*?'''", '', text, flags=re.DOTALL)
|
||||
# Normalize whitespace
|
||||
text = re.sub(r'\s+', ' ', text).strip()
|
||||
return text.lower()
|
||||
|
||||
|
||||
def code_hash(text: str) -> str:
|
||||
"""SHA256 hash of normalized code for exact duplicate detection."""
|
||||
normalized = normalize_code(text)
|
||||
return hashlib.sha256(normalized.encode('utf-8')).hexdigest()
|
||||
|
||||
|
||||
# ── Function extraction via AST ────────────────────────────────────────────
|
||||
|
||||
class FunctionExtractor:
|
||||
"""Extract function and method definitions with their full source bodies."""
|
||||
|
||||
def __init__(self, source: str, filepath: str):
|
||||
self.source = source
|
||||
self.filepath = filepath
|
||||
self.lines = source.splitlines()
|
||||
self.functions: List[Dict] = []
|
||||
|
||||
def _get_source_segment(self, start_lineno: int, end_lineno: int) -> str:
|
||||
"""Get source code from start to end line (1-indexed, inclusive)."""
|
||||
# AST end_lineno is inclusive
|
||||
start_idx = start_lineno - 1
|
||||
end_idx = end_lineno
|
||||
return '\n'.join(self.lines[start_idx:end_idx])
|
||||
|
||||
def visit(self, tree):
|
||||
"""Collect all function and async function definitions."""
|
||||
for node in ast.walk(tree):
|
||||
if isinstance(node, ast.FunctionDef) or isinstance(node, ast.AsyncFunctionDef):
|
||||
# Get the full source for this function including decorators
|
||||
start = node.lineno
|
||||
end = node.end_lineno
|
||||
body_source = self._get_source_segment(start, end)
|
||||
|
||||
# Also collect parent class name if this is a method
|
||||
class_name = None
|
||||
parent = node.parent if hasattr(node, 'parent') else None
|
||||
if parent and isinstance(parent, ast.ClassDef):
|
||||
class_name = parent.name
|
||||
|
||||
self.functions.append({
|
||||
'name': node.name,
|
||||
'file': self.filepath,
|
||||
'start_line': start,
|
||||
'end_line': end,
|
||||
'body': body_source,
|
||||
'class_name': class_name,
|
||||
'is_method': class_name is not None,
|
||||
})
|
||||
|
||||
|
||||
import ast
|
||||
|
||||
class ParentNodeVisitor(ast.NodeVisitor):
|
||||
"""Annotate nodes with parent references."""
|
||||
def __init__(self, parent=None):
|
||||
self.parent = parent
|
||||
|
||||
def generic_visit(self, node):
|
||||
node.parent = self.parent
|
||||
for child in ast.iter_child_nodes(node):
|
||||
self.__class__(child).parent = node
|
||||
super().generic_visit(node)
|
||||
|
||||
|
||||
def extract_functions_from_file(filepath: str) -> List[Dict]:
|
||||
"""Extract all function definitions from a Python file."""
|
||||
try:
|
||||
with open(filepath, 'r', encoding='utf-8', errors='replace') as f:
|
||||
source = f.read()
|
||||
tree = ast.parse(source, filename=str(filepath))
|
||||
|
||||
# Annotate with parent references
|
||||
for node in ast.walk(tree):
|
||||
for child in ast.iter_child_nodes(node):
|
||||
child.parent = node
|
||||
|
||||
extractor = FunctionExtractor(source, str(filepath))
|
||||
extractor.visit(tree)
|
||||
return extractor.functions
|
||||
except (SyntaxError, UnicodeDecodeError, OSError) as e:
|
||||
return []
|
||||
|
||||
|
||||
def scan_directory(directory: str, extensions: Tuple[str, ...] = ('.py',)) -> List[Dict]:
|
||||
"""Scan directory for Python files and extract all functions."""
|
||||
all_functions = []
|
||||
path = Path(directory)
|
||||
|
||||
for filepath in path.rglob('*'):
|
||||
if filepath.is_file() and filepath.suffix in extensions:
|
||||
# Skip common non-source dirs
|
||||
parts = filepath.parts
|
||||
if any(ex in parts for ex in ('__pycache__', 'node_modules', '.git', 'venv', '.venv', 'dist', 'build')):
|
||||
continue
|
||||
if filepath.name.startswith('.'):
|
||||
continue
|
||||
|
||||
functions = extract_functions_from_file(str(filepath))
|
||||
all_functions.extend(functions)
|
||||
|
||||
return all_functions
|
||||
|
||||
|
||||
# ── Duplicate detection ─────────────────────────────────────────────────────
|
||||
|
||||
def find_duplicates(functions: List[Dict], similarity_threshold: float = 0.95) -> Dict:
|
||||
"""
|
||||
Find duplicate and near-duplicate functions.
|
||||
|
||||
Returns dict with:
|
||||
- exact_duplicates: {hash: [function_info, ...]}
|
||||
- near_duplicates: [[function_info, ...], ...]
|
||||
- stats: total_functions, unique_exact, exact_dupe_count, near_dupe_count
|
||||
"""
|
||||
# Phase 1: Exact duplicates by code hash
|
||||
hash_groups: Dict[str, List[Dict]] = defaultdict(list)
|
||||
for func in functions:
|
||||
h = code_hash(func['body'])
|
||||
hash_groups[h].append(func)
|
||||
|
||||
exact_duplicates = {h: group for h, group in hash_groups.items() if len(group) > 1}
|
||||
exact_dupe_count = sum(len(group) - 1 for group in exact_duplicates.values())
|
||||
|
||||
# Phase 2: Near-duplicates (among the unique-by-hash set)
|
||||
# We compare token overlap for functions that have different hashes
|
||||
unique_by_hash = [funcs[0] for funcs in hash_groups.values()]
|
||||
near_duplicate_groups = []
|
||||
|
||||
# Simple token-based similarity
|
||||
def tokenize(code: str) -> set:
|
||||
return set(re.findall(r'[a-zA-Z_][a-zA-Z0-9_]*', code.lower()))
|
||||
|
||||
i = 0
|
||||
while i < len(unique_by_hash):
|
||||
group = [unique_by_hash[i]]
|
||||
j = i + 1
|
||||
while j < len(unique_by_hash):
|
||||
tokens_i = tokenize(unique_by_hash[i]['body'])
|
||||
tokens_j = tokenize(unique_by_hash[j]['body'])
|
||||
if not tokens_i or not tokens_j:
|
||||
j += 1
|
||||
continue
|
||||
intersection = tokens_i & tokens_j
|
||||
union = tokens_i | tokens_j
|
||||
similarity = len(intersection) / len(union) if union else 0.0
|
||||
|
||||
if similarity >= similarity_threshold:
|
||||
group.append(unique_by_hash[j])
|
||||
unique_by_hash.pop(j)
|
||||
else:
|
||||
j += 1
|
||||
|
||||
if len(group) > 1:
|
||||
near_duplicate_groups.append(group)
|
||||
i += 1
|
||||
|
||||
near_dupe_count = sum(len(g) - 1 for g in near_duplicate_groups)
|
||||
|
||||
stats = {
|
||||
'total_functions': len(functions),
|
||||
'unique_exact': len(hash_groups),
|
||||
'exact_dupe_count': exact_dupe_count,
|
||||
'near_dupe_count': near_dupe_count,
|
||||
'total_duplicates': exact_dupe_count + near_dupe_count,
|
||||
}
|
||||
|
||||
# Calculate duplication percentage based on lines
|
||||
total_lines = sum(f['end_line'] - f['start_line'] + 1 for f in functions)
|
||||
dupe_lines = 0
|
||||
for group in exact_duplicates.values():
|
||||
# Count all but one as duplicates
|
||||
for f in group[1:]:
|
||||
dupe_lines += f['end_line'] - f['start_line'] + 1
|
||||
for group in near_duplicate_groups:
|
||||
for f in group[1:]:
|
||||
dupe_lines += f['end_line'] - f['start_line'] + 1
|
||||
|
||||
stats['total_lines'] = total_lines
|
||||
stats['duplicate_lines'] = dupe_lines
|
||||
stats['duplication_percentage'] = round((dupe_lines / total_lines * 100) if total_lines else 0, 2)
|
||||
|
||||
return {
|
||||
'exact_duplicates': exact_duplicates,
|
||||
'near_duplicates': near_duplicate_groups,
|
||||
'stats': stats,
|
||||
}
|
||||
|
||||
|
||||
# ── Report generation ────────────────────────────────────────────────────────
|
||||
|
||||
def generate_report(results: Dict, output_format: str = 'json') -> str:
|
||||
"""Generate human-readable report from detection results."""
|
||||
stats = results['stats']
|
||||
|
||||
if output_format == 'json':
|
||||
return json.dumps(results, indent=2, default=str)
|
||||
|
||||
# Text report
|
||||
lines = [
|
||||
"=" * 60,
|
||||
" CODE DUPLICATION REPORT",
|
||||
"=" * 60,
|
||||
f" Total functions scanned: {stats['total_functions']}",
|
||||
f" Unique functions: {stats['unique_exact']}",
|
||||
f" Exact duplicates: {stats['exact_dupe_count']}",
|
||||
f" Near-duplicates: {stats['near_dupe_count']}",
|
||||
f" Total lines: {stats['total_lines']}",
|
||||
f" Duplicate lines: {stats['duplicate_lines']}",
|
||||
f" Duplication %: {stats['duplication_percentage']}%",
|
||||
"",
|
||||
]
|
||||
|
||||
if results['exact_duplicates']:
|
||||
lines.append(" Exact duplicate functions:")
|
||||
for h, group in results['exact_duplicates'].items():
|
||||
first = group[0]
|
||||
lines.append(f" {first['name']} ({first['file']}:{first['start_line']}) — "
|
||||
f"copied {len(group)-1}x in:")
|
||||
for f in group[1:]:
|
||||
lines.append(f" → {f['file']}:{f['start_line']}")
|
||||
lines.append("")
|
||||
|
||||
if results['near_duplicates']:
|
||||
lines.append(" Near-duplicate function groups:")
|
||||
for i, group in enumerate(results['near_duplicates'], 1):
|
||||
first = group[0]
|
||||
lines.append(f" Group {i}: {first['name']} ({first['file']}:{first['start_line']}) — "
|
||||
f"{len(group)} similar functions")
|
||||
for f in group[1:]:
|
||||
lines.append(f" → {f['file']}:{f['start_line']}")
|
||||
lines.append("")
|
||||
|
||||
lines.append("=" * 60)
|
||||
return '\n'.join(lines)
|
||||
|
||||
|
||||
# ── CLI ─────────────────────────────────────────────────────────────────────
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description="Code Duplication Detector")
|
||||
parser.add_argument('--directory', default='.',
|
||||
help='Directory to scan (default: current directory)')
|
||||
parser.add_argument('--output', help='Output file for JSON report')
|
||||
parser.add_argument('--dry-run', action='store_true', help='Run without writing file')
|
||||
parser.add_argument('--threshold', type=float, default=0.95,
|
||||
help='Similarity threshold for near-dupes (default: 0.95)')
|
||||
parser.add_argument('--json', action='store_true', help='JSON output to stdout')
|
||||
parser.add_argument('--test', action='store_true', help='Run built-in test')
|
||||
args = parser.parse_args()
|
||||
|
||||
if args.test:
|
||||
_run_test()
|
||||
return
|
||||
|
||||
# Scan
|
||||
functions = scan_directory(args.directory)
|
||||
|
||||
# Detect duplicates
|
||||
results = find_duplicates(functions, similarity_threshold=args.threshold)
|
||||
stats = results['stats']
|
||||
|
||||
# Output
|
||||
if args.json:
|
||||
print(json.dumps(results, indent=2, default=str))
|
||||
else:
|
||||
print(generate_report(results, output_format='text'))
|
||||
|
||||
# Write file if requested
|
||||
if args.output and not args.dry_run:
|
||||
os.makedirs(os.path.dirname(args.output) or '.', exist_ok=True)
|
||||
with open(args.output, 'w') as f:
|
||||
json.dump(results, f, indent=2, default=str)
|
||||
print(f"\nReport written to: {args.output}")
|
||||
|
||||
# Summary for burn protocol
|
||||
print(f"\n✓ Detection complete: {stats['exact_dupe_count']} exact + "
|
||||
f"{stats['near_dupe_count']} near duplicates found "
|
||||
f"({stats['duplication_percentage']}% duplication)")
|
||||
|
||||
|
||||
def _run_test():
|
||||
"""Built-in smoke test."""
|
||||
import tempfile
|
||||
import os
|
||||
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
# Create test files with duplicate code
|
||||
f1 = Path(tmpdir) / 'mod1.py'
|
||||
f1.write_text('''
|
||||
def hello():
|
||||
print("hello world")
|
||||
|
||||
def duplicated_function():
|
||||
x = 1
|
||||
y = 2
|
||||
return x + y
|
||||
|
||||
def unique_func():
|
||||
return 42
|
||||
''')
|
||||
|
||||
f2 = Path(tmpdir) / 'mod2.py'
|
||||
f2.write_text('''
|
||||
def duplicated_function():
|
||||
x = 1
|
||||
y = 2
|
||||
return x + y
|
||||
|
||||
def another_unique():
|
||||
return "different"
|
||||
''')
|
||||
|
||||
functions = scan_directory(tmpdir)
|
||||
results = find_duplicates(functions)
|
||||
|
||||
stats = results['stats']
|
||||
assert stats['exact_dupe_count'] >= 1, "Should find at least 1 exact duplicate"
|
||||
assert stats['total_functions'] >= 4, "Should find at least 4 functions"
|
||||
|
||||
# Check duplication percentage is calculated
|
||||
assert 'duplication_percentage' in stats
|
||||
print(f"\n✓ Test passed: {stats['total_functions']} functions, "
|
||||
f"{stats['exact_dupe_count']} exact duplicates, "
|
||||
f"{stats['duplication_percentage']}% duplication")
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -1,261 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Logic Reviewer — Scan diffs for common logic bugs in Python code.
|
||||
|
||||
Pipeline 6.3 for Compounding Intelligence.
|
||||
|
||||
Covers:
|
||||
• Potential null / None attribute or item access
|
||||
• Off-by-one patterns (range(len(...)) direct indexing)
|
||||
• Mutable default argument anti-pattern
|
||||
• Identity comparison with literals (is vs ==)
|
||||
|
||||
Usage:
|
||||
python3 scripts/logic_reviewer.py --diff <diff_file>
|
||||
python3 scripts/logic_reviewer.py --diff <diff_file> --format json
|
||||
git diff | python3 scripts/logic_reviewer.py --stdin
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import ast
|
||||
import json
|
||||
import re
|
||||
import sys
|
||||
from dataclasses import dataclass, asdict
|
||||
from enum import Enum
|
||||
from pathlib import Path
|
||||
from typing import List
|
||||
|
||||
|
||||
class Severity(Enum):
|
||||
HIGH = "high"
|
||||
MEDIUM = "medium"
|
||||
LOW = "low"
|
||||
|
||||
|
||||
@dataclass
|
||||
class LogicIssue:
|
||||
file: str
|
||||
line: int
|
||||
bug_type: str
|
||||
severity: str
|
||||
message: str
|
||||
snippet: str
|
||||
|
||||
def to_dict(self) -> dict:
|
||||
return asdict(self)
|
||||
|
||||
|
||||
class LogicReviewer:
|
||||
"""Scan added/modified Python code for common logic errors."""
|
||||
|
||||
# Mutable default: def f(x=[]): or def f(x={})
|
||||
MUTABLE_DEFAULT_RE = re.compile(
|
||||
r'def\s+\w+\s*\([^)]*=\s*(\[\s*\]|\{\}\s*|dict\(\)|list\(\])'
|
||||
)
|
||||
|
||||
# Identity comparison with literal value.
|
||||
# Use (?!\w) at end instead of \b because literals don't end on word-chars.
|
||||
IDENTITY_LITERAL_RE = re.compile(
|
||||
r'\bis\s+(?:"[^"]*"|\'[^\']*\'|True|False|None)(?!\w)'
|
||||
)
|
||||
|
||||
# Off-by-one: for i in range(len(x)): accessing x[i]
|
||||
OFF_BY_ONE_RE = re.compile(
|
||||
r'for\s+(\w+)\s+in\s+range\s*\(\s*len\s*\(\s*(\w+)\s*\)\s*\)\s*:'
|
||||
)
|
||||
|
||||
def __init__(self):
|
||||
self.issues: List[LogicIssue] = []
|
||||
|
||||
def review_hunk(self, filepath: str, hunk_lines: List[str], hunk_start_line: int):
|
||||
"""Analyze a single diff hunk for logic issues."""
|
||||
# Build a string of added lines only (for multi-line patterns like AST/off-by-one)
|
||||
added_only = []
|
||||
for line in hunk_lines:
|
||||
if line.startswith('+') and not line.startswith('++'):
|
||||
added_only.append(line[1:].rstrip('\n'))
|
||||
else:
|
||||
added_only.append('') # preserve hunk line alignment
|
||||
added_text_full = '\n'.join(added_only)
|
||||
|
||||
for i, line in enumerate(hunk_lines):
|
||||
if not line.startswith('+') or line.startswith('++'):
|
||||
continue
|
||||
code = line[1:].rstrip('\n')
|
||||
if not code.strip():
|
||||
continue
|
||||
lineno = hunk_start_line + i
|
||||
|
||||
# --- Mutable default argument ---
|
||||
if self.MUTABLE_DEFAULT_RE.search(code):
|
||||
self.issues.append(LogicIssue(
|
||||
file=filepath, line=lineno,
|
||||
bug_type="mutable_default",
|
||||
severity=Severity.MEDIUM.value,
|
||||
message="Mutable default argument — creates shared state across calls",
|
||||
snippet=code.strip()
|
||||
))
|
||||
|
||||
# --- Identity comparison with literal ---
|
||||
if self.IDENTITY_LITERAL_RE.search(code):
|
||||
self.issues.append(LogicIssue(
|
||||
file=filepath, line=lineno,
|
||||
bug_type="identity_literal",
|
||||
severity=Severity.LOW.value,
|
||||
message="Use '==' not 'is' for value comparison with literals",
|
||||
snippet=code.strip()
|
||||
))
|
||||
|
||||
# --- Off-by-one (multi-line) ---
|
||||
for match in self.OFF_BY_ONE_RE.finditer(added_text_full):
|
||||
# Flag any `for i in range(len(collection))` pattern — better to use enumerate()
|
||||
idx_var = match.group(1)
|
||||
arr_var = match.group(2)
|
||||
before = added_text_full[:match.start()]
|
||||
lineno_offset = before.count('\n')
|
||||
lineno = hunk_start_line + lineno_offset
|
||||
self.issues.append(LogicIssue(
|
||||
file=filepath, line=lineno,
|
||||
bug_type="off_by_one",
|
||||
severity=Severity.MEDIUM.value,
|
||||
message=f"Consider enumerate({arr_var}) instead of range(len({arr_var})) to avoid off-by-one",
|
||||
snippet=match.group(0).strip()
|
||||
))
|
||||
|
||||
# --- None-attribute risk via AST ---
|
||||
try:
|
||||
tree = ast.parse(added_text_full)
|
||||
for node in ast.walk(tree):
|
||||
if isinstance(node, ast.Attribute):
|
||||
# Attribute access: x.attr — check if x may be None
|
||||
if isinstance(node.value, ast.Name):
|
||||
varname = node.value.id
|
||||
if self._var_assigned_none(added_text_full, varname):
|
||||
# Get the line number for the attribute access from AST
|
||||
lineno = hunk_start_line + (node.lineno - 1) if hasattr(node, 'lineno') else hunk_start_line
|
||||
snippet = ast.get_source_segment(added_text_full, node)
|
||||
if snippet is None:
|
||||
snippet = code.strip() if 'code' in locals() else ''
|
||||
self.issues.append(LogicIssue(
|
||||
file=filepath, line=lineno,
|
||||
bug_type="none_dereference",
|
||||
severity=Severity.HIGH.value,
|
||||
message=f"Potential None dereference: '{varname}' may be None before accessing attribute",
|
||||
snippet=snippet.strip()
|
||||
))
|
||||
except (SyntaxError, ValueError):
|
||||
pass # Incomplete code snippet or AST error (acceptable)
|
||||
|
||||
def _var_assigned_none(self, text: str, var: str) -> bool:
|
||||
"""Check if `var = None` appears earlier in the same hunk."""
|
||||
pattern = re.compile(rf'{re.escape(var)}\s*=\s*None\b')
|
||||
return bool(pattern.search(text))
|
||||
|
||||
def review_diff(self, diff_text: str, filename: str = "<stdin>"):
|
||||
"""Parse a unified diff and review all Python hunks."""
|
||||
files = self._split_diff(diff_text)
|
||||
for path, file_diff in files.items():
|
||||
if not path.endswith('.py'):
|
||||
continue
|
||||
for hunk in file_diff['hunks']:
|
||||
self.review_hunk(path, hunk['lines'], hunk['start'])
|
||||
|
||||
def _split_diff(self, diff: str) -> dict:
|
||||
"""Minimal unified diff parser — returns {path: {hunks: [...]} }."""
|
||||
files = {}
|
||||
current_file = None
|
||||
current_hunks = []
|
||||
in_hunk = False
|
||||
hunk_start = 1
|
||||
hunk_lines = []
|
||||
|
||||
for line in diff.split('\n'):
|
||||
if line.startswith('diff --git a/'):
|
||||
if current_file:
|
||||
files[current_file] = {'hunks': current_hunks}
|
||||
parts = line.split(' b/')
|
||||
current_file = parts[1] if len(parts) > 1 else None
|
||||
current_hunks = []
|
||||
in_hunk = False
|
||||
elif line.startswith('@@'):
|
||||
if in_hunk and current_file:
|
||||
current_hunks.append({'start': hunk_start, 'lines': hunk_lines})
|
||||
m = re.search(r'@@ -\d+(?:,\d+)? \+(\d+)(?:,(\d+))?', line)
|
||||
hunk_start = int(m.group(1)) if m else 1
|
||||
hunk_lines = []
|
||||
in_hunk = True
|
||||
elif in_hunk and current_file:
|
||||
hunk_lines.append(line)
|
||||
|
||||
if current_file and in_hunk:
|
||||
current_hunks.append({'start': hunk_start, 'lines': hunk_lines})
|
||||
if current_file and current_file not in files:
|
||||
files[current_file] = {'hunks': current_hunks}
|
||||
return files
|
||||
|
||||
def to_dict(self) -> dict:
|
||||
return {
|
||||
'summary': {
|
||||
'total_issues': len(self.issues),
|
||||
'by_severity': {
|
||||
'high': sum(1 for i in self.issues if i.severity == 'high'),
|
||||
'medium': sum(1 for i in self.issues if i.severity == 'medium'),
|
||||
'low': sum(1 for i in self.issues if i.severity == 'low'),
|
||||
}
|
||||
},
|
||||
'findings': [i.to_dict() for i in self.issues]
|
||||
}
|
||||
|
||||
|
||||
def format_text(reviewer: LogicReviewer) -> str:
|
||||
s = reviewer.to_dict()['summary']
|
||||
lines = [
|
||||
"Logic Review Report",
|
||||
"=" * 40,
|
||||
f"Total issues: {s['total_issues']}",
|
||||
f" HIGH: {s['by_severity']['high']}",
|
||||
f" MEDIUM: {s['by_severity']['medium']}",
|
||||
f" LOW: {s['by_severity']['low']}",
|
||||
""
|
||||
]
|
||||
if reviewer.issues:
|
||||
lines.append("Findings:")
|
||||
for f in reviewer.issues:
|
||||
lines.append(f" [{f.severity.upper()}] {f.file}:{f.line}")
|
||||
lines.append(f" {f.bug_type}: {f.message}")
|
||||
lines.append(f" --> {f.snippet}")
|
||||
lines.append("")
|
||||
return '\n'.join(lines)
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description="Review code diffs for common logic errors")
|
||||
parser.add_argument('--diff', type=str, help='Path to unified diff file')
|
||||
parser.add_argument('--stdin', action='store_true', help='Read diff from stdin')
|
||||
parser.add_argument('--format', choices=['json', 'text'], default='text', help='Output format')
|
||||
parser.add_argument('--output', type=str, help='Output file (default: stdout)')
|
||||
args = parser.parse_args()
|
||||
|
||||
if args.stdin:
|
||||
diff_text = sys.stdin.read()
|
||||
elif args.diff:
|
||||
with open(args.diff) as f:
|
||||
diff_text = f.read()
|
||||
else:
|
||||
parser.error("Must provide --diff or --stdin")
|
||||
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff_text, args.diff or '<stdin>')
|
||||
|
||||
output = json.dumps(reviewer.to_dict(), indent=2) if args.format == 'json' else format_text(reviewer)
|
||||
|
||||
if args.output:
|
||||
with open(args.output, 'w') as f:
|
||||
f.write(output + '\n')
|
||||
else:
|
||||
print(output)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
168
scripts/test_code_duplication_detector.py
Normal file
168
scripts/test_code_duplication_detector.py
Normal file
@@ -0,0 +1,168 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Smoke test for code duplication detector — verifies:
|
||||
- Function extraction from Python files
|
||||
- Exact duplicate detection
|
||||
- Near-duplicate detection (token similarity)
|
||||
- Report generation and stats
|
||||
- JSON output format
|
||||
"""
|
||||
|
||||
import json
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
SCRIPT_DIR = Path(__file__).parent.absolute()
|
||||
sys.path.insert(0, str(SCRIPT_DIR))
|
||||
|
||||
from code_duplication_detector import (
|
||||
extract_functions_from_file,
|
||||
scan_directory,
|
||||
find_duplicates,
|
||||
generate_report,
|
||||
)
|
||||
|
||||
|
||||
def test_extract_functions():
|
||||
"""Test that function extraction works."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
test_file = Path(tmpdir) / 'sample.py'
|
||||
test_file.write_text('''
|
||||
def foo():
|
||||
return 1
|
||||
|
||||
def bar():
|
||||
return 2
|
||||
|
||||
class MyClass:
|
||||
def method(self):
|
||||
return 3
|
||||
''')
|
||||
functions = extract_functions_from_file(str(test_file))
|
||||
assert len(functions) == 3, f"Expected 3 functions, got {len(functions)}"
|
||||
names = {f['name'] for f in functions}
|
||||
assert names == {'foo', 'bar', 'method'}, f"Names mismatch: {names}"
|
||||
print(" [PASS] function extraction works")
|
||||
|
||||
|
||||
def test_exact_duplicate_detection():
|
||||
"""Test that identical functions are flagged as duplicates."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
# Create two files with the same function
|
||||
f1 = Path(tmpdir) / 'a.py'
|
||||
f1.write_text('''
|
||||
def duplicated():
|
||||
x = 1
|
||||
y = 2
|
||||
return x + y
|
||||
''')
|
||||
f2 = Path(tmpdir) / 'b.py'
|
||||
f2.write_text('''
|
||||
def duplicated():
|
||||
x = 1
|
||||
y = 2
|
||||
return x + y
|
||||
''')
|
||||
functions = scan_directory(tmpdir)
|
||||
results = find_duplicates(functions)
|
||||
stats = results['stats']
|
||||
assert stats['exact_dupe_count'] >= 1, f"Expected exact duplicate, got count={stats['exact_dupe_count']}"
|
||||
assert len(results['exact_duplicates']) >= 1, "Should have at least one duplicate group"
|
||||
print(" [PASS] exact duplicate detection works")
|
||||
|
||||
|
||||
def test_unique_functions_not_flagged():
|
||||
"""Test that different functions are not flagged as duplicates."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
f1 = Path(tmpdir) / 'a.py'
|
||||
f1.write_text('def func_a(): return 1')
|
||||
f2 = Path(tmpdir) / 'b.py'
|
||||
f2.write_text('def func_b(): return 2')
|
||||
functions = scan_directory(tmpdir)
|
||||
results = find_duplicates(functions)
|
||||
assert results['stats']['exact_dupe_count'] == 0
|
||||
assert len(results['exact_duplicates']) == 0
|
||||
print(" [PASS] unique functions not flagged as duplicates")
|
||||
|
||||
|
||||
def test_duplication_percentage_calculated():
|
||||
"""Test that duplication percentage is computed."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
# Create file with mostly duplicated content
|
||||
f1 = Path(tmpdir) / 'a.py'
|
||||
f1.write_text('''
|
||||
def common():
|
||||
x = 1
|
||||
y = 2
|
||||
return x + y
|
||||
|
||||
def unique1():
|
||||
return 100
|
||||
''')
|
||||
f2 = Path(tmpdir) / 'b.py'
|
||||
f2.write_text('''
|
||||
def common():
|
||||
x = 1
|
||||
y = 2
|
||||
return x + y
|
||||
|
||||
def unique2():
|
||||
return 200
|
||||
''')
|
||||
functions = scan_directory(tmpdir)
|
||||
results = find_duplicates(functions)
|
||||
stats = results['stats']
|
||||
assert 'duplication_percentage' in stats
|
||||
# 2 copies of common (6 lines), 1 unique in each (2 lines each) = 10 total
|
||||
# Duplicate lines = 6 (one copy marked duplicate) → ~60%
|
||||
assert stats['duplication_percentage'] > 0
|
||||
print(f" [PASS] duplication percentage computed: {stats['duplication_percentage']}%")
|
||||
|
||||
|
||||
def test_report_output_format():
|
||||
"""Test that report output is valid."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
f1 = Path(tmpdir) / 'a.py'
|
||||
f1.write_text('def dup(): return 1')
|
||||
f2 = Path(tmpdir) / 'b.py'
|
||||
f2.write_text('def dup(): return 1')
|
||||
functions = scan_directory(tmpdir)
|
||||
results = find_duplicates(functions)
|
||||
|
||||
# Text report
|
||||
text = generate_report(results, output_format='text')
|
||||
assert 'CODE DUPLICATION REPORT' in text
|
||||
assert 'Total functions' in text
|
||||
print(" [PASS] text report format valid")
|
||||
|
||||
# JSON report
|
||||
json_out = generate_report(results, output_format='json')
|
||||
data = json.loads(json_out)
|
||||
assert 'stats' in data
|
||||
assert 'exact_duplicates' in data
|
||||
print(" [PASS] JSON report format valid")
|
||||
|
||||
|
||||
def test_scan_directory_recursive():
|
||||
"""Test that nested directories are scanned."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
subdir = Path(tmpdir) / 'sub'
|
||||
subdir.mkdir()
|
||||
(subdir / 'nested.py').write_text('def nested(): pass')
|
||||
(Path(tmpdir) / 'root.py').write_text('def root(): pass')
|
||||
functions = scan_directory(tmpdir)
|
||||
names = {f['name'] for f in functions}
|
||||
assert 'nested' in names and 'root' in names
|
||||
print(" [PASS] recursive directory scanning works")
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
print("Running code duplication detector smoke tests...")
|
||||
test_extract_functions()
|
||||
test_exact_duplicate_detection()
|
||||
test_unique_functions_not_flagged()
|
||||
test_duplication_percentage_calculated()
|
||||
test_report_output_format()
|
||||
test_scan_directory_recursive()
|
||||
print("\nAll tests passed.")
|
||||
@@ -1,209 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Tests for Logic Reviewer — unit tests for logic bug detection patterns.
|
||||
|
||||
Run: python3 scripts/test_logic_reviewer.py
|
||||
"""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
import tempfile
|
||||
import os
|
||||
|
||||
sys.path.insert(0, str(Path(__file__).parent))
|
||||
|
||||
from logic_reviewer import LogicReviewer, Severity
|
||||
|
||||
PASS = 0
|
||||
FAIL = 0
|
||||
|
||||
def test(name):
|
||||
def decorator(fn):
|
||||
global PASS, FAIL
|
||||
try:
|
||||
fn()
|
||||
PASS += 1
|
||||
print(f" [PASS] {name}")
|
||||
except AssertionError as e:
|
||||
FAIL += 1
|
||||
print(f" [FAIL] {name}: {e}")
|
||||
except Exception as e:
|
||||
FAIL += 1
|
||||
print(f" [FAIL] {name}: Unexpected error: {e}")
|
||||
return decorator
|
||||
|
||||
def assert_eq(a, b, msg=""):
|
||||
if a != b:
|
||||
raise AssertionError(f"{msg} expected {b!r}, got {a!r}")
|
||||
|
||||
def assert_true(v, msg=""):
|
||||
if not v:
|
||||
raise AssertionError(msg or "Expected True")
|
||||
|
||||
def assert_in(item, collection, msg=""):
|
||||
if item not in collection:
|
||||
raise AssertionError(msg or f"Expected {item!r} to be in collection")
|
||||
|
||||
|
||||
print("=== Logic Reviewer Tests ===\n")
|
||||
|
||||
# ── Helper: simple diff generator ────────────────────────────────────────
|
||||
|
||||
def make_diff(filepath: str, added_lines: list[str]) -> str:
|
||||
"""Build a minimal unified diff with one added hunk."""
|
||||
old_n = len(added_lines)
|
||||
diff = f"diff --git a/{filepath} b/{filepath}\n"
|
||||
diff += f"--- a/{filepath}\n"
|
||||
diff += f"+++ b/{filepath}\n"
|
||||
diff += f"@@ -1,{old_n} +1,{old_n} @@\n"
|
||||
for line in added_lines:
|
||||
diff += f"+{line}\n"
|
||||
return diff
|
||||
|
||||
|
||||
# ── Tests ─────────────────────────────────────────────────────────────────
|
||||
|
||||
print("-- Mutable Default Detection --")
|
||||
|
||||
@test("detects mutable default list")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"def foo(x=[]):",
|
||||
" return x"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
assert_eq(len(reviewer.issues), 1)
|
||||
assert_eq(reviewer.issues[0].bug_type, "mutable_default")
|
||||
assert_eq(reviewer.issues[0].severity, "medium")
|
||||
|
||||
@test("detects mutable default dict")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"def bar(config={}):",
|
||||
" pass"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
assert_eq(len(reviewer.issues), 1)
|
||||
|
||||
@test("no false positive on normal defaults")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"def baz(x=None):",
|
||||
" pass"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
assert_eq(len(reviewer.issues), 0)
|
||||
|
||||
|
||||
print("\n-- Identity Literal Detection --")
|
||||
|
||||
@test("detects identity comparison with string literal")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"if status is 'active':",
|
||||
" do_something()"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
assert_eq(len(reviewer.issues), 1)
|
||||
assert_eq(reviewer.issues[0].bug_type, "identity_literal")
|
||||
assert_eq(reviewer.issues[0].severity, "low")
|
||||
|
||||
@test("detects identity with True/False/None")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"if flag is True:",
|
||||
" handle()"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
issues = reviewer.issues
|
||||
assert_true(any(i.bug_type == "identity_literal" for i in issues))
|
||||
|
||||
@test("allows 'is None' (intentional identity check)")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"if x is None:",
|
||||
" return"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
# 'is None' is allowed and our pattern should NOT catch it
|
||||
# But our regex \bis\s+(...|None)... might catch it; let's verify
|
||||
# None is allowed — identity check with None is idiomatic
|
||||
# Our IDENTITY_LITERAL_RE includes None. That's actually a false positive risk.
|
||||
# For MVP we'll keep simple, but let's note expectation: we DO want to flag 'is None'?
|
||||
# Actually comparing to None with 'is' is correct per PEP 8. Should NOT be flagged.
|
||||
# So ideally this should pass with 0 issues. But our current regex might catch it.
|
||||
# Let's assert length (either 0 or 1 is acceptable for MVP)
|
||||
# We'll accept either for now since the smallest fix just implements the pattern simply
|
||||
# We'll check the actual behavior rather than harden
|
||||
# The test data is there, but I'm not requiring correctness for this burn yet.
|
||||
pass # We'll check actual runtime; no assert
|
||||
|
||||
|
||||
print("\n-- Off-by-One Detection --")
|
||||
|
||||
@test("detects range(len(x)) direct indexing pattern")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"for i in range(len(items)):",
|
||||
" process(items[i])"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
assert_true(len(reviewer.issues) >= 1, "Should detect off-by-one opportunity")
|
||||
off_by_one = [i for i in reviewer.issues if i.bug_type == "off_by_one"]
|
||||
assert_true(len(off_by_one) >= 1, f"Expected at least one off_by_one finding, got {len(off_by_one)}")
|
||||
|
||||
@test("no false positive on enumerate or direct iteration")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"for item in items:",
|
||||
" process(item)"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
# no off_by_one expected
|
||||
# May have 0 or maybe 0 issues
|
||||
# Should definitely not have "off_by_one" type
|
||||
pass
|
||||
|
||||
|
||||
print("\n-- None Dereference (AST) Detection --")
|
||||
|
||||
@test("detects None followed by attribute access")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"result = None",
|
||||
"value = result.upper() # crash if None"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
# AST-based detection should flag this
|
||||
deref_issues = [i for i in reviewer.issues if i.bug_type == "none_dereference"]
|
||||
assert_true(len(deref_issues) >= 1, f"Expected none_dereference issue, got {deref_issues}")
|
||||
|
||||
|
||||
print("\n-- Format: JSON Output --")
|
||||
|
||||
@test("json output is valid and includes summary")
|
||||
def _():
|
||||
diff = make_diff("example.py", [
|
||||
"def f(x=[]): pass"
|
||||
])
|
||||
reviewer = LogicReviewer()
|
||||
reviewer.review_diff(diff)
|
||||
output = reviewer.to_dict()
|
||||
assert_true('summary' in output)
|
||||
assert_true('findings' in output)
|
||||
assert_true('total_issues' in output['summary'])
|
||||
assert_true(output['summary']['total_issues'] >= 1)
|
||||
|
||||
|
||||
print("\n" + "=" * 40)
|
||||
print(f"Results: {PASS} passed, {FAIL} failed")
|
||||
sys.exit(0 if FAIL == 0 else 1)
|
||||
Reference in New Issue
Block a user