Commit graph

6 commits

Author SHA1 Message Date
jedarden
724321d610 docs(bf-58z9ib): add common issues and resolutions to orphaned process troubleshooting
Add comprehensive "Common Issues and Resolutions" section documenting
5 frequently encountered orphaned process scenarios with step-by-step
resolution procedures:

1. Address Already in Use Error - Port conflicts from stale servers
2. Test Suite Hangs Indefinitely - Pipe buffer blocking wait()
3. Multiple Orphaned Processes After CI Timeout - Fuzz harness interruption
4. Zombie Process Accumulation - Unreaped children
5. Permission Denied on Verification Script - Missing execute bit

Each issue includes:
- Clear symptom description
- Root cause analysis
- Step-by-step resolution commands
- Code examples for fixes
- Prevention strategies

Resolves bead bf-58z9ib acceptance criteria:
- Lists at least 3 common issues with resolutions  (5 documented)
- File is committed to git 

Process pattern explanations (pdftract mcp, TH-0, TH_0) already exist
in docs/test-hygiene/orphaned-process-verification.md lines 110-251.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-07 03:27:44 -04:00
jedarden
dff8cfdbb1 docs(bf-51qlcf): add manual verification usage examples
Add comprehensive manual verification examples section to post-test
orphan verification documentation including:

- Basic verification commands (quick check, strict mode, JSON output)
- Specific process pattern checking (pdftract mcp, TH-0, TH_0)
- 5 common usage scenarios (development, pre-commit, debugging, monitoring, post-merge)
- Interactive vs. non-interactive modes
- Troubleshooting examples

All examples include command syntax and expected output for clarity.
Examples are copy-pasteable and cover both successful and failure cases.

Closes bf-51qlcf. Verification: notes/bf-51qlcf.md
2026-07-07 03:21:46 -04:00
jedarden
d5a2213467 docs(bf-vqcg3g): add reference to post-test integration documentation
Added cross-reference in the References section of the orphaned process
verification guide to link to the post-test integration documentation for
CI workflow integration details.

Acceptance criteria:
- File exists at docs/test-hygiene/orphaned-process-verification.md ✓
- Contains clear introduction to orphaned process verification ✓
- Documents basic verification script usage ✓
- References the post-test integration documentation ✓

Verification: docs/test-hygiene/orphaned-process-verification.md
2026-07-07 03:17:28 -04:00
jedarden
f5b8489676 docs(bf-md1uka): add troubleshooting guide for orphaned processes
- Added comprehensive troubleshooting section with investigation procedures
- Documented cleanup commands: pgrep, pkill, kill with safety warnings
- Included force-kill warnings with data loss risks and mitigations
- Provided verification procedures (immediate, post-cleanup, automated)
- Added 4-level escalation path for stubborn orphans
- Implemented decision flowchart and step-by-step investigation guide
- Closes bf-md1uka. Verification: notes/bf-md1uka.md
2026-07-07 02:55:19 -04:00
jedarden
8b711f182f docs(bf-vnx45a): add manual verification examples and process pattern explanations
Added comprehensive documentation for orphaned process verification:

- Detailed explanations for three default process patterns:
  * pdftract mcp (MCP server subprocess)
  * TH-0 (test harness - hyphen variant)
  * TH_0 (test harness - underscore variant)

- Each pattern includes:
  * What it is and when it appears
  * Typical spawn patterns
  * Why it orphans (root causes)
  * Detection examples with expected output
  * Manual cleanup commands

- Manual verification walkthrough with 4 scenarios:
  * After a test run (normal workflow)
  * Before starting a test run (pre-flight check)
  * Investigating a leaking test (binary search)
  * CI post-test verification (automation)

- 5 common orphan scenarios with symptoms, verification, and fixes:
  * Test timeout leaves children alive
  * Panic before cleanup
  * Undrained Stdio::piped() blocks wait()
  * Port already in use from previous run
  * Fuzz harness leaves target processes

All examples include realistic command-line output and reference existing
cleanup patterns (OrphanedProcessGuard, RAII).

Verification: notes/bf-vnx45a.md
Closes bf-vnx45a
2026-07-07 02:50:08 -04:00
jedarden
e946d84dce docs(bf-1lghw6): add orphaned process verification documentation
Create comprehensive documentation for orphaned process verification
system at docs/test-hygiene/orphaned-process-verification.md

The documentation includes:
- Overview of orphaned process verification and why it matters
- Usage instructions for scripts/check-orphaned-processes.sh
- Verification methods (shell script, Rust helpers, CI integration)
- Best practices for RAII guards and process cleanup
- CI integration examples
- Troubleshooting guide

Closes bf-1lghw6. Verification: notes/bf-1lghw6.md
2026-07-07 02:45:45 -04:00