Option C Tools
Loading...
Searching...
No Matches
tests_health.test_docs_health Namespace Reference

Functions

 test_docs_health_all_present (Path temp_project_root)
 test_docs_health_missing_architecture (Path temp_project_root)
 test_docs_health_missing_config (Path temp_project_root)
 test_docs_health_missing_changelog (Path temp_project_root)
 test_docs_health_security_optional_outside_production (Path temp_project_root)
 test_docs_health_security_required_in_production (Path temp_project_root)
 test_docs_health_all_missing (Path temp_project_root)
 test_docs_health_file_list_structure (Path temp_project_root)

Detailed Description

Tests for documentation health check.

Purpose
-------
Verify that check_docs_health correctly validates required documentation files.

Responsibilities
----------------
- Test all docs present.
- Test individual missing files.
- Test completely missing docs.

Diagnostics
-----------
Domain: TESTS.HEALTH
Levels:
    L2 — test lifecycle
    L3 — docs validation
    L4 — per-file presence checks

Contracts
---------
- All four required files are checked.
- Counts match actual file presence.

Function Documentation

◆ test_docs_health_all_missing()

tests_health.test_docs_health.test_docs_health_all_missing ( Path temp_project_root)
Test when no required docs exist.

Definition at line 116 of file test_docs_health.py.

◆ test_docs_health_all_present()

tests_health.test_docs_health.test_docs_health_all_present ( Path temp_project_root)
Test that all required docs are detected when present.

Definition at line 38 of file test_docs_health.py.

◆ test_docs_health_file_list_structure()

tests_health.test_docs_health.test_docs_health_file_list_structure ( Path temp_project_root)
Test that file list has correct structure.

Definition at line 124 of file test_docs_health.py.

◆ test_docs_health_missing_architecture()

tests_health.test_docs_health.test_docs_health_missing_architecture ( Path temp_project_root)
Test detection of missing ARCHITECTURE.md.

Definition at line 53 of file test_docs_health.py.

◆ test_docs_health_missing_changelog()

tests_health.test_docs_health.test_docs_health_missing_changelog ( Path temp_project_root)
CHANGELOG.md is required at Standard maturity (drift item B1).

Definition at line 81 of file test_docs_health.py.

◆ test_docs_health_missing_config()

tests_health.test_docs_health.test_docs_health_missing_config ( Path temp_project_root)
Test detection of missing debug_config.json.

Definition at line 67 of file test_docs_health.py.

◆ test_docs_health_security_optional_outside_production()

tests_health.test_docs_health.test_docs_health_security_optional_outside_production ( Path temp_project_root)
SECURITY.md is shown but not required outside Production maturity.

Definition at line 96 of file test_docs_health.py.

◆ test_docs_health_security_required_in_production()

tests_health.test_docs_health.test_docs_health_security_required_in_production ( Path temp_project_root)
SECURITY.md is required when production_mode=True (Appendix H Level 2).

Definition at line 107 of file test_docs_health.py.