Skip to content

Fix README tests to match restructured documentation #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
msarg44 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix README tests to match restructured documentation #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions tests/test_readme.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,16 @@ def test_readme_exists():
assert Path("README.md").exists()


def test_features_section():
def test_sections_present():
content = Path("README.md").read_text(encoding="utf-8")
assert "## Features" in content
assert "## Why Cain" in content
assert "## Quick Start" in content
assert "## Architecture" in content
assert "## Cloud Module" in content
assert "## Benchmark" in content
assert "## ⚠️ Legal & Ethical Use" in content
assert "## Status" in content
assert "## License" in content


def test_cloud_coverage():
Expand All @@ -18,11 +25,11 @@ def test_cloud_coverage():
assert cloud in content


def test_owasp_coverage():
def test_skills_coverage():
content = Path("README.md").read_text(encoding="utf-8")
skills = ["SQLi", "XSS", "SSRF", "CSRF", "File Upload", "XXE", "Command Injection", "Path Traversal"]
for skill in skills:
assert skill in content
assert "cloud module" in content
assert "read-only" in content
assert "benchmark" in content


def test_no_sensitive_info():
Expand Down