Skip to content

Fix README tests to match restructured documentation - #2

Open
msarg44 wants to merge 1 commit into
cdxiaodong:mainfrom
msarg44:fix-readme-tests-after-restructure
Open

Fix README tests to match restructured documentation#2
msarg44 wants to merge 1 commit into
cdxiaodong:mainfrom
msarg44:fix-readme-tests-after-restructure

Conversation

@msarg44

@msarg44 msarg44 commented Aug 12, 2026

Copy link
Copy Markdown

The README was rewritten today (commit 0f3aa88) which replaced the old ## Features section with ## Why Cain and dropped the explicit OWASP skill enumeration. Two corresponding tests were not updated, causing the test suite to fail.

Changes:

  • Replaced test_features_section with test_sections_present that validates all current README sections, including ## Why Cain and ## ⚠️ Legal & Ethical Use (with emoji)
  • Replaced test_owasp_coverage with test_skills_coverage that checks for capabilities actually mentioned in the new README: cloud module, read-only, and benchmark

Test results:

  • Before: 834 passed, 2 failed, 3 skipped
  • After: 836 passed, 0 failed, 3 skipped

The README was rewritten on 2026-08-12 (commit 0f3aa88) which replaced
the old ## Features section with ## Why Cain and dropped the explicit
OWASP skill enumeration. The two corresponding tests (test_features_section
and test_owasp_coverage) were not updated, causing the test suite to fail.

Changes:
- Replaced test_features_section with test_sections_present that validates
  all current README sections including the new ## Why Cain and the
  ## ⚠️ Legal & Ethical Use heading (with emoji)
- Replaced test_owasp_coverage with test_skills_coverage that checks for
  capabilities actually mentioned in the new README: cloud module,
  read-only, and benchmark
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant