#!/usr/bin/env python3
"""
Release readiness checker for Cyber Sentinel MCP
"""
import os
import sys
import subprocess
import re
from pathlib import Path
import json
def run_command(cmd, capture_output=True):
"""Run a command and return the result"""
try:
result = subprocess.run(
cmd, shell=True, capture_output=capture_output, text=True
)
return result.returncode == 0, result.stdout, result.stderr
except Exception as e:
return False, "", str(e)
def check_file_exists(filepath, description):
"""Check if a file exists"""
if Path(filepath).exists():
print(f"✅ {description}")
return True
else:
print(f"❌ {description}")
return False
def check_version_consistency():
"""Check if version is consistent across files"""
print("\n📋 Checking version consistency...")
# Get version from pyproject.toml
pyproject_path = Path("pyproject.toml")
if not pyproject_path.exists():
print("❌ pyproject.toml not found")
return False
content = pyproject_path.read_text()
version_match = re.search(r'version = "([^"]+)"', content)
if not version_match:
print("❌ Version not found in pyproject.toml")
return False
version = version_match.group(1)
print(f"📦 Found version: {version}")
# Check if version follows semantic versioning
if not re.match(r'^\d+\.\d+\.\d+$', version):
print(f"⚠️ Version {version} doesn't follow semantic versioning (X.Y.Z)")
return False
print(f"✅ Version format is valid: {version}")
return True
def check_tests():
"""Run tests and check if they pass"""
print("\n🧪 Running tests...")
success, stdout, stderr = run_command("python -m pytest tests/ -v --tb=short")
if success:
print("✅ All tests pass")
return True
else:
print("❌ Tests failed")
print(f"Error: {stderr}")
return False
def check_code_quality():
"""Check code formatting and quality"""
print("\n🎨 Checking code quality...")
checks = [
("black --check src/ tests/", "Code formatting (black)"),
("isort --check-only src/ tests/", "Import sorting (isort)"),
]
all_passed = True
for cmd, description in checks:
success, _, _ = run_command(cmd)
if success:
print(f"✅ {description}")
else:
print(f"❌ {description}")
all_passed = False
# Try mypy but don't fail if it has external library issues
print("🔍 Running type checking (mypy)...")
success, stdout, stderr = run_command("mypy src/")
if success:
print("✅ Type checking (mypy)")
else:
# Check if it's just external library issues
error_text = stderr + stdout
if "mcp" in error_text or "Pattern matching is only supported" in error_text:
print("⚠️ Type checking has external library issues (acceptable)")
else:
print("❌ Type checking (mypy)")
print(f"Error: {stderr}")
all_passed = False
return all_passed
def check_security():
"""Run security checks"""
print("\n🔒 Running security checks...")
# Check if bandit is available
success, _, _ = run_command("bandit --version")
if not success:
print("⚠️ bandit not installed, skipping security check")
return True
success, _, _ = run_command("bandit -r src/ -f json")
if success:
print("✅ Security check passed")
return True
else:
print("❌ Security issues found")
return False
def check_documentation():
"""Check if documentation files exist and are up-to-date"""
print("\n📚 Checking documentation...")
required_files = [
("README.md", "README file"),
("CHANGELOG.md", "Changelog"),
("LICENSE", "License file"),
("CONTRIBUTING.md", "Contributing guide"),
("PUBLISHING_GUIDE.md", "Publishing guide"),
("mcp.json", "MCP metadata"),
]
all_exist = True
for filepath, description in required_files:
if not check_file_exists(filepath, description):
all_exist = False
return all_exist
def check_build():
"""Check if package builds successfully"""
print("\n🔨 Checking package build...")
# Clean previous builds
run_command("rm -rf dist/ build/ *.egg-info/")
success, _, stderr = run_command("python -m build")
if success:
print("✅ Package builds successfully")
# Check if built files exist
dist_files = list(Path("dist").glob("*"))
if len(dist_files) >= 2: # Should have .tar.gz and .whl
print(f"✅ Built {len(dist_files)} distribution files")
return True
else:
print(f"⚠️ Only {len(dist_files)} distribution files found")
return False
else:
print("❌ Package build failed")
print(f"Error: {stderr}")
return False
def check_git_status():
"""Check git repository status"""
print("\n📝 Checking git status...")
# Check if there are uncommitted changes
success, stdout, _ = run_command("git status --porcelain")
if success:
if stdout.strip():
print("⚠️ There are uncommitted changes:")
print(stdout)
return False
else:
print("✅ No uncommitted changes")
return True
else:
print("⚠️ Not a git repository or git not available")
return True
def check_github_actions():
"""Check if GitHub Actions workflows exist"""
print("\n🔄 Checking GitHub Actions...")
workflows_dir = Path(".github/workflows")
if not workflows_dir.exists():
print("❌ .github/workflows directory not found")
return False
required_workflows = ["ci.yml", "release.yml"]
all_exist = True
for workflow in required_workflows:
workflow_path = workflows_dir / workflow
if workflow_path.exists():
print(f"✅ {workflow} workflow exists")
else:
print(f"❌ {workflow} workflow missing")
all_exist = False
return all_exist
def main():
"""Main function to run all checks"""
print("🛡️ Cyber Sentinel MCP - Release Readiness Check")
print("=" * 50)
# Change to project directory if script is run from elsewhere
script_dir = Path(__file__).parent.parent
os.chdir(script_dir)
checks = [
("Documentation", check_documentation),
("Version Consistency", check_version_consistency),
("Tests", check_tests),
("Code Quality", check_code_quality),
("Security", check_security),
("Package Build", check_build),
("Git Status", check_git_status),
("GitHub Actions", check_github_actions),
]
results = {}
all_passed = True
for check_name, check_func in checks:
try:
result = check_func()
results[check_name] = result
if not result:
all_passed = False
except Exception as e:
print(f"❌ {check_name} check failed with error: {e}")
results[check_name] = False
all_passed = False
# Summary
print("\n" + "=" * 50)
print("📊 SUMMARY")
print("=" * 50)
for check_name, result in results.items():
status = "✅ PASS" if result else "❌ FAIL"
print(f"{status} {check_name}")
print("\n" + "=" * 50)
if all_passed:
print("🎉 ALL CHECKS PASSED! Ready for release! 🚀")
print("\nNext steps:")
print("1. Run: python scripts/release.py <version>")
print("2. Or create a git tag: git tag v<version>")
print("3. Push the tag: git push origin v<version>")
else:
print("❌ SOME CHECKS FAILED! Please fix issues before release.")
print("\nFailed checks need to be addressed before release.")
return 0 if all_passed else 1
if __name__ == "__main__":
sys.exit(main())
